phorsfall-tidy_rack 0.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Paul Horsfall
+
+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.textile

@@ -0,0 +1,36 @@
+h1. Tidy Rack
+
+Tidy Rack is a "Rack":http://rack.rubyforge.org/ middleware that runs the body of HTML responses through "Tidy":http://tidy.sourceforge.net/.
+
+It's almost certainly a terrible idea to use this in production, but in development it does two useful things:
+
+* Includes an HTML comment at the end of the response body that includes info/errors/warnings generated by Tidy.
+* Prettifies and indents HTML, making View Source easier on the eye.
+
+h2. Installation
+
+Install the Gem:
+
+<pre>
+  gem install phorsfall-tidy_rack --source http://gems.github.com
+</pre>
+
+In Rails, you can add Tidy Rack to your middleware stack by adding the following to @config/development.rb@:
+
+<pre>
+  config.middleware.use 'TidyRack'
+</pre>
+
+In Sinatra or a RackUp script, this should work:
+
+<pre>
+  use TidyRack
+</pre>
+
+h2. Dependencies
+
+You'll need the "Tidy":http://tidy.sourceforge.net/ binaries available to use Tidy Rack. If you're on OS X or Linux you've likely got them already, if you're on Windows you probably have not.
+
+h2. Copyright
+
+Copyright (c) 2009 Paul Horsfall. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tidy_rack"
+    gem.summary = %Q{A Rack middleware that runs the response body through HTML Tidy.}
+    gem.email = "horsfallp@gmail.com"
+    gem.homepage = "http://github.com/phorsfall/tidy_rack"
+    gem.authors = ["Paul Horsfall"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tidy_rack #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 0
+:major: 0

data/lib/tidy_rack.rb

@@ -0,0 +1,26 @@
+require 'Open3'
+
+class TidyRack
+  def initialize(app)
+    @app = app
+  end
+  
+  def call(env)
+    status, headers, response = @app.call(env)
+    if headers['Content-Type'].include?('text/html')
+      response = tidy(response)
+      headers['Content-Length'] = response.size.to_s
+    end
+    [status, headers, response]
+  end
+  
+  def tidy(response)
+    html = ''
+    Open3.popen3("tidy -i") do |stdin, stdout, stderr|
+      response.each { |s| stdin.write s }
+      stdin.close
+      html << stdout.read
+      html << "<!--\n#{stderr.read}\n-->\n"
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'hpricot'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tidy_rack'
+
+class Test::Unit::TestCase
+end

data/test/tidy_rack_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class TidyRackTest < Test::Unit::TestCase
+  def html
+    <<-eof
+      <html>
+      <head>
+      <title>Tidy Rack<title>
+      </head>
+      <body>Hello, world!</body>
+      </html>
+    eof
+  end
+  
+  should "include the HTML Tidy generated meta tag" do
+    app = lambda { |env| [200, { 'Content-Type' => 'text/html' }, html] }
+    status, headers, response = TidyRack.new(app).call({})
+    doc = Hpricot(response)
+    assert doc.at('meta[@content*="HTML Tidy"]')
+  end
+  
+  should "only tidy html responses" do
+    app = lambda { |env| [200, { 'Content-Type' => 'text/plain' }, html] }
+    status, headers, response = TidyRack.new(app).call({})
+    doc = Hpricot(response)
+    assert_nil doc.at('meta[@content*="HTML Tidy"]')
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: phorsfall-tidy_rack
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Paul Horsfall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-05 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: horsfallp@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION.yml
+- lib/tidy_rack.rb
+- test/test_helper.rb
+- test/tidy_rack_test.rb
+has_rdoc: true
+homepage: http://github.com/phorsfall/tidy_rack
+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.2.0
+signing_key: 
+specification_version: 2
+summary: A Rack middleware that runs the response body through HTML Tidy.
+test_files: 
+- test/test_helper.rb
+- test/tidy_rack_test.rb