redis-mutex 2.1.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93509c7e322a8d7f8b8aab44e8b679b4943aaf21
-  data.tar.gz: 10570c618421703581ee0ea2cb74d6fca9b33b91
+  metadata.gz: 31cd09963698ff45f5481699862332a7299ea0fb
+  data.tar.gz: ca58764a3e815285dc03a03650969f20db9c65fc
 SHA512:
-  metadata.gz: 75ceb7ece788185aa6c8a0a32f6b36ad2a524775bb2e2e44f4751c61400fcc742d0f326e37f72857ebefd709e7e007da384522093f04e65eabe6d2dd3ca1ab5f
-  data.tar.gz: 50541e94bd60a2af29a2b835b6a909ec160b62590f104db0f61454e16e026d0e7dd678cb9b3ee7c8fe3cc5683f6eb05e3394f96030774ee1006ca0cc75ce4751
+  metadata.gz: d6cc1d509749ac3214d6bdfe8d02e1c91dcde89fc901e54c6019a451aba47c7592581eee63cf7dd0eea9a00f0776acca86d64850712929f6f29de9dadef95a6c
+  data.tar.gz: fd155b4e46710e57b0e95425ae896abdcb7a2efa7e0ddd872915156ffd2e92a0ef0933b433b0bfab0b8f399f46e500c7ee329bdb4c002a294dcef5d438a404b7

data/.travis.yml

@@ -1,12 +1,9 @@
 language: ruby
+services:
+  - redis-server
 rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
+  - 2.0.0
+  - 2.1.0
+  - rbx
   - ruby-head
   - jruby-head
-  - ree

data/README.md

@@ -37,8 +37,14 @@ that you can configure any of these timing values, as explained later.
 
 Or if you want to immediately receive `false` on an unsuccessful locking attempt, you can change the mutex mode to **non-blocking**.
 
-Changes in v2.0
----------------
+Changelog
+---------
+
+### v3.0
+
+* Ruby 2.0 or later is required.
+
+### v2.0
 
 * **Exception-based control flow**: Added `lock!` and `unlock!`, which raises an exception when fails to acquire a lock. Raises `Redis::Mutex::LockError` and `Redis::Mutex::UnlockError` respectively.
 * **INCOMPATIBLE CHANGE**: `#lock` no longer accepts a block. Use `#with_lock` instead, which uses `lock!` internally and returns the value of block.

data/lib/redis/mutex/macro.rb

@@ -28,10 +28,18 @@ class Redis
           if options[:after_failure].is_a?(Proc)
             define_method(after_method, &options[:after_failure])
           end
+          target_argument_names = instance_method(target.to_sym).parameters.map(&:last)
+          on_arguments = Array(options[:on])
+          mutex_arguments = on_arguments & target_argument_names
+          unknown_arguments = on_arguments - target_argument_names
+          if unknown_arguments.any?
+            raise ArgumentError, "You are trying to lock on unknown arguments: #{unknown_arguments.join(', ')}"
+          end
 
           define_method(with_method) do |*args|
-            key = self.class.name << '#' << target.to_s
-
+            named_arguments =  Hash[target_argument_names.zip(args)]
+            arguments  = mutex_arguments.map { |name| named_arguments.fetch(name) }
+            key = self.class.name << '#' << target.to_s << ":" << arguments.join(':')
             begin
               Redis::Mutex.with_lock(key, options) do
                 send(without_method, *args)

data/redis-mutex.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "redis-mutex"
   gem.require_paths = ["lib"]
-  gem.version       = '2.1.1' # retrieve this value by: Gem.loaded_specs['redis-mutex'].version.to_s
+  gem.version       = '3.0.0' # retrieve this value by: Gem.loaded_specs['redis-mutex'].version.to_s
 
   gem.add_runtime_dependency "redis-classy", "~> 1.2"
   gem.add_development_dependency "rspec"

data/spec/redis_mutex_macro_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+class C
+  include Redis::Mutex::Macro
+  auto_mutex :run_singularly, :block => 0, :after_failure => lambda {|id| return "failure: #{id}" }
+
+  def run_singularly(id)
+    sleep 0.1
+    return "success: #{id}"
+  end
+
+  auto_mutex :run_singularly_on_args, :block => 0, :on => [:id, :bar], :after_failure => lambda {|id, *others| return "failure: #{id}" }
+  def run_singularly_on_args(id, foo, bar)
+    sleep 0.1
+    return "success: #{id}"
+  end
+
+  auto_mutex :run_singularly_on_keyword_args, :block => 0, :on => [:id, :bar], :after_failure => lambda {|id: 1, **others| return "failure: #{id}" }
+  def run_singularly_on_keyword_args(id: 1, foo: 1, bar: 1)
+    sleep 0.1
+    return "success: #{id}"
+  end
+end
+
+describe Redis::Mutex::Macro do
+
+  def race(a, b)
+    t1 = Thread.new(&a)
+    # In most cases t1 wins, but make sure to give it a head start,
+    # not exceeding the sleep inside the method.
+    sleep 0.01
+    t2 = Thread.new(&b)
+    t1.join
+    t2.join
+  end
+
+  let(:object_arg) { Object.new }
+
+  it 'adds auto_mutex' do
+    race(
+      proc { C.new.run_singularly(1).should == "success: 1" },
+      proc { C.new.run_singularly(2).should == "failure: 2" })
+  end
+
+  it 'adds auto_mutex on different args' do
+    race(
+      proc { C.new.run_singularly_on_args(1, :'2', object_arg).should == "success: 1" },
+      proc { C.new.run_singularly_on_args(2, :'2', object_arg).should == "success: 2" })
+  end
+
+  it 'adds auto_mutex on same args' do
+    race(
+      proc { C.new.run_singularly_on_args(1, :'2', object_arg).should == "success: 1" },
+      proc { C.new.run_singularly_on_args(1, :'2', object_arg).should == "failure: 1" })
+  end
+
+  it 'adds auto_mutex on different keyword args' do
+    race(
+      proc { C.new.run_singularly_on_keyword_args(id: 1, foo: :'2', bar: object_arg).should == "success: 1" },
+      proc { C.new.run_singularly_on_keyword_args(id: 2, foo: :'2', bar: object_arg).should == "success: 2" })
+  end
+
+  it 'adds auto_mutex on same keyword args' do
+    race(
+      proc { C.new.run_singularly_on_keyword_args(id: 1, foo: :'2', bar: object_arg).should == "success: 1" },
+      proc { C.new.run_singularly_on_keyword_args(id: 1, foo: :'2', bar: object_arg).should == "failure: 1" })
+  end
+
+  it 'raise exception if there is no such argument' do
+    expect {
+      class C
+        auto_mutex :run_without_such_args, :block => 0, :on => [:missing_arg]
+        def run_without_such_args(id)
+          return "success: #{id}"
+        end
+      end
+    }.to raise_error(ArgumentError) { |error|
+      expect(error.message).to eq 'You are trying to lock on unknown arguments: missing_arg'
+    }
+  end
+end

data/spec/redis_mutex_spec.rb

@@ -2,16 +2,6 @@ require 'spec_helper'
 
 SHORT_MUTEX_OPTIONS = { :block => 0.1, :sleep => 0.02 }
 
-class C
-  include Redis::Mutex::Macro
-  auto_mutex :run_singularly, :block => 0, :after_failure => lambda {|id| return "failure: #{id}" }
-
-  def run_singularly(id)
-    sleep 0.1
-    return "success: #{id}"
-  end
-end
-
 describe Redis::Mutex do
   before do
     Redis::Classy.flushdb
@@ -160,18 +150,6 @@ describe Redis::Mutex do
     Redis::Mutex.keys.size.should == 1
   end
 
-  describe Redis::Mutex::Macro do
-    it 'adds auto_mutex' do
-      t1 = Thread.new { C.new.run_singularly(1).should == "success: 1" }
-      # In most cases t1 wins, but make sure to give it a head start,
-      # not exceeding the sleep inside the method.
-      sleep 0.01
-      t2 = Thread.new { C.new.run_singularly(2).should == "failure: 2" }
-      t1.join
-      t2.join
-    end
-  end
-
   describe 'stress test' do
     LOOP_NUM = 1000
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-mutex
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Kenn Ejima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-20 00:00:00.000000000 Z
+date: 2014-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-classy
@@ -84,6 +84,7 @@ files:
 - lib/redis/mutex.rb
 - lib/redis/mutex/macro.rb
 - redis-mutex.gemspec
+- spec/redis_mutex_macro_spec.rb
 - spec/redis_mutex_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/kenn/redis-mutex
@@ -105,10 +106,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Distrubuted mutex using Redis
 test_files:
+- spec/redis_mutex_macro_spec.rb
 - spec/redis_mutex_spec.rb
 - spec/spec_helper.rb