rack-mason 0.1.2

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+Gemfile.lock
+examples/railsapp/log/*.log
+.bundle/

data/CHANGELOG

@@ -0,0 +1,24 @@
+0.1.2 (February 21, 2011)
+* BUGFIX: process_html test helper was not working in Ruby 1.9.
+* Moved test apps into the examples directory.
+* Added a basic automated test.
+* Added bundler support.
+* Small tweaks such as require paths, gitignore updates, etc.
+
+0.1.1 (July 18, 2010)
+* Tweaked documentation but did not change code.
+
+0.1.0 (July 18, 2010)
+* Added convenience methods for testing middleware based on Rack::Mason.
+
+0.0.3 (December 3, 2009)
+* BUGFIX: 'require' problem.
+
+0.0.2 (December 3, 2009)
+* BUGFIX: Namespace error.
+
+0.0.1 (December 3, 2009)
+* BUGFIX: Wrong filename.
+
+0.0.0 (December 3, 2009)
+* Initial release.

data/Gemfile

@@ -0,0 +1,16 @@
+source :rubygems
+gem 'rack', '>= 1.0.0'
+gem 'nokogiri', '>= 1.4.0'
+
+group :development do
+  gem 'jeweler'
+end
+
+group :test do
+  gem 'diffy', '2.0.2'
+  gem 'colored'
+end
+
+group :development, :test do
+  gem 'rake'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009, 2010 Wyatt M. Greene
+
+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,54 @@
+= Rack::Mason
+
+== Copyright
+
+Rack::Mason is (c) radiospiel@open-lab.org. It is licensed under the terms of the MIT License.
+Substantial parts are based on https://github.com/techiferous/rack-mason (c) techiferous@gmail.com
+
+== Description
+
+If you are creating Rack middleware that changes the HTML response, use
+Rack::Mason to get a head start.  Rack::Mason takes care of the
+boilerplate Rack glue so that you can focus on simply changing the HTML.
+
+== Usage
+
+There are two ways you can change the HTML: as a Nokogiri document or as
+a string.  Simply define one of the following methods:
+
+  def update_body(doc)
+    ... insert code that changes the doc ...
+  end
+
+Rack::Mason also provides some convenience methods for interacting with
+Rack and Nokogiri as well as some convenience methods for testing.
+
+== Examples
+
+The examples/middlewares directory has examples of writing middleware using
+Rack::Mason.
+
+== Testing
+
+Rack::Mason comes with some test helpers that make it easier for you to
+write tests for your Rack middleware.  Refer to the documentation for
+MasonTestHelper for more details.
+
+If you want to test Rack::Mason itself, this gem doesn't come with automated tests,
+but it provides manual tests.  Each of the example middlewares is inserted into a
+Sinatra, Rails, and Rack test app.
+
+To run the Rails test app:
+* cd examples/railsapp
+* script/server
+* point your browser to http://localhost:3000
+
+To run the Sinatra test app:
+* cd examples/sinatraapp
+* ruby app.rb
+* point your browser to http://localhost:4567
+
+To run the Rack test app:
+* cd examples/rackapp
+* rackup config.ru
+* point your browser to http://localhost:9292

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Generate documentation for Rack::Mason.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'Rack::Mason'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test Rack::Mason'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+load "#{File.dirname(__FILE__)}/vex/gem.rake"

data/examples/middlewares/initial.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'rack-mason')
+
+# This middleware emphasizes the first character in every paragraph, not unlike
+# the initials in illuminated manuscripts of the Middle Ages.
+#
+module Rack
+  class Initial < Mason
+ 
+    def update_body(doc)
+      doc.css("p").each do |p|
+        p.traverse do |node|
+          if node.text?
+            if node.content =~ /(.*?)(\S)(.*)/m
+              initial_whitespace = $1
+              initial_character = $2
+              rest_of_text = $3
+              text = initial_whitespace + '<span style="font-size: 150%; font-weight: bold;">' + initial_character + 
+               '</span>' + rest_of_text
+              node.replace text
+            end
+            break
+          end
+        end
+      end
+    end
+  end
+end

data/examples/middlewares/intro.rb

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'rack-mason')
+
+# This middleware demonstrates how you would add an HTML element to the beginning
+# of a web page.
+#
+module Rack
+  class Intro < Mason
+ 
+    def update_body(doc)
+      h1 = create_node(doc, "h1", "Holy shnikes!")
+      h1['style'] = "text-align: center;"
+      add_first_child(doc.at_css("body"), h1)
+    end
+    
+  end
+end

data/examples/middlewares/l337.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'rack-mason')
+
+# This middleware converts the text of every paragraph to leetspeak.
+#
+module Rack
+  class L337 < Mason
+ 
+    def update_body(doc)
+      doc.css("p").each do |p|
+        p.traverse do |node|
+          if node.text?
+            l337_text = node.content.upcase.tr('ABCDEFGHIJKLMNOPQRSTUVWXYZ',
+                                               '48CD3F6H1JKLMN0P9R57UVWxY2')
+            update_text(node, l337_text)
+          end
+        end
+      end
+    end
+    
+  end
+end

data/examples/middlewares/stylizer.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'rack-mason')
+
+# This middleware demonstrates how to add inline CSS styles to the web page.
+#
+module Rack
+  class Stylizer < Mason
+ 
+    def update_body(doc)
+      doc.at_css("body")["style"] = "font-family: Georgia, serif; font-style: italic;"
+      doc.at_css("div#container")["style"] =
+       "margin-left:auto;margin-right:auto;width:500px;position:relative"
+    end
+    
+  end
+end

data/examples/rackapp/app.rb

@@ -0,0 +1,105 @@
+class App
+
+  def call(env)
+    response = Rack::Response.new
+    request = Rack::Request.new(env)
+    response['Content-Type'] = 'text/html'
+    if request.path =~ /more/
+      response.write more
+    else
+      response.write front_page
+    end
+    response.finish
+  end
+  
+  def front_page
+    %Q{
+      <!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>
+          <title>The Greatest Movie of All Time</title>
+        </head>
+        <body>
+          <div id="container">
+            <p>
+              What my associate is trying to say is that our new brake pads are really cool.
+              You're not even gonna believe it.
+            </p>
+            <p>
+              Like, um, let's say you're driving along
+              the road, with your family.<br />
+              And you're driving along...la de da...woo...<br />
+              And then all of a sudden
+              there's a truck tire
+              in the middle of the road
+              and you hit the brakes.<br />
+              Screeeee!
+            </p>
+            <p>
+              Woah, that was close.
+            </p>
+            <p>
+              Now let's see what happens when you're
+              driving with "the other guy's brake pads".
+            </p>
+            <p>
+              You're driving along,<br />
+              you're driving along,<br />
+              and all of a sudden your kids are
+              yelling from the back seat:<br />
+              "I gotta go to the bathroom, daddy!"<br />
+              "Not now, dammit!"<br />
+              "Truck tire! I can't stop! Aaaaa! Help!"<br />
+              "There's a cliff! Aaaaa!"<br />
+              And your family screaming:<br />
+              "Oh my God, we're burning alive!"<br />
+              "No! I can't feel my legs!"<br />
+              Here comes the meat-wagon! Woo woo woo!<br />
+              And the medic gets out and says:<br />
+              "Oh! My! God!"<br />
+              New guy's in the corner puking his guts out:<br />
+              Blllleeeeeeeaaaaaaaaaaah!<br />
+              Blllleeeeeeeaaaaaaaaaaah!<br />
+            </p>
+            <p>
+              All because you wanna save a coupla extra pennies.
+            </p>
+            <a href="/more">&laquo; inflict me with more &raquo;</a>
+          </div>
+        </body>
+      </html>
+    }
+  end
+  
+  def more
+    %Q{
+      <!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>
+          <title>More of the Greatest Movie of All Time</title>
+        </head>
+        <body>
+          <div id="container">
+            <p>
+              D+? Oh my God! I passed! I passed! Oh, man i got a D+! I'm gonna graduate!
+              I'm gonna graduate! D+!
+            </p>
+            <p>
+              Hey guys, do i look different now that i'm a college grad?
+            </p>
+            <p>
+              Apparently they give a lot fewer D+'s than D-'s.
+              It's not a grade they like to give out, i'll tell ya that right now.
+            </p>
+            <a href="/">&laquo; take me back &raquo;</a>
+          </div>
+        </body>
+      </html>
+    }
+  end
+
+end

data/examples/rackapp/config.ru

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__), 'app')
+require File.join(File.dirname(__FILE__), '..', 'middlewares', 'initial')
+require File.join(File.dirname(__FILE__), '..', 'middlewares', 'intro')
+require File.join(File.dirname(__FILE__), '..', 'middlewares', 'l337')
+require File.join(File.dirname(__FILE__), '..', 'middlewares', 'stylizer')
+
+# Note that these middlewares will seem to be applied in backwards order.
+# In other words, Rack::Stylizer parses the resulting HTML first, then
+# passes it to Rack::Initial, then to Rack::L337, and finally to Rack::Intro.
+
+use Rack::Intro
+use Rack::L337
+use Rack::Initial
+use Rack::Stylizer
+
+run App.new

data/examples/railsapp/README

@@ -0,0 +1,243 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create 
+database-backed web applications according to the Model-View-Control pattern. 
+
+This pattern splits the view (also called the presentation) into "dumb" templates
+that are primarily responsible for inserting pre-built data in between HTML tags.
+The model contains the "smart" domain objects (such as Account, Product, Person,
+Post) that holds all the business logic and knows how to persist themselves to
+a database. The controller handles the incoming requests (such as Save New Account,
+Update Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
+with a variety of other web servers.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
+Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
+FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
+
+== Apache .htaccess example for FCGI/CGI
+
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# 
+# Example:
+#   RewriteCond %{REQUEST_URI} ^/notrails.*
+#   RewriteRule .* - [L]
+
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# 
+# For better performance replace the dispatcher with the fastcgi one
+#
+# Example:
+#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+#
+# Example:
+#   Alias /myrailsapp /path/to/myrailsapp/public
+#   RewriteBase /myrailsapp
+
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# 
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong.  Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files.  Have "tail -f" commands running
+on the server.log and development.log. Rails will automatically display debugging
+and runtime information to these files. Debugging info will also be shown in the
+browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your Mongrel or
+Webrick server with --debugger. This means that you can break out of execution at any point
+in the code, investigate and change the model, AND then resume execution! 
+You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
+Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
+You would be connected to the database with the credentials defined in database.yml.
+Starting the script without arguments will connect you to the development database. Passing an
+argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from ApplicationController
+  which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the common
+  header/footer method of wrapping views. In your views, define a layout using the
+  <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
+  call <% yield %> to render the view using this layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are generated
+  for you automatically when using script/generate for controllers. Helpers can be used to
+  wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files. This should be
+  set as the DOCUMENT_ROOT of your web server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  If the app has frozen rails, those gems also go here, under vendor/rails/.
+  This directory is in the load path.