simple_scheduler 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b71b4f5c3e484c52baefe6f0a7bb053190cdd0a0
-  data.tar.gz: b24a48c76cd13c18c175bd6cf43dafd2beb45632
+  metadata.gz: 2fcaf4fe9556dbb85aec2ed64578416c97121157
+  data.tar.gz: 6cd57daf1dd3a2d8fe31c4eed3ba18904d2f4121
 SHA512:
-  metadata.gz: ba009c0d2a0565a03ffcee90c92e69de5cec1aab98f22ec523cee894bc7d200c05229053bebfef02ff9283213002a21f1d1db96ac1aa5b91d5d762f9c349173d
-  data.tar.gz: 2ee4e84837c33e00e3d6b2648446ee7cb6d4ecbb6462b20b6cd96acf41e2c26d655c9daa446749cc1a9857ca6c3d3e84de20335580da4b803b2fe0a7c1f0f3fa
+  metadata.gz: 2a6c2563947e0450d48f6d3729b3fe9746917056747894f8ad2d887c29b5a81bb2eb34a7d02785355c1b65a4bedf1fd97e6d303da1845eb9396e0bffb65707b2
+  data.tar.gz: 475b59cac94a988e02cb4eccd6f907b64221bb64c67184beefdc0d5089d104600b5598ceee675cf89ccea197f29380f2ec55e93b1e9b0dbc7eb80456a93b269b

data/lib/simple_scheduler.rb

@@ -1,5 +1,6 @@
 require "active_job"
 require "sidekiq/api"
+require_relative "./simple_scheduler/at"
 require_relative "./simple_scheduler/future_job"
 require_relative "./simple_scheduler/railtie"
 require_relative "./simple_scheduler/scheduler_job"

data/lib/simple_scheduler/at.rb

@@ -0,0 +1,99 @@
+module SimpleScheduler
+  # A Time class for parsing the :at option on a task into the first time it should run.
+  #   Time.now
+  #   # => 2016-12-09 08:24:11 -0600
+  #   SimpleScheduler::At.new("*:30")
+  #   # => 2016-12-09 08:30:00 -0600
+  #   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
+  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
+
+    # Accepts a time string to determine when a task should be run for the first time.
+    # Valid formats:
+    #   "18:00"
+    #   "3:30"
+    #   "**:00"
+    #   "*:30"
+    #   "Sun 2:00"
+    #   "[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
+    def initialize(at, time_zone = Time.zone)
+      @at = at
+      @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
+
+    # Always returns the specified hour.
+    # @return [Integer]
+    def hour
+      hour? ? at_hour : super
+    end
+
+    # Returns whether or not the hour was specified in the :at string.
+    # @return [Boolean]
+    def hour?
+      at_match[2].present?
+    end
+
+    private
+
+    def at_match
+      @at_match ||= AT_PATTERN.match(@at) || []
+    end
+
+    def at_hour
+      @at_hour ||= (at_match[2] || now.hour).to_i
+    end
+
+    def at_min
+      @at_min ||= (at_match[3] || now.min).to_i
+    end
+
+    def at_wday
+      @wday ||= DAYS.index(at_match[1])
+    end
+
+    def at_wday?
+      at_match[1].present?
+    end
+
+    def next_hour?
+      !hour? && at_hour == now.hour && at_min < now.min
+    end
+
+    def now
+      @now ||= @time_zone.now.beginning_of_minute
+    end
+
+    def parsed_day
+      parsed_day = now.beginning_of_day
+
+      # If no day of the week is given, return today
+      return parsed_day unless at_wday?
+
+      # Shift to the correct day of the week if given
+      add_days = at_wday - parsed_day.wday
+      add_days += 7 if parsed_day.wday > at_wday
+      parsed_day + add_days.days
+    end
+
+    # Returns the very first time a job should be run for the scheduled task.
+    # @return [Time]
+    def parsed_time
+      return @parsed_time if @parsed_time
+
+      @parsed_time = parsed_day
+      change_hour = at_hour
+      change_hour += 1 if next_hour?
+      @parsed_time = @parsed_time.change(hour: change_hour, min: at_min)
+      @parsed_time += at_wday? ? 1.week : 1.day if now > @parsed_time
+      @parsed_time
+    end
+  end
+end

data/lib/simple_scheduler/future_job.rb

@@ -23,12 +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?
-
-      if @task.job_class.included_modules.include?(Sidekiq::Worker)
-        queue_sidekiq_worker
-      else
-        queue_active_job
-      end
+      queue_task
     end
 
     private
@@ -62,21 +57,22 @@ module SimpleScheduler
       end
     end
 
-    # Queue the job for immediate execution using Active Job.
-    def queue_active_job
-      if @task.job_class.instance_method(:perform).arity > 0
-        @task.job_class.perform_later(@scheduled_time.to_i)
+    # The name of the method used to queue the task's job or worker.
+    # @return [Symbol]
+    def perform_method
+      if @task.job_class.included_modules.include?(Sidekiq::Worker)
+        :perform_async
       else
-        @task.job_class.perform_later
+        :perform_later
       end
     end
 
-    # Queue the job for immediate execution using Sidekiq.
-    def queue_sidekiq_worker
+    # 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.perform_async(@scheduled_time.to_i)
+        @task.job_class.send(perform_method, @scheduled_time.to_i)
       else
-        @task.job_class.perform_async
+        @task.job_class.send(perform_method)
       end
     end
   end

data/lib/simple_scheduler/task.rb

@@ -2,30 +2,13 @@ module SimpleScheduler
   # Class for parsing each task in the scheduler config YAML file and returning
   # the values needed to schedule the task in the future.
   #
-  # @!attribute [r] at
-  #   @return [String] The starting time for the interval
-  # @!attribute [r] expires_after
-  #   @return [String] The time between the scheduled and actual run time that should cause the job not to run
-  # @!attribute [r] frequency
-  #   @return [ActiveSupport::Duration] How often the job will be run
   # @!attribute [r] job_class
-  #   @return [Class] The class of the job or worker
-  # @!attribute [r] job_class_name
-  #   @return [String] The class name of the job or worker
-  # @!attribute [r] name
-  #   @return [String] The name of the task as defined in the YAML config
+  #   @return [Class] The class of the job or worker.
   # @!attribute [r] params
   #   @return [Hash] The params used to create the task
-  # @!attribute [r] queue_ahead
-  #   @return [String] The name of the task as defined in the YAML config
-  # @!attribute [r] time_zone
-  #   @return [ActiveSupport::TimeZone] The time zone to use when parsing the `at` option
   class Task
-    attr_reader :at, :expires_after, :frequency, :job_class, :job_class_name
-    attr_reader :name, :params, :queue_ahead, :time_zone
+    attr_reader :job_class, :params
 
-    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
     DEFAULT_QUEUE_AHEAD_MINUTES = 360
 
     # Initializes a task by parsing the params so the task can be queued in the future.
@@ -39,15 +22,19 @@ module SimpleScheduler
     # @option params [String] :tz The time zone to use when parsing the `at` option
     def initialize(params)
       validate_params!(params)
-      @at             = params[:at]
-      @expires_after  = params[:expires_after]
-      @frequency      = parse_frequency(params[:every])
-      @job_class_name = params[:class]
-      @job_class      = @job_class_name.constantize
-      @queue_ahead    = params[:queue_ahead] || DEFAULT_QUEUE_AHEAD_MINUTES
-      @name           = params[:name]
-      @params         = params
-      @time_zone      = params[:tz] ? ActiveSupport::TimeZone.new(params[:tz]) : Time.zone
+      @params = params
+    end
+
+    # The task's first run time as a Time-like object.
+    # @return [SimpleScheduler::At]
+    def at
+      @at ||= At.new(@params[:at], time_zone)
+    end
+
+    # The time between the scheduled and actual run time that should cause the job not to run.
+    # @return [String]
+    def expires_after
+      @params[:expires_after]
     end
 
     # Returns an array of existing jobs matching the job class of the task.
@@ -66,15 +53,10 @@ module SimpleScheduler
       @existing_run_times ||= existing_jobs.map(&:at)
     end
 
-    # Returns the very first time a job should be run for the scheduled task.
-    # @return [Time]
-    def first_run_time
-      first_run_time = first_run_day
-      change_hour = first_run_hour
-      change_hour += 1 if at_match[2].nil? && first_run_hour == now.hour && first_run_min < now.min
-      first_run_time = first_run_time.change(hour: change_hour, min: first_run_min)
-      first_run_time += at_match[1] ? 1.week : 1.day if now > first_run_time
-      first_run_time
+    # How often the job will be run.
+    # @return [ActiveSupport::Duration]
+    def frequency
+      @frequency ||= parse_frequency(@params[:every])
     end
 
     # Returns an array Time objects for future run times based on
@@ -82,60 +64,51 @@ module SimpleScheduler
     # @return [Array<Time>]
     def future_run_times
       future_run_times = existing_run_times.dup
-      last_run_time = future_run_times.last || first_run_time - frequency
+      last_run_time = future_run_times.last || at - frequency
       last_run_time = last_run_time.in_time_zone(time_zone)
 
-      while future_run_times.length < 2 || ((last_run_time - now) / 1.minute) < queue_ahead
+      # 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
         last_run_time = frequency.from_now(last_run_time)
-        last_run_time = last_run_time.change(hour: first_run_hour, min: first_run_min) if at_match[2]
+        last_run_time = last_run_time.change(hour: at.hour, min: at.min) if at.hour?
         future_run_times << last_run_time
       end
 
       future_run_times
     end
 
-    # Loads the scheduled jobs from Sidekiq once to avoid loading from
-    # Redis for each task when looking up existing scheduled jobs.
-    # @return [Sidekiq::ScheduledSet]
-    def self.scheduled_set
-      @scheduled_set ||= Sidekiq::ScheduledSet.new
+    # The class name of the job or worker.
+    # @return [String]
+    def job_class_name
+      @params[:class]
     end
 
-    private
-
-    def at_match
-      @at_match ||= AT_PATTERN.match(@at) || []
+    # The name of the task as defined in the YAML config.
+    # @return [String]
+    def name
+      @params[:name]
     end
 
-    def first_run_day
-      return @first_run_day if @first_run_day
-
-      @first_run_day = now.beginning_of_day
-
-      # If no day of the week is given, return today
-      return @first_run_day unless first_run_wday
-
-      # Shift to the correct day of the week if given
-      add_days = first_run_wday - first_run_day.wday
-      add_days += 7 if first_run_day.wday > first_run_wday
-      @first_run_day += add_days.days
-    end
-
-    def first_run_hour
-      @first_run_hour ||= (at_match[2] || now.hour).to_i
+    # The number of minutes that jobs should be queued in the future.
+    # @return [Integer]
+    def queue_ahead
+      @queue_ahead ||= @params[:queue_ahead] || DEFAULT_QUEUE_AHEAD_MINUTES
     end
 
-    def first_run_min
-      @first_run_min ||= (at_match[3] || now.min).to_i
+    # The time zone to use when parsing the `at` option.
+    # @return [ActiveSupport::TimeZone]
+    def time_zone
+      @time_zone ||= params[:tz] ? ActiveSupport::TimeZone.new(params[:tz]) : Time.zone
     end
 
-    def first_run_wday
-      @first_run_wday ||= DAYS.index(at_match[1])
+    # Loads the scheduled jobs from Sidekiq once to avoid loading from
+    # Redis for each task when looking up existing scheduled jobs.
+    # @return [Sidekiq::ScheduledSet]
+    def self.scheduled_set
+      @scheduled_set ||= Sidekiq::ScheduledSet.new
     end
 
-    def now
-      @now ||= @time_zone.now.beginning_of_minute
-    end
+    private
 
     def parse_frequency(every_string)
       split_duration = every_string.split(".")
@@ -145,9 +118,10 @@ module SimpleScheduler
     end
 
     def validate_params!(params)
-      params[:name] ||= params[:class]
       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
   end
 end

data/lib/simple_scheduler/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_scheduler
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Brian Pattison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-08 00:00:00.000000000 Z
+date: 2016-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !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: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,7 @@ files:
 - 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