sidekiq-repeat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 640363fb32bb0a5e6c6d7b9ce47109bb4d26244e
+  data.tar.gz: 43481093dd233b479c4fa4c5809cee3b547911d2
+SHA512:
+  metadata.gz: 2957cc62da166c65fc5ea481a39a903d6a6e2a533aa3f4b0a81171a0975b9d0ce253b995bdd3d9a61b4e729d4d7cb1252c515346750840e04c66955af3eed0b5
+  data.tar.gz: cb43747010d8c0aa4243a4d8d161270d54d4b2e19a75acb2dd9f446415157d70047bfa889a3e5ff61187abd7be7905019bf8e50abc88bb5cc7be36ab17e2727c

data/lib/sidekiq/repeat/middleware.rb

@@ -0,0 +1,11 @@
+module Sidekiq
+  module Repeat
+    class Middleware
+      def call(worker, item, queue)
+        yield
+      ensure
+        worker.class.reschedule if worker.class.respond_to?(:reschedule)
+      end
+    end
+  end
+end

data/lib/sidekiq/repeat/mini_ice_cube.rb

@@ -0,0 +1,96 @@
+module Sidekiq
+  module Repeat
+    ##
+    # This is a mini compatibility layer for the ice_cube syntax. Nothing fancy.
+    # It only supports interval-based -ly functions like "hourly(4)" and array
+    # list information like .minute_of_hour(0,15,30,45), as these are the ones
+    # that we use.
+    module MiniIceCube
+      module IceCubeDslErrorHandling
+        IceCubeSyntaxError = Class.new(StandardError)
+
+        def unsupported(msg)
+          fail IceCubeSyntaxError, "Sidekiq::Repeat: Unsupported ice_cube syntax. Please refer to the documentation. (#{msg})"
+        end
+
+        def method_missing(meth, *args, &block)
+          unsupported("method not found: #{meth}")
+        end
+      end
+
+      class CronSyntax
+        include IceCubeDslErrorHandling
+
+        class << self
+          def define_items_method(name, slot)
+            define_method(name) do |*args|
+              unsupported("invalid arguments for #{name}") unless args.any? && args.all? { |i| i.is_a?(Integer) || i =~ /\d+/ }
+              @slots[slot] = args.map(&:to_s).join(',')
+              self
+            end
+          end
+        end
+
+        def initialize(*args)
+          @slots = args
+        end
+
+        def to_s
+          @slots.map(&:to_s).join(' ')
+        end
+
+        define_items_method(:minute_of_hour, 0)
+        define_items_method(:hour_of_day, 1)
+        define_items_method(:day_of_month, 2)
+      end
+
+      class MainDsl
+        include IceCubeDslErrorHandling
+
+        class << self
+          def define_interval_method(name, base, *stars_prefix)
+            define_method(name) do |*args|
+              stars = stars_prefix.dup || []
+
+              if args.any?
+                interval = args.first.to_i
+                unsupported("invalid interval: #{interval}") unless interval && interval >= 0 && interval <= base
+
+                # Instead of always calculating the next() occurrence as ice_cube does,
+                # we can only have fixed run times (as per cron syntax). Hence we calculate
+                # the run times based on integer division of interval and time frame, using
+                # a random start offset based on the remaining time.
+                #
+                # NOTE: This effectivly means that after the last run in the time frame the
+                #       next run will be scheduled after interval+remainder.
+                #
+                # Example: minutely(17) will run 3 times per hour. After the last run each
+                #          hour the skip will be 17 + 9 = 26 minutes. A random offset in
+                #          [0,26) will be applied, so a possible cron line could be '4,21,38'.
+
+                times = []
+                nruns = (base / interval).floor
+                rnoff = rand(interval + base % interval).floor
+                runs  = nruns.times.map { |i| i * interval + rnoff }
+                stars << runs.map(&:to_s).join(',')
+              end
+
+              stars.fill('*', stars.size..4)
+              CronSyntax.new(*stars)
+            end
+          end
+        end
+
+        def weekly(*args)
+          unsupported('interval argument unsupported for weekly') unless args.empty?
+          CronSyntax.new(0, 3, '*', '*', 0)             # Sundays at 3AM.
+        end
+
+        define_interval_method(:minutely, 60)
+        define_interval_method(:hourly, 24, 0)          # At first minute of hour.
+        define_interval_method(:daily, 31, 0, 3)        # At night, 3AM.
+        define_interval_method(:monthly, 12, 0, 3, 0)   # First day of the month, 3AM.
+      end
+    end
+  end
+end

data/lib/sidekiq/repeat/repeatable.rb

@@ -0,0 +1,47 @@
+module Sidekiq
+  module Repeat
+    module Repeatable
+      module ClassMethods
+        def repeat(&block)
+          @cronline = MiniIceCube::MainDsl.new.instance_eval(&block).to_s
+          @cronline = CronParser.new(@cronline)
+        rescue ArgumentError
+          fail "repeat '#{@cronline}' in class #{self.name} is not a valid cron line"
+        end
+
+        def reschedule
+          return unless repeat_configured?
+          return if     already_scheduled?
+
+          ts = @cronline.next
+          self.perform_at ts.to_f
+          Sidekiq.logger.info "Scheduled #{self.name} for #{ts}."
+        end
+
+        def repeat_configured?
+          !!@cronline
+        end
+
+        def already_scheduled?
+          @ss ||= Sidekiq::ScheduledSet.new
+          @ss.any? { |job| job.klass == self.name }
+        end
+      end
+
+      class << self
+        def repeatables
+          @repeatables ||= []
+        end
+
+        def reschedule_all
+          repeatables.each(&:reschedule)
+        end
+
+        def included(klass)
+          klass.extend(Sidekiq::Repeat::Repeatable::ClassMethods)
+          repeatables << klass
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/repeat/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Repeat
+    VERSION = '0.1.0'
+  end
+end

data/lib/sidekiq/repeat.rb

@@ -0,0 +1,8 @@
+require 'parse-cron'
+require 'sidekiq'
+require 'sidekiq/api'
+
+require 'sidekiq/repeat/middleware'
+require 'sidekiq/repeat/mini_ice_cube'
+require 'sidekiq/repeat/repeatable'
+require 'sidekiq/repeat/version'

data/lib/sidekiq-repeat.rb

@@ -0,0 +1,11 @@
+require 'sidekiq/repeat'
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Repeat::Middleware
+  end
+
+  config.on(:startup) do
+    Sidekiq::Repeat::Repeatable.reschedule_all
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-repeat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- FlavourSys Technology GmbH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: parse-cron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: This gem adds recurring jobs to Sidekiq. It is heavily inspired by the
+  sidekiq-dejavu and sidetiq gems.
+email: technology@flavoursys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sidekiq-repeat.rb
+- lib/sidekiq/repeat.rb
+- lib/sidekiq/repeat/middleware.rb
+- lib/sidekiq/repeat/mini_ice_cube.rb
+- lib/sidekiq/repeat/repeatable.rb
+- lib/sidekiq/repeat/version.rb
+homepage: https://github.com/FlavourSys/sidekiq-repeat
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Repeat is a clockless recurring job system for Sidekiq.
+test_files: []