lock_method 0.4.0 → 0.5.1

data/CHANGELOG

@@ -0,0 +1,16 @@
+0.5.1 / 2012-04-17
+
+* Bug fixes
+
+  * Synchronize reading of locks among threads; previously only writing of locks had been synchronized.
+
+0.5.0 / 2012-04-17
+
+* Enhancements
+
+  * Tested on MRI 1.8, MRI 1.9, and JRuby
+
+* Bug fixes
+
+  * Proper (I hope use) used of mutexes
+  * More OS-friendly tmp file names

data/Gemfile

@@ -1,4 +1,7 @@
-source "http://rubygems.org"
+source :rubygems
 
 # Specify your gem's dependencies in cache_method.gemspec
 gemspec
+gem 'test-unit'
+gem 'dalli'
+gem 'redis'

data/lib/lock_method/config.rb

@@ -1,5 +1,5 @@
 require 'cache'
-require 'singleton'
+
 module LockMethod
   # Here's where you set config options.
   #
@@ -8,8 +8,10 @@ module LockMethod
   #
   # You'd probably put this in your Rails config/initializers, for example.
   class Config
-    include ::Singleton
-    
+    def initialize
+      @mutex = ::Mutex.new
+    end
+
     # Storage for keeping lockfiles.
     #
     # Defaults to using the filesystem's temp dir.
@@ -36,7 +38,9 @@ module LockMethod
     end
 
     def storage #:nodoc:
-      @storage ||= DefaultStorageClient.instance
+      @storage || @mutex.synchronize do
+        @storage ||= DefaultStorageClient.new
+      end
     end
     
     # TTL for method caches. Defaults to 24 hours.

data/lib/lock_method/default_storage_client.rb

@@ -1,40 +1,49 @@
-require 'singleton'
 require 'tmpdir'
 require 'fileutils'
-require 'thread'
+require 'digest/sha1'
+
 module LockMethod
   class DefaultStorageClient #:nodoc: all
-
-    include ::Singleton
-
     class Entry
       attr_reader :created_at
       attr_reader :ttl
       attr_reader :v
       def initialize(ttl, v)
-        @created_at = ::Time.now.to_f
-        @ttl = ttl
+        @created_at = ::Time.now
+        @ttl = ttl.to_f
         @v = v
       end
       def expired?
-        ttl.to_i > 0 and (::Time.now.to_f - created_at.to_f) > ttl.to_i
+        ttl > 0 and (::Time.now - created_at) > ttl
       end
     end
 
+    attr_reader :dir
+
+    def initialize
+      @mutex = ::Mutex.new
+      dir = ::File.expand_path ::File.join(::Dir.tmpdir, 'lock_method')
+      ::FileUtils.mkdir(dir) unless ::File.directory?(dir)
+      @dir = dir
+    end
+
     def get(k)
-      if ::File.exist?(path(k)) and entry = ::Marshal.load(::File.read(path(k))) and not entry.expired?
-        entry.v
+      path = path k
+      @mutex.synchronize do
+        if ::File.exist?(path) and (entry = ::Marshal.load(::File.read(path))) and not entry.expired?
+          entry.v
+        end
       end
-    rescue ::Errno::ENOENT
+    rescue
+      $stderr.puts %{[lock_method] Rescued from #{$!.inspect} while trying to get a lock}
     end
   
     def set(k, v, ttl)
       entry = Entry.new ttl, v
-      semaphore.synchronize do
-        ::FileUtils.mkdir_p dir unless ::File.directory? dir
-        ::File.open(path(k), ::File::RDWR|::File::CREAT, :external_encoding => 'ASCII-8BIT') do |f|
+      @mutex.synchronize do
+        ::File.open(path(k), 'wb') do |f|
           f.flock ::File::LOCK_EX
-          f.write ::Marshal.dump(entry)
+          f.write ::Marshal.dump entry
         end
       end
     end
@@ -44,21 +53,15 @@ module LockMethod
     end
   
     def flush
-      ::FileUtils.rm_rf dir
+      ::Dir["#{dir}/*.lock"].each do |path|
+        ::FileUtils.rm_f path
+      end
     end
-  
+
     private
-  
-    def semaphore
-      @semaphore ||= ::Mutex.new
-    end
-  
+
     def path(k)
-      ::File.join dir, k
-    end
-  
-    def dir
-      ::File.expand_path ::File.join(::Dir.tmpdir, 'lock_method')
+      ::File.join dir, "#{::Digest::SHA1.hexdigest(k)}.lock"
     end
   end
 end

data/lib/lock_method/lock.rb

@@ -3,7 +3,7 @@ module LockMethod
   class Lock #:nodoc: all
     class << self
       def find(cache_key)
-        Config.instance.storage.get cache_key
+        LockMethod.config.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
@@ -14,6 +14,23 @@ module LockMethod
       def method_signature(obj, method_id)
         [ klass_name(obj), method_id ].join method_delimiter(obj)
       end
+      def resolve_lock(obj)
+        case obj
+        when ::Array
+          obj.map do |v|
+            resolve_lock v
+          end
+        when ::Hash
+          obj.inject({}) do |memo, (k, v)|
+            kk = resolve_lock k
+            vv = resolve_lock v
+            memo[kk] = vv
+            memo
+          end
+        else
+          obj.respond_to?(:as_lock) ? [obj.class.name, obj.as_lock] : obj
+        end
+      end
     end
 
     attr_reader :obj
@@ -21,6 +38,7 @@ module LockMethod
     attr_reader :args
 
     def initialize(obj, method_id, options = {})
+      @mutex = ::Mutex.new
       @obj = obj
       @method_id = method_id
       options = options.symbolize_keys
@@ -38,23 +56,27 @@ module LockMethod
     end
     
     def ttl
-      @ttl ||= Config.instance.default_ttl
+      @ttl ||= LockMethod.config.default_ttl
     end
     
     def obj_digest
-      @obj_digest ||= ::Digest::SHA1.hexdigest(::Marshal.dump(obj.respond_to?(:as_lock) ? obj.as_lock : obj))
+      @obj_digest || @mutex.synchronize do
+        @obj_digest ||= ::Digest::SHA1.hexdigest(::Marshal.dump(Lock.resolve_lock(obj)))
+      end
     end
 
     def args_digest
-      @args_digest ||= args.to_a.empty? ? 'empty' : ::Digest::SHA1.hexdigest(::Marshal.dump(args))
+      @args_digest || @mutex.synchronize do
+        @args_digest ||= args.to_a.empty? ? 'empty' : ::Digest::SHA1.hexdigest(::Marshal.dump(Lock.resolve_lock(args)))
+      end
     end
         
     def delete
-      Config.instance.storage.delete cache_key
+      LockMethod.config.storage.delete cache_key
     end
     
     def save
-      Config.instance.storage.set cache_key, self, ttl
+      LockMethod.config.storage.set cache_key, self, ttl
     end
     
     def locked?
@@ -78,7 +100,7 @@ module LockMethod
     end
     
     def call_and_lock(*original_method_id_and_args)
-      until !spin? or !locked?
+      while locked? and spin?
         ::Kernel.sleep 0.5
       end
       if locked?
@@ -86,7 +108,7 @@ module LockMethod
       else
         begin
           save
-          obj.send *original_method_id_and_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.4.0"
+  VERSION = "0.5.1"
 end

data/lib/lock_method.rb

@@ -4,20 +4,22 @@ if ::ActiveSupport::VERSION::MAJOR >= 3
   require 'active_support/core_ext'
 end
 
-require 'lock_method/version'
+require 'lock_method/config'
+require 'lock_method/lock'
+require 'lock_method/default_storage_client'
 
 # See the README.rdoc for more info!
 module LockMethod
-  autoload :Config, 'lock_method/config'
-  autoload :Lock, 'lock_method/lock'
-  autoload :DefaultStorageClient, 'lock_method/default_storage_client'
-
   # This is what gets raised when you try to run a locked method.
   class Locked < ::StandardError
   end
 
-  def self.config #:nodoc:
-    Config.instance
+  MUTEX = ::Mutex.new
+
+  def LockMethod.config #:nodoc:
+    @config || MUTEX.synchronize do
+      @config ||= Config.new
+    end
   end
   
   # All Objects, including instances and Classes, get the <tt>#lock_method_clear</tt> method.
@@ -65,14 +67,12 @@ module LockMethod
       define_method method_id do |*args1|
         options = options.merge(:args => args1)
         lock = ::LockMethod::Lock.new self, method_id, options
-        lock.call_and_lock original_method_id, *args1
+        lock.call_and_lock(*([original_method_id]+args1))
       end
     end
   end
 end
 
-unless ::Object.method_defined? :lock_method
-  ::Object.send :include, ::LockMethod::InstanceMethods
-  ::Class.send :include, ::LockMethod::ClassMethods
-  ::Module.extend ::LockMethod::ClassMethods
-end
+::Object.send :include, ::LockMethod::InstanceMethods
+::Class.send :include, ::LockMethod::ClassMethods
+::Module.send :include, ::LockMethod::ClassMethods

data/lock_method.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "lock_method/version"
+require File.expand_path('../lib/lock_method/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "lock_method"
@@ -20,12 +19,4 @@ Gem::Specification.new do |s|
   
   s.add_runtime_dependency 'cache', '>=0.2.1'
   s.add_runtime_dependency 'activesupport'
-  s.add_development_dependency 'test-unit'
-  s.add_development_dependency 'memcached'
-  s.add_development_dependency 'redis'
-  if RUBY_VERSION >= '1.9'
-    s.add_development_dependency 'ruby-debug19'
-  else
-    s.add_development_dependency 'ruby-debug'
-  end
-end
+end

data/test/helper.rb

@@ -2,10 +2,7 @@ require 'rubygems'
 require 'bundler'
 Bundler.setup
 require 'test/unit'
-require 'ruby-debug'
 require 'shared_tests'
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'lock_method'
 
 class Blog1

data/test/test_memcached_storage.rb

@@ -1,10 +1,10 @@
 require 'helper'
 
-require 'memcached'
+require 'dalli'
 
 class TestMemcachedStorage < Test::Unit::TestCase
   def setup
-    my_cache = Memcached.new 'localhost:11211', :retry_timeout => 1, :server_failure_limit => 25
+    my_cache = Dalli::Client.new 'localhost:11211'
     my_cache.flush
     LockMethod.config.storage = my_cache
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lock_method
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-01 00:00:00.000000000 Z
+date: 2012-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cache
-  requirement: &2152246540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,62 +21,28 @@ dependencies:
         version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *2152246540
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &2152240680 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *2152240680
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: &2160094560 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2160094560
-- !ruby/object:Gem::Dependency
-  name: memcached
-  requirement: &2160090340 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2160090340
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
-  name: redis
-  requirement: &2160103240 !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
-  version_requirements: *2160103240
-- !ruby/object:Gem::Dependency
-  name: ruby-debug19
-  requirement: &2160101140 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2160101140
 description: Like alias_method, but it's lock_method!
 email:
 - seamus@abshere.net
@@ -85,6 +51,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG
 - Gemfile
 - README.rdoc
 - Rakefile
@@ -119,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: lock_method
-rubygems_version: 1.8.15
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Lets you lock methods (to memcached, redis, etc.) as though you had a lockfile