cache_replace 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTFlYjk2NzQ1NGE4YWVlOWQ0ODUwMTBiZmY5MjZjN2Q1NzQ0MDlhMw==
-  data.tar.gz: !binary |-
-    NGE2MzkxNzJkMjAxYjliMWE5Y2Q3YmFlOGY1M2I0ZTZhNWFhNDhkZA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NzVhNGYzNjljMDhhYjQ1OGM4YjljMDM4ZmY1MjhhODNjYTQxMTJhZTQwMDNl
-    Yjc1MzU3NDE3NDU4MDkxY2MwZjU0NDkyZWMwYjQ4MzcwZWQwZWVkYTBhNjM3
-    OWE5NWE2MzI0ZjQ1Njc0YjRmZTRmODE0ODdhMThlNDNhNWZiOGE=
-  data.tar.gz: !binary |-
-    MDE4Yzg2MGY1Y2VmNTBjZDI1YTc1MWI5NzJjMmUwYjEzMTg0NGVhZDEwN2Jl
-    OWFlODZjNzJhMGJmNjE0MTNjZDllM2QzZWE0ZGQ4YmI5ZGRmMzU3YzAzYzNi
-    MTdkZGE0MzdmYjgzYWEwN2I2ZTJiYjgwYTk0YTg5NTZlOGJmY2Y=
+SHA1:
+  metadata.gz: 1fdfb8b93279830fbfaf4e14856028a4fd8cfea9
+  data.tar.gz: cb6b4afa1b7309bc9d2bc8627a46858288b94706
+SHA512:
+  metadata.gz: 3e5d137737c96f4d19e12947f9bbf45397520b2447def412b9bfc0ffbe939ba292e445f8c7cf2c1297ebd97441eff6400b04884ef1b0eeb19fde22ecf2baed8a
+  data.tar.gz: defef139ad82c419deaa67d0d7addddfbfca095d9b9c41f0eb5f4e97a586e1009398df972683092050c86d1871c59c389c3b4bdc4b06e20ad745ed08726f5451

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+

data/README.md

@@ -1,34 +1,40 @@
+[![Build Status](https://api.travis-ci.org/teeparham/cache_replace.png)](https://travis-ci.org/teeparham/cache_replace)
+
 # Rails rendering extension for more server-side html caching
 
 ## Why do I need this?
 
-To squeeze the last drop out of server-side HTML caching in Rails. Use this only after you have configured as
-much in-memory caching as possible using standard techniques such as Russian Doll caching.
+To improve fragment caching efficiency in Rails by only caching the things that change. 
+Use this gem after you have configured as much in-memory caching as possible using standard techniques such as Russian Doll caching.
 
 ## Install
 
 Add this line to your Gemfile:
 
-    gem 'cache_replace'
+```ruby
+gem 'cache_replace'
+```
 
 Add this line to a helper file, likely your ApplicationHelper:
 
-    include CacheReplace
+```ruby
+include CacheReplace
+```
 
 ## Use
 
 This gem allows you to easily cache a partial of static html and replace inner dynamic html. Here is an example
-scenario where this is helpful:
+scenario:
 
 You have some html that would be cached, except for some uncacheable code nested in the DOM. For example:
 
 ##### file.html.haml:
-```
+```haml
 = render 'container'
 ```
 
 ##### _container.html.haml:
-```
+```haml
 .lots
   .of
     .htmls
@@ -36,19 +42,19 @@ You have some html that would be cached, except for some uncacheable code nested
 ```
 
 ##### _dynamic.html.haml:
-```
+```haml
 = complicated_uncacheable_stuff
 ```
 
-Sad times. You can't cache anything without resorting to madness. Oh snap! But you can:
+In the scenario above, you can't cache anything without resorting to madness. With `cache_replace`, you can:
 
 ##### file.html.haml:
-```
+```haml
 = render_cached 'container', replace: 'dynamic'
 ```
 
 ##### _container.html.haml:
-```
+```haml
 - cache "container" do
   .lots
     .of
@@ -57,14 +63,14 @@ Sad times. You can't cache anything without resorting to madness. Oh snap! But y
 ```
 
 ##### _dynamic.html.haml:
-```
+``` haml
 = complicated_uncacheable_stuff
 ```
 
-In the above example, you could also remove the `_dynamic.html.haml` file and do this:
+In the above example, you could also remove the `_dynamic.html.haml` file like so:
 
 ##### file.html.haml:
-```
+```haml
 = render_cached 'container', replace: {dynamic: complicated_uncacheable_stuff}
 ```
 
@@ -85,13 +91,13 @@ render_cached "container", replace: ["inner"]
 
 #### Map of keys to replace with values
 ```ruby
-render_cached "container", replace: {special_link: special_link(object)}
+render_cached "container", replace: {key_name: a_helper_method(object)}
 ```
 
 #### Yield to a hash of keys to replace with values
 ```ruby
 render_cached "container" do
-  {special_link: special_link(object)}
+  {key_name: a_helper_method(object)}
 end
 ```
 

data/cache_replace.gemspec

@@ -24,6 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "test-unit", ">= 2.5"
   spec.add_development_dependency "mocha", ">= 0.13"
-  spec.add_development_dependency "shoulda", ">= 3.3"
+  spec.add_development_dependency "shoulda-context"
   spec.add_development_dependency "pry", ">= 0.9"
 end

data/lib/cache_replace/version.rb

@@ -1,3 +1,3 @@
 module CacheReplace
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/cache_replace.rb

@@ -3,7 +3,8 @@ require 'cache_replace/version'
 module CacheReplace
   # Supports 4 options:
   #
-  # 1. Single partial to replace
+  # 1. Single partial to replace. 
+  #    "inner" is the key name and "_inner.*" is the partial file name.
   #
   #   render_cached "container", replace: "inner"
   #
@@ -13,12 +14,12 @@ module CacheReplace
   #
   # 3. Map of keys to replace with values
   #
-  #   render_cached "container", replace: {special_link: special_link(object)}
+  #   render_cached "container", replace: {key_name: a_helper_method(object)}
   #
   # 4. Yield to a hash of keys to replace with values
   #
   #   render_cached "container" do
-  #     {special_link: special_link(object)}
+  #     {key_name: a_helper_method(object)}
   #   end
   #
   def render_cached(static_partial, options={})
@@ -53,7 +54,7 @@ private
 
   def replace_from_hash(fragment, hash)
     hash.each do |key, value|
-      fragment.sub! cache_replace_key(key), value
+      fragment.sub! cache_replace_key(key), value.to_s
     end
   end
 end

data/test/cache_replace_test.rb

@@ -46,6 +46,10 @@ class CacheReplaceTest < Test::Unit::TestCase
     should "render with map of keys" do
       assert_equal "Fanny pack keytar viral mustache.", @renderer.render_cached("container", replace: {inner: "keytar"})
     end
+    
+    should "render with map of keys with a nil value" do
+      assert_equal "Fanny pack  viral mustache.", @renderer.render_cached("container", replace: {inner: nil})
+    end    
 
     should "render with hash block" do
       output = @renderer.render_cached("container") do

data/test/test_helper.rb

@@ -1,5 +1,5 @@
 require 'test/unit'
-require 'shoulda'
+require 'shoulda-context'
 require 'mocha/setup'
 require 'cache_replace'
-require 'pry'
+require 'pry'

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: cache_replace
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tee Parham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-19 00:00:00.000000000 Z
+date: 2013-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '2.5'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: shoulda-context
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Rails rendering extension for more server-side html caching
@@ -116,6 +116,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -135,12 +137,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []