cache_value 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tobias Crawley
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,7 @@
+= cache_value
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Tobias Crawley. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cache_value"
+    gem.summary = %Q{Easy value caching}
+    gem.email = "tcrawley@gmail.com"
+    gem.homepage = "http://github.com/tobias/cache_value"
+    gem.authors = ["Tobias Crawley"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cache_value #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/cache_value.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cache_value}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tobias Crawley"]
+  s.date = %q{2010-01-07}
+  s.email = %q{tcrawley@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cache_value.gemspec",
+     "lib/cache_value.rb",
+     "lib/cache_value/cache_machine.rb",
+     "lib/cache_value/cache_value.rb",
+     "lib/cache_value/util.rb",
+     "test/cache_machine_test.rb",
+     "test/cache_value_test.rb",
+     "test/test_helper.rb",
+     "test/util_test.rb"
+  ]
+  s.homepage = %q{http://github.com/tobias/cache_value}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Easy value caching}
+  s.test_files = [
+    "test/cache_machine_test.rb",
+     "test/cache_value_test.rb",
+     "test/test_helper.rb",
+     "test/util_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/cache_value/cache_machine.rb

@@ -0,0 +1,80 @@
+require 'active_support/core_ext/array'
+require 'active_support/core_ext/class'
+require 'active_support/inflector'
+require 'active_support/cache'
+require 'cache_value/util'
+
+module CacheValue
+  class CacheMachine
+    extend Util
+    
+    class << self
+
+      def cache_store=(*store_option)
+        @cache_store = store_option ? ActiveSupport::Cache.lookup_store(store_option) : nil
+      end
+      
+      def cache_store
+        @cache_store ||= ActiveSupport::Cache.lookup_store(:file_store, default_storage_dir)
+      end
+
+      def default_storage_dir
+        if !defined?(RAILS_ROOT)
+          raise ConfigurationException.new('Not running under rails. Set the cache_store type ' +
+                                           'and location manually using CacheValue::CacheMachine.cache_store=')
+        end
+        
+        File.join(RAILS_ROOT, 'tmp', 'cache_value_caches')
+      end
+
+      def lookup(object, method, options, arguments = nil)
+        value, last_cached = fetch_and_parse(object, method, arguments)
+        if !last_cached or !cached_value_is_still_valid?(value, last_cached, object, method, options)
+          value = call_and_store_value(object, method, arguments)
+        end
+        
+        value
+      end
+      
+      def cache_key(object, method, arguments = nil)
+        if !object.respond_to?(:cache_key)
+          raise ConfigurationException.new("object of class #{object.class.name} does not respond to :cache_key")
+        end
+        
+        key = object.cache_key.gsub('/', '_') + "_#{method}"
+        key << '_' + hex_digest(arguments) if arguments
+        key
+      end
+
+      def fetch_and_parse(object, method, arguments = nil)
+        data = cache_store.fetch(cache_key(object, method, arguments))
+        if data
+          YAML::load(data)
+        else
+          [nil, nil]
+        end
+      end
+
+      def call_and_store_value(object, method, arguments = nil)
+        without_method = caching_method_names(method).first
+        value = arguments ? object.send(without_method, *arguments) : object.send(without_method)
+        cache_store.write(cache_key(object, method, arguments), [value, Time.now].to_yaml)
+        
+        value
+      end
+
+      def cached_value_is_still_valid?(value, cached_age, object, method, options)
+        options = object.send(:method, options) if options.is_a?(Symbol)
+        if options.respond_to?(:arity)          
+          options.call(*([cached_age, object, method][0,options.arity]))
+        else
+          cached_age > Time.now - options
+        end
+      end
+
+    end
+  end
+
+  class ConfigurationException < StandardError
+  end
+end

data/lib/cache_value/cache_value.rb

@@ -0,0 +1,21 @@
+require 'cache_value/util'
+require 'cache_value/cache_machine'
+
+module CacheValue
+  module ClassMethods
+    include Util
+    
+    def cache_value(method, option)
+      without_method, with_method = caching_method_names(method)
+      class_eval do
+        define_method with_method do |*args|
+          CacheValue::CacheMachine.lookup(self, method, option, args)
+        end
+        
+        alias_method without_method, method
+        alias_method method, with_method
+      end
+    end
+  end
+
+end

data/lib/cache_value/util.rb

@@ -0,0 +1,30 @@
+require 'sha1'
+
+module CacheValue
+  module Util
+    def caching_method_names(method)
+      washed_method = method.to_s.sub(/([?!=])$/, '')
+      punctuation = $1
+      ["#{washed_method}_without_value_caching#{punctuation}",
+       "#{washed_method}_with_value_caching#{punctuation}"]
+    end
+
+    def hex_digest(values)
+      Digest::SHA1.hexdigest(stringify_value(values))
+    end
+    
+    protected
+    def stringify_value(value)
+      if value.respond_to?(:to_str)
+        value.to_str
+      elsif value.respond_to?(:cache_key)
+        value.cache_key.to_s
+      elsif value.respond_to?(:collect)
+        value.collect { |x| stringify_value(x) }.join
+      else
+        value.to_s
+      end
+    end
+    
+  end
+end

data/lib/cache_value.rb

@@ -0,0 +1,5 @@
+require 'cache_value/cache_value'
+
+module CacheValue
+  ActiveRecord::Base.send(:extend, CacheValue::ClassMethods) if defined?(ActiveRecord::Base)
+end

data/test/cache_machine_test.rb

@@ -0,0 +1,189 @@
+require 'test_helper'
+
+require 'cache_value/cache_machine'
+
+
+class CacheMachineTest < Test::Unit::TestCase
+
+  def setup
+    @cm = CacheValue::CacheMachine
+    @obj = mock
+    @method = :some_method
+    @value = 2
+  end
+
+  context 'cache store' do
+    should 'provide a cache store' do
+      ::RAILS_ROOT = '/tmp'
+      @cm.cache_store.should_not == nil
+    end
+
+    context 'default storage dir' do
+      should 'raise exception if RAILS_ENV is not set' do
+        assert_raise CacheValue::ConfigurationException do
+          @cm.default_storage_dir
+        end
+      end
+
+      should 'point to the tmp in RAILS_ROOT if available' do
+        ::RAILS_ROOT = '/tmp'
+        @cm.default_storage_dir.should == '/tmp/tmp/cache_value_caches'
+      end
+
+      
+    end
+
+    teardown do
+      Object.send(:remove_const, :RAILS_ROOT) if defined?(RAILS_ROOT)
+    end
+    
+  end
+  
+
+  context 'cache key' do
+    should 'raise exception if object does not respond_to cache_key' do
+      assert_raise CacheValue::ConfigurationException do
+        @cm.cache_key(@obj, @method)
+      end
+    end
+    
+    context 'with an object that responds to cache_key' do
+      setup do
+        @obj.expects(:cache_key).returns('a/cache/key')
+      end
+      
+      should 'include the method name at the end' do
+        assert_match /_method$/, @cm.cache_key(@obj, :method)
+      end
+
+      should 'not have any slashes' do
+        assert_no_match %r{/}, @cm.cache_key(@obj, :method)
+      end
+    end
+
+    context 'with arguments' do
+      setup do
+        @obj.expects(:cache_key).returns('a/cache/key')
+      end
+
+      should 'should include the hash in the key' do
+        now = Time.now
+        assert_match /_method_#{@cm.send(:hex_digest, [1, 2, now])}$/, @cm.cache_key(@obj, :method, [1, 2, now])
+      end
+
+    end
+  end
+  
+  context 'fetch_and_parse' do
+    setup do
+      @cache_data = ['data', Time.now]
+      @cm.expects(:cache_key).returns('')
+    end
+
+    should 'return the data and timestamp when found' do
+      @cm.cache_store.expects(:fetch).returns(@cache_data.to_yaml)
+      @cm.fetch_and_parse(@obj, @method).should == @cache_data
+    end
+
+    should 'return nils when data not found' do
+      @cm.cache_store.expects(:fetch).returns(nil)
+      @cm.fetch_and_parse(@obj, @method).should == [nil, nil]
+    end
+  end
+
+  context 'call_and_store_value' do
+    setup do
+      @obj.expects(:some_method_without_value_caching).returns(2)
+      key = 'key'
+      @cm.expects(:cache_key).with(@obj, :some_method, nil).returns(key)
+      now = Time.now
+      Time.stubs(:now).returns(now)
+      @cm.cache_store.expects(:write).with(key, [2, Time.now].to_yaml)
+    end
+    
+    should 'return the data' do
+      @cm.call_and_store_value(@obj, :some_method).should == 2
+    end
+
+  end
+
+  context 'validity of stored value' do
+    
+    context 'checking by age in seconds' do
+      should 'be valid if the value is younger than the age limit' do
+        @cm.cached_value_is_still_valid?(@value, Time.now - 30, @obj, @method, 35).should == true
+      end
+
+      should 'not be valid if the value is older than the age limit' do
+        @cm.cached_value_is_still_valid?(@value, Time.now - 30, @obj, @method, 5).should == false
+      end
+    end
+    
+    context 'checking with block' do
+      should 'pass the proper fields to the proc' do
+        now = Time.now
+        proc = lambda { |a,b,c|}
+        proc.expects(:call).with(now, @obj, @method)
+
+        @cm.cached_value_is_still_valid?(@value, now, @obj, @method, proc)
+      end
+
+      should 'only pass time if the proc only takes two args' do
+        now = Time.now
+        proc = lambda { |a|}
+        proc.expects(:call).with(now)
+
+        @cm.cached_value_is_still_valid?(@value, now, @obj, @method, proc)
+      end
+    end
+
+    context 'checking with symbol' do
+      setup do
+        @object = Object.new
+        def @object.the_method(a,b)
+          'blah'
+        end
+        
+      end
+
+      should 'call the method for the symbol on the object' do
+        @cm.cached_value_is_still_valid?(@value, Time.now, @object, @method, :the_method).should == 'blah'
+      end
+     
+    end
+    
+    should 'raise exceptions if options is incorrect'
+
+  end
+
+  context 'cache lookup' do
+    should 'call for the value (and return it) if nothing was cached' do 
+      @cm.expects(:fetch_and_parse).with(@obj, @method, nil).returns(nil, nil)
+      @cm.expects(:call_and_store_value).with(@obj, @method, nil).returns(@value)
+      @cm.lookup(@obj, @method, nil).should == @value
+    end
+
+    should 'call for the value (and return it) if the value is no longer valid' do
+      now = Time.now
+      @cm.expects(:fetch_and_parse).with(@obj, @method, nil).returns([2, now])
+      @cm.expects(:cached_value_is_still_valid?).with(@value, now, @obj, @method, 2).returns(false)
+      @cm.expects(:call_and_store_value).with(@obj, @method, nil).returns(@value)
+      @cm.lookup(@obj, @method, 2).should == @value
+    end
+    
+    should 'not call and store if the cached value is valid' do
+      @cm.expects(:fetch_and_parse).with(@obj, @method, nil).returns([2, Time.now])
+      @cm.expects(:cached_value_is_still_valid?).returns(true)
+      @cm.expects(:call_and_store_value).never
+      @cm.lookup(@obj, @method, 2).should == @value
+    end
+    
+    should 'be able to cache a nil value' do
+            @cm.expects(:fetch_and_parse).with(@obj, @method, nil).returns([nil, Time.now])
+      @cm.expects(:cached_value_is_still_valid?).returns(true)
+      @cm.expects(:call_and_store_value).never
+      @cm.lookup(@obj, @method, 2).should == nil
+    end
+      
+  end
+end

data/test/cache_value_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+require 'cache_value/cache_value'
+
+class CacheTestClass
+  extend CacheValue::ClassMethods
+  
+  def do_something
+    'blech'
+  end
+  
+  cache_value :do_something, 'yo'
+
+end
+
+class CacheValueTest < Test::Unit::TestCase
+  
+  def setup
+    @cacher = CacheTestClass.new
+  end
+
+  should 'delegate the cache lookup to CacheMachine' do
+    CacheValue::CacheMachine.expects(:lookup).with(@cacher, :do_something, 'yo', [])
+    @cacher.do_something
+  end
+  
+  context 'aliased methods' do
+    
+    context 'generate caching method names' do
+      should 'generate vanilla names' do
+        @cacher.class.caching_method_names(:vanilla).should == %w{ vanilla_without_value_caching vanilla_with_value_caching }
+      end
+
+      should 'generate chocolate! names' do
+        @cacher.class.caching_method_names(:chocolate!).should == %w{ chocolate_without_value_caching! chocolate_with_value_caching! }
+      end
+      
+      should 'generate strawberry? names' do
+        @cacher.class.caching_method_names(:strawberry?).should == %w{ strawberry_without_value_caching? strawberry_with_value_caching? }
+      end
+      
+    end
+
+    should 'have aliased a with method' do
+      @cacher.respond_to?(:do_something_with_value_caching).should == true
+    end
+
+    should 'have aliased a without method' do
+      @cacher.respond_to?(:do_something_without_value_caching).should == true
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'matchy'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cache_value'
+
+class Test::Unit::TestCase
+end

data/test/util_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+require 'cache_value/util'
+
+
+class UtilTest < Test::Unit::TestCase
+  include CacheValue::Util
+  
+  should 'be true' do
+    assert true
+  end
+  
+  should 'have some tests here' 
+  
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: cache_value
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Tobias Crawley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-07 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: tcrawley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- cache_value.gemspec
+- lib/cache_value.rb
+- lib/cache_value/cache_machine.rb
+- lib/cache_value/cache_value.rb
+- lib/cache_value/util.rb
+- test/cache_machine_test.rb
+- test/cache_value_test.rb
+- test/test_helper.rb
+- test/util_test.rb
+has_rdoc: true
+homepage: http://github.com/tobias/cache_value
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Easy value caching
+test_files: 
+- test/cache_machine_test.rb
+- test/cache_value_test.rb
+- test/test_helper.rb
+- test/util_test.rb