shallow 0.0.0 → 0.1.1

data/Rakefile

@@ -6,7 +6,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "shallow"
     gem.summary = %Q{A gem for creating cached response for expensive method calls}
-    gem.description = %Q{TODO: longer description of your gem}
+    gem.description = %Q{A gem for creating cached response for expensive method calls}
     gem.email = "jeremy.n.friesen@gmail.com"
     gem.homepage = "http://github.com/jeremyf/shallow"
     gem.authors = ["Jeremy Friesen"]

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.1

data/lib/shallow.rb

@@ -0,0 +1,94 @@
+require 'yaml'
+require 'singleton'
+module Shallow
+  CACHE_FOLDER = 'shallow'
+  module Method
+    def self.with_cache_clearing_for(context)
+      yield and return unless context.respond_to?(:returning_value_cache_caller)
+      old_method = context.method(:returning_value_cache_caller)
+      context.meta_def(:returning_value_cache_caller) do
+        Shallow::Caller::Clear
+      end
+      yield
+    ensure
+      context.meta_def(:returning_value_cache_caller, &old_method)
+    end
+
+    def shallow_method(method_name, options = {})
+      scope = options[:scope] || options['scope'] || lambda { nil }
+      class_eval do
+        define_method(:returning_value_cache_caller) do
+          Shallow::Caller::Base
+        end
+        old_method = instance_method(method_name.to_sym)
+        define_method(method_name.to_sym) do |*args, &block|
+          returning_value_cache_caller.new(
+          :args => args,
+          :keys => [instance_eval(&scope).to_s, method_name],
+          :capture => old_method.bind(self)
+          ).call(&block)
+        end
+      end
+    end
+  end
+
+  class Cache
+    def initialize
+      @data_store = {}
+    end
+    include Singleton
+    def exist?(key)
+      @data_store.key?(key)
+    end
+    def fetch(key)
+      if @data_store.key?(key)
+        @data_store.fetch(key)
+      else
+        @data_store[key] = yield
+      end
+    end
+    def delete(key)
+      @data_store.delete(key)
+    end
+    def read(key)
+      @data_store.fetch(key)
+    end
+  end
+
+  module Caller
+    class Base
+      attr_reader :cache_key, :captured_method
+      def initialize(options = {})
+        keys = options[:keys]
+        @args = options[:args]
+        @cache_key = File.join(keys.inject([CACHE_FOLDER]){|m,v| m << v.to_s})
+        @captured_method = options[:capture]
+      end
+
+      def call(&context)
+        if cache.exist?(cache_key)
+          returning_value = YAML.load(cache.read(cache_key))
+          context.call(*returning_value, &context) if block_given? && !returning_value.nil?
+          return *returning_value
+        else
+          returning_value = nil
+          cache.fetch(cache_key) {
+            returning_value = captured_method.call(*@args, &lambda {|args| context.call(args); args })
+            returning_value ? [returning_value].to_yaml : nil.to_yaml
+          }
+          return *returning_value
+        end
+      end
+      protected
+      def cache
+        Cache.instance
+      end
+    end
+    class Clear < Base
+      def call(&context)
+        cache.delete(cache_key) if cache.exist?(cache_key)
+        super(&context)
+      end
+    end
+  end
+end

data/shallow.gemspec

@@ -0,0 +1,51 @@
+# 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{shallow}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy Friesen"]
+  s.date = %q{2010-04-01}
+  s.description = %q{A gem for creating cached response for expensive method calls}
+  s.email = %q{jeremy.n.friesen@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/shallow.rb",
+     "shallow.gemspec",
+     "test/helper.rb",
+     "test/test_shallow.rb"
+  ]
+  s.homepage = %q{http://github.com/jeremyf/shallow}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A gem for creating cached response for expensive method calls}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_shallow.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/test/test_shallow.rb

@@ -1,7 +1,49 @@
 require 'helper'
 
 class TestShallow < Test::Unit::TestCase
-  def test_something_for_real
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  def setup
+    @klass = Class.new {
+      attr_accessor :value
+      extend Shallow::Method
+      def foo(msg)
+        msg
+      end
+      shallow_method(:foo)
+      def bar(*args)
+        yield(*args)
+      end
+      shallow_method(:bar)
+
+      def with_value
+        return nil if value.nil?
+        yield(value)
+      end
+      shallow_method(:with_value)
+    }
+    @object = @klass.new
+  end
+  
+  def test_cache_return_value
+    assert_equal 'message', @object.foo('message')
+    assert_equal 'message', @object.foo('bob_message')
+  end
+  
+  def test_cache_yielded_values
+    @yielded_value = nil
+    @object.bar(1,2,3) { |a,b,c| @yielded_value = [a,b,c] }
+    assert_equal [1,2,3], @yielded_value
+    @object.bar(2,3,4) { |a,b,c| @yielded_value = [a,b,c] }
+    assert_equal [1,2,3], @yielded_value
+  end
+  
+  def test_cache_return_value_and_yield_value
+    @yielded_value = :false
+    @object.value = nil
+    assert_equal nil, @object.with_value { |val| @yielded_value = val }
+    assert_equal :false, @yielded_value
+
+    @object.value = 1
+    assert_equal nil, @object.with_value { |val| @yielded_value = val }
+    assert_equal :false, @yielded_value
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 0
-  - 0
-  version: 0.0.0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Jeremy Friesen
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-30 00:00:00 -04:00
+date: 2010-04-01 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -35,6 +35,7 @@ files:
 - Rakefile
 - VERSION
 - lib/shallow.rb
+- shallow.gemspec
 - test/helper.rb
 - test/test_shallow.rb
 has_rdoc: true