forget-me-not 0.3.2 → 0.3.2.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjkxMWJmMmY2NWMwYmZiN2FhNDFlZjY3N2E4NGMwYjljMGMyNzJjOQ==
+    ZTExZjc2Zjk2OWUzNWJjODVmOWU1MTM2MWUzMzJkNjk0YTIyYTNiMQ==
   data.tar.gz: !binary |-
-    MzczYmI5Yzc5MjIwMmY4NDc2OWQxNzkwYzlhNDllMTZmMDEyMmVhYQ==
+    ZTEwNTAwMDA3OWE1NTM3NWMwYzM4MTIwZTEwZTU4ZWQwY2FlZjljMA==
 SHA512:
   metadata.gz: !binary |-
-    YzYyY2IwZDkxZDQwNzYxMzFiNTAwMTc4NzE1NDgzNjE5NGFkM2VmNWQwOWEz
-    NThiMTgyNzVjOGZjMTg4YjIwMDkxOGMzYWJjZDA0ZjZmMjM5NDE2NWM2YWJh
-    MTJiOTMwOGZmNDBkODUxYmNhYWEyNDM2NDA4MWY2NGRjODYwOWM=
+    MjE4NjNmOGMyNTI0MmFjZWYzYjJjNzczYjFlZTc4YzM0ZGQyNjI4MjI4NzJk
+    ZWZlMjdlOTk4MzMyMTgwZGY0M2RkODcwYjZlZGI2MjRmZjNiM2E2OGYyMDli
+    ZTNlZmMwYmYwYTI2ZTgyYzkzYjZjOGIwOGVlNzMxZGZlZWQ1Zjc=
   data.tar.gz: !binary |-
-    ZTVjZmM1NjJmZmZmNmIxZGJiZTBhODdjOGYxODMxNmFiN2E1ZDk0MTgxOThi
-    NGVlODkyNGFiODkwNjVlMWUzMDlmNDE2ZTBiNzk3YjViN2Y5NDE3OTEyNGM5
-    YzZkNTgyY2M2Mzc2MGIxYTVkMWU0MjcxODBiNjViOGQ4NzZkNmE=
+    N2RjYzY2YWY3YWRlZGU2MmE1MDRmZTA5MjBjY2NmYWY3NDA1Mjg5MWU0MGM3
+    NzkwYWQ5MjkwMGM4NDE5ODkyZWFhYmVlYjI1MzFiOTllNWYxZTI4NzcyYmZk
+    YzhiNDdlM2RkYzQ4ZTY1NDI2OGQwNDJhYmI4ZTI4YjUxMGFmOTc=

data/CHANGELOG.md

@@ -1,3 +1,4 @@
+## 0.3.2.1 - Add the ability to log cache hits and misses
 ## 0.3.2.0 - Revise the method for computing keys in cacheable.
 Need to use the digest for both the arguments and the instance properties.
 

data/lib/forget-me-not/cacheable.rb

@@ -31,29 +31,32 @@ module ForgetMeNot
       def define_cache_method(method, options)
         method_name = method.name.to_sym
         key_prefix = "/cached_method_result/#{self.name}"
-        instance_key_proc = get_instance_key_proc(options[:include]) if options.has_key?(:include)
+        instance_key = get_instance_key_proc(options[:include]) if options.has_key?(:include)
 
         undef_method(method_name)
         define_method(method_name) do |*args, &block|
           raise 'Cannot pass blocks to cached methods' if block
-          instance_key = instance_key_proc.call(self) if instance_key_proc
-          instance_key_hash = Digest::SHA1.hexdigest(instance_key.to_s) if instance_key
 
           cache_key = [
             key_prefix,
-            instance_key_hash,
+            (instance_key && instance_key.call(self)),
             method_name,
-            Digest::SHA1.hexdigest(args.to_s)
+            args.to_s,
           ].compact.join '/'
 
-          # 'Double bagging' the key makes sure that we do not overflow the range of a string hash key
           cache_key_hash = Digest::SHA1.hexdigest(cache_key)
 
-          puts "key: #{cache_key} (#{cache_key_hash})" if defined?(Testing)
-
-          Cacheable.cache_fetch(cache_key_hash) do
+          cache_hit = true
+          result = Cacheable.cache_fetch(cache_key_hash) do
+            cache_hit = false
             method.bind(self).call(*args)
           end
+
+          if Cacheable.log_cache_activity
+            Cacheable.logger.info "Cache #{cache_hit ? 'hit' : 'miss'} for #{cache_key} (#{cache_key_hash})"
+          end
+
+          result
         end
       end
 
@@ -122,6 +125,30 @@ module ForgetMeNot
       end
     end
 
+    class << self
+      attr_accessor :log_cache_activity
+
+      def logger
+        return @logger if defined?(@logger)
+        @logger = rails_logger || default_logger
+      end
+
+      def logger=(logger)
+        @logger = logger
+      end
+
+      def rails_logger
+        defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
+      end
+
+      def default_logger
+        logger = Logger.new(STDOUT)
+        logger.level = Logger::INFO
+        logger
+      end
+    end
+
+
     private
     def self.default_cache
       rails_cache ||

data/lib/forget-me-not/version.rb

@@ -1,3 +1,3 @@
 module ForgetMeNot
-  VERSION = '0.3.2'
+  VERSION = '0.3.2.1'
 end

data/spec/cacheable_spec.rb

@@ -65,6 +65,7 @@ module ForgetMeNot
 
   describe Cacheable do
     before do
+      Cacheable.log_cache_activity = true
       Cacheable.cache = ActiveSupport::Cache::MemoryStore.new
       TestClass.clear_calls
       TestClass2.clear_calls
@@ -206,9 +207,7 @@ module ForgetMeNot
         foo = TestClass2.new('general', 201312)
         foo.method1
 
-        puts Cacheable.cache.inspect
-        puts Cacheable.cache.instance_variable_get('@data').inspect
-        ugly_hash_key = "dd22a078b1a5e6e8cb2a0f8f0bf1105823103249"
+        ugly_hash_key = '90914de582dd73182e909216e27b3898120e07c3'
         expect(Cacheable.cache.read(ugly_hash_key)).not_to be_nil
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forget-me-not
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.2.1
 platform: ruby
 authors:
 - Koan Health
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-19 00:00:00.000000000 Z
+date: 2013-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport