cache_rocket 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 378ac5399bdb7f58e8c5b3dfeaea5a76c4369997
-  data.tar.gz: 6d0835c56392e598f0b2fff73c6296bb25efd2be
+  metadata.gz: 127bbbf2d03cd8f29d2fbf71eabe3f80f218088c
+  data.tar.gz: 231d24676b56a959e4fb988df98c9891098b7f16
 SHA512:
-  metadata.gz: 85ff2503338f81cc30a5f9ccb68917e1ff9cd3395294ae7a51503c6f4e46920d25b76d84d5d0ee87277b9a134eb2d603e235cbdcd416f247c454ecb8e01dcdaf
-  data.tar.gz: 47af1c4e271361ae739086a237c574d5bca195eee62ea06557d417db16c2c10a62b405e94b47d7e01c7b7e9bec1d7218dec268a409d5125d90075ab2263cdfd6
+  metadata.gz: df4ca70e460b54af44adb5539378b895e6dc86b384e8b3dd3b2024be7b2dd648105ca833bfee2f7ea10d029105623d81f1a8f5ba50fd9610c126946a92374db9
+  data.tar.gz: dc06d403bdb980ff4c3ca0c80ab5ef3e098fdfdaa18f8d22f1f2f409887ad4968d282b106b203044d312f15544751ec45b1ab2fa17416fe227f158c9357792f5

data/README.md

@@ -22,7 +22,7 @@ Add the gem to your Gemfile:
 gem 'cache_rocket'
 ```
 
-Include the CacheRocket module so your views can use the `render_cached` method.
+Include the CacheRocket module so your views can use the `cache_replace` and `render_cached` methods.
 Most likely you would put this in your `ApplicationHelper`:
 
 ```ruby
@@ -32,11 +32,11 @@ include CacheRocket
 ## Use
 
 CacheRocket allows you to cache a fragment of html and replace inner html.
-You inject dynamic content into a static, cached outer partial.
+You inject dynamic content into a cached fragment that contains a placeholder.
 
 ### `cache_replace`
 
-The simplest usage is inline with the `cache_replace` helper. It works
+The simplest usage is inline with the `cache_replace` method. It works
 like Rails' `cache` method, plus it replaces content that you do not want
 to cache because it is impractical or inefficient.
 
@@ -45,19 +45,24 @@ For example:
 #### Before
 
 ```haml
-.htmls
+.lots.of.htmls
   = Time.now
+.more.htmls
+  = user.name
 ```
 
 #### After
 
 ```haml
-- cache_replace("the-time", replace: { time: Time.now }) do
-  .htmls
+- cache_replace("some-key", replace: { time: Time.now, name: user.name }) do
+  .lots.of.htmls
     = cache_replace_key :time
+  .more.htmls
+    = cache_replace_key :name
 ```
 
-Now the fragment is cached once with a placeholder, and the time is always replaced when rendered.
+Now the fragment is cached once with placeholders, and the time and user name are 
+replaced when rendered.
 
 Obviously, the above example is contrived and would not result in any
 performance benefit. When the block of html you are rendering is large,
@@ -168,14 +173,14 @@ render_cached 'outer', replace: ['inner', 'footer']
 #### Hash of keys to replace with values
 
 ```ruby
-render_cached 'outer', replace: { key_name: a_helper_method(object) }
+render_cached 'outer', replace: { key_name: a_method(object) }
 ```
 
 #### Block containing a hash of keys to replace with values
 
 ```ruby
 render_cached 'outer' do
-  { key_name: a_helper_method(object) }
+  { key_name: a_method(object) }
 end
 ```
 
@@ -183,14 +188,14 @@ end
 
 ```ruby
 render_cached 'outer', collection: objects,
-  replace: { key_name: -> (object) { a_helper_method(object) } }
+  replace: { key_name: -> (object) { a_method(object) } }
 ```
 
 #### Render a collection with block syntax
 
 ```ruby
 render_cached 'outer', collection: objects do
-  { key_name: -> (object) { a_helper_method(object) } }
+  { key_name: -> (object) { a_method(object) } }
 end
 ```
 
@@ -199,7 +204,7 @@ end
 ```ruby
 render_cached 'outer', collection: objects do
   {
-    key_1: -> (object) { a_helper_method(object) },
+    key_1: -> (object) { a_method(object) },
     key_2: -> (item) { item.name },
   }
 end

data/lib/cache_rocket/fragment.rb

@@ -5,7 +5,7 @@ module CacheRocket
     include Key
 
     def initialize(value)
-      @value = value
+      @value = value.to_s.dup
     end
 
     def to_s

data/lib/cache_rocket/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CacheRocket
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cache_rocket
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Tee Parham