cache_rocket 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f75dd60c6e5762540a56e4a7085162a9c74f102b
-  data.tar.gz: 14af9f5f4e9d64c1181b4f07eb6605b2d004a7bf
+  metadata.gz: 773ba9d38b86d5eef1b88d160ea2b51ed524b0f2
+  data.tar.gz: 1d20fdb597fe139dc8f5eb2bee78a369a476e251
 SHA512:
-  metadata.gz: b960decd0407c187ea85ba06acfdfbd8f6f66292191f7c7837b893363cd3f91e84b2f272388cb910101a4f6e7e0198de12233c42c693c1a746c7a13143d7d84b
-  data.tar.gz: c37b830692708e77e91e350f0c8986d95eb90b40900814f29132256fbe48c85b526d865684673267432b3c501f41ec484008d2813a78a0c9e170cd42b110c607
+  metadata.gz: 26b198780bd4a790d8f3935c589c96ba241d3897e07423ec313821bdc24c70a69dd4a914af21f86f924c330ee725ddb1bd6b56176b4387e8a32664d8d1e87ec8
+  data.tar.gz: 17fd751c32a819d3a371d5356698e756fa4d2c88a751ae2f4b49913ddb811f29f6482bd29124a342cac2afa78cf77a554d1adfc66407dfec46880ddb995ecb78

data/README.md

@@ -1,9 +1,9 @@
-[![Gem Version](https://badge.fury.io/rb/cache_rocket.png)][gem]
-[![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 Version](https://badge.fury.io/rb/cache_rocket.svg)][gem]
+[![Build Status](https://travis-ci.org/neighborland/cache_rocket.svg?branch=master)][build]
+[![Coverage Status](http://img.shields.io/coveralls/neighborland/cache_rocket.svg)][coverage]
+[![Code Climate](http://img.shields.io/codeclimate/github/neighborland/cache_rocket.svg)][climate]
 
-[gem]: http://badge.fury.io/rb/cache_rocket
+[gem]: http://rubygems.org/gems/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
@@ -12,18 +12,18 @@
 
 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 be replaced with dynamic content.
 
 ### Install
 
-Add this line to your Gemfile:
+Add the gem to your Gemfile:
 
 ```ruby
 gem 'cache_rocket'
 ```
 
-Add this line to a helper file, likely your ApplicationHelper:
+Include the CacheRocket module so your views can use the `render_cached` method.
+Most likely you would put this in your `ApplicationHelper`:
 
 ```ruby
 include CacheRocket
@@ -31,17 +31,19 @@ include CacheRocket
 
 ### Use
 
-This gem allows you to cache a fragment of html and replace inner html. You cache the donut and replace the donut hole.
+CacheRocket allows you to cache a fragment of html and replace inner html. 
+You inject dynamic content into a static, cached outer partial. 
+You cache the donut and replace the donut hole.
 
 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
-= render 'container'
+= render 'outer'
 ```
 
-##### _container.html.haml:
+##### _outer.html.haml:
 ```haml
 .lots
   .of
@@ -51,20 +53,20 @@ For example:
 
 ##### _inner.html.haml:
 ```haml
-= complicated_uncacheable_stuff
+= uncacheable_content
 ```
 
 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`:
+with `render_cached` in `file`, specify the partial to replace in `outer`, and cache `outer`:
 
 ##### file.html.haml:
 ```haml
-= render_cached 'container', replace: 'inner'
+= render_cached 'outer', replace: 'inner'
 ```
 
-##### _container.html.haml:
+##### _outer.html.haml:
 ```haml
-- cache 'container' do
+- cache 'outer' do
   .lots
     .of
       .htmls
@@ -73,19 +75,19 @@ with `render_cached` in `file`, specify the partial to replace in `container`, a
 
 ##### _inner.html.haml:
 ``` haml
-= complicated_uncacheable_stuff
+= uncacheable_content
 ```
 
 In this example, you could remove the `_inner.html.haml` file altogether, like so:
 
 ##### file.html.haml:
 ```haml
-= render_cached 'container', replace: { inner: complicated_uncacheable_stuff }
+= render_cached 'outer', replace: { inner: uncacheable_content }
 ```
 
-##### _container.html.haml:
+##### _outer.html.haml:
 ```haml
-- cache 'container' do
+- cache 'outer' do
   .lots
     .of
       .htmls
@@ -99,43 +101,53 @@ In this example, you could remove the `_inner.html.haml` file altogether, like s
 #### Single partial to replace
 
 ```ruby
-render_cached 'container', replace: 'inner'
+render_cached 'outer', replace: 'inner'
 ```
 
 #### Array of partials to replace
 ```ruby
-render_cached 'container', replace: ['inner', 'footer']
+render_cached 'outer', replace: ['inner', 'footer']
 ```
 
 #### Hash of keys to replace with values
 ```ruby
-render_cached 'container', replace: { key_name: a_helper_method(object) }
+render_cached 'outer', replace: { key_name: a_helper_method(object) }
 ```
 
 #### Block containing a hash of keys to replace with values
 ```ruby
-render_cached 'container' do
+render_cached 'outer' 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,
-  replace: { key_name: ->(object){ a_helper_method(object) } }
+render_cached 'outer', 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) } }
+render_cached 'outer', collection: objects do
+  { key_name: -> (object) { a_helper_method(object) } }
+end
+```
+
+#### Render a collection with block syntax with multiple keys
+```ruby
+render_cached 'outer', collection: objects do
+  { 
+    key_1: -> (object) { a_helper_method(object) },
+    key_2: -> (item) { item.name },
+  }
 end
 ```
 
 ### 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.
+Benchmark your page rendering times before and after to see if it helps.
 
 ### Benefits
 
@@ -190,7 +202,7 @@ If the cached content is rarely retrieved, `cache_replace` can help:
 ```
 
 ```haml
-= render 'common_interests', replace: { something: 'common_interests/inner' }
+= render_cached 'common_interests', replace: { something: 'common_interests/inner' }
 ```
 
 #### Faster first page loads

data/lib/cache_rocket/fragment.rb

@@ -24,7 +24,7 @@ module CacheRocket
       end
     end
 
-  private
+    private
 
     def replace_from_hash(hash)
       hash.each do |key, value|
@@ -43,7 +43,7 @@ module CacheRocket
     end
 
     def replace_item_hash(item, hash)
-      item_fragment = self.value.dup
+      item_fragment = value.dup
 
       hash.each do |key, proc|
         item_fragment.gsub! cache_replace_key(key), proc.call(item)
@@ -51,6 +51,5 @@ module CacheRocket
 
       item_fragment
     end
-
   end
-end
+end

data/lib/cache_rocket/key.rb

@@ -1,13 +1,12 @@
 module CacheRocket
   module Key
-    CACHE_REPLACE_KEY_OPEN  = '<cr '
+    CACHE_REPLACE_KEY_OPEN = "<cr "
 
     # string key containing the partial file name or placeholder key.
     # It is a tag that should never be returned to be rendered by the
     # client, but if so, it will be hidden since CR is not a valid html tag.
     def cache_replace_key(key)
-      "#{CACHE_REPLACE_KEY_OPEN}#{key.to_s}>".html_safe
+      "#{CACHE_REPLACE_KEY_OPEN}#{key}>".html_safe
     end
-
   end
-end
+end

data/lib/cache_rocket/version.rb

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

data/lib/cache_rocket.rb

@@ -1,16 +1,16 @@
-require 'active_support/core_ext/string'
-require 'cache_rocket/key'
-require 'cache_rocket/fragment'
-require 'cache_rocket/version'
+require "active_support/core_ext/string"
+require "cache_rocket/key"
+require "cache_rocket/fragment"
+require "cache_rocket/version"
 
 module CacheRocket
   include Key
 
   ERROR_MISSING_KEY_OR_BLOCK = "You must either pass a `replace` key or a block to render_cached."
-  
+
   # Supports 5 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"
@@ -33,7 +33,7 @@ module CacheRocket
   #
   #   render_cached "partial", collection: objects, replace: { key_name: ->(object){a_method(object)} }
   #
-  def render_cached(partial, options={})
+  def render_cached(partial, options = {})
     replace_hash = options.delete(:replace)
     collection = options.delete(:collection)
 
@@ -43,16 +43,14 @@ module CacheRocket
     when Hash
       fragment.replace replace_hash, collection
     when NilClass
-      raise ArgumentError.new(ERROR_MISSING_KEY_OR_BLOCK) unless block_given?
+      raise(ArgumentError, ERROR_MISSING_KEY_OR_BLOCK) unless block_given?
       fragment.replace yield, collection
     else
-      key_array = *replace_hash
-      key_array.each do |key|
+      [*replace_hash].each do |key|
         fragment.gsub! cache_replace_key(key), render(key, options)
       end
     end
 
     fragment.to_s.html_safe
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_rocket
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Tee Parham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2015-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -30,56 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.1'
 description: Rails rendering extension for server-side html caching
 email:
 - tee@neighborland.com
@@ -87,22 +59,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".ruby-version"
-- ".travis.yml"
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- cache_rocket.gemspec
 - lib/cache_rocket.rb
 - lib/cache_rocket/fragment.rb
 - lib/cache_rocket/key.rb
 - lib/cache_rocket/version.rb
-- test/cache_rocket_test.rb
-- test/fragment_test.rb
-- test/key_test.rb
-- test/test_helper.rb
 homepage: https://github.com/neighborland/cache_rocket
 licenses:
 - MIT
@@ -123,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rails rendering extension for server-side html caching

data/.gitignore

@@ -1,14 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-Gemfile.lock
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.1.0

data/.travis.yml

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

data/Gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-group :test do
-  gem 'coveralls', require: false
-end
-
-gemspec

data/Rakefile

@@ -1,12 +0,0 @@
-#!/usr/bin/env rake
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-desc 'Run tests'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-task default: :test

data/cache_rocket.gemspec

@@ -1,28 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cache_rocket/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "cache_rocket"
-  spec.version       = CacheRocket::VERSION
-  spec.authors       = ["Tee Parham"]
-  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/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 "minitest"
-  spec.add_development_dependency "mocha", "~> 1.0"
-  spec.add_development_dependency "pry", "~> 0.9"
-end

data/test/cache_rocket_test.rb

@@ -1,118 +0,0 @@
-require 'test_helper'
-
-class CacheRocketTest < MiniTest::Spec
-  class FakeRenderer
-    include CacheRocket
-  end
-
-  before do
-    @renderer = FakeRenderer.new
-  end
-
-  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
-
-  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
-
-    it "render with single partial" do
-      assert_equal "Fanny pack quinoa hoodie viral mustache.", @renderer.render_cached("container", replace: "inner")
-    end
-
-    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
-
-    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"
-
-      assert_equal "quinoa hoodie high life viral mustache.",
-        @renderer.render_cached("container", replace: ["inner", "other"])
-    end
-
-    it "render with map of keys" do
-      assert_equal "Fanny pack keytar viral mustache.", @renderer.render_cached("container", replace: {inner: "keytar"})
-    end
-    
-    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    
-
-    it "render with hash block" do
-      output = @renderer.render_cached("container") do
-        {inner: "keytar"}
-      end
-      assert_equal "Fanny pack keytar viral mustache.", output
-    end
-
-    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."
-
-      assert_equal "quinoa hoodie quinoa hoodie viral mustache.",
-        @renderer.render_cached("container", replace: "inner")
-    end
-
-    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')}."
-
-      assert_equal "I like stout, stout and chips.",
-         @renderer.render_cached("container", replace: {food: "chips", beer: 'stout'})
-    end
-
-    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) } })
-    end
-
-    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) } }
-      end
-
-      assert_equal "Hi Snoop.Hi Boo.", rendered
-    end
-
-    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_raises(ArgumentError) do
-        @renderer.render_cached("container")
-      end
-    end
-  end
-end

data/test/fragment_test.rb

@@ -1,40 +0,0 @@
-require 'test_helper'
-
-module CacheRocket
-  class FragmentTest < MiniTest::Spec
-    describe "#to_s" do
-      it "equal value" do
-        assert_equal "yo", Fragment.new("yo").to_s
-      end
-    end
-
-    describe "#gsub!" do
-      it "substitute value" do
-        fragment = Fragment.new("hello there, hello.")
-        assert_equal "yo there, yo.", fragment.gsub!("hello", "yo")
-      end
-    end
-
-    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
-
-      it "replace collection with Proc" do
-        def last5(object)
-          object.last(5)
-        end
-        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(replace_hash, collection)
-      end
-    end
-
-  end
-end

data/test/key_test.rb

@@ -1,18 +0,0 @@
-require 'test_helper'
-
-module CacheRocket
-  class KeyTest < MiniTest::Spec
-
-    describe "#cache_replace_key" do
-      it "return key with prefix" do
-        class KeyFake
-          include Key
-        end
-
-        key = KeyFake.new
-        assert_equal CacheRocket::Key::CACHE_REPLACE_KEY_OPEN + "some/thing>", key.cache_replace_key("some/thing")
-      end
-    end
-
-  end
-end

data/test/test_helper.rb

@@ -1,9 +0,0 @@
-if ENV['TRAVIS']
-  require 'coveralls'
-  Coveralls.wear!
-end
-
-require 'minitest/autorun'
-require 'mocha/mini_test'
-require 'cache_rocket'
-require 'pry'