forget-me-not 0.3.0 → 0.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjQwMzE4NWI3Nzc0Zjc4ZWZjNWE3YmI0NjlkOGQxY2QxNDA0OGE4Mg==
+    ZDBlMjk4MDJmODI1YmU4Njc5NDA0ZjMxNjA3MmUwZTMyODgzMDg1YQ==
   data.tar.gz: !binary |-
-    NmI3MmViNjhiZDYxNjg1MGExNjliYmM0MGU2ZDY5NjZkYWE0ODYyZg==
+    Mjc4Yjg0YjcwOGJjOTE4NDVkZWQ3MDg0NWZhODhiMjI4N2RhNTFmNg==
 SHA512:
   metadata.gz: !binary |-
-    YTI0MDg1Yzc2M2U5YWU4OWM4OTA3NWY5NmQzMTEzYThiOWNlNjU0ZGRiZDY2
-    Y2ExODM0MjUxZmQwZmZkMWY1ZDc4NjQ1MjU0Y2ZkNjVhYWFhZWJiZjU2OWNj
-    MmRkZTE0YjQ1NWMzYWQwMDZhN2FiZjBlY2JmYjhmNzdkMjJjMWM=
+    MmZhOTEwOTE3NGY2YzljODFhNzgzZTU0YjMwMzU3YjBhMjA1ZjEwYjZmN2Jh
+    MmFmYzM2YjFlOTQzNmExNzAxYjE3YzFhNzUyZmQ1MzZlMzQyYWMzZTNhODhh
+    M2EyY2M5Y2U0MjE3OTU2Zjk0ODg5OTUxOTQ4ZDNjOTUzY2NkYTE=
   data.tar.gz: !binary |-
-    NzU3ZDRhNDhiMGJhNjAyNDk1YjY4ZTIxYjRhNzEzZGI1NzIxODg2ZWMwMDRm
-    Yzc0NDA3NDgwZjcwOTZlZDZlOTBmZTY0MzQzNTdmMDhlYTA1MDMzZDdmYzU5
-    ODY2NzFlYWYxODQxNzg4MjQ0ODU4MTY5YmNlOGY1YmM5MDNiZjk=
+    YzRiN2VhZmNkYTBlNzYwY2YxYWY5MzM1MGE4MzQxYWU4YTllZGFlNTA4OGM5
+    MTgxZjlkYzhlYjdmNDU3ZWVjYTliMTk4MDZmNWJmOTBjZWViZDg5NTdiMWMy
+    YWFmNGU3MjI5ZmJiM2RkZTY3MDY4Y2FhNWI5ZWM1M2U1ZjhiNGE=

data/README.md

@@ -83,10 +83,14 @@ An additional caution is warranted when memoizing methods that take arguments.
 in different results being memoized, if the set of arguments is unbounded, a great deal of memory can be consumed to
 hold on to the results.
 
+Memoization uses Ruby's hash() to differentiate arguments.  **If you are using a custom class as an argument to a
+memoized method, you must implement a valid hash method that is computed based upon the properties of the class.**
+
 The easiest way to prevent stale results and excessive consumption of memory when memoizing is to ensure that two
 things are true:
  - The memoizing object has a finite, well-known life span (e.g., a request)
  - If arguments are used, the set of possible arguments is bounded
+ - If arguments are used, every class must have a meaningful hash() method (the built in string, number, array, and hash all meet this criteria)
 
 In order to draw attention to the potential issues with argument driven memoization, you must call the memoize_with_args
 method if the method being memoized has arity > 0.
@@ -115,7 +119,11 @@ The basics are unsurprising:
     end
 
 Like memoization, arguments are fully supported and will result in distinct storage to the cache.  Unlike memoization,
-you do not need to call a with_args variant of the cache method.
+you do not need to call a with_args variant of the cache method.  Caching uses Ruby's to_s() to create a string
+representation of the argument (we can't use Ruby's hash, because the hash value depends upon the runtime).
+
+**If you are using a custom class as an argument to a cached method, you must implement a valid to_s
+method that is computed based upon the properties of the class.**
 
 To control warming the cache, implement the cache_warm method
 

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

@@ -1,3 +1,5 @@
+require 'digest'
+
 module ForgetMeNot
 # Allows the cross-system caching of lengthy function calls
   module Cacheable
@@ -39,10 +41,10 @@ module ForgetMeNot
             key_prefix,
             (instance_key && instance_key.call(self)),
             method_name,
-            args.hash
+            Digest::SHA1.hexdigest(args.to_s)
           ].compact.join '/'
 
-          puts "key: #{cache_key}" if (defined?(Rails) && Rails.env.test?)
+          puts "key: #{cache_key}" if defined?(Testing)
 
           Cacheable.cache_fetch(cache_key) do
             method.bind(self).call(*args)

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

@@ -1,3 +1,3 @@
 module ForgetMeNot
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'bundler/setup'
 require 'simplecov'
 
+Testing = true
+
 if ENV['TRAVIS']
   require 'coveralls'
   SimpleCov.formatter = Coveralls::SimpleCov::Formatter

metadata

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