Class: Que::Scheduler::Schedule

Inherits:
Object
  • Object
show all
Defined in:
lib/que/scheduler/schedule.rb

Class Method Summary collapse

Class Method Details

.from_file(location) ⇒ Object 



29
30
31
 
# File 'lib/que/scheduler/schedule.rb', line 29

def from_file(location)
  from_yaml(File.read(location))
end

.from_hash(config_hash) ⇒ Object 



38
39
40
41
42
 
# File 'lib/que/scheduler/schedule.rb', line 38

def from_hash(config_hash)
  config_hash
    .map { |name, defined_job_hash| hash_item_to_defined_job(name.to_s, defined_job_hash) }
    .index_by(&:name)
end

.from_yaml(config) ⇒ Object 



33
34
35
36
 
# File 'lib/que/scheduler/schedule.rb', line 33

def from_yaml(config)
  config_hash = YAML.safe_load(config)
  from_hash(config_hash)
end

.hash_item_to_defined_job(name, defined_job_hash_in) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/que/scheduler/schedule.rb', line 44

def hash_item_to_defined_job(name, defined_job_hash_in)
  defined_job_hash = defined_job_hash_in.stringify_keys
  # Que stores arguments as a json array. If the args we have to provide are already an
  # array we can can simply pass them through. If it is a single non-nil value, then we make
  # an array with one item which is that value (this includes if it is a hash). It could
  # also be a single nil value.
  args_array =
    if defined_job_hash.key?("args")
      args = defined_job_hash["args"]
      if args.is_a?(Array)
        # An array of args was requested
        args
      else
        # A single value, a nil, or a hash was requested. que expects this to
        # be enqueued as an array of 1 item
        [args]
      end
    else
      # No args were requested
      []
    end

  Que::Scheduler::DefinedJob.create(
    name: name,
    job_class: defined_job_hash["class"]&.to_s || name,
    queue: defined_job_hash["queue"],
    args_array: args_array,
    priority: defined_job_hash["priority"],
    cron: defined_job_hash["cron"],
    schedule_type: defined_job_hash["schedule_type"]&.to_sym
  )
end

.schedule ⇒ Object

The main method for determining the schedule. It has to evaluate the schedule as late as possible (ie just as it is about to be used) as we cannot guarantee we are in a Rails app with initializers. In a future release this may change to “fast fail” in Rails by checking the config up front.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/que/scheduler/schedule.rb', line 12

def schedule
  @schedule ||=
    begin
      configuration = Que::Scheduler.configuration
      if !configuration.schedule.nil?
        # If an explicit schedule as a hash has been defined, use that.
        from_hash(configuration.schedule)
      elsif File.exist?(configuration.schedule_location)
        # If the schedule is defined as a file location, then load it and return it.
        from_file(configuration.schedule_location)
      else
        raise "No que-scheduler config set, or file found " \
              "at #{configuration.schedule_location}"
      end
    end
end