basiccache 0.0.21 → 0.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01928e29f4f24f46565978f288a68f8188680696
-  data.tar.gz: a6d587ec58409e3b516ef5d08dc72bb822c11765
+  metadata.gz: 22d2709c9524354f74da72c0b334aa8eb8f41b1b
+  data.tar.gz: 395bc1e79ca4a535e7bfd209e156684d9bb1adca
 SHA512:
-  metadata.gz: f51d6a8627626a3facdfd62b376ad0aa3b2ee3ae8492b5221933cb9dc4a579dba1cbf042124bbab48a930da6f4074bc425d0287e373b2b860727c49247510de0
-  data.tar.gz: 37c5521e200019da014db4943cc86f8d7a1ec5ea8b2edef82644868c3bf9177e2242c508376b4aecea277c9af8a28043b3c5165d460920555801fe833a140d2e
+  metadata.gz: b4184929bde760bfbc19555318fd9186ae3a1728291cebc49e859c48752448bdb8e288b47e00688d984e0a9044f84b764118081ec6766f7b0f580c46f055f85f
+  data.tar.gz: 51df167bc6fee497e09d1d77751d3b850b474136a54464fa12234653b4201ea52ba0d82c19670abe8909c4694b0a67097b0220df877a71cad38ef79e7f80353d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    basiccache (0.0.21)
+    basiccache (0.0.22)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -56,6 +56,54 @@ my_cache.clear!
 
 The .clear! method can be passed a key name to clear just a specific key, as well.
 
+### MethodCacher
+
+MethodCacher provides a helper module for caching method calls inside a class.
+
+To cache the results of Foo.bar and Foo.act, for instance, you'd do the following:
+
+```
+require 'basiccache'
+
+class Foo
+  include MethodCacher
+
+  def initialize
+    enable_caching [:bar, :act]
+  end
+
+  def bar
+    # deep computation here
+  end
+
+  def act
+    # more super deep calculations
+  end
+
+  def other
+    # this method isn't cached
+  end
+end
+```
+
+You can also provide a second argument to enable_caching to specify a custom cache object (like TimeCache):
+
+```
+require 'basiccache'
+
+class Foo
+  include MethodCacher
+
+  def initialize
+    enable_caching [:act], BasicCache::TimeCache.new
+  end
+
+  def act
+    # super deep time-sensitive calculations
+  end
+end
+```
+
 ## Subclasses
 
 ### TimeCache

data/basiccache.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'basiccache'
-  s.version     = '0.0.21'
+  s.version     = '0.0.22'
   s.date        = Time.now.strftime("%Y-%m-%d")
   s.summary     = 'Provides a minimal key/value caching layer'
   s.description = "Allows an application to dynamically cache values and retrieve them later"

data/lib/basiccache.rb

@@ -26,6 +26,6 @@ module BasicCache
   end
 end
 
-require 'version'
 require 'caches/cache'
 require 'caches/timecache'
+require 'methodcacher'

data/lib/methodcacher.rb

@@ -0,0 +1,17 @@
+##
+# Helper module for caching methods inside a class
+# To use, extend your class with MethodCacher
+# Then, in initialize, call enable_caching
+
+module MethodCacher
+  def enable_caching(methods, cache = nil)
+    cache ||= BasicCache.new
+    methods.each do |name|
+      uncached_name = "#{name}_uncached".to_sym
+      (class << self; self; end).class_eval do
+        alias_method uncached_name, name
+        define_method(name) { |*a| cache.cache { send uncached_name, *a } }
+      end
+    end
+  end
+end

data/spec/basiccache_spec.rb

@@ -1,12 +1,6 @@
 require 'spec_helper'
 
 describe BasicCache do
-  describe '::VERSION' do
-    it 'follows the semantic version scheme' do
-      expect(BasicCache::VERSION).to match /\d+\.\d+\.\d+/
-    end
-  end
-
   describe '.new' do
     it 'creates cache objects' do
       expect(BasicCache.new).to be_an_instance_of BasicCache::Cache

data/spec/methodcacher_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+##
+# Example class for testing method caching
+
+class Example
+  include MethodCacher
+
+  def initialize(skip_cache = false)
+    return if skip_cache
+    enable_caching [:repeat]
+    enable_caching [:time_repeat], BasicCache::TimeCache.new(1)
+  end
+
+  def repeat(input)
+    input
+  end
+
+  def time_repeat(input)
+    input
+  end
+
+  def not_cached(input)
+    input
+  end
+end
+
+describe MethodCacher do
+  let(:test_object) { Example.new }
+  let(:uncached_object) { Example.new(skip_cache: true) }
+
+  describe '#enable_caching' do
+    it 'wraps methods with the cache' do
+      expect(test_object.repeat 2).to eql 2
+      expect(test_object.repeat 3).to eql 2
+    end
+    it "doesn't mess with other instances" do
+      expect(uncached_object.repeat 5).to eql 5
+      expect(uncached_object.repeat 6).to eql 6
+    end
+    it 'allows a user-supplied cache object' do
+      expect(test_object.time_repeat 2).to eql 2
+      expect(test_object.time_repeat 3).to eql 2
+      sleep 2
+      expect(test_object.time_repeat 4).to eql 4
+    end
+    it 'does not override other methods' do
+      expect(test_object.not_cached 7).to eql 7
+      expect(test_object.not_cached 8).to eql 8
+    end
+    it 'aliases the uncached methods' do
+      expect(test_object.repeat_uncached 5).to eql 5
+      expect(test_object.repeat_uncached 4).to eql 4
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: basiccache
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.0.22
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-24 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -127,10 +127,11 @@ files:
 - lib/basiccache.rb
 - lib/caches/cache.rb
 - lib/caches/timecache.rb
-- lib/version.rb
+- lib/methodcacher.rb
 - spec/basiccache_spec.rb
 - spec/caches/cache_spec.rb
 - spec/caches/timecache_spec.rb
+- spec/methodcacher_spec.rb
 - spec/spec_helper.rb
 - vendor/cache/ast-1.1.0.gem
 - vendor/cache/coveralls-0.7.0.gem
@@ -187,4 +188,5 @@ test_files:
 - spec/basiccache_spec.rb
 - spec/caches/cache_spec.rb
 - spec/caches/timecache_spec.rb
+- spec/methodcacher_spec.rb
 - spec/spec_helper.rb

data/lib/version.rb

@@ -1,6 +0,0 @@
-##
-# Define the version
-
-module BasicCache
-  VERSION = '0.0.20'
-end