sidetiq 0.1.2 → 0.1.3

data/README.md

@@ -2,6 +2,7 @@ Sidetiq
 =======
 
 [![Build Status](https://travis-ci.org/tobiassvn/sidetiq.png)](https://travis-ci.org/tobiassvn/sidetiq)
+[![Dependency Status](https://gemnasium.com/tobiassvn/sidetiq.png)](https://gemnasium.com/tobiassvn/sidetiq)
 
 Recurring jobs for [Sidekiq](http://mperham.github.com/sidekiq/).
 
@@ -118,6 +119,16 @@ loaded by default, so it will have to be required manually:
 require 'sidetiq/web'
 ```
 
+### NOTES
+
+By default Sidekiq uses a 15 second polling interval to check if scheduled
+jobs are due. If a recurring job has to run more often than that you should
+lower this value.
+
+```ruby
+Sidekiq.options[:poll_interval] = 1
+```
+
 ### SCREENSHOT
 
 ![Screenshot](http://f.cl.ly/items/1P2u1v091F3V1n381g2I/Screen%20Shot%202013-02-01%20at%2012.16.17.png)

data/examples/simple.rb

@@ -5,6 +5,10 @@ require 'sidetiq'
 
 Sidekiq.options[:poll_interval] = 1
 
+Sidekiq.configure_server do |config|
+  Sidetiq::Clock.start!
+end
+
 class MyWorker
   include Sidekiq::Worker
   include Sidetiq::Schedulable

data/lib/sidetiq.rb

@@ -18,3 +18,7 @@ require 'sidetiq/schedule'
 require 'sidetiq/schedulable'
 require 'sidetiq/version'
 
+# The Sidetiq namespace.
+module Sidetiq
+end
+

data/lib/sidetiq/clock.rb

@@ -6,27 +6,52 @@ module Sidetiq
     config.utc = false
   end
 
+  # Public: The Sidetiq clock.
   class Clock
     include Singleton
     include MonitorMixin
 
+    # Public: Start time offset from epoch used for calculating run
+    # times in the Sidetiq schedules.
     START_TIME = Sidetiq.config.utc ? Time.utc(2010, 1, 1) : Time.local(2010, 1, 1)
 
-    attr_reader :schedules, :thread
+    # Public: Returns a hash of Sidetiq::Schedule instances.
+    attr_reader :schedules
 
-    def self.method_missing(meth, *args, &block)
+    # Public: Returns the clock thread.
+    attr_reader :thread
+
+    def self.method_missing(meth, *args, &block) # :nodoc:
       instance.__send__(meth, *args, &block)
     end
 
-    def initialize
+    def initialize # :nodoc:
       super
       @schedules = {}
     end
 
+    # Public: Get the schedule for `worker`.
+    #
+    # worker - A Sidekiq::Worker class
+    #
+    # Examples
+    #
+    #   schedule_for(MyWorker)
+    #   # => Sidetiq::Schedule
+    #
+    # Returns a Sidetiq::Schedule instances.
     def schedule_for(worker)
       schedules[worker] ||= Sidetiq::Schedule.new(START_TIME)
     end
 
+    # Public: Issue a single clock tick.
+    #
+    # Examples
+    #
+    #   tick
+    #   # => Hash of Sidetiq::Schedule objects
+    #
+    # Returns a hash of Sidetiq::Schedule instances.
     def tick
       @tick = gettime
       synchronize do
@@ -38,10 +63,29 @@ module Sidetiq
       end
     end
 
+    # Public: Returns the current time used by the clock.
+    #
+    # Sidetiq::Clock uses `clock_gettime()` on UNIX systems and
+    # `mach_absolute_time()` on Mac OS X.
+    #
+    # Examples
+    #
+    #   gettime
+    #   # => 2013-02-04 12:00:45 +0000
+    #
+    # Returns a Time instance.
     def gettime
       Sidetiq.config.utc ? clock_gettime.utc : clock_gettime
     end
 
+    # Public: Starts the clock unless it is already running.
+    #
+    # Examples
+    #
+    #   start!
+    #   # => Thread
+    #
+    # Returns the Thread instance of the clock thread.
     def start!
       return if ticking?
 
@@ -49,8 +93,17 @@ module Sidetiq
       @thread = Thread.start { clock { tick } }
       @thread.abort_on_exception = true
       @thread.priority = Sidetiq.config.resolution
+      @thread
     end
 
+    # Public: Stops the clock if it is running.
+    #
+    # Examples
+    #
+    #   stop!
+    #   # => nil
+    #
+    # Returns nil.
     def stop!
       if ticking?
         @thread.kill
@@ -58,6 +111,18 @@ module Sidetiq
       end
     end
 
+    # Public: Returns the status of the clock.
+    #
+    # Examples
+    #
+    #   ticking?
+    #   # => false
+    #
+    #   start!
+    #   ticking?
+    #   # => true
+    #
+    # Returns true or false.
     def ticking?
       @thread && @thread.alive?
     end

data/lib/sidetiq/config.rb

@@ -1,11 +1,23 @@
 module Sidetiq
   class << self
+    # Public: Sets the configuration used by Sidetiq.
     attr_writer :config
 
+    # Public: Configuration wrapper for block configurations.
+    #
+    # Examples
+    #
+    #   Sidetiq.configure do |config|
+    #     config.resolution = 0.2
+    #   end
+    #
+    # Yields the configuration OpenStruct currently set.
+    # Returns nothing.
     def configure
       yield config
     end
 
+    # Public: Returns the current configuration used by Sidetiq.
     def config
       @config ||= OpenStruct.new
     end

data/lib/sidetiq/schedulable.rb

@@ -1,7 +1,18 @@
 module Sidetiq
+  # Public: Mixin for Sidekiq::Worker classes.
+  #
+  # Examples
+  #
+  #   class MyWorker
+  #       include Sidekiq::Worker
+  #       include Sidetiq::Schedulable
+  #
+  #       # Daily at midnight
+  #       tiq { daily }
+  #     end
   module Schedulable
     module ClassMethods
-      def tiq(&block)
+      def tiq(&block) # :nodoc:
         clock = Sidetiq::Clock.instance
         clock.synchronize do
           clock.schedule_for(self).instance_eval(&block)
@@ -9,7 +20,7 @@ module Sidetiq
       end
     end
 
-    def self.included(klass)
+    def self.included(klass) # :nodoc:
       klass.extend(Sidetiq::Schedulable::ClassMethods)
     end
   end

data/lib/sidetiq/schedule.rb

@@ -1,4 +1,5 @@
 module Sidetiq
+  # Internal: Recurrence schedules.
   class Schedule < IceCube::Schedule
     def method_missing(meth, *args, &block)
       if IceCube::Rule.respond_to?(meth)

data/lib/sidetiq/version.rb

@@ -1,9 +1,16 @@
 module Sidetiq
+  # Public: Sidetiq version namespace.
   module VERSION
+    # Public: Sidetiq major version number.
     MAJOR = 0
+
+    # Public: Sidetiq minor version number.
     MINOR = 1
-    PATCH = 2
 
+    # Public: Sidetiq patch level.
+    PATCH = 3
+
+    # Public: String representation of the current Sidetiq version.
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end
 end

data/lib/sidetiq/web.rb

@@ -2,7 +2,6 @@ require 'sidekiq/web'
 
 module Sidetiq
   module Web
-
     def self.registered(app)
       app.helpers do
         def find_template(view, *args, &block)

data/sidetiq.gemspec

@@ -19,6 +19,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.extensions    = ['ext/sidetiq_ext/extconf.rb']
 
-  gem.add_dependency 'sidekiq'
-  gem.add_dependency 'ice_cube'
+  gem.add_dependency 'sidekiq',  '~> 2.7.0'
+  gem.add_dependency 'ice_cube', '~> 0.9.3'
 end

metadata

@@ -2,7 +2,7 @@
 name: sidetiq
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Tobias Svensson
@@ -14,34 +14,34 @@ dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.7.0
     none: false
   name: sidekiq
   type: :runtime
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.7.0
     none: false
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.3
     none: false
   name: ice_cube
   type: :runtime
   prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.3
     none: false
 description: High-resolution job scheduler for Sidekiq
 email: