cache_rocket 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 864c56c4f67471c61a8bb9dbea603410616d3fb6
+  data.tar.gz: f39b92cc8432727cf11e305e87c9820885472491
+SHA512:
+  metadata.gz: 8ef3d5ebf32c1010b0c928c7b1daf55ded395ca1c6a0bd6a378bc790c4760ac7380ec6d52baf07348f251ee380420e91a028fb4e70071f1fb1996d1a77081065
+  data.tar.gz: 105657511b52018069395a9fe968e1f7202280b6fbe95301350ebebe03e297f29a3bb270d7565dbc6a89f881c7b5e09ffd599c94be8624d24ea544d17a45ee99

data/.gitignore

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

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tee Parham
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+[![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
+
+## Why do I need this?
+
+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
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'cache_rocket'
+```
+
+Add this line to a helper file, likely your ApplicationHelper:
+
+```ruby
+include CacheRocket
+```
+
+## Use
+
+This gem allows you to easily 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:
+
+##### file.html.haml:
+```haml
+= render 'container'
+```
+
+##### _container.html.haml:
+```haml
+.lots
+  .of
+    .htmls
+      = render 'dynamic'
+```
+
+##### _dynamic.html.haml:
+```haml
+= complicated_uncacheable_stuff
+```
+
+In the scenario above, you can't cache anything. With `cache_rocket`, you can:
+
+##### file.html.haml:
+```haml
+= render_cached 'container', replace: 'dynamic'
+```
+
+##### _container.html.haml:
+```haml
+- cache "container" do
+  .lots
+    .of
+      .htmls
+        = cache_replace_key 'dynamic'
+```
+
+##### _dynamic.html.haml:
+``` haml
+= complicated_uncacheable_stuff
+```
+
+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}
+```
+
+## Options
+
+`render_cached` provides 4 calling styles:
+
+#### Single partial to replace
+
+```ruby
+render_cached "container", replace: "inner"
+```
+
+#### Array of partials to replace
+```ruby
+render_cached "container", replace: ["inner"]
+```
+
+#### Map of keys to replace with values
+```ruby
+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
+  {key_name: a_helper_method(object)}
+end
+```
+
+## Contribute
+
+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

data/Rakefile

@@ -0,0 +1,12 @@
+#!/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

@@ -0,0 +1,27 @@
+# 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/teeparham/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.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"
+end

data/lib/cache_rocket.rb

@@ -0,0 +1,62 @@
+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. 
+  #    "inner" is the key name and "_inner.*" is the partial file name.
+  #
+  #   render_cached "container", replace: "inner"
+  #
+  # 2. Array of partials to replace
+  #
+  #   render_cached "container", replace: ["inner"]
+  #
+  # 3. Map of keys to replace with values
+  #
+  #   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
+  #     {key_name: a_helper_method(object)}
+  #   end
+  #
+  # 5. Render a collection with Procs for replace values.
+  #
+  #   render_cached "partial", collection: objects, replace: { key_name: ->(object){a_method(object)} }
+  #
+  def render_cached(partial, options={})
+    replace = options.delete(:replace)
+    collection = options.delete(:collection)
+
+    fragment = Fragment.new(render(partial, options))
+
+    case replace
+    when Hash
+      if collection
+        fragment.replace_collection collection, replace
+      else
+        fragment.replace_from_hash replace
+      end
+    when NilClass
+      raise ArgumentError.new(ERROR_MISSING_KEY_OR_BLOCK) unless block_given?
+      fragment.replace_from_hash yield
+    else
+      replace = *replace
+      replace.each do |key|
+        fragment.gsub! cache_replace_key(key), render(key, options)
+      end
+    end
+
+    fragment.to_s.html_safe
+  end
+
+end

data/lib/cache_rocket/fragment.rb

@@ -0,0 +1,48 @@
+module CacheRocket
+  class Fragment
+    include Key
+
+    attr_accessor :value
+
+    def initialize(value)
+      self.value = value
+    end
+
+    def to_s
+      value
+    end
+
+    def gsub!(key, value)
+      self.value.gsub! key, value
+    end
+
+    def replace_from_hash(hash)
+      hash.each do |key, value|
+        gsub! cache_replace_key(key), value.to_s
+      end
+    end
+
+    def replace_collection(collection, replace_hash)
+      html = ""
+
+      collection.each do |item|
+        html << replace_item_hash(item, replace_hash)
+      end
+
+      self.value = html
+    end
+
+  private
+
+    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)
+      end
+
+      item_fragment
+    end
+
+  end
+end

data/lib/cache_rocket/key.rb

@@ -0,0 +1,13 @@
+module CacheRocket
+  module Key
+    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
+    end
+
+  end
+end

data/lib/cache_rocket/version.rb

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

data/test/cache_rocket_test.rb

@@ -0,0 +1,90 @@
+require 'test_helper'
+
+class CacheRocketTest < Test::Unit::TestCase
+  class FakeRenderer
+    include CacheRocket
+  end
+
+  setup do
+    @renderer = FakeRenderer.new
+  end
+
+  context "#cache_replace_key" do
+    should "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
+      @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
+      assert_equal "Fanny pack quinoa hoodie viral mustache.", @renderer.render_cached("container", replace: "inner")
+    end
+
+    should "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
+      @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
+
+    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
+        {inner: "keytar"}
+      end
+      assert_equal "Fanny pack keytar viral mustache.", output
+    end
+
+    should "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
+
+    should "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
+
+    should "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
+    
+    should "raise ArgumentError with invalid syntax" do
+      @renderer.stubs(:render).with("container").returns("")
+      assert_raise(ArgumentError) do
+        @renderer.render_cached("container")
+      end
+    end
+  end
+end

data/test/fragment_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+module CacheRocket
+  class FragmentTest < Test::Unit::TestCase
+    context "#to_s" do
+      should "equal value" do
+        assert_equal "yo", Fragment.new("yo").to_s
+      end
+    end
+
+    context "#gsub!" do
+      should "gsub 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
+        cr_key = Fragment.new(nil).cache_replace_key(:xx)
+        fragment = Fragment.new("hey #{cr_key} hey.")
+        fragment.replace_from_hash(xx: "yo")
+        assert_equal "hey yo hey.", fragment.value
+      end
+    end
+
+    context "#replace_collection" do
+      should "replace with Proc" do
+        def last5(object)
+          object.last(5)
+        end
+        replace_hash = { something: ->(obj){ last5(obj)} }
+        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)
+      end
+    end
+
+  end
+end

data/test/key_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+module CacheRocket
+  class KeyTest < Test::Unit::TestCase
+
+    context "#cache_replace_key" do
+      should "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

@@ -0,0 +1,8 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'test/unit'
+require 'shoulda-context'
+require 'mocha/setup'
+require 'cache_rocket'
+require 'pry'

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: cache_rocket
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Tee Parham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-30 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
+  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-context
+  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'
+- !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
+email:
+- tee@neighborland.com
+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/teeparham/cache_rocket
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Rails rendering extension for server-side html caching
+test_files: []