lock_method 0.3.0 → 0.4.0

data/README.rdoc

@@ -6,7 +6,7 @@ Lets you lock a method so that only one process can call it at a time. Defaults
 
 == Real-world usage
 
-In production use at {carbon.brighterplanet.com}[http://carbon.brighterplanet.com] and {data.brighterplanet.com}[http://data.brighterplanet.com].
+In production use at {impact.brighterplanet.com}[http://impact.brighterplanet.com] and {data.brighterplanet.com}[http://data.brighterplanet.com].
 
 == Example
 
@@ -20,8 +20,8 @@ In production use at {carbon.brighterplanet.com}[http://carbon.brighterplanet.co
       lock_method :get_latest_entries
 
       # used by lock_method to differentiate between instances
-      def hash
-        url.hash
+      def as_lock
+        url
       end
     end
 
@@ -32,25 +32,21 @@ Then you can do
 
 Just in case, you can clear them
 
-    my_blog.clear_method_lock :get_latest_entries
+    my_blog.lock_method_clear :get_latest_entries
 
 == Pays attention to method arguments
 
 If you lock Foo.bar(*args), calling Foo.bar(:baz) will not lock out Foo.bar(:zoo).
 
-== Defining #hash
+== Defining #as_lock
 
-If you want to lock instance methods, you should define <tt>#hash</tt> on those instances.
+If you want to lock instance methods, you should define <tt>#as_lock</tt> on those instances.
 
-You should follow Ruby convention and have <tt>#hash</tt> return a <tt>Fixnum</tt>.
+== Locking across hosts
 
-Ideally, you should try to make a <tt>String</tt> or a <tt>Hash</tt> and call the standard <tt>#hash</tt> on that.
+If you want to lock across hosts, just use shared storage, like a remote Redis or memcached instance.
 
-Note: this is NOT the same thing as <tt>#to_hash</tt>! That returns a <tt>Hash</tt>... but what we want is an integer "hash code."
-
-== Defining #method_lock_hash instead of #hash
-
-If you don't want to modify #hash, you can use #method_lock_hash instead.
+If you want to lock locally, but you're using shared storage, just get the hostname of the locking instance into the <tt>as_lock</tt>.
 
 == Configuration (and supported cache clients)
 

data/lib/lock_method.rb

@@ -20,13 +20,13 @@ module LockMethod
     Config.instance
   end
   
-  # All Objects, including instances and Classes, get the <tt>#clear_method_lock</tt> method.
+  # All Objects, including instances and Classes, get the <tt>#lock_method_clear</tt> method.
   module InstanceMethods
     # Clear the lock for a particular method.
     #
     # Example:
-    #     my_blog.clear_method_lock :get_latest_entries
-    def clear_method_lock(method_id)
+    #     my_blog.lock_method_clear :get_latest_entries
+    def lock_method_clear(method_id)
       lock = ::LockMethod::Lock.new self, method_id
       lock.delete
     end

data/lib/lock_method/lock.rb

@@ -1,4 +1,4 @@
-require 'digest/md5'
+require 'digest/sha1'
 module LockMethod
   class Lock #:nodoc: all
     class << self
@@ -41,12 +41,12 @@ module LockMethod
       @ttl ||= Config.instance.default_ttl
     end
     
-    def obj_hash
-      @obj_hash ||= obj.respond_to?(:method_lock_hash) ? obj.method_lock_hash : obj.hash
+    def obj_digest
+      @obj_digest ||= ::Digest::SHA1.hexdigest(::Marshal.dump(obj.respond_to?(:as_lock) ? obj.as_lock : obj))
     end
 
     def args_digest
-      @args_digest ||= args.to_a.empty? ? 'empty' : ::Digest::MD5.hexdigest(args.join)
+      @args_digest ||= args.to_a.empty? ? 'empty' : ::Digest::SHA1.hexdigest(::Marshal.dump(args))
     end
         
     def delete
@@ -65,7 +65,7 @@ module LockMethod
       if obj.is_a?(::Class) or obj.is_a?(::Module)
         [ 'LockMethod', 'Lock', method_signature, args_digest ].join ','
       else
-        [ 'LockMethod', 'Lock', method_signature, obj_hash, args_digest ].join ','
+        [ 'LockMethod', 'Lock', method_signature, obj_digest, args_digest ].join ','
       end
     end
             

data/lib/lock_method/version.rb

@@ -1,3 +1,3 @@
 module LockMethod
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/test/helper.rb

@@ -25,17 +25,17 @@ class Blog1
     ["voo vaa #{name}"]
   end
   lock_method :get_latest_entries2, 5 # second
-  def hash
-    raise "Used hash"
+  def marshal_dump
+    raise "Used marshal_dump"
   end
-  def method_lock_hash
-    name.hash
+  def as_lock
+    name
   end
 end
 
 class Blog1a < Blog1
-  def method_lock_hash
-    raise "Used method_lock_hash"
+  def as_lock
+    raise "Used as_lock"
   end
 end
 

data/test/shared_tests.rb

@@ -114,7 +114,7 @@ module SharedTests
     end
   
     # but now we clear the lock
-    new_instance_of_my_blog.clear_method_lock :get_latest_entries
+    new_instance_of_my_blog.lock_method_clear :get_latest_entries
     assert_nothing_raised do
       new_instance_of_my_blog.get_latest_entries
     end
@@ -134,7 +134,7 @@ module SharedTests
     end
     
     # but now we clear the lock
-    Blog2.clear_method_lock :get_latest_entries
+    Blog2.lock_method_clear :get_latest_entries
     assert_nothing_raised do
       Blog2.get_latest_entries
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lock_method
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-12 00:00:00.000000000Z
+date: 2012-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cache
-  requirement: &2153961100 !ruby/object:Gem::Requirement
+  requirement: &2152246540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *2153961100
+  version_requirements: *2152246540
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2153960680 !ruby/object:Gem::Requirement
+  requirement: &2152240680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153960680
+  version_requirements: *2152240680
 - !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &2153960220 !ruby/object:Gem::Requirement
+  requirement: &2160094560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153960220
+  version_requirements: *2160094560
 - !ruby/object:Gem::Dependency
   name: memcached
-  requirement: &2153959800 !ruby/object:Gem::Requirement
+  requirement: &2160090340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153959800
+  version_requirements: *2160090340
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2153959380 !ruby/object:Gem::Requirement
+  requirement: &2160103240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153959380
+  version_requirements: *2160103240
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &2153958940 !ruby/object:Gem::Requirement
+  requirement: &2160101140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153958940
+  version_requirements: *2160101140
 description: Like alias_method, but it's lock_method!
 email:
 - seamus@abshere.net
@@ -119,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: lock_method
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Lets you lock methods (to memcached, redis, etc.) as though you had a lockfile
@@ -130,3 +130,4 @@ test_files:
 - test/test_default_storage.rb
 - test/test_memcached_storage.rb
 - test/test_redis_storage.rb
+has_rdoc: