forget-me-not 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDgxZjQ2MjE0MmM1ODk2ZWMzODVlM2ExMmQyZjg5YmQ1NzUwNWRlZQ==
+    NjQwMzE4NWI3Nzc0Zjc4ZWZjNWE3YmI0NjlkOGQxY2QxNDA0OGE4Mg==
   data.tar.gz: !binary |-
-    MzNkM2Y0OWIyNTE4Yzk4NWZlNDI2Nzc1YjI4MzhhZjUwYjMyMTZjMQ==
+    NmI3MmViNjhiZDYxNjg1MGExNjliYmM0MGU2ZDY5NjZkYWE0ODYyZg==
 SHA512:
   metadata.gz: !binary |-
-    YzI2OTAyOWZhZjU5ZmQxODNjYzE0OWFjZDAzNmQ4NWU5YmU4YWY2YjBmMDhj
-    YTFiMmEyZjNkNWRiM2IyNWZiYmY2MTVkN2IwOTkzNGM4OWM2N2UzMTE1OGJl
-    MjViZWE2NGZhZmQzNjMxZjA0MDA2YWE0YzA1ZTUxN2FlNDdlNDE=
+    YTI0MDg1Yzc2M2U5YWU4OWM4OTA3NWY5NmQzMTEzYThiOWNlNjU0ZGRiZDY2
+    Y2ExODM0MjUxZmQwZmZkMWY1ZDc4NjQ1MjU0Y2ZkNjVhYWFhZWJiZjU2OWNj
+    MmRkZTE0YjQ1NWMzYWQwMDZhN2FiZjBlY2JmYjhmNzdkMjJjMWM=
   data.tar.gz: !binary |-
-    Yzc5NTExM2YzNjI1MjdlYzZkNmUwYzg1MzZjNWIzMGU3Nzg3MWM2NzY4MDdi
-    ZTViODhjYzg2YWQxNDE4MjdhOGYzMDZiOGI0MWU2YTY4ZmZjZjNkZTdlOTVh
-    ODZlYmI0ZDVmYjMwZGJhOTdmMTQ4ZTc5ZGQ0MzYzOTYyNmEzZjg=
+    NzU3ZDRhNDhiMGJhNjAyNDk1YjY4ZTIxYjRhNzEzZGI1NzIxODg2ZWMwMDRm
+    Yzc0NDA3NDgwZjcwOTZlZDZlOTBmZTY0MzQzNTdmMDhlYTA1MDMzZDdmYzU5
+    ODY2NzFlYWYxODQxNzg4MjQ0ODU4MTY5YmNlOGY1YmM5MDNiZjk=

data/CHANGELOG.md

@@ -1,2 +1,3 @@
+## 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

data/README.md

@@ -93,6 +93,9 @@ 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.
 
+#### Blocks
+You may not pass a block to a memoized method.  Attempting to do so results in an error being raised.
+
 #### 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
@@ -111,7 +114,8 @@ The basics are unsurprising:
       cache :some_method
     end
 
-Like memoization, arguments are fully supported and will result in distinct storage to the cache.
+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.
 
 To control warming the cache, implement the cache_warm method
 
@@ -156,6 +160,9 @@ key members.
 Of course, every argument variation and every included instance property amplifies the potential amount of cache
 memory that is consumed.
 
+#### Blocks
+You may not pass a block to a cached method.  Attempting to do so results in an error being raised.
+
 #### 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.

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

@@ -32,7 +32,9 @@ module ForgetMeNot
         instance_key = get_instance_key_proc(options[:include]) if options.has_key?(:include)
 
         undef_method(method_name)
-        define_method(method_name) do |*args|
+        define_method(method_name) do |*args, &block|
+          raise 'Cannot pass blocks to cached methods' if block
+
           cache_key = [
             key_prefix,
             (instance_key && instance_key.call(self)),

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

@@ -33,7 +33,9 @@ module ForgetMeNot
         key_prefix = "/memoized_method_result/#{self.name}"
 
         undef_method(method_name)
-        define_method(method_name) do |*args|
+        define_method(method_name) do |*args, &block|
+          raise 'Cannot pass blocks to memoized methods' if block
+
           memoize_key = [
             key_prefix,
             method_name,

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

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

data/spec/cacheable_spec.rb

@@ -30,6 +30,12 @@ module ForgetMeNot
       "method5({#{hash_arg.map { |k, v| "#{k}/#{v}" }.join '|' }})"
     end
 
+    def self.cache_warm(*args)
+      item = new
+      item.method1
+      item.method2(args.first)
+    end
+
     cache_results :method1, :method2, :method3, :method4, :method5
   end
 
@@ -93,6 +99,22 @@ module ForgetMeNot
 
         expect(TestClass.count(:method1)).to eq 2
       end
+
+      it 'should raise an error if called with a block on initial caching' do
+        foo = TestClass.new
+        expect do
+          foo.method1 {'a block'}
+        end.to raise_error 'Cannot pass blocks to cached methods'
+      end
+
+      it 'should raise an error if called with a block after initial caching' do
+        foo = TestClass.new
+        foo.method1
+        expect do
+          foo.method1 {'a block'}
+        end.to raise_error 'Cannot pass blocks to cached methods'
+      end
+
     end
 
     describe 'cache arity-1 calls' do
@@ -193,6 +215,31 @@ module ForgetMeNot
         expect(Cacheable.cachers_and_descendants & expected).to eq expected
       end
 
+      it 'Cache Warming should call warmed methods' do
+        Cacheable.warm('foo')
+
+        expect(TestClass.count(:method1)).to eq 1
+        expect(TestClass.count(:method2)).to eq 1
+        expect(TestClass.count(:method3)).to eq 0
+        expect(TestClass.count(:method4)).to eq 0
+        expect(TestClass.count(:method5)).to eq 0
+      end
+
+      it 'Cache Warming should call warm methods again' do
+        TestClass.new.method1
+        TestClass.new.method2('foo')
+
+        expect(TestClass.count(:method1)).to eq 1
+        expect(TestClass.count(:method2)).to eq 1
+
+        Cacheable.warm('foo')
+
+        expect(TestClass.count(:method1)).to eq 2
+        expect(TestClass.count(:method2)).to eq 2
+        expect(TestClass.count(:method3)).to eq 0
+        expect(TestClass.count(:method4)).to eq 0
+        expect(TestClass.count(:method5)).to eq 0
+      end
     end
   end
 end

data/spec/memoizable_spec.rb

@@ -59,6 +59,20 @@ module ForgetMeNot
         expect(MemoizeTestClass.count(:method1)).to eq 2
       end
 
+      it 'should raise an error if called with a block on initial memoization' do
+        foo = MemoizeTestClass.new
+        expect do
+          foo.method1 {'a block'}
+        end.to raise_error 'Cannot pass blocks to memoized methods'
+      end
+
+      it 'should raise an error if called with a block after initial memoization' do
+        foo = MemoizeTestClass.new
+        foo.method1
+        expect do
+          foo.method1 {'a block'}
+        end.to raise_error 'Cannot pass blocks to memoized methods'
+      end
     end
 
     describe 'memoize arity > 0 calls' do

data/spec/spec_helper.rb

@@ -1,13 +1,17 @@
-require 'rubygems'
 require 'bundler/setup'
-require 'rspec'
+require 'simplecov'
 
-require 'active_support/all'
-require 'timecop'
+if ENV['TRAVIS']
+  require 'coveralls'
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+end
 
-require 'coveralls'
-Coveralls.wear!
+SimpleCov.start do
+  add_filter '/spec/'
+end
 
+require 'active_support/all'
+require 'timecop'
 require 'forget-me-not'
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forget-me-not
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Koan Health
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2013-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - ! '>='
       - !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
 email:
 - development@koanhealth.com