rack-plastic 0.0.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.0.0 (December 3, 2009)
+* Initial release.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 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,55 @@
+= Rack::Plastic
+
+== Description
+
+If you are creating Rack middleware that changes the HTML response, use
+Plastic to get a head start.  Plastic 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 change_nokogiri_doc(doc)
+    ... insert code that changes the doc ...
+    doc
+  end
+
+  def change_html_string(html)
+    ... insert code that changes the html string ...
+    html
+  end
+
+If you define both methods, change_nokogiri_doc will be called first, then
+the doc will be converted to an HTML string, then the string will be
+passed to change_html_string.
+
+Rack::Plastic also provides some convenience methods for interacting with
+Rack and Nokogiri.
+
+== Examples
+
+The test/middlewares directory has examples of writing middleware using
+Plastic.
+
+== Testing
+
+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 test/railsapp
+* script/server
+* point your browser to http://localhost:3000
+
+To run the Sinatra test app:
+* cd test/sinatraapp
+* ruby app.rb
+* point your browser to http://localhost:4567
+
+To run the Rack test app:
+* cd test/rackapp
+* rackup config.ru
+* point your browser to http://localhost:9292

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake'
+require 'rake/rdoctask'
+
+desc 'Generate documentation for Plastic.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'Rack::Plastic'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name          = "rack-plastic"
+    s.version       = "0.0.0"
+    s.author        = "Wyatt Greene"
+    s.email         = "techiferous@gmail.com"
+    s.summary       = "Helps you write Rack middleware using Nokogiri."
+    s.description   = %Q{
+      If you are creating Rack middleware that changes the HTML response, use
+      Plastic to get a head start.  Plastic takes care of the
+      boilerplate Rack glue so that you can focus on simply changing the HTML.
+    }
+    s.add_dependency('rack', '>= 1.0.0')
+    s.add_dependency('nokogiri', '>= 1.4.0')
+    s.require_path  = "lib"
+    s.files         = []
+    s.files         << "README.rdoc"
+    s.files         << "LICENSE"
+    s.files         << "CHANGELOG"
+    s.files         << "Rakefile"
+    s.files         += Dir.glob("lib/**/*")
+    s.files         += Dir.glob("test/**/*")
+    s.homepage      = "http://github.com/techiferous/rack-plastic"
+    s.requirements  << "none"
+    s.has_rdoc      = true
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end

data/lib/plastic.rb

@@ -0,0 +1,85 @@
+require 'nokogiri'
+
+module Rack
+
+  # If you are creating Rack middleware that changes the HTML response, inherit
+  # from Rack::Plastic to get a head start.  Rack::Plastic takes care of the
+  # boilerplate Rack glue so that you can focus on simply changing the HTML.
+  #
+  # 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 change_nokogiri_doc(doc)
+  #     ... insert code that changes the doc ...
+  #     doc
+  #   end
+  # 
+  #   def change_html_string(html)
+  #     ... insert code that changes the html string ...
+  #     html
+  #   end
+  #
+  # If you define both methods, change_nokogiri_doc will be called first, then
+  # the doc will be converted to an HTML string, then the string will be
+  # passed to change_html_string.
+  #
+  # Rack::Plastic also provides some convenience methods for interacting with
+  # Rack and Nokogiri.
+  #
+  class Plastic
+ 
+    # Rack::Plastic provides an initialize method so that your middleware
+    # doesn't have to.
+    #
+    def initialize(app, options = {}) #:nodoc:
+      @app = app
+      @options = options
+      @p = PlasticHelper.new
+    end
+    
+    # Rack::Plastic provides a call method so that your middleware doesn't
+    # have to.
+    #
+    def call(env) #:nodoc:
+      @p.send(:handle_request, env, @app, @options, self)
+    end
+    
+    private
+
+    # returns the current request as a Rack::Request object
+    #
+    def request #:doc:
+      @p.request
+    end
+    
+    # returns the hash of options that were given to your middleware
+    #
+    def options #:doc:
+      @p.options
+    end
+
+    # a convenience method for adding a new HTML element as the first child
+    # of another HTML element
+    #
+    def add_first_child(parent, new_child) #:doc:
+      parent.children.first.add_previous_sibling(new_child)
+    end
+ 
+    # a convenience method for quickly creating a new HTML element
+    #
+    def create_node(doc, node_name, content=nil) #:doc:
+      node = Nokogiri::XML::Node.new(node_name, doc)
+      node.content = content if content
+      node
+    end
+    
+    # Nokogiri's node.content=(text) method automatically HTML escapes the given text.
+    # This can cause problems.  This method updates the text of an HTML element
+    # without escaping the text.
+    #
+    def update_text(node, new_text) #:doc:
+      node.send(:native_content=, new_text)
+    end
+
+  end
+end

data/lib/plastic_helper.rb

@@ -0,0 +1,81 @@
+require 'nokogiri'
+
+module Rack
+
+  # PlasticHelper was created to separate Plastic's implementation from Plastic's
+  # interface.
+  #
+  # This class basically contains all of the Rack code that you'd have to write every
+  # time you wanted to write a new middleware that modifies the HTML response.
+  #
+  class PlasticHelper #:nodoc:
+    
+    def request
+      @request
+    end
+    
+    def options
+      @options
+    end
+
+    private
+    
+    def handle_request(env, app, options, plastic)
+      @app = app
+      @options = options
+      @request = Rack::Request.new(env)
+      status, @headers, @body = @app.call(env)
+      if html?
+        if plastic.respond_to? :change_nokogiri_doc
+            doc = Nokogiri::HTML(body_to_string)
+          doc = plastic.send(:change_nokogiri_doc, doc)
+          if !doc.is_a?(Nokogiri::XML::Document)
+            raise "You must return a Nokogiri::XML::Document object from change_nokogiri_doc."
+          end
+          new_body_string = doc.to_html
+        else
+          new_body_string = body_to_string
+        end
+        if plastic.respond_to? :change_html_string
+          new_body_string = plastic.send(:change_html_string, new_body_string)
+          if !new_body_string.is_a?(String)
+            raise "You must return a String from change_html_string."
+          end
+        end
+        update_response_body(new_body_string)
+        update_content_length
+      end
+      [status, @headers, @body]
+    end
+    
+    def html?
+      @headers["Content-Type"] && @headers["Content-Type"].include?("text/html")
+    end
+
+    def body_to_string
+      s = ""
+      @body.each { |x| s << x }
+      s
+    end
+    
+    def update_response_body(new_body_string)
+      # If we're dealing with a Rails response, we don't want to throw the
+      # response object away, we just want to update the response string.
+      if @body.class.name == "ActionController::Response"
+        @body.body = new_body_string
+      else
+        @body = [new_body_string]
+      end
+    end
+
+    def update_content_length
+      length = 0
+      @body.each do |s|   # we can't use inject because @body may not respond to it
+        length += Rack::Utils.bytesize(s)   # we use Rack::Utils.bytesize to avoid
+                                            # incompatibilities between Ruby 1.8 and 1.9
+      end
+      @headers['Content-Length'] = length.to_s
+    end
+    
+  end
+end

data/test/middlewares/initial.rb

@@ -0,0 +1,35 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'plastic')
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'plastic_helper')
+
+# This middleware emphasizes the first character in every paragraph, not unlike
+# the initials in illuminated manuscripts of the Middle Ages.
+#
+module Rack
+  class Initial < Plastic
+ 
+    def change_nokogiri_doc(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
+              update_text(node, initial_whitespace + "openingspantag" + initial_character + 
+               "closingspantag" + rest_of_text)
+            end
+            break
+          end
+        end
+      end
+      doc
+    end
+    
+    def change_html_string(html)
+      html.gsub!(/openingspantag/, '<span style="font-size: 150%; font-weight: bold;">')
+      html.gsub!(/closingspantag/, '</span>')
+      html
+    end
+    
+  end
+end

data/test/middlewares/intro.rb

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

data/test/middlewares/l337.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'plastic')
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'plastic_helper')
+
+# This middleware converts the text of every paragraph to leetspeak.
+#
+module Rack
+  class L337 < Plastic
+ 
+    def change_nokogiri_doc(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
+      doc
+    end
+    
+  end
+end

data/test/middlewares/stylizer.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'plastic')
+require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'plastic_helper')
+
+# This middleware demonstrates how to add inline CSS styles to the web page.
+#
+module Rack
+  class Stylizer < Plastic
+ 
+    def change_nokogiri_doc(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"
+      doc
+    end
+    
+  end
+end

data/test/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