simple_scheduler 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 778a394ce23dfc08f29201e0d0734a5521c42747
-  data.tar.gz: f35fccb6c74a0a5d5e73c39736b09db21bf1f030
+  metadata.gz: 2216e4b3a7b296545fc87bf4ec4509c6e54cf80c
+  data.tar.gz: 3f7b99ddda05bbf8d97d320351e6bed5a617dea9
 SHA512:
-  metadata.gz: 58b59b0e13d746d27ddbf0261972337957bf912f172ff13fbefa5a0d0186da03446212ce9a105182539043fcf49d2786ab8bf0d926527879660fe54c5103bc29
-  data.tar.gz: 77a7202de9dd23ad87e16c850eb93fe4bf090bd6adf1476ea32300971e622b9118df4fc0b30ac3597e1aca8ec8f46ba8166687c2eade8f49de837fa91f698252
+  metadata.gz: 3ea3d1b9fb643828f411b3b260e4684188d3115ea65a2f409720b4fc199092645d86fd4ac841043c2d6c2375cbf17d2dd3c1e62eb677144715a9adb0a32113a5
+  data.tar.gz: 2b02cd203eb5bf2f16a6e469bc2cbab794445840bd95c6ce4af666a87628644a1c557f1d5bb9649ce55ca0aece0fe43837b1c886d8002a321dc5ff8ca339e249

data/README.md

@@ -62,10 +62,11 @@ queue_ahead: 360 # Number of minutes to queue jobs into the future
 queue_name: "default" # The Sidekiq queue name used by SimpleScheduler::FutureJob
 tz: "America/Chicago" # The application time zone will be used by default if not set
 
-# Runs once every 2 minutes
+# Runs once every 2 minutes starting at the top of the hour
 simple_task:
   class: "SomeActiveJob"
   every: "2.minutes"
+  at: "*:00"
 
 # Runs once every day at 4:00 AM. The job will expire after 23 hours, which means the
 # job will not run if 23 hours passes (server downtime) before the job is actually run
@@ -126,11 +127,10 @@ How frequently the task should be performed as an ActiveSupport duration definit
 "1.week"
 ```
 
-#### :at (optional)
+#### :at
 
-This is the starting point\* for the `:every` duration. If not given, the job will
-run immediately when the configuration file is loaded for the first time and will
-follow the `:every` duration to determine future execution times.
+This is the starting point\* for the `:every` duration. This must be set so the expected
+run times in the future can be determined without duplicating jobs already in the queue.
 
 Valid string formats/examples:
 

data/lib/simple_scheduler/at.rb

@@ -9,8 +9,8 @@ module SimpleScheduler
   #   SimpleScheduler::At.new("Sun 0:00")
   #   # => 2016-12-11 00:00:00 -0600
   class At < Time
-    AT_PATTERN = /\A(Sun|Mon|Tue|Wed|Thu|Fri|Sat)?\s?(?:\*{1,2}|((?:\b[0-1]?[0-9]|2[0-3]))):([0-5]\d)\z/
-    DAYS = %w(Sun Mon Tue Wed Thu Fri Sat).freeze
+    AT_PATTERN = /\A(Sun|Mon|Tue|Wed|Thu|Fri|Sat)?\s?(?:\*{1,2}|((?:\b[0-1]?[0-9]|2[0-3]))):([0-5]\d)\z/.freeze
+    DAYS = %w[Sun Mon Tue Wed Thu Fri Sat].freeze
 
     # Error class raised when an invalid string is given for the time.
     class InvalidTime < StandardError; end
@@ -25,12 +25,14 @@ module SimpleScheduler
     #   "[Sun|Mon|Tue|Wed|Thu|Fri|Sat] 00:00"
     # @param at [String] The formatted string for a task's run time
     # @param time_zone [ActiveSupport::TimeZone] The time zone to parse the at time in
+    # rubocop:disable Metrics/AbcSize
     def initialize(at, time_zone = nil)
       @at = at
       @time_zone = time_zone || Time.zone
       super(parsed_time.year, parsed_time.month, parsed_time.day,
             parsed_time.hour, parsed_time.min, parsed_time.sec, parsed_time.utc_offset)
     end
+    # rubocop:enable Metrics/AbcSize
 
     # Always returns the specified hour if the hour was given, otherwise
     # it returns the hour calculated based on other specified options.
@@ -49,8 +51,10 @@ module SimpleScheduler
 
     def at_match
       @at_match ||= begin
-        match = @at.nil? ? [] : AT_PATTERN.match(@at)
+        match = AT_PATTERN.match(@at)
+        raise InvalidTime, "The `at` option is required." if @at.nil?
         raise InvalidTime, "The `at` option '#{@at}' is invalid." if match.nil?
+
         match
       end
     end
@@ -64,7 +68,7 @@ module SimpleScheduler
     end
 
     def at_wday
-      @wday ||= DAYS.index(at_match[1])
+      @at_wday ||= DAYS.index(at_match[1])
     end
 
     def at_wday?

data/lib/simple_scheduler/future_job.rb

@@ -23,6 +23,7 @@ module SimpleScheduler
       @task = Task.new(task_params)
       @scheduled_time = Time.at(scheduled_time).in_time_zone(@task.time_zone)
       raise Expired if expired?
+
       queue_task
     end
 
@@ -50,6 +51,7 @@ module SimpleScheduler
     # @return [Boolean]
     def expired?
       return false if @task.expires_after.blank?
+
       expire_duration.from_now(@scheduled_time) < Time.now.in_time_zone(@task.time_zone)
     end
 

data/lib/simple_scheduler/scheduler_job.rb

@@ -29,8 +29,7 @@ module SimpleScheduler
     def queue_future_jobs
       tasks.each do |task|
         # Schedule the new run times using the future job wrapper.
-        new_run_times = task.future_run_times - task.existing_run_times
-        new_run_times.each do |time|
+        task.future_run_times.each do |time|
           SimpleScheduler::FutureJob.set(queue: @queue_name, wait_until: time)
                                     .perform_later(task.params, time.to_i)
         end

data/lib/simple_scheduler/task.rb

@@ -16,7 +16,7 @@ module SimpleScheduler
     # @option params [String] :class The class of the Active Job or Sidekiq Worker
     # @option params [String] :every How frequently the job will be performed
     # @option params [String] :at The starting time for the interval
-    # @option params [String] :expires_after The time between the scheduled and actual run time that should cause the job not to run
+    # @option params [String] :expires_after The interval used to determine how late the job is allowed to run
     # @option params [Integer] :queue_ahead The number of minutes that jobs should be queued in the future
     # @option params [String] :task_name The name of the task as defined in the YAML config
     # @option params [String] :tz The time zone to use when parsing the `at` option
@@ -42,6 +42,7 @@ module SimpleScheduler
     def existing_jobs
       @existing_jobs ||= SimpleScheduler::Task.scheduled_set.select do |job|
         next unless job.display_class == "SimpleScheduler::FutureJob"
+
         task_params = job.display_args[0].symbolize_keys
         task_params[:class] == job_class_name && task_params[:name] == name
       end.to_a
@@ -62,22 +63,24 @@ module SimpleScheduler
     # Returns an array Time objects for future run times based on
     # the current time and the given minutes to look ahead.
     # @return [Array<Time>]
+    # rubocop:disable Metrics/AbcSize
     def future_run_times
-      future_run_times = existing_run_times.dup
-      last_run_time = future_run_times.last || at - frequency
+      last_run_time = at - frequency
       last_run_time = last_run_time.in_time_zone(time_zone)
+      future_run_times = []
 
       # Ensure there are at least two future jobs scheduled and that the queue ahead time is filled
-      while future_run_times.length < 2 || minutes_queued_ahead(last_run_time) < queue_ahead
+      while (future_run_times + existing_run_times).length < 2 || minutes_queued_ahead(last_run_time) < queue_ahead
         last_run_time = frequency.from_now(last_run_time)
         # The hour may not match because of a shift caused by DST in previous run times,
         # so we need to ensure that the hour matches the specified hour if given.
         last_run_time = last_run_time.change(hour: at.hour, min: at.min) if at.hour?
-        future_run_times << last_run_time
+        future_run_times << last_run_time unless existing_run_times.include?(last_run_time)
       end
 
       future_run_times
     end
+    # rubocop:enable Metrics/AbcSize
 
     # The class name of the job or worker.
     # @return [String]
@@ -126,6 +129,7 @@ module SimpleScheduler
     def validate_params!(params)
       raise ArgumentError, "Missing param `class` specifying the class of the job to run." unless params.key?(:class)
       raise ArgumentError, "Missing param `every` specifying how often the job should run." unless params.key?(:every)
+
       @job_class = params[:class].constantize
       params[:name] ||= params[:class]
     end

data/lib/simple_scheduler/version.rb

@@ -1,3 +1,3 @@
 module SimpleScheduler
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_scheduler
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Pattison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-17 00:00:00.000000000 Z
+date: 2019-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rainbow
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +84,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.66.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.66.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: An enhancement for Heroku Scheduler + Sidekiq for scheduling jobs at specific