cache_rocket 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 864c56c4f67471c61a8bb9dbea603410616d3fb6
-  data.tar.gz: f39b92cc8432727cf11e305e87c9820885472491
+  metadata.gz: 02591106ca977ec2f38b633c6003fbbe730d7714
+  data.tar.gz: 61d116127812127f1eceb606b2af0fca5f83acfb
 SHA512:
-  metadata.gz: 8ef3d5ebf32c1010b0c928c7b1daf55ded395ca1c6a0bd6a378bc790c4760ac7380ec6d52baf07348f251ee380420e91a028fb4e70071f1fb1996d1a77081065
-  data.tar.gz: 105657511b52018069395a9fe968e1f7202280b6fbe95301350ebebe03e297f29a3bb270d7565dbc6a89f881c7b5e09ffd599c94be8624d24ea544d17a45ee99
+  metadata.gz: fd1fca1866a158eae06686d10f73ab57de4eee8fb5d2ca593c215ef80b37258cfdb608998bd1476164a12bf433d634313015fb5486e329409b56f494c51be7dc
+  data.tar.gz: 1a227ce2c6238563950171be071e3d1027e4dc148ad2e4c50b806c8c2a781a3ab8d23e2ab06b6ee0bc971a8c134757a9913d2c0e6d295b6b088e9a1411a541fe

data/README.md

@@ -1,11 +1,9 @@
 [![Gem Version](https://badge.fury.io/rb/cache_rocket.png)][gem]
 [![Build Status](https://api.travis-ci.org/teeparham/cache_rocket.png)][build]
-[![Coverage Status](https://coveralls.io/repos/teeparham/cache_rocket.badge.png)][coverage]
 [![Code Climate](https://codeclimate.com/github/teeparham/cache_rocket.png)][climate]
 
 [gem]: http://badge.fury.io/rb/cache_rocket
 [build]: https://travis-ci.org/teeparham/cache_rocket
-[coverage]: https://coveralls.io/r/teeparham/cache_rocket
 [climate]: https://codeclimate.com/github/teeparham/cache_rocket
 
 # Rails rendering extension for server-side html caching
@@ -31,10 +29,10 @@ include CacheRocket
 
 ## Use
 
-This gem allows you to easily cache a partial of static html and replace inner dynamic html. Here is an example
+This gem allows you to cache a partial of static html and replace inner dynamic html. Here is an example
 scenario:
 
-You have some html that would be cached, except for some uncacheable code nested in the DOM. For example:
+You have some html that you would like to cache, but cannot because of some uncacheable code nested in the DOM. For example:
 
 ##### file.html.haml:
 ```haml
@@ -79,12 +77,12 @@ In the above example, you could also remove the `_dynamic.html.haml` file like s
 
 ##### file.html.haml:
 ```haml
-= render_cached 'container', replace: {dynamic: complicated_uncacheable_stuff}
+= render_cached 'container', replace: { dynamic: complicated_uncacheable_stuff }
 ```
 
 ## Options
 
-`render_cached` provides 4 calling styles:
+`render_cached` provides several calling styles:
 
 #### Single partial to replace
 
@@ -94,18 +92,31 @@ render_cached "container", replace: "inner"
 
 #### Array of partials to replace
 ```ruby
-render_cached "container", replace: ["inner"]
+render_cached "container", replace: ["inner", "footer"]
 ```
 
-#### Map of keys to replace with values
+#### Hash of keys to replace with values
 ```ruby
-render_cached "container", replace: {key_name: a_helper_method(object)}
+render_cached "container", replace: { key_name: a_helper_method(object) }
 ```
 
-#### Yield to a hash of keys to replace with values
+#### Block containing a hash of keys to replace with values
 ```ruby
 render_cached "container" do
-  {key_name: a_helper_method(object)}
+  { key_name: a_helper_method(object) }
+end
+```
+
+#### Render a collection with hash of keys, using a Proc for each collection item
+```ruby
+render_cached "container", collection: objects,
+  replace: { key_name: ->(object){ a_helper_method(object) } }
+```
+
+#### Render a collection with block syntax
+```ruby
+render_cached "container", collection: objects do
+  { key_name: ->(object){ a_helper_method(object) } }
 end
 ```
 

data/lib/cache_rocket.rb

@@ -34,24 +34,20 @@ module CacheRocket
   #   render_cached "partial", collection: objects, replace: { key_name: ->(object){a_method(object)} }
   #
   def render_cached(partial, options={})
-    replace = options.delete(:replace)
+    replace_hash = options.delete(:replace)
     collection = options.delete(:collection)
 
     fragment = Fragment.new(render(partial, options))
 
-    case replace
+    case replace_hash
     when Hash
-      if collection
-        fragment.replace_collection collection, replace
-      else
-        fragment.replace_from_hash replace
-      end
+      fragment.replace replace_hash, collection
     when NilClass
       raise ArgumentError.new(ERROR_MISSING_KEY_OR_BLOCK) unless block_given?
-      fragment.replace_from_hash yield
+      fragment.replace yield, collection
     else
-      replace = *replace
-      replace.each do |key|
+      key_array = *replace_hash
+      key_array.each do |key|
         fragment.gsub! cache_replace_key(key), render(key, options)
       end
     end

data/lib/cache_rocket/fragment.rb

@@ -16,6 +16,16 @@ module CacheRocket
       self.value.gsub! key, value
     end
 
+    def replace(hash, collection)
+      if collection
+        replace_collection collection, hash
+      else
+        replace_from_hash hash
+      end
+    end
+
+  private
+
     def replace_from_hash(hash)
       hash.each do |key, value|
         gsub! cache_replace_key(key), value.to_s
@@ -32,8 +42,6 @@ module CacheRocket
       self.value = html
     end
 
-  private
-
     def replace_item_hash(item, hash)
       item_fragment = self.value.dup
 

data/lib/cache_rocket/version.rb

@@ -1,3 +1,3 @@
 module CacheRocket
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/cache_rocket_test.rb

@@ -79,7 +79,19 @@ class CacheRocketTest < Test::Unit::TestCase
       assert_equal "Hi Snoop.Hi Boo.",
         @renderer.render_cached("partial", collection: dogs, replace: {dog: ->(dog){dog_name(dog)} })
     end
-    
+
+    should "replace collection using hash block with Proc" do
+      def dog_name(dog) dog end
+      @renderer.stubs(:render).with("partial", {}).returns "Hi #{@renderer.cache_replace_key(:dog)}."
+      dogs = %w[Snoop Boo]
+
+      rendered = @renderer.render_cached("partial", collection: dogs) do
+        { dog: ->(dog){dog_name(dog)} }
+      end
+
+      assert_equal "Hi Snoop.Hi Boo.", rendered
+    end
+
     should "raise ArgumentError with invalid syntax" do
       @renderer.stubs(:render).with("container").returns("")
       assert_raise(ArgumentError) do

data/test/fragment_test.rb

@@ -9,32 +9,30 @@ module CacheRocket
     end
 
     context "#gsub!" do
-      should "gsub value" do
+      should "substitute value" do
         fragment = Fragment.new("hello there, hello.")
         assert_equal "yo there, yo.", fragment.gsub!("hello", "yo")
       end
     end
 
-    context "#replace_from_hash" do
-      should "replace cache keys" do
+    context "#replace" do
+      should "replace cache keys from hash" do
         cr_key = Fragment.new(nil).cache_replace_key(:xx)
         fragment = Fragment.new("hey #{cr_key} hey.")
-        fragment.replace_from_hash(xx: "yo")
+        fragment.replace({xx: "yo"}, nil)
         assert_equal "hey yo hey.", fragment.value
       end
-    end
 
-    context "#replace_collection" do
-      should "replace with Proc" do
+      should "replace collection with Proc" do
         def last5(object)
           object.last(5)
         end
-        replace_hash = { something: ->(obj){ last5(obj)} }
+        replace_hash = { something: ->(object){ last5(object)} }
         collection = %w[xxTiger xxSkunk]
         cr_key = Fragment.new(nil).cache_replace_key(:something)
         fragment = Fragment.new("hey #{cr_key} hey.")
         assert_equal "hey Tiger hey.hey Skunk hey.",
-          fragment.replace_collection(collection, replace_hash)
+          fragment.replace(replace_hash, collection)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_rocket
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Tee Parham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-30 00:00:00.000000000 Z
+date: 2013-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack