que-scheduler 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6250ff590c3c280c0219d93ba57f85758a993fba1185d2064f1ba714c8c9e4c
-  data.tar.gz: cb49ce9c63314888e05f48cc7cd5a98817deb0df03763b9aae756055261acdbb
+  metadata.gz: 78c9bc8d137dbe8a7c2428e50c615928c5d702d06432763b5346030fcbe81d5b
+  data.tar.gz: 3e639fd3f2263266fa25e25c637390f718e7751726feaefaa63f69cc91124f2d
 SHA512:
-  metadata.gz: 9516e812e2d394d5ff7c23641db0344a34c3560ad4ed02a114cc9820beee8202da9416450fbfc68f92bfaa6aed4f5bf16d1df3d2476f487a58f6f0fb32141aa1
-  data.tar.gz: 4d29b9a9161713935ccf1dcea71303195131fa8c27570b05a528fdec68d146b72c316ebeed523fabecda625c0128e4accca76ba0f47ba63fb8ff1d6106c96120
+  metadata.gz: b599d23b38d8263412e2a1fa7eb6621f564a628ae7b66800b0259667a76956e0a9e16824bd463a24edd0752119f30ec01ac3a1951e1d4abfc1d05ed1905745dc
+  data.tar.gz: 42691328a2727e14f15305e6baac0f0d7b3e4cb1d1a91c80d2ef1f7ab42db56e3bd1640884805adf381d65fbe2d6b3d7abbe2373e8ef49dfbeb737f790b76700

data/README.md

@@ -36,8 +36,8 @@ resque-scheduler files, but with additional features.
 ## Schedule configuration
 
 The schedule file should be placed here: `config/que_schedule.yml`. Alternatively if you
-wish to generate the configuration dynamically, you can set it directly with
-`Que::Scheduler.schedule = some_hash`.
+wish to generate the configuration dynamically, you can set it directly using an initializer
+(see "Gem configuration" below).
 
 The file is a list of que job classes with arguments and a schedule frequency (in crontab 
 syntax). The format is similar to the resque-scheduler format, though priorities must be supplied as
@@ -135,19 +135,34 @@ A job can have a `schedule_type` assigned to it. Valid values are:
 
 ## Gem configuration
 
-You can configure some aspects of the gem with an initializer. The default is given below.
+You can configure some aspects of the gem with a config block (eg in a Rails initializer). 
+The default is given below. You can omit any configuration sections you are not intending to change.
+It is quite likely you won't have to create this config at all.
 
 ```ruby
 Que::Scheduler.configure do |config|
   # The location of the schedule yaml file.
-  config.schedule_location = ENV.fetch('QUE_SCHEDULER_CONFIG_LOCATION', 'config/que_schedule.yml')
+  config.schedule_location = ENV.fetch("QUE_SCHEDULER_CONFIG_LOCATION", "config/que_schedule.yml")
+
+  # The schedule as a hash. You can use this if you want to build the schedule yourself at runtime.
+  # This will override the above value if provided.
+  config.schedule = {
+    SpecifiedByHashTestJob: {
+      cron: "02 11 * * *"
+    }
+  }
   
-  # Specify a transaction block adapter. By default, que-scheduler uses the one supplied by que.
-  # However, if, for example you rely on listeners to ActiveRecord's exact `transaction` method, or 
+  # The transaction block adapter. By default, que-scheduler uses the one supplied by que.
+  # However if, for example, you rely on listeners to ActiveRecord's exact `transaction` method, or 
   # Sequel's DB.after_commit helper, then you can supply it here.
   config.transaction_adapter = ::Que.method(:transaction)
-end
 
+  # Which queue name the que-scheduler job should self-schedule on. Typically this is the default
+  # queue of que, which has a different name in Que 0.x ("") and 1.x ("default").
+  # It *must* be the "highest throughput" queue - do not work the scheduler on a "long 
+  # running jobs" queue. It is very unlikely you will want to change this. 
+  config.que_scheduler_queue = ENV.fetch("QUE_SCHEDULER_QUEUE", "" or "default")
+end
 ```
 
 ## Scheduler Audit
@@ -159,8 +174,25 @@ migration tasks.
 Additionally, there is the audit table `que_scheduler_audit_enqueued`. This logs every job that 
 the scheduler enqueues.
 
+que-scheduler comes with the `QueSchedulerAuditClearDownJob` job built in that you can optionally
+schedule to clear down audit rows if you don't need to retain them indefinitely. You should add this
+to your own scheduler config yaml.
+
+For example:
+
+```yaml
+# This will clear down the oldest que-scheduler audit rows. Since que-scheduler
+# runs approximately every minute, 129600 is 90 days.
+Que::Scheduler::Jobs::QueSchedulerAuditClearDownJob:
+  cron: "0 0 * * *"
+  args:
+    retain_row_count: 129600
+```
+
+## Required migrations
+
 When there is a major version (breaking) change, a migration should be run in. The version of the 
-latest migration proceeds at a faster rate than the version of the gem, eg if the gem is on version
+latest migration proceeds at a faster rate than the version of the gem. eg If the gem is on version
 3 then the migrations may be on version 6). 
 
 To run in all the migrations required up to a number, just migrate to that number with one line, and
@@ -188,23 +220,6 @@ The changes in past migrations were:
 |    5    | Dropped an unnecessary index                                                    |
 |    6    | Enforced single scheduler job at the trigger level                              |
 
-## Built in optional job for audit clear down
-
-que-scheduler comes with the `QueSchedulerAuditClearDownJob` job built in that you can optionally
-schedule to clear down audit rows if you don't need to retain them indefinitely. You should add this
-to your own scheduler config yaml.
-
-For example:
-
-```yaml
-# This will clear down the oldest que-scheduler audit rows. Since que-scheduler
-# runs approximately every minute, 129600 is 90 days.
-Que::Scheduler::Jobs::QueSchedulerAuditClearDownJob:
-  cron: "0 0 * * *"
-  args:
-    retain_row_count: 129600
-```
-
 ## HA Redundancy and DB restores
 
 Because of the way que-scheduler works, it requires no additional processes. It is, itself, a Que job.

data/lib/que/scheduler.rb

@@ -1,6 +1,6 @@
 require "que/scheduler/version"
 require "que/scheduler/version_support"
-require "que/scheduler/config"
+require "que/scheduler/configuration"
 require "que/scheduler/scheduler_job"
 require "que/scheduler/db"
 require "que/scheduler/audit"

data/lib/que/scheduler/configuration.rb

@@ -0,0 +1,35 @@
+require "que"
+require_relative "version_support"
+
+module Que
+  module Scheduler
+    class Configuration
+      attr_accessor :schedule_location
+      attr_accessor :schedule
+      attr_accessor :transaction_adapter
+      attr_accessor :que_scheduler_queue
+    end
+
+    class << self
+      attr_accessor :configuration
+
+      def configure
+        self.configuration ||= Configuration.new
+        yield(configuration)
+      end
+
+      def apply_defaults
+        configure do |config|
+          config.schedule_location =
+            ENV.fetch("QUE_SCHEDULER_CONFIG_LOCATION", "config/que_schedule.yml")
+          config.transaction_adapter = ::Que.method(:transaction)
+          config.que_scheduler_queue =
+            ENV.fetch("QUE_SCHEDULER_QUEUE", Que::Scheduler::VersionSupport.default_scheduler_queue)
+          config.schedule = nil
+        end
+      end
+    end
+  end
+end
+
+Que::Scheduler.apply_defaults

data/lib/que/scheduler/db.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "config"
+require_relative "configuration"
 
 module Que
   module Scheduler

data/lib/que/scheduler/schedule.rb

@@ -1,21 +1,31 @@
+require_relative "configuration"
 require_relative "defined_job"
 
 module Que
   module Scheduler
     class Schedule
       class << self
+        # 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.
         def schedule
           @schedule ||=
             begin
-              location = Que::Scheduler.configuration.schedule_location
-              from_file(location)
+              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
 
-        def schedule=(schedule_config)
-          @schedule = schedule_config.nil? ? nil : from_yaml(schedule_config)
-        end
-
         def from_file(location)
           from_yaml(IO.read(location))
         end
@@ -69,10 +79,6 @@ module Que
       def schedule
         Schedule.schedule
       end
-
-      def schedule=(value)
-        Schedule.schedule = value
-      end
     end
   end
 end

data/lib/que/scheduler/version.rb

@@ -1,5 +1,5 @@
 module Que
   module Scheduler
-    VERSION = "4.0.0".freeze
+    VERSION = "4.0.1".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: que-scheduler
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Harry Lascelles
@@ -112,6 +112,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
@@ -319,7 +333,7 @@ files:
 - lib/que-scheduler.rb
 - lib/que/scheduler.rb
 - lib/que/scheduler/audit.rb
-- lib/que/scheduler/config.rb
+- lib/que/scheduler/configuration.rb
 - lib/que/scheduler/db.rb
 - lib/que/scheduler/defined_job.rb
 - lib/que/scheduler/enqueueing_calculator.rb

data/lib/que/scheduler/config.rb

@@ -1,27 +0,0 @@
-require "que"
-require_relative "version_support"
-
-module Que
-  module Scheduler
-    class << self
-      attr_accessor :configuration
-    end
-
-    def self.configure
-      self.configuration ||= Configuration.new
-      yield(configuration)
-    end
-
-    class Configuration
-      attr_accessor :schedule_location
-      attr_accessor :transaction_adapter
-      attr_accessor :que_scheduler_queue
-    end
-  end
-end
-
-Que::Scheduler.configure do |config|
-  config.schedule_location = ENV.fetch("QUE_SCHEDULER_CONFIG_LOCATION", "config/que_schedule.yml")
-  config.transaction_adapter = ::Que.method(:transaction)
-  config.que_scheduler_queue = Que::Scheduler::VersionSupport.default_scheduler_queue
-end