cache_rocket 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02591106ca977ec2f38b633c6003fbbe730d7714
-  data.tar.gz: 61d116127812127f1eceb606b2af0fca5f83acfb
+  metadata.gz: f75dd60c6e5762540a56e4a7085162a9c74f102b
+  data.tar.gz: 14af9f5f4e9d64c1181b4f07eb6605b2d004a7bf
 SHA512:
-  metadata.gz: fd1fca1866a158eae06686d10f73ab57de4eee8fb5d2ca593c215ef80b37258cfdb608998bd1476164a12bf433d634313015fb5486e329409b56f494c51be7dc
-  data.tar.gz: 1a227ce2c6238563950171be071e3d1027e4dc148ad2e4c50b806c8c2a781a3ab8d23e2ab06b6ee0bc971a8c134757a9913d2c0e6d295b6b088e9a1411a541fe
+  metadata.gz: b960decd0407c187ea85ba06acfdfbd8f6f66292191f7c7837b893363cd3f91e84b2f272388cb910101a4f6e7e0198de12233c42c693c1a746c7a13143d7d84b
+  data.tar.gz: c37b830692708e77e91e350f0c8986d95eb90b40900814f29132256fbe48c85b526d865684673267432b3c501f41ec484008d2813a78a0c9e170cd42b110c607

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0
+ruby-2.1.0

data/.travis.yml

@@ -2,4 +2,4 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-
+  - 2.1.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Tee Parham
+Copyright (c) 2013 Neighborland, Inc.
 
 MIT License
 

data/README.md

@@ -1,19 +1,21 @@
 [![Gem Version](https://badge.fury.io/rb/cache_rocket.png)][gem]
-[![Build Status](https://api.travis-ci.org/teeparham/cache_rocket.png)][build]
-[![Code Climate](https://codeclimate.com/github/teeparham/cache_rocket.png)][climate]
+[![Build Status](https://api.travis-ci.org/neighborland/cache_rocket.png)][build]
+[![Coverage Status](https://coveralls.io/repos/neighborland/cache_rocket/badge.png)][coverage]
+[![Code Climate](https://codeclimate.com/github/neighborland/cache_rocket.png)][climate]
 
 [gem]: http://badge.fury.io/rb/cache_rocket
-[build]: https://travis-ci.org/teeparham/cache_rocket
-[climate]: https://codeclimate.com/github/teeparham/cache_rocket
+[build]: https://travis-ci.org/neighborland/cache_rocket
+[coverage]: https://coveralls.io/r/neighborland/cache_rocket
+[climate]: https://codeclimate.com/github/neighborland/cache_rocket
 
-# Rails rendering extension for server-side html caching
+## Rails rendering extension for server-side html caching
 
-## Why do I need this?
+CacheRocket improves fragment caching efficiency in Rails. 
+CacheRocket allows caching more generic html fragments and allowing the contents of the cached fragments 
+to be replaced with dynamic content. 
+CacheRocket is a technique that may be used with other Rails caching strategies such as Russian Doll caching.
 
-To improve fragment caching efficiency in Rails by only caching the things that change.
-CacheRocket may be used in with other Rails caching strategies such as Russian Doll caching.
-
-## Install
+### Install
 
 Add this line to your Gemfile:
 
@@ -27,12 +29,12 @@ Add this line to a helper file, likely your ApplicationHelper:
 include CacheRocket
 ```
 
-## Use
+### Use
 
-This gem allows you to cache a partial of static html and replace inner dynamic html. Here is an example
-scenario:
+This gem allows you to cache a fragment of html and replace inner html. You cache the donut and replace the donut hole.
 
-You have some html that you would like to cache, but cannot because of some uncacheable code nested in the DOM. For example:
+Assume 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
@@ -44,86 +46,159 @@ You have some html that you would like to cache, but cannot because of some unca
 .lots
   .of
     .htmls
-      = render 'dynamic'
+      = render 'inner'
 ```
 
-##### _dynamic.html.haml:
+##### _inner.html.haml:
 ```haml
 = complicated_uncacheable_stuff
 ```
 
-In the scenario above, you can't cache anything. With `cache_rocket`, you can:
+In the scenario above, you can't cache anything. With `cache_rocket`, you can. Replace `render`
+with `render_cached` in `file`, specify the partial to replace in `container`, and cache `container`:
 
 ##### file.html.haml:
 ```haml
-= render_cached 'container', replace: 'dynamic'
+= render_cached 'container', replace: 'inner'
 ```
 
 ##### _container.html.haml:
 ```haml
-- cache "container" do
+- cache 'container' do
   .lots
     .of
       .htmls
-        = cache_replace_key 'dynamic'
+        = cache_replace_key 'inner'
 ```
 
-##### _dynamic.html.haml:
+##### _inner.html.haml:
 ``` haml
 = complicated_uncacheable_stuff
 ```
 
-In the above example, you could also remove the `_dynamic.html.haml` file like so:
+In this example, you could remove the `_inner.html.haml` file altogether, like so:
 
 ##### file.html.haml:
 ```haml
-= render_cached 'container', replace: { dynamic: complicated_uncacheable_stuff }
+= render_cached 'container', replace: { inner: complicated_uncacheable_stuff }
 ```
 
-## Options
+##### _container.html.haml:
+```haml
+- cache 'container' do
+  .lots
+    .of
+      .htmls
+        = cache_replace_key 'inner'
+```
+
+### Options
 
-`render_cached` provides several calling styles:
+`render_cached` supports several styles of arguments:
 
 #### Single partial to replace
 
 ```ruby
-render_cached "container", replace: "inner"
+render_cached 'container', replace: 'inner'
 ```
 
 #### Array of partials to replace
 ```ruby
-render_cached "container", replace: ["inner", "footer"]
+render_cached 'container', replace: ['inner', 'footer']
 ```
 
 #### 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) }
 ```
 
 #### Block containing a hash of keys to replace with values
 ```ruby
-render_cached "container" do
+render_cached 'container' do
   { 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,
+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
+render_cached 'container', collection: objects do
   { key_name: ->(object){ a_helper_method(object) } }
 end
 ```
 
-## Contribute
+### YMMV
+
+`cache_rocket` is not magic. It should not be used in all situations.
+Benchmark your page load times before and after to see if it helps.
+
+### Benefits
+
+#### More server-side caching
+
+See the example above.
+
+#### Use far less memory
+
+Typically, one would key the `users/bio` partial on the `user` object like so:
+
+##### users/bio.haml:
+```haml
+- cache [user, 'bio'] do
+  .lots-of-htmls
+    = user.bio
+```
+
+```haml
+= render 'users/bio'
+```
+
+With 1000 users, there are 1000 cached items. This can use a lot of memory.
+Instead we can cache the `users/bio` partial once and replace the content we need using
+`cache_replace`. With 1000 users, we use 1/1000th the memory.
+
+##### users/bio.haml:
+```haml
+- cache('users/bio') do
+  .lots-of-htmls
+    = cache_replace_key :bio
+```
+
+```haml
+= render_cached 'users/bio', replace: { bio: user.bio }
+```
+
+#### Simpler cache keys
+
+If you have a cache key containing multiple models, it will generally be very inefficient:
+```haml
+- cache(user, other_user) do
+  = render 'common_interests'
+```
+
+If the cached content is rarely retrieved, `cache_replace` can help:
+
+```haml
+- cache('common_interests') do
+  .htmls
+    = cache_replace_key :something
+```
+
+```haml
+= render 'common_interests', replace: { something: 'common_interests/inner' }
+```
+
+#### Faster first page loads
+
+By caching common html, you ensure that you will render cached content the first time a model-dependent
+fragment is rendered. See the `Use far less memory` section above for an example.
+
+### References
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+* Slides from Boulder Ruby presentation: http://www.slideshare.net/teeparham/rails-html-fragment-caching-with-cache-rocket
+* Rails cache benchmark test app: https://github.com/teeparham/cache_benchmark

data/cache_rocket.gemspec

@@ -10,18 +10,19 @@ Gem::Specification.new do |spec|
   spec.email         = ["tee@neighborland.com"]
   spec.description   = %q{Rails rendering extension for server-side html caching}
   spec.summary       = %q{Rails rendering extension for server-side html caching}
-  spec.homepage      = "https://github.com/teeparham/cache_rocket"
+  spec.homepage      = "https://github.com/neighborland/cache_rocket"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
   spec.test_files    = `git ls-files -- {test}/*`.split("\n")
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 1.9.3"
+
   spec.add_dependency "actionpack", ">= 3.2"
 
-  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-context"
-  spec.add_development_dependency "pry", ">= 0.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha", "~> 1.0"
+  spec.add_development_dependency "pry", "~> 0.9"
 end

data/lib/cache_rocket/fragment.rb

@@ -45,8 +45,8 @@ module CacheRocket
     def replace_item_hash(item, hash)
       item_fragment = self.value.dup
 
-      hash.each do |key, value|
-        item_fragment.gsub! cache_replace_key(key), value.call(item)
+      hash.each do |key, proc|
+        item_fragment.gsub! cache_replace_key(key), proc.call(item)
       end
 
       item_fragment

data/lib/cache_rocket/version.rb

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

data/test/cache_rocket_test.rb

@@ -1,37 +1,37 @@
 require 'test_helper'
 
-class CacheRocketTest < Test::Unit::TestCase
+class CacheRocketTest < MiniTest::Spec
   class FakeRenderer
     include CacheRocket
   end
 
-  setup do
+  before do
     @renderer = FakeRenderer.new
   end
 
-  context "#cache_replace_key" do
-    should "return key with prefix" do
+  describe "#cache_replace_key" do
+    it "return key with prefix" do
       assert_equal CacheRocket::CACHE_REPLACE_KEY_OPEN + "some/thing>", @renderer.cache_replace_key("some/thing")
     end
   end
 
-  context "#render_cached" do
-    setup do
+  describe "#render_cached" do
+    before do
       @renderer.stubs(:render).with("container", {}).returns "Fanny pack #{@renderer.cache_replace_key('inner')} viral mustache."
       @renderer.stubs(:render).with("inner", {}).returns "quinoa hoodie"
     end
 
-    should "render with single partial" do
+    it "render with single partial" do
       assert_equal "Fanny pack quinoa hoodie viral mustache.", @renderer.render_cached("container", replace: "inner")
     end
 
-    should "pass options to inner render" do
+    it "pass options to inner render" do
       @renderer.expects(:render).with("container", variable: "x").returns ""
       @renderer.expects(:render).with("inner", variable: "x").returns ""
       @renderer.render_cached("container", variable: "x", replace: "inner")
     end
 
-    should "render with array of partials" do
+    it "render with array of partials" do
       @renderer.stubs(:render).with("container", {}).
         returns "#{@renderer.cache_replace_key('inner')} #{@renderer.cache_replace_key('other')} viral mustache."
       @renderer.stubs(:render).with("other", {}).returns "high life"
@@ -40,22 +40,22 @@ class CacheRocketTest < Test::Unit::TestCase
         @renderer.render_cached("container", replace: ["inner", "other"])
     end
 
-    should "render with map of keys" do
+    it "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
+    it "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
+    it "render with hash block" do
       output = @renderer.render_cached("container") do
         {inner: "keytar"}
       end
       assert_equal "Fanny pack keytar viral mustache.", output
     end
 
-    should "replace every instance of key in inner partial" do
+    it "replace every instance of key in inner partial" do
       @renderer.stubs(:render).with("container", {}).
         returns "#{@renderer.cache_replace_key('inner')} #{@renderer.cache_replace_key('inner')} viral mustache."
 
@@ -63,7 +63,7 @@ class CacheRocketTest < Test::Unit::TestCase
         @renderer.render_cached("container", replace: "inner")
     end
 
-    should "replace every instance of the keys with hash values" do
+    it "replace every instance of the keys with hash values" do
       @renderer.stubs(:render).with("container", {}).
         returns "I like #{@renderer.cache_replace_key('beer')}, #{@renderer.cache_replace_key('beer')} and #{@renderer.cache_replace_key('food')}."
 
@@ -71,30 +71,46 @@ class CacheRocketTest < Test::Unit::TestCase
          @renderer.render_cached("container", replace: {food: "chips", beer: 'stout'})
     end
 
-    should "replace collection with Proc in replace key" do
+    it "replace collection with Proc in replace key" do
       def dog_name(dog) dog end
+
       @renderer.stubs(:render).with("partial", {}).returns "Hi #{@renderer.cache_replace_key(:dog)}."
       dogs = %w[Snoop Boo]
 
       assert_equal "Hi Snoop.Hi Boo.",
-        @renderer.render_cached("partial", collection: dogs, replace: {dog: ->(dog){dog_name(dog)} })
+        @renderer.render_cached("partial", collection: dogs, replace: {dog: ->(dog) { dog_name(dog) } })
     end
 
-    should "replace collection using hash block with Proc" do
+    it "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)} }
+        { dog: ->(dog) { dog_name(dog) } }
       end
 
       assert_equal "Hi Snoop.Hi Boo.", rendered
     end
 
-    should "raise ArgumentError with invalid syntax" do
+    it "replace collection with multiple procs" do
+      def dog_name(dog) dog end
+      def reverse(dog) dog.reverse end
+
+      @renderer.stubs(:render).with("partial", {}).returns "#{@renderer.cache_replace_key(:reverse)} #{@renderer.cache_replace_key(:dog)}."
+      dogs = %w[Snoop Boo]
+
+      rendered = @renderer.render_cached("partial", collection: dogs) do
+        { dog: ->(dog) { dog_name(dog) }, reverse: ->(dog) { reverse(dog) } }
+      end
+
+      assert_equal "poonS Snoop.ooB Boo.", rendered
+    end
+
+    it "raise ArgumentError with invalid syntax" do
       @renderer.stubs(:render).with("container").returns("")
-      assert_raise(ArgumentError) do
+      assert_raises(ArgumentError) do
         @renderer.render_cached("container")
       end
     end

data/test/fragment_test.rb

@@ -1,29 +1,29 @@
 require 'test_helper'
 
 module CacheRocket
-  class FragmentTest < Test::Unit::TestCase
-    context "#to_s" do
-      should "equal value" do
+  class FragmentTest < MiniTest::Spec
+    describe "#to_s" do
+      it "equal value" do
         assert_equal "yo", Fragment.new("yo").to_s
       end
     end
 
-    context "#gsub!" do
-      should "substitute value" do
+    describe "#gsub!" do
+      it "substitute value" do
         fragment = Fragment.new("hello there, hello.")
         assert_equal "yo there, yo.", fragment.gsub!("hello", "yo")
       end
     end
 
-    context "#replace" do
-      should "replace cache keys from hash" do
+    describe "#replace" do
+      it "replace cache keys from hash" do
         cr_key = Fragment.new(nil).cache_replace_key(:xx)
         fragment = Fragment.new("hey #{cr_key} hey.")
         fragment.replace({xx: "yo"}, nil)
         assert_equal "hey yo hey.", fragment.value
       end
 
-      should "replace collection with Proc" do
+      it "replace collection with Proc" do
         def last5(object)
           object.last(5)
         end
@@ -37,4 +37,4 @@ module CacheRocket
     end
 
   end
-end
+end

data/test/key_test.rb

@@ -1,10 +1,10 @@
 require 'test_helper'
 
 module CacheRocket
-  class KeyTest < Test::Unit::TestCase
+  class KeyTest < MiniTest::Spec
 
-    context "#cache_replace_key" do
-      should "return key with prefix" do
+    describe "#cache_replace_key" do
+      it "return key with prefix" do
         class KeyFake
           include Key
         end

data/test/test_helper.rb

@@ -1,8 +1,9 @@
-require 'coveralls'
-Coveralls.wear!
+if ENV['TRAVIS']
+  require 'coveralls'
+  Coveralls.wear!
+end
 
-require 'test/unit'
-require 'shoulda-context'
-require 'mocha/setup'
+require 'minitest/autorun'
+require 'mocha/mini_test'
 require 'cache_rocket'
 require 'pry'

metadata

@@ -1,97 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: cache_rocket
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Tee Parham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-31 00:00:00.000000000 Z
+date: 2014-02-21 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: 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
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
 - !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-context
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.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 server-side html caching
@@ -101,9 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -117,7 +103,7 @@ files:
 - test/fragment_test.rb
 - test/key_test.rb
 - test/test_helper.rb
-homepage: https://github.com/teeparham/cache_rocket
+homepage: https://github.com/neighborland/cache_rocket
 licenses:
 - MIT
 metadata: {}
@@ -127,18 +113,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Rails rendering extension for server-side html caching
 test_files: []
+has_rdoc: