lock_method 0.1.3 → 0.2.0

data/README.rdoc

@@ -32,11 +32,9 @@ Just in case, you can clear them
 
 In production use at {carbon.brighterplanet.com}[http://carbon.brighterplanet.com], the Brighter Planet emission estimate web service.
 
-== Ignores arguments when locking a method
+== Pays attention to method arguments
 
-lock_method ignores arguments when locking. So if you call Foo.bar(:a), calls to Foo.bar(:b) will be locked until the first call finishes.
-
-Maybe future versions will support this.
+If you lock Foo.bar(*args), calling Foo.bar(:baz) will not lock out Foo.bar(:zoo).
 
 == Defining #hash
 

data/lib/lock_method/default_storage_client.rb

@@ -4,18 +4,37 @@ require 'fileutils'
 require 'thread'
 module LockMethod
   class DefaultStorageClient #:nodoc: all
+
     include ::Singleton
+
+    class Entry
+      attr_reader :created_at
+      attr_reader :ttl
+      attr_reader :v
+      def initialize(attrs = {})
+        attrs.each do |k, v|
+          instance_variable_set "@#{k}", v
+        end
+      end
+      def expired?
+        ttl.to_i > 0 and (::Time.now.to_f - created_at.to_f) > ttl.to_i
+      end
+    end
+
     def get(k)
-      return unless ::File.exist? path(k)
-      ::Marshal.load ::File.read(path(k))
+      if ::File.exist?(path(k)) and entry = ::Marshal.load(::File.read(path(k))) and not entry.expired?
+        entry.v
+      end
     rescue ::Errno::ENOENT
     end
   
     def set(k, v, ttl)
+      entry = Entry.new :created_at => ::Time.now.to_f, :ttl => ttl, :v => v
       semaphore.synchronize do
+        ::FileUtils.mkdir_p dir unless ::File.directory? dir
         ::File.open(path(k), ::File::RDWR|::File::CREAT) do |f|
           f.flock ::File::LOCK_EX
-          f.write ::Marshal.dump(v)
+          f.write ::Marshal.dump(entry)
         end
       end
     end
@@ -39,9 +58,7 @@ module LockMethod
     end
   
     def dir
-      dir = ::File.expand_path(::File.join(::Dir.tmpdir, 'lock_method'))
-      ::FileUtils.mkdir_p dir unless ::File.directory? dir
-      dir
+      ::File.expand_path ::File.join(::Dir.tmpdir, 'lock_method')
     end
   end
 end

data/lib/lock_method/lock.rb

@@ -1,10 +1,9 @@
+require 'digest/md5'
 module LockMethod
   class Lock #:nodoc: all
     class << self
       def find(cache_key)
-        if hsh = Config.instance.storage.get(cache_key)
-          new hsh
-        end
+        Config.instance.storage.get cache_key
       end
       def klass_name(obj)
         (obj.is_a?(::Class) or obj.is_a?(::Module)) ? obj.to_s : obj.class.to_s
@@ -27,15 +26,14 @@ module LockMethod
       end
     end
 
-    def initialize(options = {})
-      options.each do |k, v|
+    def initialize(attrs = {})
+      attrs.each do |k, v|
         instance_variable_set "@#{k}", v
       end
     end
 
     attr_reader :obj
     attr_reader :method_id
-    attr_reader :original_method_id
     attr_reader :args
         
     def method_signature
@@ -54,71 +52,59 @@ module LockMethod
       @thread_object_id ||= ::Thread.current.object_id
     end
     
-    def expiry
-      @expiry ||= ::Time.now + ttl
+    def obj_hash
+      @obj_hash ||= obj.respond_to?(:method_lock_hash) ? obj.method_lock_hash : obj.hash
     end
-    
+
+    def args_digest
+      @args_digest ||= args.to_a.empty? ? 'empty' : ::Digest::MD5.hexdigest(args.join)
+    end
+        
     def delete
       Config.instance.storage.delete cache_key
     end
     
     def save
-      # make sure these are set
-      self.pid
-      self.thread_object_id
-      self.expiry
-      # --
-      Config.instance.storage.set cache_key, to_hash, ttl
-    end
-    
-    def to_hash
-      instance_variables.inject({}) do |memo, ivar_name|
-        memo[ivar_name.to_s.sub('@', '')] = instance_variable_get ivar_name
-        memo
-      end
+      Config.instance.storage.set cache_key, self, ttl
     end
     
     def locked?
-      if existing_lock = Lock.find(cache_key)
-        existing_lock.in_force?
+      if other_lock = Lock.find(cache_key)
+        other_lock.process_and_thread_still_alive?
       end
     end
     
     def cache_key
       if obj.is_a?(::Class) or obj.is_a?(::Module)
-        [ 'LockMethod', 'Lock', method_signature ].join ','
+        [ 'LockMethod', 'Lock', method_signature, args_digest ].join ','
       else
-        [ 'LockMethod', 'Lock', method_signature, obj_hash ].join ','
+        [ 'LockMethod', 'Lock', method_signature, obj_hash, args_digest ].join ','
       end
     end
-    
-    def obj_hash
-      @obj_hash ||= obj.respond_to?(:method_lock_hash) ? obj.method_lock_hash : obj.hash
-    end
-    
-    def in_force?
-      not expired? and process_and_thread_still_exist?
-    end
-    
-    def expired?
-      expiry.to_f < ::Time.now.to_f
-    end
-    
-    def process_and_thread_still_exist?
+            
+    def process_and_thread_still_alive?
       if pid == ::Process.pid
         Lock.thread_alive? thread_object_id
       else
         Lock.process_alive? pid
       end
     end
+
+    def marshal_dump
+      [ pid, thread_object_id ]
+    end
+    
+    def marshal_load(source)
+      @pid, @thread_object_id = source
+    end
     
-    def call_original_method
+    def call_and_lock(*original_method_id_and_args)
       if locked?
         raise Locked
       else
         begin
           save
-          obj.send original_method_id, *args
+          obj.send *original_method_id_and_args
         ensure
           delete
         end

data/lib/lock_method/version.rb

@@ -1,3 +1,3 @@
 module LockMethod
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/lock_method.rb

@@ -46,8 +46,8 @@ module LockMethod
       original_method_id = "_unlocked_#{method_id}"
       alias_method original_method_id, method_id
       define_method method_id do |*args|
-        lock = ::LockMethod::Lock.new :obj => self, :method_id => method_id, :original_method_id => original_method_id, :args => args, :ttl => ttl
-        lock.call_original_method
+        lock = ::LockMethod::Lock.new :obj => self, :method_id => method_id, :args => args, :ttl => ttl
+        lock.call_and_lock original_method_id, *args
       end
     end
   end

data/test/helper.rb

@@ -16,7 +16,7 @@ class Blog1
     @url = url
   end
   def get_latest_entries
-    sleep 8
+    sleep 2
     ["hello from #{name}"]
   end
   lock_method :get_latest_entries
@@ -42,7 +42,7 @@ end
 class Blog2
   class << self
     def get_latest_entries
-      sleep 8
+      sleep 2
       'danke schoen'
     end
     lock_method :get_latest_entries
@@ -51,12 +51,17 @@ class Blog2
       ["voo vaa #{name}"]
     end
     lock_method :get_latest_entries2, 5 # second
+    def work_really_hard_on(target)
+      sleep 2
+      target.to_s
+    end
+    lock_method :work_really_hard_on
   end
 end
 
 module BlogM
   def self.get_latest_entries
-    sleep 8
+    sleep 2
     'danke schoen'
   end
   def self.get_latest_entries2

data/test/shared_tests.rb

@@ -6,11 +6,11 @@ def new_instance_of_another_blog
 end
 
 module SharedTests
-  def test_locked_method_return_value
+  def test_01_locked_method_return_value
     assert_equal ["hello from my_blog"], new_instance_of_my_blog.get_latest_entries
   end
   
-  def test_locked_by_normally_terminating_process
+  def test_02_locked_by_normally_terminating_process
     pid = Kernel.fork { Blog2.get_latest_entries }
   
     # give it a bit of time to lock
@@ -29,7 +29,7 @@ module SharedTests
     end
   end
   
-    def test_module_method_locked_by_normally_terminating_process
+  def test_03_module_method_locked_by_normally_terminating_process
     pid = Kernel.fork { BlogM.get_latest_entries }
   
     # give it a bit of time to lock
@@ -48,7 +48,7 @@ module SharedTests
     end
   end
   
-  def test_locked_by_SIGKILLed_process
+  def test_04_locked_by_SIGKILLed_process
     pid = Kernel.fork { Blog2.get_latest_entries }
     
     # give it a bit of time to lock
@@ -70,7 +70,7 @@ module SharedTests
     end
   end
   
-  def test_locked_by_killed_thread
+  def test_05_locked_by_killed_thread
     blocker = Thread.new { Blog2.get_latest_entries }
   
     # give it a bit of time to lock
@@ -90,7 +90,7 @@ module SharedTests
     end
   end
   
-  def test_locked_by_normally_finishing_thread
+  def test_06_locked_by_normally_finishing_thread
     blocker = Thread.new { Blog2.get_latest_entries }
   
     # give it a bit of time to lock
@@ -110,7 +110,7 @@ module SharedTests
     end
   end
   
-  def test_lock_instance_method
+  def test_07_lock_instance_method
     pid = Kernel.fork { new_instance_of_my_blog.get_latest_entries }
   
     # give it a bit of time to lock
@@ -130,7 +130,7 @@ module SharedTests
     end
   end
   
-  def test_instance_method_lock_is_unique_to_instance
+  def test_08_instance_method_lock_is_unique_to_instance
     pid = Kernel.fork { new_instance_of_my_blog.get_latest_entries }
   
     # give it a bit of time to lock
@@ -144,7 +144,7 @@ module SharedTests
     Process.wait pid
   end
   
-  def test_clear_instance_method_lock
+  def test_09_clear_instance_method_lock
     pid = Kernel.fork { new_instance_of_my_blog.get_latest_entries }
   
     # give it a bit of time to lock
@@ -164,7 +164,7 @@ module SharedTests
     Process.wait pid
   end
   
-  def test_clear_class_method_lock
+  def test_10_clear_class_method_lock
     pid = Kernel.fork { Blog2.get_latest_entries }
   
     # give it a bit of time to lock
@@ -184,7 +184,7 @@ module SharedTests
     Process.wait pid
   end
   
-  def test_expiring_lock
+  def test_11_expiring_lock
     pid = Kernel.fork { Blog2.get_latest_entries2 }
   
     # give it a bit of time to lock
@@ -209,4 +209,23 @@ module SharedTests
     
     Process.wait pid
   end
+  
+  def test_12_locked_according_to_method_arguments
+    pid = Kernel.fork { Blog2.work_really_hard_on :foo }
+  
+    # give it a bit of time to lock
+    sleep 1
+        
+    # the blocker won't have finished
+    assert_raises(LockMethod::Locked) do
+      Blog2.work_really_hard_on :foo
+    end
+  
+    # let the blocker finish
+    Process.wait pid
+    
+    assert_nothing_raised do
+      Blog2.work_really_hard_on :foo
+    end
+  end
 end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: lock_method
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 3
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors: 
 - Seamus Abshere
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-12 23:00:00 -06:00
+date: 2011-03-15 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,11 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 0
-        - 2
-        - 1
         version: 0.2.1
   type: :runtime
   version_requirements: *id001
@@ -42,9 +32,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id002
@@ -56,9 +43,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id003
@@ -70,23 +54,17 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: ruby-debug
+  name: ruby-debug19
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id005
@@ -129,18 +107,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []