lock_and_cache 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fe1e1aa249ac319cc720916c9f3677caad588c7
-  data.tar.gz: 4cc645768c09dbdadecf4acc1fd725f74f0868a3
+  metadata.gz: a51c74453543a2aea1c7a2d38029ed0ca28b19ef
+  data.tar.gz: 279b3e00a6356f9745163de77d4583e7dda4d90a
 SHA512:
-  metadata.gz: f9560ee842aaaf400e9685066b7758ceb5c654ec86e218f8f79ad75e9d9e9f2ab1df602e4645a031323c969666449c7b8157c6cf0e08eef8252e7fa3a235cf77
-  data.tar.gz: 7b7f13f14b8a6fd2a03a4dbd860b1edd5fb9090fcbdc9e6b8c1f4f64c88ecd2a98fd02eaf2fb575f5e8ee5c59d9e0e3973fb2abf8cf13c8c902d0433a79b7473
+  metadata.gz: db2cc229fd44e3e9432eb4233c23c02625066d5228aeb087e739922004a724627f7b85a4ceb3b54d89a6f6afc4963c17b57712cdf5d4ada077786107e21b625f
+  data.tar.gz: 396bcc439d0c3ff5bce552115fb69c858c70bcd921518ff7dfd6a770388f50ba6c2b22681273bd203d45afc82fd45a37b5bb187e51304082614b42d3d5d63f30

data/CHANGELOG

@@ -1,3 +1,14 @@
+0.1.0 / 2015-01-22
+
+* Breaking changes
+
+  * Redis only
+  * Now you use it inside methods (like Rails.cache.fetch) instead of outside (like cache_method)
+
+* Enhancements
+
+  * Way simpler, no dependency on CacheMethod
+
 0.0.5 / 2014-12-12
 
 * Enhancements

data/README.md

@@ -5,7 +5,7 @@ TODO: Write a gem description
 ## Wishlist
 
 * no dep on activerecord
-* no dep on cache_method
+* no dep on redis
 
 ## Installation
 

data/lib/lock_and_cache.rb

@@ -1,36 +1,86 @@
 require 'lock_and_cache/version'
 
 require 'hash_digest'
-require 'cache_method'
 require 'active_record'
 require 'with_advisory_lock'
 
 module LockAndCache
-  # only for instance methods
-  def lock_and_cache(method_id)
-    unlocked_method_id = "_lock_and_cache_unlocked_#{method_id}"
-    alias_method unlocked_method_id, method_id
-
-    define_method method_id do |*args|
-      debug = (ENV['LOCK_AND_CACHE_DEBUG'] == 'true')
-      lock_key = [self.class.name, method_id, HashDigest.digest3([as_cache_key]+args)].join('/')
-      debug_lock_key = [self.class.name, method_id, [as_cache_key]+args].join('/') if debug
-      Thread.exclusive { $stderr.puts "[lock_and_cache] A #{debug_lock_key}" } if debug
-      if cache_method_cached?(method_id, args)
-        return send(method_id, *args) # which will be the cached version
-      end
-      Thread.exclusive { $stderr.puts "[lock_and_cache] B #{debug_lock_key}" } if debug
-      ActiveRecord::Base.with_advisory_lock(lock_key) do
-        Thread.exclusive { $stderr.puts "[lock_and_cache] C #{debug_lock_key}" } if debug
-        if cache_method_cached?(method_id, args)
-          send method_id, *args # which will be the cached version
+  def LockAndCache.storage=(v)
+    raise "only redis for now" unless v.class.to_s == 'Redis'
+    @storage = v
+  end
+
+  def LockAndCache.storage
+    @storage
+  end
+
+  def LockAndCache.flush
+    storage.flushdb
+  end
+
+  class Key
+    attr_reader :obj
+    attr_reader :kaller
+
+    def initialize(obj, kaller, parts)
+      @obj = obj
+      @kaller = kaller
+      @_parts = parts
+    end
+
+    def digest
+      @digest ||= ::HashDigest.digest3([obj_class_name, method_id] + parts)
+    end
+
+    def debug
+      @debug ||= [obj_class_name, method_id] + parts
+    end
+
+    def parts
+      @parts ||= @_parts.map do |v|
+        case v
+        when ::String, ::Symbol, ::Hash, ::Array
+          v
         else
-          Thread.exclusive { $stderr.puts "[lock_and_cache] D #{debug_lock_key}" } if debug
-          send unlocked_method_id, *args
+          v.respond_to?(:lock_and_cache_key) ? v.lock_and_cache_key : v.id
         end
       end
     end
 
-    cache_method method_id
+    def method_id
+      @method_id ||= begin
+        kaller[0] =~ /in `(\w+)'/
+        $1 or raise "couldn't get method_id from #{kaller[0]}"
+      end
+    end
+
+    def obj_class_name
+      @obj_class_name ||= (obj.class == ::Class) ? obj.name : obj.class.name
+    end
+
+  end
+
+  def lock_and_cache(*key_parts)
+    raise "need a block" unless block_given?
+    debug = (ENV['LOCK_AND_CACHE_DEBUG'] == 'true')
+    key = LockAndCache::Key.new self, caller, key_parts
+    digest = key.digest
+    storage = LockAndCache.storage
+    Thread.exclusive { $stderr.puts "[lock_and_cache] A #{key.debug}" } if debug
+    if storage.exists digest
+      return ::Marshal.load(storage.get(digest))
+    end
+    Thread.exclusive { $stderr.puts "[lock_and_cache] B #{key.debug}" } if debug
+    ActiveRecord::Base.with_advisory_lock(digest) do
+      Thread.exclusive { $stderr.puts "[lock_and_cache] C #{key.debug}" } if debug
+      if storage.exists digest
+        ::Marshal.load storage.get(digest)
+      else
+        Thread.exclusive { $stderr.puts "[lock_and_cache] D #{key.debug}" } if debug
+        memo = yield
+        storage.set digest, ::Marshal.dump(memo)
+        memo
+      end
+    end
   end
 end

data/lib/lock_and_cache/version.rb

@@ -1,3 +1,3 @@
 module LockAndCache
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/lock_and_cache.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'activerecord'
-  spec.add_runtime_dependency 'cache_method'
   spec.add_runtime_dependency 'hash_digest'
   spec.add_runtime_dependency 'with_advisory_lock'
 
@@ -29,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pg'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'redis'
 end

data/spec/lock_and_cache_spec.rb

@@ -1,17 +1,20 @@
 require 'spec_helper'
 
 class Foo
+  include LockAndCache
+
   def initialize(id)
     @id = id
     @count = 0
   end
+
   def click
-    @count += 1
+    lock_and_cache(self) do
+      @count += 1
+    end
   end
 
-  extend LockAndCache
-  lock_and_cache :click
-  def as_cache_key
+  def lock_and_cache_key
     @id
   end
 end
@@ -19,10 +22,13 @@ end
 require 'set'
 $clicking = Set.new
 class Bar
+  include LockAndCache
+
   def initialize(id)
     @id = id
     @count = 0
   end
+
   def unsafe_click
     Thread.exclusive do
       # puts "clicking bar #{@id} - #{$clicking.to_a} - #{$clicking.include?(@id)} - #{@id == $clicking.to_a[0]}"
@@ -36,18 +42,23 @@ class Bar
     end
     @count
   end
+
   def click
-    unsafe_click
+    lock_and_cache(self) do
+      unsafe_click
+    end
   end
 
-  extend LockAndCache
-  lock_and_cache :click
-  def as_cache_key
+  def lock_and_cache_key
     @id
   end
 end
 
 describe LockAndCache do
+  before do
+    LockAndCache.flush
+  end
+
   it 'has a version number' do
     expect(LockAndCache::VERSION).not_to be nil
   end

data/spec/spec_helper.rb

@@ -3,4 +3,7 @@ require 'lock_and_cache'
 
 ActiveRecord::Base.establish_connection adapter: 'postgresql', database: 'lock_and_cache_test'
 
+require 'redis'
+LockAndCache.storage = Redis.new
+
 require 'pry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lock_and_cache
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Seamus Abshere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-12 00:00:00.000000000 Z
+date: 2015-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: cache_method
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: hash_digest
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Lock and cache methods, in case things should only be calculated once
   across processes.
 email: