sidecloq 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d0f6f9c7d36841096162c3d1ec7775220e58438
-  data.tar.gz: 4d11bcc58feabca4f13c0cf05f6a8d34257e5d29
+  metadata.gz: c42da59e13d5181bbdaed20b903ea9ec5215d341
+  data.tar.gz: 80bcf519574b7937caa39c862305fedcec503587
 SHA512:
-  metadata.gz: 328c80251970cb9899a5106394a5a0c206ce5317fb88be4d4f01092e6521d7f8fcd487535403d6bd917636739be852b0a0051f51ea25ab739dfbebef040ce894
-  data.tar.gz: 3a956934c7415080ca8a68664471cab8e86707eb914b3ae4864f58b2ada039c47e7559c76054982f0e4780f58d87172079e8a4426be107f2d41e579e9c571bbd
+  metadata.gz: d285cf602bc72794c0f01854550fd9a6315d2ab740633e67880e3ec2704f327fbbed220c8f46c013112525d406a8e0ff3609ac68bdac5b9b7ea9dfb98088bd9e
+  data.tar.gz: 6e6af9ab2fb27b80aa41020bb8d9dbd48b967cde2c9d5e8f943b25be7974d27fdb5c6a30127455c336d96c4a5b330e3b8497e01a903277ee4c8533d0a3a0c0ea

data/.travis.yml

@@ -16,3 +16,6 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby-head
+addons:
+  code_climate:
+    repo_token: dee2fdcb3562533038a22e862c0fc91a6f1fa38730cd2b77177655e5b9507c83

data/Gemfile

@@ -6,3 +6,5 @@ platforms :mri do
   gem 'pry'
   gem 'minitest-utils'
 end
+
+gem 'codeclimate-test-reporter', group: :test, require: false

data/README.md

@@ -1,13 +1,41 @@
+![Sidecloq](clock_a_clock_on_the_side.png)
+
 # Sidecloq
 
 [![Build Status](https://travis-ci.org/mattyr/sidecloq.svg)](https://travis-ci.org/mattyr/sidecloq)
+[![Gem Version](https://badge.fury.io/rb/sidecloq.svg)](https://badge.fury.io/rb/sidecloq)
+[![Code Climate](https://codeclimate.com/github/mattyr/sidecloq/badges/gpa.svg)](https://codeclimate.com/github/mattyr/sidecloq)
+[![Test Coverage](https://codeclimate.com/github/mattyr/sidecloq/badges/coverage.svg)](https://codeclimate.com/github/mattyr/sidecloq/coverage)
+[![Dependency Status](https://gemnasium.com/mattyr/sidecloq.svg)](https://gemnasium.com/mattyr/sidecloq)
 
-Another recurring job extension for Sidekiq.
+Recurring / Periodic / Scheduled / Cron job extension for
+[Sidekiq](https://github.com/mperham/sidekiq)
 
 ## Why
 
-TODO: design principles, differences, inspiration (sidetiq,
-sidekiq-scheduler, resque-scheduler)
+There are several options for running periodic tasks with Sidekiq,
+including [Sidetiq](https://github.com/tobiassvn/sidetiq),
+[sidekiq-scheduler](https://github.com/Moove-it/sidekiq-scheduler),
+[sidekiq-cron](https://github.com/ondrejbartas/sidekiq-cron), as well as
+[Sidekiq Pro](http://sidekiq.org/products/pro).  Each tackles the
+problem slightly differently. Sidecloq is inspired by various facets
+of these projects, as well as
+[resque-scheduler](https://github.com/resque/resque-scheduler). I urge
+you to take a look at all of these options to see what works best for
+you.
+
+Sidecloq is:
+
+- **Lightweight:** Celluloid is not required.  This coincides well with
+  Sidekiq 4, which no longer uses Celluloid.
+- **Clean:** Sidecloq leverages only the public API of Sidekiq, and does
+  not pollute the Sidekiq namespace.
+- **Easy to deploy:** Sidecloq boots with all Sideqik processes,
+  automatically.  Leader election ensures only one process enqueues
+  jobs, and a new leader is automatically chosen should the current
+  leader die.
+- **Easy to configure:** Schedule configuration is done in YAML, using
+  the familiar cron syntax. No special DSL or job class mixins required.
 
 ## Installation
 
@@ -17,20 +45,61 @@ Add this line to your application's Gemfile:
 gem 'sidecloq'
 ```
 
-Configure Sidecloq alongside your Sidekiq config.  If using Rails, and
-your schedule is located at config/sidecloq.yml, you don't have to do
-anything (ie, omit this whole configuration block).
+## Configuration
+
+### Quickstart
+
+Tell Sidecloq where your schedule file is located:
 
 ```ruby
 Sidcloq.configure do |config|
-  config[:schedule_file] =
-    File.join(Rails.root, "config/myschedule.yml")
+  config[:schedule_file] = "path/to/myschedule.yml"
 end
 ```
+### Rails
 
-TODO: configuration options
+If using Rails, and your schedule is located at config/sidecloq.yml,
+Sidecloq will find the schedule automatically (ie, you don't have to use
+the above configuration block).
 
-TODO: schedule file format (like resque-scheduler)
+## Schedule file format
+
+### Example:
+
+```yaml
+my_scheduled_job: # a unique name for this schedule
+  class: Jobs::DoWork # the job class
+  cron: "* * * * *" # cron formatted schedule
+  queue: "queue_name" # Sidekiq queue for job
+
+my_other_scheduled_job:
+  class: Jobs::AnotherClassName
+  cron: "1 1 * * *"
+  queue: "a_different_queue"
+```
+
+### Rails
+
+If using Rails, you can nest the schedules under top-level environment
+keys, and Sidecloq will select the correct group based on the Rails
+environment.  This is useful for development/staging scenarios. For
+example:
+
+```yaml
+production:
+  # these will only run in production
+  my_scheduled_job:
+    class: Jobs::ClassName
+    cron: "* * * * *"
+    queue: "queue_name"
+
+staging:
+  # this will only run in staging
+  my_other_scheduled_job:
+    class: Jobs::AnotherClassName
+    cron: "1 1 * * *"
+    queue: "a_different_queue"
+```
 
 ## Web Extension
 
@@ -41,7 +110,11 @@ require 'sidekiq/web'
 require 'sidecloq/web'
 ```
 
-TODO: screenshot/directions
+This will add a "Recurring" tab to the sidekiq web ui, where the loaded
+schedules are displayed.  You can enqueue a job immediately by clicking
+it's corresponding "Enqueue now" button.
+
+![Sidecloq web ui extension screenshot](screenshot.png)
 
 ## Contributing
 
@@ -50,5 +123,3 @@ Bug reports and pull requests are welcome.
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-TODO: project links

data/Rakefile

@@ -1,21 +1,38 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
+  t.libs << 'test'
+  t.libs << 'lib'
   t.test_files = FileList['test/**/test_*.rb']
 end
 
-task :default => :test
+task default: :test
 
-desc "Run the Sidekiq web interface (w/Sidecloq)"
+desc 'Run the Sidekiq web interface (w/Sidecloq)'
 task :web do
   require 'sidekiq'
   require 'sidecloq'
 
   Sidekiq.configure_client do |config|
-    config.redis = { url: 'redis://localhost:6379/0', size: 1, namespace: 'sidecloq' }
+    config.redis = {
+      url: 'redis://localhost:6379/0',
+      size: 1,
+      namespace: 'sidecloq'
+    }
+  end
+
+  # throw a fake job in
+  Sidecloq.configure do |config|
+    sched = Sidecloq::Schedule.from_hash({
+      my_scheduled_job: {
+        class: 'DoWork',
+        cron: '* * * * *',
+        queue: 'default'
+      }
+    })
+    sched.save_redis
+    config[:schedule] = sched
   end
 
   require 'sidekiq/web'

data/lib/sidecloq/locker.rb

@@ -3,9 +3,9 @@ module Sidecloq
   class Locker
     include Utils
 
-    DEFAULT_LOCK_KEY = "sidecloq_leader_lock"
+    DEFAULT_LOCK_KEY = 'sidecloq_leader_lock'
 
-    def initialize(options={})
+    def initialize(options = {})
       # we keep a connection from the pool by default
       @redis = options[:redis] || Sidekiq.redis_pool.checkout
       @key = options[:lock_key] || DEFAULT_LOCK_KEY
@@ -24,33 +24,36 @@ module Sidecloq
     end
 
     def stop(timeout = nil)
-      if @check_task
-        logger.debug("Stopping locker check task")
-        @check_task.shutdown
-        @check_task.wait_for_termination(timeout)
-        logger.debug("Stopped locker check task")
-      end
+      return unless @check_task
+
+      logger.debug('Stopping locker check task')
+      @check_task.shutdown
+      @check_task.wait_for_termination(timeout)
+      logger.debug('Stopped locker check task')
     end
 
-    def has_lock?
+    def locked?
       @obtained_lock.set?
     end
 
     private unless $TESTING
 
     def start
-      logger.debug("Starting locker check task")
-      @check_task = Concurrent::TimerTask.new(execution_interval: @check_interval, run_now: true) do
-        get_or_refresh_lock
+      logger.debug('Starting locker check task')
+      @check_task = Concurrent::TimerTask.new(
+        execution_interval: @check_interval,
+        run_now: true
+      ) do
+        try_to_get_or_refresh_lock
       end
       @check_task.execute
     end
 
-    def get_or_refresh_lock
+    def try_to_get_or_refresh_lock
       # redlock is in ms, not seconds
       @lock = @lock_manager.lock(@key, @ttl * 1000, extend: @lock)
       @obtained_lock.set if @lock
-      logger.debug("Leader lock #{"not " if !@lock}held")
+      logger.debug("Leader lock #{'not ' unless @lock}held")
       @lock
     end
   end

data/lib/sidecloq/runner.rb

@@ -13,24 +13,24 @@ module Sidecloq
 
     def run
       @thread = Thread.new do
-        logger.info("Runner starting")
+        logger.info('Runner starting')
         @locker.with_lock do
           # i am the leader
-          logger.info("Obtained leader lock")
+          logger.info('Obtained leader lock')
           @scheduler.run
         end
-        logger.info("Runner ending")
+        logger.info('Runner ending')
       end
     end
 
     def stop(timeout = nil)
-      logger.debug("Stopping runner")
-      if @locker.has_lock?
+      logger.debug('Stopping runner')
+      if @locker.locked?
         @scheduler.stop(timeout)
         @locker.stop(timeout)
       end
       @thread.join if @thread
-      logger.debug("Stopped runner")
+      logger.debug('Stopped runner')
     end
 
     private unless $TESTING

data/lib/sidecloq/schedule.rb

@@ -32,23 +32,20 @@ module Sidecloq
     end
 
     def self.from_hash(hash)
-      if defined?(Rails) && hash.key?(Rails.env)
-        hash = hash[Rails.env]
-      end
+      hash = hash[Rails.env] if defined?(Rails) && hash.key?(Rails.env)
 
-      specs = hash.inject({}) do |memo, (name, spec)|
+      specs = hash.each_with_object({}) do |(name, spec), memo|
         memo[name] = spec.dup.tap do |s|
           s['class'] = name unless spec.key?('class') || spec.key?(:class)
           s['args'] = s['args'] || s[:args] || []
         end
-        memo
       end
 
       new(specs)
     end
 
     def save_yaml(filename)
-      File.open(filename,'w') do |h|
+      File.open(filename, 'w') do |h|
         h.write @job_specs.to_yaml
       end
     end

data/lib/sidecloq/scheduler.rb

@@ -10,13 +10,13 @@ module Sidecloq
 
     # run queues jobs per their schedules, blocking forever
     def run
-      logger.info("Loading schedules into redis")
+      logger.info('Loading schedules into redis')
       sync_with_redis
-      logger.info("Starting scheduler")
+      logger.info('Starting scheduler')
       load_schedule_into_rufus
-      logger.debug("Joining rufus thread")
+      logger.debug('Joining rufus thread')
       rufus.join
-      logger.debug("Scheduler run ended")
+      logger.debug('Scheduler run ended')
     end
 
     def stop(timeout = nil)
@@ -33,7 +33,7 @@ module Sidecloq
         rufus.shutdown(:wait)
       end
       rufus.join
-      logger.info("Stopped scheduler")
+      logger.info('Stopped scheduler')
     end
 
     private unless $TESTING
@@ -47,7 +47,7 @@ module Sidecloq
     end
 
     def load_schedule_into_rufus
-      logger.debug("Scheduling jobs")
+      logger.debug('Scheduling jobs')
       @schedule.job_specs.each do |name, spec|
         load_into_rufus(name, spec)
       end
@@ -71,14 +71,14 @@ module Sidecloq
 
       # failed enqeueuing should not b0rk stuff
       begin
-        enqueue_job!(name, spec)
+        enqueue_job!(spec)
       rescue => e
         logger.info "error enqueuing #{name} - #{e.class.name}: #{e.message}"
       end
     end
 
     # can raise exceptions, but shouldn't
-    def enqueue_job!(name, spec)
+    def enqueue_job!(spec)
       Sidekiq::Client.push(spec)
     end
   end

data/lib/sidecloq/utils.rb

@@ -1,5 +1,8 @@
 module Sidecloq
+  # Useful stuff
   module Utils
+    # Sets the Sidekiq::Logging context automatically with direct calls to
+    # *.logger
     class ContextLogger
       def initialize(ctx)
         @context = ctx
@@ -25,9 +28,7 @@ module Sidecloq
     def will_never_run(cronline)
       # look for non-existent day of month
       split = cronline.split(/\s+/)
-      if split.length > 3 &&
-          split[2] =~ /\d+/
-          split[3] =~ /\d+/
+      if split.length > 3 && split[2] =~ /\d+/ && split[3] =~ /\d+/
 
         month = split[3].to_i
         day = split[2].to_i

data/lib/sidecloq/version.rb

@@ -1,3 +1,3 @@
 module Sidecloq
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/lib/sidecloq/web.rb

@@ -1,9 +1,9 @@
 module Sidecloq
+  # Plugin for sidekiq-web
   module Web
     VIEW_PATH = File.expand_path('../../../web/views', __FILE__)
 
     def self.registered(app)
-
       app.get '/recurring' do
         @schedule = Schedule.from_redis
 
@@ -11,12 +11,13 @@ module Sidecloq
       end
 
       app.post '/recurring/:name/enqueue' do |name|
+        # rubocop:disable Lint/AssignmentInCondition
         if spec = Sidecloq::Schedule.from_redis.job_specs[name]
           Sidekiq::Client.push(spec)
         end
+        # rubocop:enableLint/AssignmentInCondition
         redirect "#{root_path}recurring"
       end
-
     end
   end
 end

data/lib/sidecloq.rb

@@ -11,6 +11,7 @@ require 'sidecloq/scheduler'
 require 'sidecloq/runner'
 require 'sidecloq/version'
 
+# Sideloq provides a lightweight recurring job scheduler for sidekiq
 module Sidecloq
   def self.install
     Sidekiq.configure_server do |config|
@@ -33,13 +34,12 @@ module Sidecloq
   end
 
   def self.configure
-    yield self
+    yield options
   end
 
   def self.startup
-    unless options[:scheduler]
-      options[:schedule] ||= extract_schedule
-    end
+    options[:schedule] ||= extract_schedule unless options[:scheduler]
+
     @runner = Runner.new(options)
     @runner.run
   end
@@ -55,13 +55,13 @@ module Sidecloq
     return options[:schedule] if options[:schedule]
 
     # try for a file
-    options[:schedule_file] ||= "config/sidecloq.yml"
-    if File.exists?(options[:schedule_file])
+    options[:schedule_file] ||= 'config/sidecloq.yml'
+    if File.exist?(options[:schedule_file])
       return Schedule.from_yaml(options[:schedule_file])
     elsif defined?(Rails)
       # try rails-root-relative
       full_path = File.join(Rails.root, options[:schedule_file])
-      if File.exists?(full_path)
+      if File.exist?(full_path)
         options[:schedule_file] = full_path
         return Schedule.from_yaml(options[:schedule_file])
       end

data/sidetoq.gemspec

@@ -4,30 +4,30 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sidecloq/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sidecloq"
+  spec.name          = 'sidecloq'
   spec.version       = Sidecloq::VERSION
-  spec.authors       = ["Matt Robinson"]
-  spec.email         = ["robinson.matty@gmail.com"]
+  spec.authors       = ['Matt Robinson']
+  spec.email         = ['robinson.matty@gmail.com']
 
-  spec.summary       = %q{Recurring jobs for Sidekiq}
+  spec.summary       = 'Recurring jobs for Sidekiq'
   spec.description   = spec.summary
-  spec.homepage      = "http://github.com/mattyr/sidecloq"
-  spec.license       = "MIT"
+  spec.homepage      = 'http://github.com/mattyr/sidecloq'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "bin"
+  spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "sidekiq", "~> 4.0.1"
-  spec.add_dependency "redlock", "~> 0.1.2"
+  spec.add_dependency 'sidekiq', '~> 4.0.1'
+  spec.add_dependency 'redlock', '~> 0.1.2'
   # mimics some dev dependencies of sidekiq:
-  spec.add_dependency "concurrent-ruby"
-  spec.add_dependency "sinatra", "~> 1.4", ">= 1.4.6"
-  spec.add_dependency "redis-namespace", "~> 1.5", ">= 1.5.2"
-  spec.add_dependency "multi_json", "~> 1.11"
-  spec.add_dependency "rufus-scheduler", "~> 3.1", ">= 3.1.10"
+  spec.add_dependency 'concurrent-ruby'
+  spec.add_dependency 'sinatra', '~> 1.4', '>= 1.4.6'
+  spec.add_dependency 'redis-namespace', '~> 1.5', '>= 1.5.2'
+  spec.add_dependency 'multi_json', '~> 1.11'
+  spec.add_dependency 'rufus-scheduler', '~> 3.1', '>= 3.1.10'
 
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
 end

data/web/views/recurring.erb

@@ -5,8 +5,7 @@
     <thead>
       <tr>
         <th>Name</th>
-        <th>Description</th>
-        <th>Interval</th>
+        <th>Cron</th>
         <th>Class</th>
         <th>Queue</th>
         <th>Arguments</th>
@@ -18,7 +17,6 @@
       <% @schedule.job_specs.each do |name, job_spec| %>
         <tr>
           <td><%= name %></td>
-          <td><%= job_spec['description'] %></td>
           <td><%= job_spec.fetch 'cron', job_spec['every'] %></td>
           <td><%= job_spec['class'] %></td>
           <td>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidecloq
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Matt Robinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-23 00:00:00.000000000 Z
+date: 2015-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -167,6 +167,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- clock_a_clock_on_the_side.png
 - lib/sidecloq.rb
 - lib/sidecloq/locker.rb
 - lib/sidecloq/runner.rb
@@ -175,6 +176,7 @@ files:
 - lib/sidecloq/utils.rb
 - lib/sidecloq/version.rb
 - lib/sidecloq/web.rb
+- screenshot.png
 - sidetoq.gemspec
 - web/views/recurring.erb
 homepage: http://github.com/mattyr/sidecloq