lawnchair 0.6.6 → 0.6.7

data/README.rdoc

@@ -49,7 +49,25 @@ Available options:
 * :expires_in - takes a time in seconds and will be set as the ttl on the key (only works for Redis store) 
 * :raw - tells the cache not to marshall the data, if you are storing a string value, this is the way to go
 * :in_process - stores the value in memory for as long as the ruby process is running as well as in redis
+* :interpolate - allows you to cache large pieces of data but override sections of it with dynamic content
+
+== Interpolating Data
+
+Caching large pieces of the page can prove to be difficult in a highly dynamic environment. Content interpolation
+makes this easier to deal with common things such as user names, timestamps, flash messages and more.
+
+  cached_result = Lawnchair.cache("cached_time") { "current time: __TIME__" }
+  => "current time: __TIME__"
+  
+Now let's interpolate this data with dynamic content.
+
+  cached_result = Lawnchair.cache("cached_time", :interpolate => {"__TIME__" => Time.now.to_s}) { "current time: __TIME__" }
+  => "current time: Tue Aug 24 16:13:40 -0700 2010"
+  cached_result = Lawnchair.cache("cached_time", :interpolate => {"__TIME__" => Time.now.to_s}) { "current time: __TIME__" }
+  => "current time: Tue Aug 24 16:13:42 -0700 2010"
   
+Notice that the timestamp is different for each call, even though the data is coming out of the cache.
+
 == In Process Caching
 
 If you want to get really fancy you can cache the values in process as well as in Redis.  This can be a fairly significant win
@@ -89,7 +107,6 @@ If you need to flush all the values in the Redis database
 
   Lawnchair.flushdb
 
-
 == Note on Patches/Pull Requests
  
 * Fork the project.
@@ -100,3 +117,5 @@ If you need to flush all the values in the Redis database
 == Copyright
 
 Copyright (c) 2010 Shane Wolf. See LICENSE for details.
+
+Thanks to Tyler Kovacs for the inspiration for content interpolation.

data/VERSION

@@ -1 +1 @@
-0.6.6
+0.6.7

data/lawnchair.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{lawnchair}
-  s.version = "0.6.6"
+  s.version = "0.6.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Shane Wolf"]
-  s.date = %q{2010-08-10}
+  s.date = %q{2010-08-24}
   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 = [

data/lib/lawnchair.rb

@@ -21,7 +21,9 @@ module Lawnchair
       else
         store = Lawnchair::StorageEngine::Redis
       end
-      store.fetch(key, options, &block)
+      interpolate(options[:interpolate]) do
+        store.fetch(key, options, &block)
+      end
     end
 
     def connectdb(redis=nil)
@@ -31,6 +33,11 @@ module Lawnchair
     def flushdb
       redis.flushdb
     end
+    
+    def interpolate(interpolations, &block)
+      interpolations ||= {}
+      interpolations.inject(block.call){|cached_data, interpolated_data| cached_data.gsub!(interpolated_data.first, interpolated_data.last) }
+    end
   end
   
   class Cache

data/lib/storage_engine/abstract.rb

@@ -9,6 +9,7 @@ module Lawnchair
         end
       
         def fetch(key, options={}, &block)
+                    
           start_time = Time.now
           if exists?(key)
             value = get(key, options)

data/spec/lawnchair_spec.rb

@@ -47,7 +47,7 @@ class Grass
 end
 
 describe "Lawnchair::Cache" do
-  describe ".me" do
+  describe ".cache" do
     it "returns the value if it exists" do
       expected_object = [1,2,3,4]
       Lawnchair.cache("marshalled_array") { expected_object }
@@ -63,7 +63,7 @@ describe "Lawnchair::Cache" do
       Marshal.load(Lawnchair.redis["Lawnchair:marshalled_array"]).should == [1,2,3,4]
     end
     
-    describe "when in_process => true" do
+    context "when in_process => true" do
       it "fetches the value to/from the composite store" do
         mock_composite_engine = Lawnchair::StorageEngine::Composite.new
         Lawnchair::StorageEngine::Composite.stub!(:new).and_return(mock_composite_engine)
@@ -73,6 +73,33 @@ describe "Lawnchair::Cache" do
       end
     end
     
+    context "when there is content to be interpolated" do
+      context "when the key exists in the cache" do
+        before do 
+          Lawnchair.cache("mu") { "current time: __TIME__" }
+          Lawnchair.redis.exists("Lawnchair:mu").should be_true
+        end
+        
+        it "replaces the key with the given data" do
+          now = Time.now.to_s(:db)
+          cached_result = Lawnchair.cache("mu", :interpolate => {"__TIME__" => now}) { "current time: __TIME__" }
+          cached_result.should == "current time: #{now}"
+        end
+      end
+      
+      context "when the key does NOT exist in the cache" do
+        before do 
+          Lawnchair.redis.exists("mu").should be_false
+        end
+        
+        it "replaces the key with the given data" do
+          now = Time.now.to_s(:db)
+          cached_result = Lawnchair.cache("mu", :interpolate => {"__TIME__" => now}) { "current time: __TIME__" }
+          cached_result.should == "current time: #{now}"
+        end
+      end
+    end
+    
     describe "caching a method" do
       it "should cache the value of a method" do
         grass = Grass.new
@@ -105,41 +132,41 @@ describe "Lawnchair::Cache" do
         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 the parameter 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 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

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ 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 
+  config.before(:each)  do
     Lawnchair.flushdb
     abstract_store = Lawnchair::StorageEngine::Abstract
     abstract_store.data_store.keys.each {|k| abstract_store.data_store.delete(k)}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lawnchair
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: false
   segments: 
   - 0
   - 6
-  - 6
-  version: 0.6.6
+  - 7
+  version: 0.6.7
 platform: ruby
 authors: 
 - Shane Wolf
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-10 00:00:00 -07:00
+date: 2010-08-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency