lock_method 0.0.1 → 0.0.2

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 rdoc/*
 secret.sh
+.DS_Store

data/README.rdoc

@@ -39,7 +39,7 @@ or this might even work...
 
     LockMethod.config.storage = Rails.cache
 
-See <tt>Config</tt> for the full list of supported caches.
+See Config for the full list of supported caches.
 
 == Copyright
 

data/lib/lock_method.rb

@@ -2,8 +2,8 @@ require 'lock_method/version'
 # See the README.rdoc for more info!
 module LockMethod
   autoload :Config, 'lock_method/config'
-  autoload :Storage, 'lock_method/storage'
   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
@@ -13,10 +13,6 @@ module LockMethod
     Config.instance
   end
   
-  def self.storage #:nodoc:
-    Storage.instance
-  end
-    
   # All Objects, including instances and Classes, get the <tt>#clear_lock</tt> method.
   module InstanceMethods
     # Clear the lock for a particular method.

data/lib/lock_method/config.rb

@@ -19,16 +19,23 @@ module LockMethod
     # * memcache-storage[https://github.com/mperham/memcache-storage] (MemCache, the one commonly used by Rails)
     #
     # Supported Redis clients:
-    # * redis[https://github.com/ezmobius/redis-rb] (NOTE: AUTOMATIC CACHE EXPIRATION NOT SUPPORTED)
+    # * redis[https://github.com/ezmobius/redis-rb]
+    #
+    # Supports anything that works with the cache[https://github.com/seamusabshere/cache] gem.
     #
     # Example:
     #     LockMethod.config.storage = Memcached.new '127.0.0.1:11211'
-    def storage=(storage)
-      @storage = storage
+    def storage=(raw_client_or_nil)
+      if raw_client_or_nil.nil?
+        @storage = nil
+      else
+        require 'cache'
+        @storage = ::Cache.new raw_client_or_nil
+      end
     end
 
     def storage #:nodoc:
-      @storage ||= Storage::DefaultStorageClient.new
+      @storage ||= DefaultStorageClient.instance
     end
     
     # TTL for method caches. Defaults to 24 hours.

data/lib/lock_method/default_storage_client.rb

@@ -0,0 +1,47 @@
+require 'singleton'
+require 'tmpdir'
+require 'fileutils'
+require 'thread'
+module LockMethod
+  class DefaultStorageClient #:nodoc: all
+    include ::Singleton
+    def get(k)
+      return unless ::File.exist? path(k)
+      ::Marshal.load ::File.read(path(k))
+    rescue ::Errno::ENOENT
+    end
+  
+    def set(k, v, ttl)
+      semaphore.synchronize do
+        ::File.open(path(k), ::File::RDWR|::File::CREAT) do |f|
+          f.flock ::File::LOCK_EX
+          f.write ::Marshal.dump(v)
+        end
+      end
+    end
+  
+    def delete(k)
+      ::FileUtils.rm_f path(k)
+    end
+  
+    def flush
+      ::FileUtils.rm_rf dir
+    end
+  
+    private
+  
+    def semaphore
+      @semaphore ||= ::Mutex.new
+    end
+  
+    def path(k)
+      ::File.join dir, k
+    end
+  
+    def dir
+      dir = ::File.expand_path(::File.join(::Dir.tmpdir, 'lock_method'))
+      ::FileUtils.mkdir_p dir unless ::File.directory? dir
+      dir
+    end
+  end
+end

data/lib/lock_method/lock.rb

@@ -1,8 +1,8 @@
 module LockMethod
-  class Lock
+  class Lock #:nodoc: all
     class << self
       def find(method_signature)
-        if hsh = Storage.instance.get(method_signature)
+        if hsh = Config.instance.storage.get(method_signature)
           new hsh
         end
       end
@@ -59,7 +59,7 @@ module LockMethod
     end
     
     def delete
-      Storage.instance.delete method_signature
+      Config.instance.storage.delete method_signature
     end
     
     def save
@@ -68,7 +68,7 @@ module LockMethod
       self.thread_object_id
       self.expiry
       # --
-      Storage.instance.set method_signature, to_hash, ttl
+      Config.instance.storage.set method_signature, to_hash, ttl
     end
     
     def to_hash

data/lib/lock_method/version.rb

@@ -1,3 +1,3 @@
 module LockMethod
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lock_method.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
   
+  s.add_dependency 'cache'
   s.add_development_dependency 'test-unit'
   s.add_development_dependency 'memcached'
   s.add_development_dependency 'redis'

data/test/test_default_storage.rb

@@ -3,7 +3,7 @@ require 'helper'
 class TestDefaultStorageClient < Test::Unit::TestCase
   def setup
     LockMethod.config.storage = nil
-    LockMethod.storage.flush
+    LockMethod.config.storage.flush
   end
   
   include SharedTests

data/test/test_memcached_storage.rb

@@ -4,8 +4,9 @@ require 'memcached'
 
 class TestMemcachedStorage < Test::Unit::TestCase
   def setup
-    LockMethod.config.storage = Memcached.new 'localhost:11211'
-    LockMethod.storage.flush
+    my_cache = Memcached.new 'localhost:11211'
+    my_cache.flush
+    LockMethod.config.storage = my_cache
   end
     
   include SharedTests

data/test/test_redis_storage.rb

@@ -7,8 +7,9 @@ if ENV['REDIS_URL']
   class TestRedisStorage < Test::Unit::TestCase
     def setup
       uri = URI.parse(ENV["REDIS_URL"])
-      LockMethod.config.storage = Redis.new(:host => uri.host, :port => uri.port, :password => uri.password)
-      LockMethod.storage.flush
+      my_cache = Redis.new(:host => uri.host, :port => uri.port, :password => uri.password)
+      my_cache.flushdb
+      LockMethod.config.storage = my_cache
     end
     
     include SharedTests

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lock_method
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Seamus Abshere
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-16 00:00:00 -06:00
+date: 2011-02-17 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: test-unit
+  name: cache
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -30,10 +30,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: memcached
+  name: test-unit
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -47,7 +47,7 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: redis
+  name: memcached
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -61,7 +61,7 @@ dependencies:
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: ruby-debug
+  name: redis
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -74,6 +74,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  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
 description: Like alias_method, but it's lock_method!
 email: 
 - seamus@abshere.net
@@ -90,9 +104,8 @@ files:
 - Rakefile
 - lib/lock_method.rb
 - lib/lock_method/config.rb
+- lib/lock_method/default_storage_client.rb
 - lib/lock_method/lock.rb
-- lib/lock_method/storage.rb
-- lib/lock_method/storage/default_storage_client.rb
 - lib/lock_method/version.rb
 - lock_method.gemspec
 - test/helper.rb

data/lib/lock_method/storage.rb

@@ -1,60 +0,0 @@
-require 'singleton'
-module LockMethod
-  # All storage requests go through a clearinghouse.
-  class Storage #:nodoc: all
-    autoload :DefaultStorageClient, 'lock_method/storage/default_storage_client'
-    
-    include ::Singleton
-    
-    def delete(k)
-      if defined?(::Memcached) and bare_storage.is_a?(::Memcached)
-        begin; bare_storage.delete(k); rescue ::Memcached::NotFound; nil; end
-      elsif defined?(::Redis) and bare_storage.is_a?(::Redis)
-        bare_storage.del k
-      else
-        bare_storage.delete k
-      end
-    end
-    
-    def flush
-      bare_storage.send %w{ flush flush_all clear flushdb }.detect { |c| bare_storage.respond_to? c }
-    end
-    
-    def get(k)
-      if defined?(::Memcached) and bare_storage.is_a?(::Memcached)
-        begin; bare_storage.get(k); rescue ::Memcached::NotFound; nil; end
-      elsif defined?(::Redis) and bare_storage.is_a?(::Redis)
-        if cached_v = bare_storage.get(k) and cached_v.is_a?(::String)
-          ::Marshal.load cached_v
-        end
-      elsif bare_storage.respond_to?(:get)
-        bare_storage.get k
-      elsif bare_storage.respond_to?(:read)
-        bare_storage.read k
-      else
-        raise "Don't know how to work with #{bare_storage.inspect}"
-      end
-    end
-        
-    def set(k, v, ttl)
-      ttl ||= ::LockMethod.config.default_ttl
-      if defined?(::Redis) and bare_storage.is_a?(::Redis)
-        bare_storage.setex k, ttl, ::Marshal.dump(v)
-      elsif bare_storage.respond_to?(:set)
-        bare_storage.set k, v, ttl
-      elsif bare_storage.respond_to?(:write)
-        if ttl == 0
-          bare_storage.write k, v # never expire
-        else
-          bare_storage.write k, v, :expires_in => ttl
-        end
-      else
-        raise "Don't know how to work with #{bare_storage.inspect}"
-      end
-    end
-    
-    def bare_storage
-      Config.instance.storage
-    end
-  end
-end

data/lib/lock_method/storage/default_storage_client.rb

@@ -1,47 +0,0 @@
-require 'tmpdir'
-require 'fileutils'
-require 'thread'
-module LockMethod
-  class Storage
-    class DefaultStorageClient
-      def get(k)
-        return unless ::File.exist? path(k)
-        ::Marshal.load ::File.read(path(k))
-      rescue ::Errno::ENOENT
-      end
-    
-      def set(k, v, ttl)
-        semaphore.synchronize do
-          ::File.open(path(k), ::File::RDWR|::File::CREAT) do |f|
-            f.flock ::File::LOCK_EX
-            f.write ::Marshal.dump(v)
-          end
-        end
-      end
-    
-      def delete(k)
-        ::FileUtils.rm_f path(k)
-      end
-    
-      def flush
-        ::FileUtils.rm_rf dir
-      end
-    
-      private
-    
-      def semaphore
-        @semaphore ||= ::Mutex.new
-      end
-    
-      def path(k)
-        ::File.join dir, k
-      end
-    
-      def dir
-        dir = ::File.expand_path(::File.join(::Dir.tmpdir, 'lock_method'))
-        ::FileUtils.mkdir_p dir unless ::File.directory? dir
-        dir
-      end
-    end
-  end
-end