lock_and_cache 2.2.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50f297c6ed5c5ab409f6d00f66a0c486c013c525
-  data.tar.gz: 34806102910c3f13163b4d2aab2369924571405b
+  metadata.gz: 90b85cb8a2f2d566cbf6cd7a69375ee6772206c8
+  data.tar.gz: fae5041a751ce3617604de792c8f0cc6400919d2
 SHA512:
-  metadata.gz: c5c6d160ac201fbc645ddd39d8e3c461da39a90a2ea8e9512705d508ad51c66accbca98deaa62432a08db1f11c6256db347015dea148f9bffff8d41ef63f2e72
-  data.tar.gz: f84b2182fedcd9c7095a68a34dba3109b69ff301b818bf32d4eb77cad5f56ad6546f010141661011e5692e9a8ba46b15501d56d76eaace96fb88bbdd020812dc
+  metadata.gz: b54fa87634f6e9378eec8ab209eed851a41bd1e13e5cc10af293b80d0d68b217cd46ddbf496cbe49e959ec6f6dc100f582201e8ca316940eb0b6ad2db8b880c5
+  data.tar.gz: 1002dc77996ab481d8d150261cde2d7b8e9afc08640edad85ca5171ba7f6b5ac6d1dfcfbb249c956b67e13ef2813f48b88c04e69c07196cef84898e567800480

data/CHANGELOG

@@ -1,3 +1,9 @@
+3.0.0 / 2016-04-02
+
+* Breaking changes
+
+  * In context mode (when you `include LockAndCache`), really call #lock_and_cache_key or #id on the instance
+
 2.2.2 / 2015-12-18
 
 * Bug fixes

data/README.md

@@ -215,6 +215,7 @@ You can expire nil values with a different timeout (`nil_expires`) than other va
 ## Wishlist
 
 * Convert most tests to use standalone mode, which is easier to understand
+* Make explicit Key unit tests
 * Check options
 * Lengthen heartbeat so it's not so sensitive
 * Clarify which options are seconds or milliseconds

data/lib/lock_and_cache/key.rb

@@ -17,21 +17,38 @@ module LockAndCache
       def extract_class_name(context)
         (context.class == ::Class) ? context.name : context.class.name
       end
+
+      # @private
+      #
+      # Extract id from context. Calls #lock_and_cache_key if available, otherwise #id
+      def extract_context_id(context)
+        if context.class == ::Class
+          nil
+        elsif context.respond_to?(:lock_and_cache_key)
+          context.lock_and_cache_key
+        elsif context.respond_to?(:id)
+          context.id
+        else
+          raise "#{context} must respond to #lock_and_cache_key or #id"
+        end
+      end
     end
 
     METHOD_NAME_IN_CALLER = /in `([^']+)'/
 
+    attr_reader :context
     attr_reader :method_id
-    attr_reader :class_name
 
     def initialize(parts, options = {})
       @_parts = parts
+      @context = options[:context]
       @method_id = if options.has_key?(:method_id)
         options[:method_id]
       elsif options.has_key?(:caller)
         Key.extract_method_id_from_caller options[:caller]
+      elsif context
+        raise "supposed to call context with method_id or caller"
       end
-      @class_name = Key.extract_class_name options[:context] if options.has_key?(:context)
     end
 
     # A (non-cryptographic) digest of the key parts for use as the cache key
@@ -46,8 +63,8 @@ module LockAndCache
 
     # A human-readable representation of the key parts
     def key
-      @key ||= if method_id
-        [class_name, method_id, parts]
+      @key ||= if context
+        [class_name, context_id, method_id, parts].compact
       else
         parts
       end
@@ -66,6 +83,14 @@ module LockAndCache
 
     alias debug key
 
+    def context_id
+      @context_id ||= Key.extract_context_id context
+    end
+
+    def class_name
+      @class_name ||= Key.extract_class_name context
+    end
+
     # An array of the parts we use for the key
     def parts
       @parts ||= @_parts.map do |v|

data/lib/lock_and_cache/version.rb

@@ -1,3 +1,3 @@
 module LockAndCache
-  VERSION = '2.2.2'
+  VERSION = '3.0.0'
 end

data/spec/lock_and_cache_spec.rb

@@ -17,6 +17,12 @@ class Foo
     end
   end
 
+  def cached_rand
+    lock_and_cache do
+      rand
+    end
+  end
+
   def click_null
     lock_and_cache do
       nil
@@ -48,6 +54,32 @@ class Foo
   end
 end
 
+class FooId
+  include LockAndCache
+  def click
+    lock_and_cache do
+      nil
+    end
+  end
+  def id
+    @id ||= rand
+  end
+end
+
+class FooClass
+  class << self
+    include LockAndCache
+    def click
+      lock_and_cache do
+        nil
+      end
+    end
+    def id
+      raise "called id"
+    end
+  end
+end
+
 require 'set'
 $clicking = Set.new
 class Bar
@@ -152,6 +184,34 @@ describe LockAndCache do
       expect(foo.click_last_hash_as_options).to eq(3)
     end
 
+    it "calls #lock_and_cache_key" do
+      expect(foo).to receive(:lock_and_cache_key)
+      foo.click
+    end
+
+    it "calls #lock_and_cache_key to differentiate" do
+      a = Foo.new 1
+      b = Foo.new 2
+      expect(a.cached_rand).not_to eq(b.cached_rand)
+    end
+  end
+
+  describe 'self-identification in context mode' do
+    it "calls #id for non-class" do
+      foo_id = FooId.new
+      expect(foo_id).to receive(:id)
+      foo_id.click
+    end
+    it "calls class name for non-class" do
+      foo_id = FooId.new
+      expect(FooId).to receive(:name)
+      foo_id.click
+    end
+    it "uses class name for class" do
+      expect(FooClass).to receive(:name)
+      expect(FooClass).not_to receive(:id)
+      FooClass.click
+    end
   end
 
   describe "locking" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lock_and_cache
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Seamus Abshere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-18 00:00:00.000000000 Z
+date: 2016-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport