simple_scheduler 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc8ab786b041bb9aa884a20fc7868b959b9007f5
-  data.tar.gz: 13eea6770174d5d114150cd50d51a8d10597269c
+  metadata.gz: 1f751bd8ec5a6af716c6a02b21160687cf3cb9a0
+  data.tar.gz: 0d39d2c7480d32eae74d7eb70e19afb3df0da899
 SHA512:
-  metadata.gz: 42828b1c2ce9c204dc0534bc88dfc773861fa7e97e949aa6b1a74a545c9258044de2df96b6c0e540ec27ebe2d63c3822b59aa18eb4ea2ecb2c51db3f7e8eff2b
-  data.tar.gz: 8b8e8872d57f94bfe8c0e7a5a1d18403532d0b85c81e7679138135670c60cf4b947d997145cb3eb901febc63a1e6a8af24bbf0f239b4bdf8e9fe6a0d435ddf39
+  metadata.gz: b2258e9b118862d9fe6b2b6dce8e63fa103dbd1eac20ac27788fc6fa5486d37a53a8472d2f484de99527529145a3c50c73ba8b66f4dc61e4634884d3e43bd9cc
+  data.tar.gz: 6f9eed4ce1271dc15e582777726e149a83f2d8da23dd6cc9fa3e29406441460484e50fbeef3d006791c4f08a10478fef810796ea88823cff69ab08f86646a34e

data/README.md

@@ -123,9 +123,9 @@ How frequently the task should be performed as an ActiveSupport duration definit
 
 #### :at (optional)
 
-This is the starting point for the `every` duration. If not given, the job will
+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.
+follow the `:every` duration to determine future execution times.
 
 Valid string formats/examples:
 
@@ -134,14 +134,18 @@ Valid string formats/examples:
 "3:30"
 "**:00"
 "*:30"
-"Sun 2:00"
-"[Sun|Mon|Tue|Wed|Thu|Fri|Sat] 00:00"
+"Sun 2:00" # [Sun|Mon|Tue|Wed|Thu|Fri|Sat]
 ```
 
+\* If you specify the hour of the day the job should run, it will only run in that hour,
+so if you specify an `:every` duration of less than `1.day`, the job will only run
+when the run time hour matches the `:at` time's hour.
+See [#17](https://github.com/simplymadeapps/simple_scheduler/issues/17) for more info.
+
 #### :expires_after (optional)
 
 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 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 `SimpleScheduler::FutureJob`. This
@@ -155,6 +159,27 @@ The string should be in the form of an ActiveSupport duration.
 "23.hours"
 ```
 
+#### :queue_ahead (optional)
+
+The `:queue_ahead` is the number of minutes that the job should be scheduled into the future.
+The default value is `360`, so Simple Scheduler will make sure you have scheduled jobs for
+the next 6 hours. This allows for a major outage without losing track of jobs that were
+supposed to run during that time.
+
+**There are always a minimum of 2 scheduled jobs for each scheduled task.** This ensures there
+is always one job in the queue that can be used to determine the next run time, even if one of
+the two was executed during the 10 minute Heroku Scheduler wait time.
+
+The `:queue_ahead` can be set as a global configuration option or for each individual task.
+
+#### :tz (optional)
+
+Use `:tz` to specify the time zone of your `:at` time. If no time zone is specified, the Time.zone
+default in your Rails app will be used when parsing the `:at` time. A list of all the available
+timezone identifiers can be obtained using `TZInfo::Timezone.all_identifiers`.
+
+The `:tz` can be set as a global configuration option or for each individual task.
+
 ## Writing Your Jobs
 
 There is no guarantee that the job will run at the exact time given in the
@@ -171,9 +196,57 @@ class ExampleJob < ActiveJob::Base
 end
 ```
 
+#### Determine if the Job Should Run
+
+Simple Scheduler doesn't support specifying multiple days of the week or a specific day of the month.
+You can use the `scheduled_time` with a guard clause to ensure the job only runs on specific days.
+
+Set up the jobs to run every day, even though we don't actually want them to run every day:
+
+```yml
+# config/simple_scheduler.yml
+payroll:
+  class: "PayrollJob"
+  every: "1.day"
+  at: "0:00"
+
+weekday_reports:
+  class: "WeekdayReportsJob"
+  every: "1.day"
+  at: "18:00"
+```
+
+Use a guard clause in each of our jobs to exit the job if it shouldn't run that day:
+
+```ruby
+# A job that runs only on the 1st and 15th of the month.
+class PayrollJob < ActiveJob::Base
+  # @param scheduled_time [Integer] The epoch time for when the job was scheduled to be run
+  def perform(scheduled_time)
+    # Exit the job unless it's the 1st or 15th day of the month
+    day_of_the_month = Time.at(scheduled_time).day
+    return unless day_of_the_month == 1 || day_of_the_month == 15
+
+    # Perform the job...
+  end
+end
+
+# A job that runs only on weekdays, Monday - Friday.
+class WeekdayReportsJob < ActiveJob::Base
+  # @param scheduled_time [Integer] The epoch time for when the job was scheduled to be run
+  def perform(scheduled_time)
+    # Exit the job unless it's Monday (1), Tuesday (2), Wednesday (3), Thursday (4), or Friday (5)
+    day_of_the_week = Time.at(scheduled_time).wday
+    return unless (1..5).include?(day_of_the_week)
+
+    # Perform the job...
+  end
+end
+```
+
 ## Handling Expired Jobs
 
-If you assign the `expires_after` option to your task, you may want to know if
+If you assign the `:expires_after` option to your task, you may want to know if
 a job wasn't run because it expires. Add this block to an initializer file:
 
 ```ruby

data/lib/simple_scheduler/at.rb

@@ -9,7 +9,7 @@ module SimpleScheduler
   #   SimpleScheduler::At.new("Sun 0:00")
   #   # => 2016-12-11 00:00:00 -0600
   class At < Time
-    AT_PATTERN = /(Sun|Mon|Tue|Wed|Thu|Fri|Sat)?\s?(?:\*{1,2}|((?:\b[0-1]?[0-9]|2[0-3]))):([0-5]\d)/
+    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
 
     # Error class raised when an invalid string is given for the time.

data/lib/simple_scheduler/future_job.rb

@@ -77,10 +77,10 @@ module SimpleScheduler
 
     # Queue the task with the scheduled time if the job allows.
     def queue_task
-      if @task.job_class.instance_method(:perform).arity > 0
-        @task.job_class.send(perform_method, @scheduled_time.to_i)
-      else
+      if @task.job_class.instance_method(:perform).arity.zero?
         @task.job_class.send(perform_method)
+      else
+        @task.job_class.send(perform_method, @scheduled_time.to_i)
       end
     end
   end

data/lib/simple_scheduler/version.rb

@@ -1,3 +1,3 @@
 module SimpleScheduler
-  VERSION = "0.2.7".freeze
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_scheduler
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - Brian Pattison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -177,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: An enhancement for Heroku Scheduler + Sidekiq for scheduling jobs at specific