webficient-rack-tidy 0.0.2

data/README.rdoc

@@ -0,0 +1,85 @@
+= Tidy Markup Cleaner for Rack
+
+Rack::Tidy cleans text/html markup by automatically 
+indenting and reformatting content. Best results are achieved 
+with valid markup, when you simply want to use this component 
+to produce clean (X)HTML rendered by templating systems such as ERb.
+
+Rack::Tidy relies on the power of the Tidy gem and defaults to settings
+based on convention. However, you can override these through configuration.
+
+For more information about the Rack specification, check out http://rack.rubyforge.org
+
+== Installation
+
+Prerequisites:
+
+  -Rack gem (sudo gem install rack)
+  -Tidy gem (sudo gem install tidy)
+
+From Gem:
+
+  $ sudo gem install webficient-rack-tidy
+
+With a local working copy:
+
+  $ git clone git://github.com/webficient/rack-tidy.git
+  $ rake build && sudo rake install
+
+== Usage
+
+Basic Usage
+-----------
+
+Rack::Tidy is implemented as a piece of Rack middleware and can be used with
+any Rack-based application. If your application includes a rackup (`.ru`) file
+or uses Rack::Builder to construct the application pipeline, simply require
+and use as follows:
+
+  require 'rack/tidy'
+
+  use Rack::Tidy
+  run app
+
+Using with Rails
+----------------
+
+Add this to your `config/environment.rb`:
+
+  # above Rails::Initializer block
+  require 'rack/tidy'
+
+  # inside Rails::Initializer block
+  config.middleware.use Rack::Tidy
+
+You should now see `Rack::Cache` listed in the middleware pipeline:
+
+  rake middleware
+    
+Configuration Options
+---------------------
+
+The Tidy gem requires setting an internal path variable that points to the Tidy library,
+which will differ per platform. Rack::Tidy defaults to '/usr/lib/libtidy.A.dylib'
+which is the default location for the Tidy gem on Mac Leopard. To override the constant,
+simply define it in your application's configuration file:
+        
+  TIDY_LIB = '/usr/lib/tidylib.so'
+
+Need Rack::Tidy to ignore certain paths? In your config, pass in an optional array of paths:
+
+  # Rails example
+  config.middleware.use Rack::Tidy, 
+    :ignore_paths => ['/admin', '/cms']
+
+Rack::Tidy relies on convention with regard to Tidy's configuration (see Rack::Tidy::Cleaner for details). If you want to override/set attributes supported by the Tidy gem, declare them in your configuration as an optional hash:
+
+  # Rails example
+  config.middleware.use Rack::Tidy,
+    'indent-spaces' => 4
+          
+See http://tidy.sourceforge.net/docs/quickref.html for Tidy gem config options
+
+== Copyright
+
+Copyright (c) 2009 Phil Misiowiec, Webficient LLC. See MIT-LICENSE for details.

data/lib/rack/tidy/cleaner.rb

@@ -0,0 +1,63 @@
+require 'tidy'
+
+module Rack::Tidy
+  # This class is the interface between Rack and the Tidy gem
+  class Cleaner
+    
+    # Defaults for the Tidy gem config
+    DEFAULT_TIDY_OPTS = {
+      'char-encoding'     => 'utf8',
+      'indent'            => true,
+      'indent-spaces'     => 2,
+      'tidy-mark'         => false,
+      'wrap'              => 0 }
+          
+    # Tidy gem options, see http://tidy.sourceforge.net/docs/quickref.html
+    attr_accessor :tidy_options
+    
+    # Paths to be ignored during Rack::Tidy processing
+    attr_accessor :ignore_paths
+                
+    def initialize(app, options = {})
+      ::Tidy.path = TIDY_LIB
+      @app = app
+      self.ignore_paths = options[:ignore_paths] || []
+      self.tidy_options = DEFAULT_TIDY_OPTS.merge(options)
+    end
+    
+    # method required by Rack interface
+    def call(env)
+      call! env
+    end
+
+    # thread safe version using shallow copy of env
+    def call!(env)
+      @env = env.dup
+      status, @headers, response = @app.call(@env)      
+      if should_clean?
+        @headers.delete('Content-Length')
+        response = Rack::Response.new(
+          tidy_markup(response.respond_to?(:body) ? response.body : response),
+          status,
+          @headers
+        )
+        response.finish
+        response.to_a
+      else
+        [status, @headers, response]
+      end
+    end
+    
+    private
+              
+      def should_clean? #:nodoc:
+        @headers["Content-Type"] && 
+        @headers["Content-Type"].include?("text/html") &&         
+        self.ignore_paths.none? { |p| @env["PATH_INFO"].start_with?(p) }
+      end
+      
+      def tidy_markup(content) #:nodoc:
+        ::Tidy.open(self.tidy_options) { |tidy| tidy.clean(content) }
+      end
+  end
+end

data/lib/rack/tidy.rb

@@ -0,0 +1,47 @@
+require 'rack'
+
+# = Tidy Markup Cleaner for Rack
+#
+# Rack::Tidy cleans text/html markup by automatically 
+# indenting and reformatting content. Best results are achieved 
+# with valid markup, when you simply want to use this component 
+# to produce clean (X)HTML rendered by templating systems such as ERb.
+#
+# Rack::Tidy relies on the power of the Tidy gem and defaults to settings
+# based on convention. However, you can override these through configuration.
+#
+# === Usage
+#
+# Within a rackup file (or with Rack::Builder):
+#   require 'rack/tidy'
+#   use Rack::Tidy,
+#     :ignore_paths => ['/admin', '/cms'],
+#     'indent-spaces' => 4
+#   run app
+#
+# Rails example:
+#   # above Rails::Initializer block
+#   require 'rack/tidy'
+#
+#   # inside Rails::Initializer block 
+#   config.middleware.use Rack::Tidy,
+#     :ignore_paths => ['/admin', '/cms'],
+#     'indent-spaces' => 4
+module Rack::Tidy
+  autoload :Cleaner, 'rack/tidy/cleaner'
+  
+  # Specify path of Tidy library, e.g.
+  #   "/usr/lib/libtidy.A.dylib" (Mac; also the default if not set)
+  #   "/usr/lib/tidylib.so" (Ubuntu)
+  #   "/usr/lib/libtidy-0.99.so.0" (Fedora/CentOS)
+  TIDY_LIB = defined?(::TIDY_LIB) ? ::TIDY_LIB : '/usr/lib/libtidy.A.dylib'
+  
+  # Create a new Rack::Tidy middleware component that cleans text/html markup
+  # using the Tidy gem. The +options+ Hash can be used to specify which paths
+  # should be ignored during processing as well as Tidy gem configuration values. 
+  # See Cleaner for defaults and http://tidy.sourceforge.net/docs/quickref.html 
+  # for more options
+  def self.new(backend, options = {})
+    Cleaner.new(backend, options)
+  end
+end

data/test/rack_tidy_sample_data.rb

@@ -0,0 +1,97 @@
+module RackTidySampleData
+  
+DIRTY_HTML = <<-dirty
+<!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" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>True Blood - Wikipedia, the free encyclopedia</title>
+<link href="/stylesheets/style.css" media="screen" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<p><i><b>True Blood</b></i> is an <a href="/wiki/Television_in_the_United_States" title="Television in the United States">American</a> <a href="/wiki/Television_drama_series" title="Television drama series" class="mw-redirect">television drama series</a> created and produced by <a href="/wiki/Alan_Ball_(screenwriter)" title="Alan Ball (screenwriter)">Alan Ball</a>. It is based on the <i><a href="/wiki/The_Southern_Vampire_Mysteries" title="The Southern Vampire Mysteries">The Southern Vampire Mysteries</a></i> series of novels by <a href="/wiki/Charlaine_Harris" title="Charlaine Harris">Charlaine Harris</a>. The show is broadcast on the premium cable network <a href="/wiki/HBO" title="HBO">HBO</a> in the United States. It is produced by HBO in association with Ball's production company, Your Face Goes Here Entertainment. It premiered on September 7, 2008.</p>
+<h1>Episode Guide</h1>
+<ul>
+<li><a href="/wiki/True_Blood_(season_1)">Season One</a></li>
+<li><a href="/wiki/True_Blood_(season_2)">Season Two</a></li>
+</ul>
+</body>
+</html>
+dirty
+
+CLEAN_HTML = <<-clean
+<!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" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>
+      True Blood - Wikipedia, the free encyclopedia
+    </title>
+    <link href="/stylesheets/style.css" media="screen" rel="stylesheet" type="text/css" />
+  </head>
+  <body>
+    <p>
+      <i><b>True Blood</b></i> is an <a href="/wiki/Television_in_the_United_States" title="Television in the United States">American</a> <a href="/wiki/Television_drama_series" title="Television drama series" class="mw-redirect">television drama series</a> created and produced by <a href="/wiki/Alan_Ball_(screenwriter)" title="Alan Ball (screenwriter)">Alan Ball</a>. It is based on the <i><a href="/wiki/The_Southern_Vampire_Mysteries" title="The Southern Vampire Mysteries">The Southern Vampire Mysteries</a></i> series of novels by <a href="/wiki/Charlaine_Harris" title="Charlaine Harris">Charlaine Harris</a>. The show is broadcast on the premium cable network <a href="/wiki/HBO" title="HBO">HBO</a> in the United States. It is produced by HBO in association with Ball's production company, Your Face Goes Here Entertainment. It premiered on September 7, 2008.
+    </p>
+    <h1>
+      Episode Guide
+    </h1>
+    <ul>
+      <li>
+        <a href="/wiki/True_Blood_(season_1)">Season One</a>
+      </li>
+      <li>
+        <a href="/wiki/True_Blood_(season_2)">Season Two</a>
+      </li>
+    </ul>
+  </body>
+</html>
+clean
+
+CLEAN_HTML_WITH_4_SPACE_INDENTS = <<-clean_with_4
+<!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" xml:lang="en" lang="en">
+    <head>
+        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+        <title>
+            True Blood - Wikipedia, the free encyclopedia
+        </title>
+        <link href="/stylesheets/style.css" media="screen" rel="stylesheet" type="text/css" />
+    </head>
+    <body>
+        <p>
+            <i><b>True Blood</b></i> is an <a href="/wiki/Television_in_the_United_States" title="Television in the United States">American</a> <a href="/wiki/Television_drama_series" title="Television drama series" class="mw-redirect">television drama series</a> created and produced by <a href="/wiki/Alan_Ball_(screenwriter)" title="Alan Ball (screenwriter)">Alan Ball</a>. It is based on the <i><a href="/wiki/The_Southern_Vampire_Mysteries" title="The Southern Vampire Mysteries">The Southern Vampire Mysteries</a></i> series of novels by <a href="/wiki/Charlaine_Harris" title="Charlaine Harris">Charlaine Harris</a>. The show is broadcast on the premium cable network <a href="/wiki/HBO" title="HBO">HBO</a> in the United States. It is produced by HBO in association with Ball's production company, Your Face Goes Here Entertainment. It premiered on September 7, 2008.
+        </p>
+        <h1>
+            Episode Guide
+        </h1>
+        <ul>
+            <li>
+                <a href="/wiki/True_Blood_(season_1)">Season One</a>
+            </li>
+            <li>
+                <a href="/wiki/True_Blood_(season_2)">Season Two</a>
+            </li>
+        </ul>
+    </body>
+</html>
+clean_with_4
+
+CSS = <<-css
+body {
+font-family: "Lucida Grande", "Lucida Sans Unicode", Verdana, sans-serif;
+font-size: 1em;
+margin: 0 auto;
+}
+css
+
+JS = <<-js
+function(foo) {
+alert('bar')
+}
+js
+
+end

data/test/rack_tidy_test.rb

@@ -0,0 +1,103 @@
+require 'test_helper'
+require 'rack_tidy_sample_data'
+
+class RackTidyTest < Test::Unit::TestCase
+  include RackTidySampleData
+  
+  def get_response(path, body, content_type = 'text/html', options = {})
+    app = Rack::Builder.new do
+      use Rack::Tidy, options
+      run lambda { |env| [200, {'Content-Type' => content_type}, [body] ] }
+    end
+    Rack::MockRequest.new(app).get(path)
+  end
+    
+  context "Rack::Tidy" do  
+    context "with content type equal to 'text/html'" do
+      setup do
+        @response = get_response('/', DIRTY_HTML)
+      end
+      should "clean response body" do
+        assert_equal CLEAN_HTML, @response.body
+      end
+            
+      context "with ignore paths containing one item that matches current path" do        
+        setup do 
+          @response = get_response('/cms', DIRTY_HTML, 'text/html', :ignore_paths => '/cms')
+        end
+        should "not clean response body" do
+          assert_equal DIRTY_HTML, @response.body
+        end        
+      end
+      
+      context "with ignore paths containing array of items with one matching current path" do
+        setup do
+          @response = get_response('/cms',
+            DIRTY_HTML, 
+            'text/html', 
+            :ignore_paths => ['/admin', '/cms'])
+        end
+        should "not clean response body" do
+          assert_equal DIRTY_HTML, @response.body
+        end
+      end
+      
+      context "with ignore paths containing array of items that don't match current path" do
+        setup do
+          @response = get_response('/',
+            DIRTY_HTML, 
+            'text/html', 
+            :ignore_paths => ['/admin', '/cms'])
+        end
+        should "clean response body" do
+          assert_equal CLEAN_HTML, @response.body
+        end
+      end
+          
+      context "with 'indent-spaces' set to 4" do
+        setup do
+          @response = get_response('/',
+            DIRTY_HTML, 
+            'text/html', 
+            'indent-spaces' => 4)
+        end
+
+        should "clean response body, indenting with 4 spaces" do
+          assert_equal CLEAN_HTML_WITH_4_SPACE_INDENTS, @response.body
+        end
+      end
+    end
+    
+    context "with content type equal to 'text/css'" do
+      setup do
+        @response = get_response('/', CSS, 'text/css')
+      end
+      should "not clean response body" do
+        assert_equal CSS, @response.body
+      end
+    end
+    
+    context "with content type equal to 'application/javascript'" do
+      setup do        
+        @response = get_response('/', JS, 'application/javascript')
+      end
+      should "not clean response body" do
+        assert_equal JS, @response.body
+      end
+    end
+  
+    context "with ignore path set and multiple requests" do
+      setup do
+        app = Rack::Builder.new do
+          use Rack::Tidy, :ignore_paths => '/cms'
+          run lambda { |env| [200, {'Content-Type' => 'text/html'}, [DIRTY_HTML] ] }
+        end
+        Rack::MockRequest.new(app).get('/')
+        @response = Rack::MockRequest.new(app).get('/cms')
+      end
+      should "not clean response body" do
+        assert_equal DIRTY_HTML, @response.body
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'rack/tidy'
+require 'rack/mock'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: webficient-rack-tidy
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Phil Misiowiec
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: tidy
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Rack middleware for automatically cleaning markup using Tidy
+email: phil@webficient.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/rack/tidy.rb
+- lib/rack/tidy/cleaner.rb
+- README.rdoc
+has_rdoc: false
+homepage: http://github.com/webficient/rack-tidy
+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: Rack middleware for automatically cleaning markup using Tidy
+test_files: 
+- test/rack_tidy_sample_data.rb
+- test/rack_tidy_test.rb
+- test/test_helper.rb