forget-me-not 0.3.2.2 → 0.3.2.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MWQ5ODI0Njg4OGM5NmEyN2Y1YWE0Njg3Njc5ODEyMTYyNjJkMjg4Yg==
-  data.tar.gz: !binary |-
-    OGZkMGZjMWExMWFjNDQyZjM5NjhjMzFiZmM4MzhiMDY3MjY0Njc1NQ==
+SHA1:
+  metadata.gz: e9d63f71859db7131922113b56e78be6ed7fa1fd
+  data.tar.gz: e092139b53b438533be342c47bb64a6bdc707f01
 SHA512:
-  metadata.gz: !binary |-
-    Y2Q2ODU1N2QzZGZjZWIxOGQ1YWQ0N2ZiYTVhNGVmMDllODNiZmU5ZjNkOTM4
-    ZGU4YTI1ZjhiNTdiYzBmNDk2NDNkYzE4MzA0ZDFiOGQ5MWEwNTE3NzY4NDRi
-    YWEwYmVjMzhlZGJmMmFhNTJjOGQ4ODFhYjRlZDFmNDM1MmE2MjE=
-  data.tar.gz: !binary |-
-    ODFkMTlkZjZlZGZiYmExNzAyYWE5MGY3MDMwOWI5YWIxMjYxZWJkNTQ1YjA0
-    M2EyNzg3NDAzOGQ0OGY3ZWNmNzc1ODEzZTc2MTJiNTM4MzBkNDc0YTE5YTQy
-    MDZjNWY4ZjQ4N2E3Y2FmMjNhODcyYzc0YmYzZDUxZTk0MDM2YTc=
+  metadata.gz: 1474e10c8c3160243502f1578b95adf5b0850b1edf27852949de1f5c84b2d6dcdf9fc808ccc6e231b89f8b1dfee6768df011003db2977a0ca94abf80fbf6f4f6
+  data.tar.gz: 7671c7048583e1516c13f4d080f0444ba26e447b47fb7ed20cecba8dcd25e9097a6f41e98540eb831b576d9fd232f2442fa6d5cab20bd61dfb79634368453ca2

data/CHANGELOG.md

@@ -1,3 +1,4 @@
+## 0.3.2.3 - Improve logging control
 ## 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.
@@ -7,4 +8,4 @@ Was using Ruby's hash(), but that varies by ruby runtime.
 
 ## 0.3.0.0 - Detect attempts to pass a block to cached or memoized methods and raise an error.
 ## 0.2.0.0 - Still pre release, but made a new method for memoizing methods with args.
-## 0.1.0.0 - Pre Release
+## 0.1.0.0 - Pre Release

data/README.md

@@ -178,6 +178,10 @@ instance of MemoryStore will be used.  Failing that, cache will raise an error.
 This is intended to provide a reasonably sane default, but really, set the ForgetMeNot::Cacheable.cache with something
 shaped like an ActiveSupport::Cacheable::Store
 
+## Troubleshooting
+Both Memoizable and Cacheable have logging of their cache activity (cacheable more so).  By default, this is disabled.
+To enable logging, change the module property log_activity to true.  Both the cache and memoizable specs do this.
+
 ## Origins
 This is an extension of the ideas and approach found here:
 https://github.com/sferik/twitter/blob/master/lib/twitter/memoizable.rb.  You guys rock.
@@ -192,4 +196,4 @@ https://github.com/sferik/twitter/blob/master/lib/twitter/memoizable.rb.  You gu
 6. Create new Pull Request
 
 ## Copyright
-(c) 2013 Koan Health. See LICENSE.txt for further details.
+(c) 2013 Koan Health. See LICENSE.txt for further details.

data/lib/forget-me-not.rb

@@ -1,5 +1,6 @@
 require 'forget-me-not/version'
 
+require 'forget-me-not/logging'
 require 'forget-me-not/cacheable'
 require 'forget-me-not/memoizable'
 require 'forget-me-not/hash_cache'

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

@@ -10,6 +10,9 @@ module ForgetMeNot
       end
     end
 
+    extend Logging
+
+
     module ClassMethods
       def cache_results(*methods)
         options = methods.last.is_a?(Hash) ? methods.pop : {}
@@ -38,10 +41,10 @@ module ForgetMeNot
           raise 'Cannot pass blocks to cached methods' if block
 
           cache_key = [
-            key_prefix,
-            (instance_key && instance_key.call(self)),
-            method_name,
-            args.to_s,
+              key_prefix,
+              (instance_key && instance_key.call(self)),
+              method_name,
+              args.to_s,
           ].compact.join '/'
 
           cache_key_hash = Digest::SHA1.hexdigest(cache_key)
@@ -52,7 +55,7 @@ module ForgetMeNot
             method.bind(self).call(*args)
           end
 
-          if Cacheable.log_cache_activity
+          if Cacheable.log_activity
             Cacheable.logger.info "Cache #{cache_hit ? 'hit' : 'miss'} for #{cache_key} (#{cache_key_hash})"
           end
 
@@ -132,40 +135,17 @@ 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 ||
-      active_support_cache ||
-      raise(
-      <<-ERR_TEXT
-        When using Cacheable in a project that does not have a Rails or ActiveSupport Cache,
-        you must explicitly set the cache to an object shaped like ActiveSupport::Cache::Store
-        ERR_TEXT
-        )
+          active_support_cache ||
+          raise(
+              <<-ERR_TEXT
+          When using Cacheable in a project that does not have a Rails or ActiveSupport Cache,
+          you must explicitly set the cache to an object shaped like ActiveSupport::Cache::Store
+          ERR_TEXT
+          )
     end
 
     def self.rails_cache
@@ -174,10 +154,10 @@ module ForgetMeNot
 
     def self.active_support_cache
       defined?(ActiveSupport) &&
-        defined?(ActiveSupport::Cache) &&
-        defined?(ActiveSupport::Cache::MemoryStore) &&
-        ActiveSupport::Cache::MemoryStore.new
+          defined?(ActiveSupport::Cache) &&
+          defined?(ActiveSupport::Cache::MemoryStore) &&
+          ActiveSupport::Cache::MemoryStore.new
     end
 
   end
-end
+end

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

@@ -0,0 +1,24 @@
+module ForgetMeNot
+  module Logging
+    attr_accessor :log_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
+end

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

@@ -6,6 +6,8 @@ module ForgetMeNot
         base.extend(ClassMethods)
       end
     end
+    extend Logging
+
 
     module ClassMethods
       def memoize(*methods)
@@ -22,7 +24,7 @@ module ForgetMeNot
       private
       def memoize_method(method_name, options)
         method = instance_method(method_name)
-        raise 'Cannot memoize with arity > 0.  Use memoize_with_args instead.' if method.arity > 0 && ! options[:allow_args]
+        raise 'Cannot memoize with arity > 0.  Use memoize_with_args instead.' if method.arity > 0 && !options[:allow_args]
         visibility = method_visibility(method_name)
         define_memoized_method(method, options)
         send(visibility, method_name)
@@ -37,12 +39,14 @@ module ForgetMeNot
           raise 'Cannot pass blocks to memoized methods' if block
 
           memoize_key = [
-            key_prefix,
-            method_name,
-            args.hash
+              key_prefix,
+              method_name,
+              args.hash
           ].compact.join '/'
 
-          puts "key: #{memoize_key}" if (defined?(Rails) && Rails.env.test?)
+          if Memoizable.log_activity
+            Memoizable.logger.info("key: #{memoize_key}")
+          end
 
           fetch_from_storage(memoize_key) do
             method.bind(self).call(*args)
@@ -61,6 +65,10 @@ module ForgetMeNot
       end
     end
 
+    def log(message)
+      ForgetMeNot.logger.info "key: #{memoize_key}" if ForgetMeNot.logger
+    end
+
     def fetch_from_storage(key, &block)
       storage.fetch(key, &block)
     end
@@ -71,7 +79,7 @@ module ForgetMeNot
 
     class << self
       def storage_builder
-        @storage_builder ||= Proc.new {HashCache.new}
+        @storage_builder ||= Proc.new { HashCache.new }
       end
 
       def storage_builder=(builder)
@@ -80,4 +88,6 @@ module ForgetMeNot
     end
 
   end
+  mattr_accessor :logger
+
 end

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

@@ -1,3 +1,3 @@
 module ForgetMeNot
-  VERSION = '0.3.2.2'
+  VERSION = '0.3.2.3'
 end

data/spec/cacheable_spec.rb

@@ -93,7 +93,7 @@ module ForgetMeNot
 
   describe Cacheable do
     before do
-      Cacheable.log_cache_activity = true
+      Cacheable.log_activity = true
       Cacheable.cache = ActiveSupport::Cache::MemoryStore.new
       TestClass.clear_calls
       TestClass2.clear_calls

data/spec/memoizable_spec.rb

@@ -37,6 +37,8 @@ module ForgetMeNot
 
   describe Memoizable do
     before do
+      Memoizable.log_activity = true
+
       MemoizeTestClass.clear_calls
     end
 

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: forget-me-not
 version: !ruby/object:Gem::Version
-  version: 0.3.2.2
+  version: 0.3.2.3
 platform: ruby
 authors:
 - Koan Health
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-20 00:00:00.000000000 Z
+date: 2016-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: timecop
   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'
 - !ruby/object:Gem::Dependency
   name: coveralls
   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'
 - !ruby/object:Gem::Dependency
   name: simplecov
   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: Caching and Memoization Mixins
@@ -101,15 +101,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/forget-me-not/cacheable.rb
-- lib/forget-me-not/hash_cache.rb
-- lib/forget-me-not/memoizable.rb
-- lib/forget-me-not/version.rb
-- lib/forget-me-not.rb
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/forget-me-not.rb
+- lib/forget-me-not/cacheable.rb
+- lib/forget-me-not/hash_cache.rb
+- lib/forget-me-not/logging.rb
+- lib/forget-me-not/memoizable.rb
+- lib/forget-me-not/version.rb
 - spec/cacheable_spec.rb
 - spec/memoizable_spec.rb
 - spec/spec_helper.rb
@@ -124,17 +125,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Mixins that provide caching and memoization for Ruby classes