forget-me-not 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YWI4NDI2YmQ5NTc1NjMyOGM5Y2UyZjk1NmFhYTcwODQyNWYzMzQ0Mw==
+    ZDgxZjQ2MjE0MmM1ODk2ZWMzODVlM2ExMmQyZjg5YmQ1NzUwNWRlZQ==
   data.tar.gz: !binary |-
-    NTFmOTRhYTg3NjNjZjAwM2JmNzIyYmRkNmI3YzM5NjJlNWY1ZjI4NA==
+    MzNkM2Y0OWIyNTE4Yzk4NWZlNDI2Nzc1YjI4MzhhZjUwYjMyMTZjMQ==
 SHA512:
   metadata.gz: !binary |-
-    MWJiNjdmODBmOTIwZGEzOThjNThjZDU2YjJlODk0M2RhN2Q2MjJkNjU5MjVj
-    YTZmYmU2ZDViYjg4MTc1Yzc0YjQ4M2ZmMjBjOTkxYzViZTAwZmQ4NzUzZTgw
-    OWQzMzRkODE0ZWMwN2VlNjIwNjk4NGJlYzAxMDY4NjE4ZjhhNjk=
+    YzI2OTAyOWZhZjU5ZmQxODNjYzE0OWFjZDAzNmQ4NWU5YmU4YWY2YjBmMDhj
+    YTFiMmEyZjNkNWRiM2IyNWZiYmY2MTVkN2IwOTkzNGM4OWM2N2UzMTE1OGJl
+    MjViZWE2NGZhZmQzNjMxZjA0MDA2YWE0YzA1ZTUxN2FlNDdlNDE=
   data.tar.gz: !binary |-
-    M2MwOWE5MjFlN2U4ODRlN2VjMDg0MWQzYWZlODk0YmE2YmY5MmU5MjlhNmJj
-    MmJhNzk1N2RiMzM4YjMxNzY3MTlhYWI3MTYyM2FhYjViZTA4MTU5MDI4OWU0
-    ZGRiNWIxOTJkZWI5MmQxY2FjYzU3MzUwMTE3NDg4OGViM2NlYzA=
+    Yzc5NTExM2YzNjI1MjdlYzZkNmUwYzg1MzZjNWIzMGU3Nzg3MWM2NzY4MDdi
+    ZTViODhjYzg2YWQxNDE4MjdhOGYzMDZiOGI0MWU2YTY4ZmZjZjNkZTdlOTVh
+    ODZlYmI0ZDVmYjMwZGJhOTdmMTQ4ZTc5ZGQ0MzYzOTYyNmEzZjg=

data/CHANGELOG.md

@@ -1 +1,2 @@
-## 0.0.1.0 - Pre Release
+## 0.2.0.0 - Still pre release, but made a new method for memoizing methods with args.
+## 0.1.0.0 - Pre Release

data/README.md

@@ -60,16 +60,40 @@ called once.
         'result'
       end
 
-      def some_other_method(with_an_arg)
+      def method_with_args(with_an_arg)
       	"result2-#{with_an_arg}"
       end
 
-      memoize :some_method, :some_other_method
+      memoize :some_method
+      memoize_with_args :method_with_args
     end
 
-Calls to both some_method and some_other_method are memoized.  Notice that some_other_method takes an argument, differing
-argument values will result in different results being memoized.
+Calls to both some_method and method_with_args are memoized.
 
+#### Caution!
+Use caution when memoizing results on long-lived objects (e.g., objects that live for the life-time of the process).
+Memoized results never expire and the initially calculated result will always be the one that is returned.  This can
+lead to incorrect application logic if the memoized results would differ if calculated at a later time.
+
+_Consider the case of the application that memoizes a user's privileges the first time they are needed.  If the privilege
+container were long lived, it would never reflect a change in the user's privileges.  (There are more subtle ways to
+lose, this is just an obvious example)._
+
+An additional caution is warranted when memoizing methods that take arguments.  Because different argument values result
+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.
+
+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
+
+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.
+
+Memoization is a powerful tool, but like all powerful tools, needs to be used with knowledge and respect.
+
+#### Storage
 By default, the memoization code stores results in a simple Hash based cache.  If you have other requirements, perhaps
 a thread-safe storage, then set the ForgetMeNot::Memoization.storage_builder property to a proc that will create a new
 instance of whatever storage you desire.
@@ -128,11 +152,16 @@ key members.
       cache :some_method, :include => :important_property
     end
 
+#### Caution!
+Of course, every argument variation and every included instance property amplifies the potential amount of cache
+memory that is consumed.
+
+#### Storage
 By default, the cache will attempt to use the Rails cache.  If that isn't found, but ActiveSupport is available, a new
-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.  Cacheable expects a cache shaped like an
-ActiveSupport::Cacheable::Store
+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
 
 ## Origins
 This is an extension of the ideas and approach found here:

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

@@ -13,15 +13,22 @@ module ForgetMeNot
         methods.each { |m| memoize_method(m, options) }
       end
 
+      def memoize_with_args(*methods)
+        options = methods.last.is_a?(Hash) ? methods.pop : {}
+        options = options.merge(allow_args: true)
+        methods.each { |m| memoize_method(m, options) }
+      end
+
       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]
         visibility = method_visibility(method_name)
         define_memoized_method(method, options)
         send(visibility, method_name)
       end
 
-      def define_memoized_method(method, options)
+      def define_memoized_method(method, _)
         method_name = method.name.to_sym
         key_prefix = "/memoized_method_result/#{self.name}"
 

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

@@ -1,3 +1,3 @@
 module ForgetMeNot
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/memoizable_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 module ForgetMeNot
+
   class MemoizeTestClass
     include Memoizable
     include MethodCounter
@@ -30,13 +31,13 @@ module ForgetMeNot
       "method5({#{hash_arg.map { |k, v| "#{k}/#{v}" }.join '|' }})"
     end
 
-    memoize :method1, :method2, :method3, :method4, :method5
+    memoize :method1
+    memoize_with_args :method2, :method3, :method4, :method5
   end
 
   describe Memoizable do
     before do
       MemoizeTestClass.clear_calls
-      TestClass2.clear_calls
     end
 
 
@@ -60,6 +61,45 @@ module ForgetMeNot
 
     end
 
+    describe 'memoize arity > 0 calls' do
+      it 'throws an exception if memoize is called for a function with arguments' do
+        expect do
+          Class.new do
+            include Memoizable
+
+            def method(arg)
+            end
+            memoize :method
+          end
+        end.to raise_error 'Cannot memoize with arity > 0.  Use memoize_with_args instead.'
+      end
+
+      it 'allows memoization if the allow_args option is true' do
+        expect do
+          Class.new do
+            include Memoizable
+
+            def method(arg)
+            end
+            memoize :method, allow_args: true
+          end
+        end.not_to raise_error
+      end
+
+      it 'allows memoization if memoize_with_args is called' do
+        expect do
+          Class.new do
+            include Memoizable
+
+            def method(arg)
+            end
+            memoize_with_args :method
+          end
+        end.not_to raise_error
+      end
+
+
+    end
     describe 'memoize arity-1 calls' do
       it 'should memoize calls from the same instance, same argument' do
         foo = MemoizeTestClass.new

metadata

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