cache_replace 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTdiNzUyNjYyM2NkYzA2ZjhmMjcyNDE3Nzg0M2Q4NGViZjM0NzY3ZA==
+  data.tar.gz: !binary |-
+    NGZlMDZlYWNhOTVkNTE4ZTFiNzAyMGE1NTNmMDQyMTNhMTAwM2E2Yg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    M2FkMmIyY2Q2YTVjNzBlYzMwZjg4ODY2ZmU4NjI2NjE5MTE3ZDcyNDQ5MjEy
+    MDY0OTFlMGU1ZjI1YWU2MjJhNGZjNjJjMmM2Zjc3N2M0MzA4NGZkNDdkY2I5
+    NDU3YzdmMTVkODg5OWI2MmE1MGZjNjQyZDk1NzdkMjA5NDk2OWU=
+  data.tar.gz: !binary |-
+    NzlkNjU0ODkxMGU0OWE4OGYzZDliZTE0MDE3Mzg4NTQ4NDMyMjRhMDhlM2Mz
+    NGMyYzMzMGQ0NmU4ZjVlZjIwNDNjY2JmYzQ1Y2U5YmMyODVhYzE4MWExNGU0
+    ODRiZjJhMTUwZmU3YTgyZGFhYTE0ODVkOWYzOWEyZjRlMjZjZTQ=

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

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+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,104 @@
+# 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.
+
+## Install
+
+Add this line to your Gemfile:
+
+    gem 'cache_replace'
+
+Add this line to a helper file, likely your ApplicationHelper:
+
+    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:
+
+You have some html that would be cached, except for some uncacheable code nested in the DOM. For example:
+
+##### file.html.haml:
+```
+= render 'container'
+```
+
+##### _container.html.haml:
+```
+.lots
+  .of
+    .htmls
+      = render 'dynamic'
+```
+
+##### _dynamic.html.haml:
+```
+= complicated_uncacheable_stuff
+```
+
+Sad times. You can't cache anything without resorting to madness. Oh snap! But you can:
+
+##### file.html.haml:
+```
+= render_cached 'container', replace: 'dynamic'
+```
+
+##### _container.html.haml:
+```
+- cache "container" do
+  .lots
+    .of
+      .htmls
+        = cache_replace_key 'dynamic'
+```
+
+##### _dynamic.html.haml:
+```
+= complicated_uncacheable_stuff
+```
+
+In the above example, you could also remove the `_dynamic.html.haml` file and do this:
+
+##### file.html.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: {special_link: special_link(object)}
+```
+
+#### Yield to a hash of keys to replace with values
+```ruby
+render_cached "container" do
+  {special_link: special_link(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_replace.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cache_replace/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cache_replace"
+  spec.version       = CacheReplace::VERSION
+  spec.authors       = ["Tee Parham"]
+  spec.email         = ["tee@neighborland.com"]
+  spec.description   = %q{Rails rendering extension for more server-side html caching}
+  spec.summary       = %q{Rails rendering extension for more server-side html caching}
+  spec.homepage      = "https://github.com/teeparham/cache_replace"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = `git ls-files -- {test}/*`.split("\n")
+  spec.require_paths = ["lib"]
+
+  # need #raw
+  spec.add_dependency "actionpack", ">= 3.2"
+
+  spec.add_development_dependency "bundler", ">= 1.3"
+  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 "pry", ">= 0.9"
+end

data/lib/cache_replace.rb

@@ -0,0 +1,58 @@
+require 'cache_replace/version'
+
+module CacheReplace
+  # Supports 4 options:
+  #
+  # 1. Single partial to replace
+  #
+  #   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: {special_link: special_link(object)}
+  #
+  # 4. Yield to a hash of keys to replace with values
+  #
+  #   render_cached "container" do
+  #     {special_link: special_link(object)}
+  #   end
+  #
+  def render_cached(static_partial, options={})
+    replace = options.delete(:replace)
+    fragment = render(static_partial, options)
+
+    case replace
+    when Hash
+      replace_from_hash fragment, replace
+    when NilClass
+      replace_from_hash fragment, yield
+    else
+      replace = *replace
+      replace.each do |key|
+        fragment.sub! cache_replace_key(key), render(key, options)
+      end
+    end
+
+    raw fragment
+  end
+
+  CACHE_FRAGMENT_KEY = '____>>'
+
+  # string key containing the partial file name or placeholder key
+  # it should return a string that your renderer will never contain
+  def cache_replace_key(key)
+    raw "#{CACHE_FRAGMENT_KEY}#{key.to_s}"
+  end
+
+private
+
+  def replace_from_hash(fragment, hash)
+    hash.each do |key, value|
+      fragment.sub! cache_replace_key(key), value
+    end
+  end
+end

data/lib/cache_replace/version.rb

@@ -0,0 +1,3 @@
+module CacheReplace
+  VERSION = "0.0.1"
+end

data/test/cache_replace_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class CacheReplaceTest < Test::Unit::TestCase
+  class FakeRenderer
+    include CacheReplace
+
+    # mock ActionView::Helpers::OutputSafetyHelper
+    def raw(value)
+      value
+    end
+  end
+
+  setup do
+    @renderer = FakeRenderer.new
+  end
+
+  context "#cache_replace_key" do
+    should "return key with prefix" do
+      assert_equal CacheReplace::CACHE_FRAGMENT_KEY + "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 hash block" do
+      output = @renderer.render_cached("container") do
+        {inner: "keytar"}
+      end
+      assert_equal "Fanny pack keytar viral mustache.", output
+    end
+  end
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: cache_replace
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tee Parham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-16 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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !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
+email:
+- tee@neighborland.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cache_replace.gemspec
+- lib/cache_replace.rb
+- lib/cache_replace/version.rb
+- test/cache_replace_test.rb
+- test/test_helper.rb
+homepage: https://github.com/teeparham/cache_replace
+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.3
+signing_key: 
+specification_version: 4
+summary: Rails rendering extension for more server-side html caching
+test_files: []