lawnchair 0.5.2 → 0.5.4

data/README.rdoc

@@ -10,7 +10,7 @@ Lawnchair includes a Rails view helper that can be used to cache the rendered vi
 
 == Usage Examples
 
-All you really need to do is wrap some expensive piece of Ruby code in the Lawnchair::Cache.me method as a block and it will be evaluated and the return value will cached in the given cache key.
+All you really need to do is wrap some expensive piece of Ruby code in the Lawnchair.cache method as a block and it will be evaluated and the return value will cached in the given cache key.
 
 MAKE SURE REDIS SERVER IS RUNNING PRIOR TO TRYING ANYTHING BELOW!!!
 
@@ -24,7 +24,7 @@ This will connect to a default database on localhost, if you want to connect to
 
 Obligatory example:
   
-  Lawnchair::Cache.me("cache_key2") do
+  Lawnchair.cache("cache_key2") do
     # ideally this would be something a little more computationally expensive, but sleep will have to do
     (1..3).inject([]) do
       |set, i| set << Time.now.strftime("%H:%M:%S")
@@ -41,7 +41,7 @@ Now, since it is cached, any time this block method is called (for the next 60 m
 
 If an hour is too long, or short for the cache key expiration you can set that to anything you want using the :expires_in hash key and entering a time in seconds
 
-  Lawnchair::Cache.me("cache_key", :expires_in => 1.day) do
+  Lawnchair.cache("cache_key", :expires_in => 1.day) do
     # expensive code to be cached for 24 hours
   end
   
@@ -55,7 +55,7 @@ Available options:
 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
 if you are running the Redis server on a different physical machine as all network latency is taken out of the equation, especially if you are hitting a cache key many times on the same request.  Also, it's probably best not to store TONS of keys in there, as your ruby process can bloat fairly quickly if you put everything in there.  Also, these will persist as long as the process is running, unless you manually expire it.
 
-  Lawnchair::Cache.me("cache_key3", :in_process => true) do
+  Lawnchair.cache("cache_key3", :in_process => true) do
     # expensive code to be cached in process AND in redis
   end
   

data/VERSION

@@ -1 +1 @@
-0.5.2
+0.5.4

data/lawnchair.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{lawnchair}
-  s.version = "0.5.2"
+  s.version = "0.5.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Shane Wolf"]

data/lib/lawnchair.rb

@@ -11,8 +11,10 @@ if defined? RAILS_ENV
 end
 
 module Lawnchair
-  class Cache
-    def self.me(key, options={}, &block)
+  class << self
+    attr_reader :redis
+    
+    def cache(key, options={}, &block)
       if options[:in_process]
         store = Lawnchair::StorageEngine::Composite.new(:in_process, :redis)
       else
@@ -20,10 +22,6 @@ module Lawnchair
       end
       store.fetch(key, options, &block)
     end
-  end
-  
-  class << self
-    attr_reader :redis
 
     def connectdb(redis=nil)
       @redis = (redis || Redis.new(:db => 11))
@@ -33,4 +31,12 @@ module Lawnchair
       redis.flushdb
     end
   end
+  
+  class Cache
+    # <b>DEPRECATED:</b> Please use <tt>Lawnchair.cache</tt> instead.
+    def self.me(key, options={}, &block)
+      warn "[DEPRECATION] 'Lawnchair::Cache.me' is deprecated.  Please use 'Lawnchair.cache' instead."
+      Lawnchair.cache(key, options, &block)
+    end
+  end
 end

data/lib/view/helper.rb

@@ -3,7 +3,7 @@ module Lawnchair
   module View
     module Helper
       def lawnchair_cache(key, &block)
-        rendered_value = Lawnchair::Cache.me(key, :raw => true) do
+        rendered_value = Lawnchair.cache(key, :raw => true) do
           capture(&block)
         end
         concat(rendered_value)

data/spec/lawnchair_spec.rb

@@ -4,15 +4,15 @@ describe "Lawnchair::Cache" do
   describe ".me" do
     it "returns the value if it exists" do
       expected_object = [1,2,3,4]
-      Lawnchair::Cache.me("marshalled_array") { expected_object }
+      Lawnchair.cache("marshalled_array") { expected_object }
       
-      x = Lawnchair::Cache.me("marshalled_array") { "JUNK DATA" }
+      x = Lawnchair.cache("marshalled_array") { "JUNK DATA" }
       x.should == expected_object
     end
     
     it "marshalls the object into redis" do
       expected_object = [1,2,3,4]
-      Lawnchair::Cache.me("marshalled_array") { expected_object }
+      Lawnchair.cache("marshalled_array") { expected_object }
       
       Marshal.load(Lawnchair.redis["Lawnchair:marshalled_array"]).should == [1,2,3,4]
     end
@@ -23,7 +23,7 @@ describe "Lawnchair::Cache" do
         Lawnchair::StorageEngine::Composite.stub!(:new).and_return(mock_composite_engine)
         
         mock_composite_engine.should_receive(:fetch)
-        Lawnchair::Cache.me("mu", :in_process => true, :raw => true) { "fasa" }
+        Lawnchair.cache("mu", :in_process => true, :raw => true) { "fasa" }
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: lawnchair
 version: !ruby/object:Gem::Version 
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors: 
 - Shane Wolf