simple_scheduler 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fcaf4fe9556dbb85aec2ed64578416c97121157
-  data.tar.gz: 6cd57daf1dd3a2d8fe31c4eed3ba18904d2f4121
+  metadata.gz: 965fd30f738af89658435f906c3f8cd3367632ec
+  data.tar.gz: adc78088a3126a006eed623162ab99dcb373c218
 SHA512:
-  metadata.gz: 2a6c2563947e0450d48f6d3729b3fe9746917056747894f8ad2d887c29b5a81bb2eb34a7d02785355c1b65a4bedf1fd97e6d303da1845eb9396e0bffb65707b2
-  data.tar.gz: 475b59cac94a988e02cb4eccd6f907b64221bb64c67184beefdc0d5089d104600b5598ceee675cf89ccea197f29380f2ec55e93b1e9b0dbc7eb80456a93b269b
+  metadata.gz: 6fac392b17f7584ed1d7136200b88ec64e2ae104a3e6fdd4d5d9ce7ef1b9084f03dc719e8f002c40c32c5370b27dac546044c9c109bdf05cee1b565fc2ad1cf2
+  data.tar.gz: ed647beb0eef9ddbfeaafb0d2d3c125e2a1dfff45cbbb007da8fdc5febfb1a17f662fe8fcd7290e9d4afa5859a0d816e9c76c3fd455f19fd5659bc93c7971c2d

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/simplymadeapps/simple_scheduler.svg?branch=master)](https://travis-ci.org/simplymadeapps/simple_scheduler)
 [![Code Climate](https://codeclimate.com/github/simplymadeapps/simple_scheduler/badges/gpa.svg)](https://codeclimate.com/github/simplymadeapps/simple_scheduler)
+[![Test Coverage](https://codeclimate.com/github/simplymadeapps/simple_scheduler/badges/coverage.svg)](https://codeclimate.com/github/simplymadeapps/simple_scheduler/coverage)
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/simplymadeapps/simple_scheduler/)
 
 Simple Scheduler is a scheduling add-on that is designed to be used with
@@ -81,6 +82,8 @@ Add the rake task to Heroku Scheduler and set it to run every 10 minutes:
 rake simple_scheduler
 ```
 
+![Heroku Scheduler](https://cloud.githubusercontent.com/assets/124570/21104523/6d733d1a-c04c-11e6-89af-590e7d234cdf.gif)
+
 It may be useful to point to a specific configuration file in non-production environments:
 
 ```
@@ -126,10 +129,13 @@ Valid string formats/examples:
 
 #### :expires_after (optional)
 
-If your worker process is down for an extended period of time, you may not want jobs
-to execute when the server comes back online. By specifying an `expires_after` value,
-your job will not fire if the time the job actually runs later, by the specified
-duration, than the scheduled run time.
+If your worker process is down for an extended period of time, you may not want certain jobs
+to execute when the server comes back online. The `expires_after` value will be used
+to determine if it's too late to run the job at the actual run time.
+
+All jobs are scheduled in the future using the `SimpleScheculder::FutureJob`. This
+wrapper job does the work of evaluating the current time and determining if the
+scheduled job should run. See [Handling Expired Jobs](#handling-expired-jobs).
 
 The string should be in the form of an ActiveSupport duration.
 
@@ -179,9 +185,9 @@ end
 
 ## How It Works
 
-Once the rake task is added to Heroku Scheduler, the Simple Scheduler library
-will load the configuration file every 10 minutes, and ensure that each task
-has jobs scheduled in the future be checking the `Sidekiq::ScheduledSet`.
+The Heroku Scheduler must be set up to run `rake simple_scheduler` every 10 minutes.
+The rake task will load the configuration file each time and ensure that each task has
+jobs scheduled for the future. This is done by checking the `Sidekiq::ScheduledSet`.
 
 A minimum of two jobs is always added to the scheduled set. By default all
 jobs for the next six hours are queued in advance. This ensures that there is

data/lib/simple_scheduler/at.rb

@@ -7,7 +7,7 @@ module SimpleScheduler
   #   SimpleScheduler::At.new("1:00")
   #   # => 2016-12-10 01:00:00 -0600
   #   SimpleScheduler::At.new("Sun 0:00")
-  #   # => 2016-12-11 01:00:00 -0600
+  #   # => 2016-12-11 00:00:00 -0600
   class At < Time
     AT_PATTERN = /(Sun|Mon|Tue|Wed|Thu|Fri|Sat)?\s?(?:\*{1,2}|(\d{1,2})):(\d{1,2})/
     DAYS = %w(Sun Mon Tue Wed Thu Fri Sat).freeze
@@ -29,7 +29,8 @@ module SimpleScheduler
             parsed_time.hour, parsed_time.min, parsed_time.sec, parsed_time.utc_offset)
     end
 
-    # Always returns the specified hour.
+    # Always returns the specified hour if the hour was given, otherwise
+    # it returns the hour calculated based on other specified options.
     # @return [Integer]
     def hour
       hour? ? at_hour : super
@@ -64,7 +65,7 @@ module SimpleScheduler
     end
 
     def next_hour?
-      !hour? && at_hour == now.hour && at_min < now.min
+      !hour? && at_min < now.min
     end
 
     def now
@@ -90,8 +91,14 @@ module SimpleScheduler
 
       @parsed_time = parsed_day
       change_hour = at_hour
+
+      # Add an additional hour if a specific hour wasn't given, if the minutes
+      # given are less than the current time's minutes.
       change_hour += 1 if next_hour?
       @parsed_time = @parsed_time.change(hour: change_hour, min: at_min)
+
+      # If the parsed time is still before the current time, add an additional day if
+      # the week day wasn't specified or add an additional week to get the correct time.
       @parsed_time += at_wday? ? 1.week : 1.day if now > @parsed_time
       @parsed_time
     end

data/lib/simple_scheduler/future_job.rb

@@ -30,6 +30,7 @@ module SimpleScheduler
 
     # The duration between the scheduled run time and actual run time that
     # will cause the job to expire. Expired jobs will not be executed.
+    # @return [ActiveSupport::Duration]
     def expire_duration
       split_duration = @task.expires_after.split(".")
       duration = split_duration[0].to_i

data/lib/simple_scheduler/scheduler_job.rb

@@ -24,10 +24,8 @@ module SimpleScheduler
     # Queue each of the future jobs into Sidekiq from the defined tasks.
     def queue_future_jobs
       tasks.each do |task|
-        new_run_times = task.future_run_times - task.existing_run_times
-        next if new_run_times.empty?
-
         # 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|
           SimpleScheduler::FutureJob.set(wait_until: time).perform_later(task.params, time.to_i)
         end
@@ -35,7 +33,7 @@ module SimpleScheduler
     end
 
     # The array of tasks loaded from the config YAML.
-    # @return [Array<SimpleScheduler::SchedulerJob]
+    # @return [Array<SimpleScheduler::Task]
     def tasks
       @config.map do |task_name, options|
         task_params = options.symbolize_keys

data/lib/simple_scheduler/task.rb

@@ -42,8 +42,8 @@ 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]
-        task_params["class"] == job_class_name && task_params["name"] == name
+        task_params = job.display_args[0].symbolize_keys
+        task_params[:class] == job_class_name && task_params[:name] == name
       end.to_a
     end
 
@@ -68,8 +68,10 @@ module SimpleScheduler
       last_run_time = last_run_time.in_time_zone(time_zone)
 
       # Ensure there are at least two future jobs scheduled and that the queue ahead time is filled
-      while future_run_times.length < 2 || ((last_run_time - Time.now) / 1.minute) < queue_ahead
+      while future_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
       end
@@ -110,6 +112,10 @@ module SimpleScheduler
 
     private
 
+    def minutes_queued_ahead(last_run_time)
+      (last_run_time - Time.now) / 1.minute
+    end
+
     def parse_frequency(every_string)
       split_duration = every_string.split(".")
       frequency = split_duration[0].to_i

data/lib/simple_scheduler/version.rb

@@ -1,3 +1,3 @@
 module SimpleScheduler
-  VERSION = "0.2.2".freeze
+  VERSION = "0.2.3".freeze
 end

metadata

@@ -1,111 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: simple_scheduler
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Brian Pattison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-09 00:00:00.000000000 Z
+date: 2016-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   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: codeclimate-test-reporter
+  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: rspec-rails
   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: rubocop
   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: simplecov
   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: simplecov-rcov
   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'
 description: |2
@@ -118,17 +132,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
-- README.md
-- Rakefile
-- lib/simple_scheduler.rb
 - lib/simple_scheduler/at.rb
 - lib/simple_scheduler/future_job.rb
 - lib/simple_scheduler/railtie.rb
 - lib/simple_scheduler/scheduler_job.rb
 - lib/simple_scheduler/task.rb
 - lib/simple_scheduler/version.rb
+- lib/simple_scheduler.rb
 - lib/tasks/simple_scheduler_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
 homepage: https://github.com/simplymadeapps/simple_scheduler
 licenses:
 - MIT
@@ -139,17 +153,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: An enhancement for Heroku Scheduler + Sidekiq for scheduling jobs at specific