lawnchair 0.6.2 → 0.6.4

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/gizm0duck/lawnchair"
     gem.authors = ["Shane Wolf"]
     gem.add_dependency "redis", ">=0.1.2"
+    gem.add_dependency "activesupport", ">=2.3.2"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.6.2
+0.6.4

data/lawnchair.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{lawnchair}
-  s.version = "0.6.2"
+  s.version = "0.6.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Shane Wolf"]
-  s.date = %q{2010-06-03}
+  s.date = %q{2010-07-13}
   s.description = %q{Fully featured caching mechanism for arbitrary pieces of resource expensive ruby code using Redis while being able to optionally store data in the Ruby process itself for maximum efficiency.}
   s.email = %q{shanewolf@gmail.com}
   s.extra_rdoc_files = [
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lawnchair.gemspec",
+     "lib/active_record_extension.rb",
      "lib/lawnchair.rb",
      "lib/marshal_extension.rb",
      "lib/storage_engine/abstract.rb",
@@ -43,7 +44,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/gizm0duck/lawnchair}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Speed up your app by caching expensive code in Redis or in the ruby process itself}
   s.test_files = [
     "spec/lawnchair_spec.rb",
@@ -59,13 +60,16 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<redis>, [">= 0.1.2"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.2"])
     else
       s.add_dependency(%q<redis>, [">= 0.1.2"])
+      s.add_dependency(%q<activesupport>, [">= 2.3.2"])
     end
   else
     s.add_dependency(%q<redis>, [">= 0.1.2"])
+    s.add_dependency(%q<activesupport>, [">= 2.3.2"])
   end
 end
 

data/lib/active_record_extension.rb

@@ -0,0 +1,31 @@
+require 'activesupport'
+require 'activerecord'
+module ActiveRecord
+  module LawnchairExtension
+    
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods      
+      def lawnchair_cache(method, options={})
+        self.class_eval %{
+          def #{method}_with_lawnchair(*args)
+            ident = lambda { |obj| obj.class.respond_to?(:primary_key) ? obj.send(obj.class.primary_key) : obj.to_s }
+            arg_keys = args.map(&ident).join(':')
+            key = "#\{self.class.name\}:#{method}:#\{ident.call(self)\}:#\{arg_keys\}"
+            Lawnchair.cache(key, #{options.inspect}) do
+              self.#{method}_without_lawnchair(*args)
+            end
+          end
+        }
+
+        alias_method_chain method, :lawnchair
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include ActiveRecord::LawnchairExtension
+end

data/lib/lawnchair.rb

@@ -6,6 +6,7 @@ require 'storage_engine/in_process'
 require 'storage_engine/composite'
 
 if defined? RAILS_ENV
+  require 'active_record_extension'
   require 'marshal_extension' if RAILS_ENV =~ /development/
   require 'view/helper'
 end
@@ -40,4 +41,5 @@ module Lawnchair
       Lawnchair.cache(key, options, &block)
     end
   end
-end
+end
+

data/lib/storage_engine/abstract.rb

@@ -10,11 +10,15 @@ module Lawnchair
       
         def fetch(key, options={}, &block)
           if self.db_connection?
+            start_time = Time.now
             if exists?(key)
               value = get(key, options)
+              log("HIT", key, Time.now-start_time)
+              return value
             else
               value = block.call
               set(key, value, options)
+              log("MISS", key, Time.now-start_time)
               return value
             end
           else
@@ -40,6 +44,10 @@ module Lawnchair
         def db_connection?
           true
         end
+        
+        def log(message, key, elapsed)
+          ActionController::Base.logger.info("Lawnchair Cache: #{message} (%0.6f secs): #{key}" % elapsed) if defined? ::ActionController::Base
+        end
       end
     end
   end

data/lib/storage_engine/in_process.rb

@@ -25,7 +25,9 @@ module Lawnchair
         end
   
         def expire!(key)
+          start_time = Time.now
           data_store.delete(computed_key(key))
+          log("EXPIRATION", key, Time.now-start_time)
         end
       end
     end

data/lib/storage_engine/redis.rb

@@ -21,7 +21,9 @@ module Lawnchair
         end
   
         def expire!(key)
+          start_time = Time.now
           data_store.del(computed_key(key))
+          log("EXPIRATION", key, Time.now-start_time)
         end
         
         def connection_established!
@@ -32,7 +34,7 @@ module Lawnchair
           return @db_connection unless @db_connection.nil?
           verify_db_connection
         end
-        
+             
         def verify_db_connection
           begin
             data_store.info

data/spec/lawnchair_spec.rb

@@ -1,5 +1,51 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
+class Fertilize
+  attr_reader :size
+
+  def initialize(size, key)
+    @size = size
+    @key = key
+  end
+
+  def self.primary_key
+    :spread
+  end
+
+  def spread
+    @key
+  end
+end
+
+class Grass
+  include ActiveRecord::LawnchairExtension
+  attr_reader :length
+
+  def initialize
+    @length = 10
+  end
+
+  def kill
+    @length = 0
+  end
+
+  def mow
+    @length -= 1
+  end
+
+  def cut(how_much)
+    @length -= how_much
+  end
+
+  def weed(puff, *args)
+    @length -= puff.size
+  end
+
+  lawnchair_cache :mow
+  lawnchair_cache :cut
+  lawnchair_cache :weed, :expires_in => 0
+end
+
 describe "Lawnchair::Cache" do
   describe ".me" do
     it "returns the value if it exists" do
@@ -26,5 +72,87 @@ describe "Lawnchair::Cache" do
         Lawnchair.cache("mu", :in_process => true, :raw => true) { "fasa" }
       end
     end
+    
+    describe "caching a method" do
+      it "should cache the value of a method" do
+        grass = Grass.new
+        grass.mow.should == 9
+        grass.mow.should == 9
+      end
+
+      it "should cache a unique value per instance" do
+        grass = Grass.new
+        weed = Grass.new
+        weed.kill
+        grass.mow.should == 9
+        grass.mow.should == 9
+        weed.mow.should == -1
+        weed.mow.should == -1
+      end
+
+      describe "with parameters" do
+        it "caches the value by parameter value as well" do
+          grass = Grass.new
+          grass.cut(2).should == 8
+          grass.cut(1).should == 7
+          grass.cut(3).should == 4
+
+          grass.cut(1).should == 7
+          grass.cut(2).should == 8
+          grass.cut(3).should == 4
+
+          grass.length.should == 4
+        end
+      end
+      
+      describe "when the paramter is an ActiveRecord object" do
+        before do
+          @treatment1 = Fertilize.new(3, 'a')
+          @treatment2 = Fertilize.new(3, 'b')
+          @treatment3 = Fertilize.new(2, 'c')
+          @treatment1_again = Fertilize.new(187, 'a')
+          @grass = Grass.new
+        end
+        
+        it "uses the primary key in the id" do
+          @grass.weed(@treatment1).should == 7
+          @grass.weed(@treatment2).should == 4
+          @grass.weed(@treatment3).should == 2     
+               
+          @grass.weed(@treatment1).should == 7
+          @grass.weed(@treatment2).should == 4          
+          @grass.weed(@treatment3).should == 2          
+
+          @grass.weed(@treatment1_again).should == 7
+        end
+      end
+      
+      describe "when there are multiple parameters" do
+        before do
+          @treatment1 = Fertilize.new(3, 'a')
+          @grass = Grass.new
+        end
+        
+        it "takes all parameters into consideration" do
+          @grass.weed(@treatment1, [1,2,3]).should == 7
+          @grass.weed(@treatment1, [1,2]).should == 4
+          @grass.weed(@treatment1, [1,2,3]).should == 7
+          @grass.weed(@treatment1, [1,2]).should == 4
+        end
+      end
+      
+      describe "when options are passed" do
+        before do
+          @treatment1 = Fertilize.new(3, 'a')
+          @grass = Grass.new
+        end
+        
+        it "allows the same options as regular calls to Lawnchair.cache" do
+          @grass.weed(@treatment1, [1,2]).should == 7
+          sleep 1
+          @grass.weed(@treatment1, [1,2]).should == 4
+        end
+      end
+    end
   end
-end
+end

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'lawnchair'
 require 'spec'
 require 'spec/autorun'
-
+require 'active_record_extension'
 Spec::Runner.configure do |config|
   config.before(:all)   { Lawnchair.connectdb(Redis.new(:db => 11)) }
   config.before(:each)  do 

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lawnchair
 version: !ruby/object:Gem::Version 
-  version: 0.6.2
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  - 4
+  version: 0.6.4
 platform: ruby
 authors: 
 - Shane Wolf
@@ -9,19 +15,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-03 00:00:00 -07:00
+date: 2010-07-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: redis
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 1
+        - 2
         version: 0.1.2
-    version: 
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 3
+        - 2
+        version: 2.3.2
+  type: :runtime
+  version_requirements: *id002
 description: Fully featured caching mechanism for arbitrary pieces of resource expensive ruby code using Redis while being able to optionally store data in the Ruby process itself for maximum efficiency.
 email: shanewolf@gmail.com
 executables: []
@@ -38,6 +66,7 @@ files:
 - Rakefile
 - VERSION
 - lawnchair.gemspec
+- lib/active_record_extension.rb
 - lib/lawnchair.rb
 - lib/marshal_extension.rb
 - lib/storage_engine/abstract.rb
@@ -64,21 +93,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Speed up your app by caching expensive code in Redis or in the ruby process itself