sidekiq-lock 0.0.1 → 0.2.0

data/.travis.yml

@@ -1,7 +1,12 @@
 language: ruby
 
+services:
+  - redis-server
+
 rvm:
   - 1.9.3
+  - jruby-19mode
+  - rbx
   - 2.0.0
 
 notifications:

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 0.2.0
+
+- ability to globally configure `lock` method name
+
+``` ruby
+Sidekiq.configure_server do |config|
+  config.lock_method = :redis_lock
+end
+```
+
+- added inline test helper, by requiring `sidekiq/lock/testing/inline`
+  you will have access to two methods:
+
+  - `set_sidekiq_lock(worker_class, payload)`
+
+  - `clear_sidekiq_lock`
+
+  That will setup `RedisLock` under proper thread variable.
+  This can be handy if you test your workers inline (without full stack middleware)
+
 ## 0.0.1
 
 - Initial release

data/Gemfile

@@ -1,4 +1,8 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in sidekiq-lock.gemspec
+source "https://rubygems.org"
 gemspec
+
+platforms :rbx do
+  gem "rubysl", "~> 2.0"                     # if using anything in the ruby standard library
+  gem "rubinius-developer_tools", "~> 2.0.0" # if using any of coverage, debugger, profiler
+  gem "minitest"                             # if using minitest
+end

data/README.md

@@ -2,6 +2,9 @@
 
 [![Code Climate](https://codeclimate.com/github/emq/sidekiq-lock.png)](https://codeclimate.com/github/emq/sidekiq-lock)
 [![Build Status](https://travis-ci.org/emq/sidekiq-lock.png?branch=master)](https://travis-ci.org/emq/sidekiq-lock)
+[![Coverage Status](https://coveralls.io/repos/emq/sidekiq-lock/badge.png)](https://coveralls.io/r/emq/sidekiq-lock)
+[![Dependency Status](https://gemnasium.com/emq/sidekiq-lock.png)](https://gemnasium.com/emq/sidekiq-lock)
+[![Gem Version](https://badge.fury.io/rb/sidekiq-lock.png)](http://badge.fury.io/rb/sidekiq-lock)
 
 Redis-based simple locking mechanism for [sidekiq][2]. Uses [SET command][1] introduced in Redis 2.6.16.
 
@@ -90,6 +93,23 @@ end
 
 Just be sure to provide valid redis key as a lock name.
 
+### Customizing lock method name
+
+You can change `lock` to something else (globally) in sidekiq server configuration:
+
+``` ruby
+Sidekiq.configure_server do |config|
+  config.lock_method = :redis_lock
+end
+```
+
+### Inline testing
+
+As you know middleware is not invoked when testing jobs inline, you can require in your test/spec helper file `sidekiq/lock/testing/inline` to include two methods that will help you setting / clearing up lock manually:
+
+- `set_sidekiq_lock(worker_class, payload)` - note: payload should be an array of worker arguments
+- `clear_sidekiq_lock`
+
 ## Contributing
 
 1. Fork it

data/lib/sidekiq/lock.rb

@@ -1,9 +1,18 @@
-require "sidekiq/lock/version"
-require "sidekiq/lock/worker"
 require "sidekiq/lock/middleware"
 require "sidekiq/lock/redis_lock"
+require "sidekiq/lock/version"
+require "sidekiq/lock/worker"
 
 module Sidekiq
+
+  def self.lock_method
+    @lock_method || :lock
+  end
+
+  def self.lock_method=(method)
+    @lock_method = method
+  end
+
   module Lock
     THREAD_KEY = :sidekiq_lock
   end
@@ -14,3 +23,4 @@ Sidekiq.configure_server do |config|
     chain.add Sidekiq::Lock::Middleware
   end
 end
+

data/lib/sidekiq/lock/testing/inline.rb

@@ -0,0 +1,8 @@
+def set_sidekiq_lock(worker_class, payload)
+  options = worker_class.get_sidekiq_options['lock']
+  Thread.current[Sidekiq::Lock::THREAD_KEY] = Sidekiq::Lock::RedisLock.new(options, payload)
+end
+
+def clear_sidekiq_lock
+  Thread.current[Sidekiq::Lock::THREAD_KEY] = nil
+end

data/lib/sidekiq/lock/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Lock
-    VERSION = "0.0.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/sidekiq/lock/worker.rb

@@ -2,8 +2,10 @@ module Sidekiq
   module Lock
     module Worker
 
-      def lock
-        Thread.current[Sidekiq::Lock::THREAD_KEY]
+      def self.included(base)
+        base.send(:define_method, Sidekiq.lock_method) do
+          Thread.current[Sidekiq::Lock::THREAD_KEY]
+        end
       end
 
     end

data/sidekiq-lock.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "coveralls", "~> 0.7.0"
+  spec.add_development_dependency "mocha", "~> 0.14.0"
 end

data/test/lib/middleware_test.rb

@@ -1,38 +1,13 @@
 require "test_helper"
 
-class LockWorker
-  include Sidekiq::Worker
-  include Sidekiq::Lock::Worker
-  sidekiq_options lock: { timeout: 1, name: 'lock-worker' }
-end
-
-class DynamicLockWorker
-  include Sidekiq::Worker
-  include Sidekiq::Lock::Worker
-  sidekiq_options lock: {
-    timeout: proc { |user_id, timeout| timeout*2 },
-    name:    proc { |user_id, timeout| "lock:#{user_id}" }
-  }
-end
-
-class RegularWorker
-  include Sidekiq::Worker
-  include Sidekiq::Lock::Worker
-end
-
-
 module Sidekiq
   module Lock
     describe Middleware do
 
-      def thread_variable
-        Thread.current[Sidekiq::Lock::THREAD_KEY]
-      end
-
       before do
         Sidekiq.redis = REDIS
         Sidekiq.redis { |c| c.flushdb }
-        Thread.current[Sidekiq::Lock::THREAD_KEY] = nil
+        set_lock_variable!
       end
 
       let(:handler){ Sidekiq::Lock::Middleware.new }
@@ -42,7 +17,7 @@ module Sidekiq
           true
         end
 
-        assert_kind_of RedisLock, thread_variable
+        assert_kind_of RedisLock, lock_thread_variable
       end
 
       it 'sets lock variable with provided dynamic options' do
@@ -50,8 +25,8 @@ module Sidekiq
           true
         end
 
-        assert_equal "lock:1234", thread_variable.name
-        assert_equal 2000,   thread_variable.timeout
+        assert_equal "lock:1234", lock_thread_variable.name
+        assert_equal 2000,   lock_thread_variable.timeout
       end
 
       it 'sets nothing for workers without lock options' do
@@ -59,7 +34,7 @@ module Sidekiq
           true
         end
 
-        assert_nil thread_variable
+        assert_nil lock_thread_variable
       end
 
     end

data/test/lib/redis_lock_test.rb

@@ -32,6 +32,11 @@ module Sidekiq
         assert RedisLock.new({ 'timeout' => 500, 'name' => 'lock-name' }, [])
       end
 
+      it "is released by default" do
+        lock = RedisLock.new({ 'timeout' => 500, 'name' => 'lock-name' }, [])
+        refute lock.acquired?
+      end
+
       it "can accept block as arguments" do
         lock = RedisLock.new({
             'timeout' => proc { |options| options['timeout'] * 2 },

data/test/lib/testing/inline_test.rb

@@ -0,0 +1,22 @@
+require "test_helper"
+require "sidekiq/lock/testing/inline"
+
+describe "inline test helper" do
+
+  after { set_lock_variable! }
+
+  it "has helper fuction for setting lock" do
+    Sidekiq::Lock::RedisLock.expects(:new).with({ timeout: 1, name: 'lock-worker' }, 'worker argument').returns('lock set')
+    set_sidekiq_lock(LockWorker, 'worker argument')
+    assert_equal 'lock set', lock_thread_variable
+  end
+
+  it "has helper fuction for clearing lock" do
+    set_lock_variable! "test"
+    assert_equal "test", lock_thread_variable
+
+    clear_sidekiq_lock
+    assert_nil lock_thread_variable
+  end
+
+end

data/test/lib/worker_test.rb

@@ -4,11 +4,26 @@ module Sidekiq
   module Lock
     describe Worker do
 
+      after { set_lock_variable! }
+
       it 'sets lock method that points to thread variable' do
-        Thread.current[Sidekiq::Lock::THREAD_KEY] = "test"
+        set_lock_variable! "test"
         assert_equal "test", LockWorker.new.lock
       end
 
+      it 'allows method name configuration' do
+        Sidekiq.lock_method = :custom_lock_name
+
+        class WorkerWithCustomLockName
+          include Sidekiq::Worker
+          include Sidekiq::Lock::Worker
+        end
+
+        set_lock_variable! "custom_name"
+
+        assert_equal "custom_name", WorkerWithCustomLockName.new.custom_lock_name
+      end
+
     end
   end
 end

data/test/test_helper.rb

@@ -1,11 +1,16 @@
+require 'coveralls'
+Coveralls.wear!
+
 Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8
 
 require "minitest/autorun"
 require "minitest/pride"
+require "mocha/setup"
 
 require "sidekiq"
 require "sidekiq-lock"
+require "test_workers"
 
 Sidekiq.logger.level = Logger::ERROR
 
@@ -16,3 +21,11 @@ def redis(command, *args)
     c.send(command, *args)
   end
 end
+
+def set_lock_variable!(value = nil)
+  Thread.current[Sidekiq::Lock::THREAD_KEY] = value
+end
+
+def lock_thread_variable
+  Thread.current[Sidekiq::Lock::THREAD_KEY]
+end

data/test/test_workers.rb

@@ -0,0 +1,19 @@
+class LockWorker
+  include Sidekiq::Worker
+  include Sidekiq::Lock::Worker
+  sidekiq_options lock: { timeout: 1, name: 'lock-worker' }
+end
+
+class DynamicLockWorker
+  include Sidekiq::Worker
+  include Sidekiq::Lock::Worker
+  sidekiq_options lock: {
+    timeout: proc { |user_id, timeout| timeout*2 },
+    name:    proc { |user_id, timeout| "lock:#{user_id}" }
+  }
+end
+
+class RegularWorker
+  include Sidekiq::Worker
+  include Sidekiq::Lock::Worker
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-lock
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-14 00:00:00.000000000 Z
+date: 2013-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -91,6 +91,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
 description: Simple redis-based lock mechanism for your sidekiq workers
 email:
 - rafal.wojsznis@gmail.com
@@ -109,13 +141,16 @@ files:
 - lib/sidekiq/lock.rb
 - lib/sidekiq/lock/middleware.rb
 - lib/sidekiq/lock/redis_lock.rb
+- lib/sidekiq/lock/testing/inline.rb
 - lib/sidekiq/lock/version.rb
 - lib/sidekiq/lock/worker.rb
 - sidekiq-lock.gemspec
 - test/lib/middleware_test.rb
 - test/lib/redis_lock_test.rb
+- test/lib/testing/inline_test.rb
 - test/lib/worker_test.rb
 - test/test_helper.rb
+- test/test_workers.rb
 homepage: https://github.com/emq/sidekiq-lock
 licenses:
 - MIT
@@ -131,7 +166,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 153540864602808106
+      hash: -2239756141932312381
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -140,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 153540864602808106
+      hash: -2239756141932312381
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -150,5 +185,7 @@ summary: Simple redis-based lock mechanism for your sidekiq workers
 test_files:
 - test/lib/middleware_test.rb
 - test/lib/redis_lock_test.rb
+- test/lib/testing/inline_test.rb
 - test/lib/worker_test.rb
 - test/test_helper.rb
+- test/test_workers.rb