easy_esi 0.2.1

data/CHANGELOG

@@ -0,0 +1 @@
+0.2.0 - new esi include format, expire all caches that use old esi includes 

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+group :dev do
+  gem 'actionpack', '~>3.1.0.rc4'
+  gem 'redgreen'
+  gem 'rake'
+  gem 'rspec', '~>2'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,67 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.1.0.rc4)
+      activemodel (= 3.1.0.rc4)
+      activesupport (= 3.1.0.rc4)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.0)
+      rack-cache (~> 1.0.1)
+      rack-mount (~> 0.8.1)
+      rack-test (~> 0.6.0)
+      sprockets (~> 2.0.0.beta.10)
+      tzinfo (~> 0.3.27)
+    activemodel (3.1.0.rc4)
+      activesupport (= 3.1.0.rc4)
+      bcrypt-ruby (~> 2.1.4)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.0.rc4)
+      multi_json (~> 1.0)
+    bcrypt-ruby (2.1.4)
+    builder (3.0.0)
+    diff-lcs (1.1.2)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.1.0)
+    i18n (0.6.0)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    multi_json (1.0.3)
+    rack (1.3.0)
+    rack-cache (1.0.2)
+      rack (>= 0.4)
+    rack-mount (0.8.1)
+      rack (>= 1.0.0)
+    rack-test (0.6.0)
+      rack (>= 1.0)
+    rake (0.9.2)
+    redgreen (1.2.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sprockets (2.0.0.beta.10)
+      hike (~> 1.0)
+      rack (~> 1.0)
+      tilt (!= 1.3.0, ~> 1.1)
+    tilt (1.3.2)
+    tzinfo (0.3.28)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 3.1.0.rc4)
+  jeweler
+  rake
+  redgreen
+  rspec (~> 2)

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rake/testtask'
+Rake::TestTask.new(:default) do |test|
+  test.libs << 'lib'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'easy_esi'
+    gem.summary = "Rails: Cached pages with updated partials"
+    gem.email = "michael@grosser.it"
+    gem.homepage = "http://github.com/grosser/#{gem.name}"
+    gem.authors = ["Michael Grosser"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: gem install jeweler"
+end

data/Readme.md

@@ -0,0 +1,72 @@
+Cached pages with updated partials.<br/>
+
+Serve completely cached pages, but keep e.g. "Welcome <%= current_user %>" updated.<br/>
+Does not influence not-cached actions.
+
+Basics
+======
+**Up and running in 23 seconds or money back!**
+
+### Install (5s)
+[Rails 2 Version](http://github.com/grosser/easy_esi/tree/rails2)
+
+    gem install easy_esi
+Or
+
+    rails plugin install git://github.com/grosser/easy_esi.git
+
+### Action-cache the controller (5s)
+    class UsersController < ApplicationController
+      caches_action :show
+      enable_esi
+    end
+
+### Refactor partials that should stay updated (3s)
+Has no effect for non-esi controllers!
+    <%= render 'profile' %>
+    IS NOW
+    <%= esi_render 'profile' %>
+
+    <%= render 'profile', :local_variable => :foo %>
+    IS NOW
+    <%= esi_render :partial => 'profile', :locals => {:local_variable => :foo} %>
+
+### Realize that its that simple (10s)
+
+Behind the scenes
+=================
+`esi_render` inserts an esi-include (`<esi:include .... />`).<br/>
+an `after_filter` or easy-esi-rails-cache-hack replaces these by rendering the partial.<br/>
+==> if you want to share view caches between controllers,
+call enable_esi in all of them (or in ApplicationController).
+
+Comparison
+===========
+Normally ESI means having an extra server that parses `<esi>` tags and then calls your app to render these partials.
+Which adds a whole lot of new problems(passing arguments, login, expiration, security...).
+On top of that it will slow down your application unless you do everything so perfect that it gets
+faster then a action-cached request (which is really hard...).
+
+With 'hard' Esi, each `<esi>` tag causes a new, (yet small) request which needs to load all data (instance-variables) anew.<br/>
+With easy-esi, each `<esi>` tag causes a partial to be rendered, inside the current context, re-using instance-variables.
+
+Compared to normal [ESI](http://en.wikipedia.org/wiki/Edge_Side_Includes) this means:
+
+ - Testable caching
+ - Enabled per-controller
+ - No global changes
+ - Deactivatable at any moment
+ - before-filters still work
+ - No extra server
+ - No new actions
+ - No duplicate server requests
+ - No new configuration language
+ - No purge requests
+ - No external dependencies
+ - ...
+
+Author
+======
+[Michael Grosser](http://grosser.it)<br/>
+michael@grosser.it<br/>
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/easy_esi.gemspec

@@ -0,0 +1,49 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{easy_esi}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2011-06-19}
+  s.email = %q{michael@grosser.it}
+  s.files = [
+    "CHANGELOG",
+    "Gemfile",
+    "Gemfile.lock",
+    "Rakefile",
+    "Readme.md",
+    "VERSION",
+    "easy_esi.gemspec",
+    "init.rb",
+    "lib/easy_esi.rb",
+    "test/easy_esi_test.rb",
+    "test/views/esi_disabled/_a_partial.erb",
+    "test/views/esi_disabled/show.erb",
+    "test/views/esi_disabled/test_filter.erb",
+    "test/views/esi_disabled/with_hash.erb",
+    "test/views/esi_enabled/_a_partial.erb",
+    "test/views/esi_enabled/_unserialize.erb",
+    "test/views/esi_enabled/serialize.erb",
+    "test/views/esi_enabled/show.erb",
+    "test/views/esi_enabled/with_hash.erb"
+  ]
+  s.homepage = %q{http://github.com/grosser/easy_esi}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Rails: Cached pages with updated partials}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'easy_esi'

data/lib/easy_esi.rb

@@ -0,0 +1,79 @@
+class EasyEsi
+  VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
+  
+  def self.include_for(data)
+    %{<esi:include src="#{serialize(data)}"/>}.html_safe
+  end
+
+  def self.replace_includes(text)
+    text.gsub(%r{<esi:include src="[^"]*"/>}) do |match|
+      match =~ /"(.*)"/
+      yield unserialize($1)
+    end
+  end
+
+  def self.unserialize(data)
+    YAML.load Base64.decode64(data)
+  end
+
+  def self.serialize(data)
+    Base64.encode64(data.to_yaml).gsub("\n",'')
+  end
+
+  private
+
+  def self.query_to_hash(string)
+    string.split('&').map{|kv| kv.split('=')}.inject({}){|hash, kv| hash[kv[0]]=kv[1];hash}
+  end
+end
+
+class ActionView::Base
+  def esi_render data
+    if controller.esi_enabled
+      EasyEsi.include_for data
+    else
+      render data
+    end
+  end
+end
+
+# replace cached includes
+# cache miss:
+#  filter_with_esi -> filter_without_esi -> after_filter -> filter_with_esi
+#  do not replace <include> in after filter, but after filter_without_esi
+#
+# cache hit:
+#  filter_with_esi -> filter_without_esi -> filter_with_esi
+#  after_filter will not be called, but <include> needs to be replaced
+#
+class ActionController::Caching::Actions::ActionCacheFilter
+  def filter_with_esi(controller, &block)
+    controller.instance_variable_set "@do_not_replace_esi", true
+    result = filter_without_esi(controller, &block)
+    controller.instance_variable_set "@do_not_replace_esi", false
+
+    controller.send(:render_esi) if controller.esi_enabled
+
+    result
+  end
+  alias_method_chain :filter, :esi
+end
+
+class ActionController::Base
+  class_inheritable_accessor :esi_enabled
+
+  def self.enable_esi
+    self.esi_enabled = true
+    after_filter :render_esi
+  end
+
+  protected
+
+  def render_esi
+    return if @do_not_replace_esi or not response_body.kind_of?(String)
+    self.response_body = EasyEsi.replace_includes(response_body) do |data|
+      data = {:partial => data} if data.kind_of?(String)
+      _render_template(data)
+    end
+  end
+end

data/test/easy_esi_test.rb

@@ -0,0 +1,182 @@
+require 'rubygems'
+require 'rspec'
+require 'active_support/all'
+require 'action_pack'
+require 'action_controller'
+require 'action_dispatch/testing/test_process'
+require 'test/unit'
+require 'redgreen'
+$LOAD_PATH << 'lib'
+require 'init'
+
+# fake checks
+require 'ostruct'
+module ActionController::UrlFor
+  def _routes
+    helpers = OpenStruct.new
+    helpers.url_helpers = Module.new
+    helpers
+  end
+end
+
+ActionController::Base.cache_store = :memory_store
+
+ROUTES = ActionDispatch::Routing::RouteSet.new
+ROUTES.draw do
+  match ':controller(/:action(/:id(.:format)))'
+end
+ROUTES.finalize!
+
+class EsiDisabledController < ActionController::Base
+  self.view_paths = 'test/views'
+  caches_action :show, :random, :with_hash
+
+  def random
+    render :text => rand.to_s
+  end
+
+  def show
+  end
+
+  def with_hash
+  end
+
+  def uncached
+    render :action => :show
+  end
+
+  def self._routes
+    ROUTES
+  end
+
+  def url_for(*args)
+    'xxx'
+  end
+end
+
+# funky patch to get @routes working, in 'setup' did not work
+module ActionController::TestCase::Behavior
+  def process_with_routes(*args)
+    @routes = ROUTES
+    process_without_routes(*args)
+  end
+  alias_method_chain :process, :routes
+end
+
+class EsiDisabledTest < ActionController::TestCase
+  def setup
+    @controller = EsiDisabledController.new
+    @controller.cache_store.clear
+  end
+
+  test "caches actions" do
+    get :random
+    cached = @response.body
+    get :random
+    @response.body.should == cached
+  end
+
+  test "it has esi disabled" do
+    @controller.esi_enabled.should == nil
+  end
+
+  test "it renders correctly" do
+    get :show, :in_action => 'A', :in_esi => 'B'
+    @response.body.should == "A B"
+  end
+
+  test "it renders old esi-partial when action was cached" do
+    get :show, :in_action => 'A', :in_esi => 'B'
+    get :show, :in_action => 'X', :in_esi => 'C'
+    @response.body.should == "A B"
+  end
+
+  test "it renders up-to-date esi-partial when action was not cached" do
+    get :uncached, :in_action => 'X', :in_esi => 'C'
+    @response.body.should == "X C"
+  end
+
+  test "it does not render esi includes" do
+    get :test_filter
+    @response.body.should == '<esi:include src="no_change"/>'
+  end
+
+  test "it renders old esi-partial with hash" do
+    get :with_hash, :in_esi => 'C'
+    get :with_hash, :in_esi => 'D'
+    @response.body.should == "From hash: C"
+  end
+end
+
+
+class EsiEnabledController < EsiDisabledController
+  enable_esi
+
+  def test_filter
+  end
+
+  def send_a_file
+    send_file "VERSION"
+  end
+
+  def url_for(*args)
+    'xxx'
+  end
+end
+
+class EsiEnabledTest < ActionController::TestCase
+  def setup
+    @controller = EsiEnabledController.new
+    @controller.cache_store.clear
+  end
+
+  test "caches actions" do
+    get :random
+    cached = @response.body
+    get :random
+    @response.body.should == cached
+  end
+
+  test "it has esi enabled" do
+    @controller.esi_enabled.should == true
+  end
+
+  test "it renders correctly" do
+    get :show, :in_action => 'A', :in_esi => 'B'
+    @response.body.strip.should == "A B"
+  end
+
+  test "it up-to-date esi partial when action was cached" do
+    get :show, :in_action => 'A', :in_esi => 'B'
+    get :show, :in_action => 'X', :in_esi => 'C'
+    @response.body.strip.should == "A C"
+  end
+
+  test "it renders up-to-date esi-partial when action was not cached" do
+    get :uncached, :in_action => 'X', :in_esi => 'C'
+    @response.body.strip.should == "X C"
+  end
+
+  test "it renders up-to-date esi-partial with hash" do
+    get :with_hash, :in_esi => 'C'
+    get :with_hash, :in_esi => 'D'
+    @response.body.should == "From hash: D"
+  end
+
+  test "it can serialize arbitrary data" do
+    data = {'src' => 'something else', 1 => :x, 2 => ['"','/','___----']}
+    get :serialize, :render_data => data
+    @response.body.strip.should == data.inspect
+  end
+
+  test "it can send a file" do
+    get :send_a_file
+    @response.body.should == File.read('VERSION')
+  end
+end
+
+class TestEasyEsi < ActionController::TestCase
+  test "it has a VERSION" do
+    EasyEsi::VERSION.should =~ /^\d+\.\d+\.\d+$/
+  end
+end

data/test/views/esi_disabled/_a_partial.erb

@@ -0,0 +1 @@
+<%= params[:in_esi] %>

data/test/views/esi_disabled/show.erb

@@ -0,0 +1 @@
+<%= params[:in_action] %> <%= esi_render 'a_partial' %>

data/test/views/esi_disabled/test_filter.erb

@@ -0,0 +1 @@
+<esi:include src="no_change"/>

data/test/views/esi_disabled/with_hash.erb

@@ -0,0 +1 @@
+From hash: <%= esi_render :partial => 'a_partial' %>

data/test/views/esi_enabled/_a_partial.erb

@@ -0,0 +1 @@
+<%= params[:in_esi] %>

data/test/views/esi_enabled/_unserialize.erb

@@ -0,0 +1 @@
+<%= data.inspect.html_safe %>

data/test/views/esi_enabled/serialize.erb

@@ -0,0 +1 @@
+<%= render 'unserialize', :data => params[:render_data]%>

data/test/views/esi_enabled/show.erb

@@ -0,0 +1 @@
+<%= params[:in_action] %> <%= esi_render 'a_partial' %>

data/test/views/esi_enabled/with_hash.erb

@@ -0,0 +1 @@
+From hash: <%= esi_render :partial => 'a_partial' %>

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: easy_esi
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-19 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: michael@grosser.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- VERSION
+- easy_esi.gemspec
+- init.rb
+- lib/easy_esi.rb
+- test/easy_esi_test.rb
+- test/views/esi_disabled/_a_partial.erb
+- test/views/esi_disabled/show.erb
+- test/views/esi_disabled/test_filter.erb
+- test/views/esi_disabled/with_hash.erb
+- test/views/esi_enabled/_a_partial.erb
+- test/views/esi_enabled/_unserialize.erb
+- test/views/esi_enabled/serialize.erb
+- test/views/esi_enabled/show.erb
+- test/views/esi_enabled/with_hash.erb
+has_rdoc: true
+homepage: http://github.com/grosser/easy_esi
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: "Rails: Cached pages with updated partials"
+test_files: []
+