rack-esi 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Florian Assmann
+
+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.rdoc

@@ -0,0 +1,17 @@
+= rack-esi
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Florian Assmann. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-esi"
+    gem.summary = %Q{ESI middleware implementation for Rack.}
+    gem.description = %Q{Nokogiri based ESI middleware implementation for Rack with (limited) support for include, remove and comment.}
+    gem.email = "florian.assmann@email.de"
+    gem.homepage = "http://github.com/boof/rack-esi"
+    gem.authors = ["Florian Assmann"]
+    gem.add_development_dependency "riot", ">= 0"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rack-esi.rb

@@ -0,0 +1,75 @@
+require 'rack'
+require 'nokogiri'
+
+class Rack::ESI
+  NS = { 'esi' => 'http://www.edge-delivery.org/esi/1.0' }
+  Error = Class.new RuntimeError
+
+  def initialize(app, options = {})
+    @app  = app
+
+    @paths          = options[:skip]
+    @types          = options[:only] || /^text\/(?:x|ht)ml/
+    @max_includes   = options[:includes] || 32
+    @max_recursion  = options[:depth] || 5
+  end
+
+  def call env, counter = { :recursion => 0, :includes => 0 }
+    return @app.call(env) if skip_path? env['PATH_INFO']
+
+    status, headers, source = @app.call env
+    return status, headers, source if skip_type? headers['Content-Type']
+
+    Rack::Response.new { |target|
+      source.each { |body| target.write compile(body, env, counter) }
+    }.finish
+  end
+
+  private
+
+    def fetch(path, env, counter)
+      call env.merge('PATH_INFO' => path), counter if path
+    end
+
+    # Should I use XML::SAX::Parser?
+    def compile(body, env, counter)
+      document = Nokogiri.XML body
+
+      document.css('esi|include,esi|remove,esi|comment', NS).each do |node|
+        case node.name
+        when 'include'
+          next unless counter[:includes] < @max_includes
+          counter[:includes] += 1
+          begin
+            next unless counter[:recursion] < @max_recursion
+            counter[:recursion] += 1
+            status, headers, compiled = fetch node['src'], env, counter
+            status, headers, compiled = fetch node['alt'], env, counter if status != 200
+          ensure
+            counter[:recursion] -= 1
+          end
+
+          if status != 200
+            raise Error if node['onerror'] != 'continue'
+            compiled = []
+          end
+
+          data = '' and compiled.each { |body| data << body }
+          node.swap data
+
+        when 'remove', 'comment'
+          node.unlink
+        end
+      end
+
+      document.to_xhtml
+    end
+
+    def skip_path?(path)
+      @paths =~ path if @paths
+    end
+    def skip_type?(type)
+      @types !~ type
+    end
+
+end

data/test/fixtures/index.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:esi="http://www.edge-delivery.org/esi/1.0">
+	<head>
+		<title>index.html</title>
+		<esi:comment text="This comment should be removed!" />
+		<esi:include src="/metatags.fragment" />
+	</head>
+	<body>
+	</body>
+</html>

data/test/fixtures/metatags.fragment

@@ -0,0 +1 @@
+<meta name="replacement" content="content" />

data/test/fixtures/raw.html

@@ -0,0 +1,10 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:esi="http://www.edge-delivery.org/esi/1.0">
+	<head>
+		<title>raw.html</title>
+		<esi:comment text="This comment should be removed!" />
+	</head>
+	<body>
+	</body>
+</html>

data/test/rack-esi_test.rb

@@ -0,0 +1,31 @@
+require 'teststrap'
+
+context 'Rack::ESI' do
+
+  __dirname__ = File.expand_path File.dirname(__FILE__)
+  root = Pathname.new File.join(__dirname__, 'fixtures')
+  opts = { :urls => ['/'], :root => root }
+
+  setup { ESI.new Static.new(App.new, opts), :skip => /raw/ }
+
+  context 'GET /raw.html' do
+    setup { MockRequest.new(topic).get '/raw.html' }
+    asserts('Content-Type') { topic.content_type }.equals 'text/html'
+    should('not be altered') { topic.body == root.join('raw.html').read }
+  end
+
+  context 'GET /index.html' do
+    setup { MockRequest.new(topic).get '/index.html' }
+
+    asserts('Content-Type') { topic.content_type }.equals 'text/html'
+    should('not have any ESI specific nodes') do
+      html(topic.body).
+      at('//esi:include|//esi:remove|//esi:comment', Rack::ESI::NS).nil?
+    end
+    should('have meta replacement with content') do
+      not html(topic.body).
+      at("//meta[@name='replacement' and @content='content']").nil?
+    end
+  end
+
+end

data/test/teststrap.rb

@@ -0,0 +1,17 @@
+require 'pathname'
+require 'rubygems'
+require 'riot'
+require 'rack-esi'
+require 'rack/mock'
+
+def html(body)
+  Nokogiri.HTML(body).root
+end
+
+class App
+  def call(env)
+    Rack::Response.new.finish
+  end
+end
+
+include Rack

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: rack-esi
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Florian Assmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-26 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riot
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Nokogiri based ESI middleware implementation for Rack with (limited) support for include, remove and comment.
+email: florian.assmann@email.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack-esi.rb
+- test/fixtures/index.html
+- test/fixtures/metatags.fragment
+- test/fixtures/raw.html
+- test/rack-esi_test.rb
+- test/teststrap.rb
+has_rdoc: true
+homepage: http://github.com/boof/rack-esi
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: ESI middleware implementation for Rack.
+test_files: 
+- test/rack-esi_test.rb
+- test/teststrap.rb