RubyGems - avdi-rack_base_uri - Versions diffs - 0.0.2 - Mend

avdi-rack_base_uri 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

data/README ADDED

@@ -0,0 +1,65 @@
+= rack_base_uri
+* http://avdi.org/
+== DESCRIPTION:
+A middleware to automatically set the base URI for [X]HTML documents. This is
+useful when you want to mount a web application on a subdirectory,
+e.g. http://example.org/myapp/
+The effect is accomplished by munging [X]HTML responses with HPricot.  So in the
+above example, HTML documents will have a "<base
+href='http://example.org/myapp/'>" element added to their HEAD, and XHTML
+documents will have the xml:base attribute of the root element set to
+'http://example.org/myapp/'.
+== FEATURES/PROBLEMS:
+* It might work
+== SYNOPSIS:
+In your rackup file:
+ require 'rack_base_uri'
+ use Rack::CommonLogger
+ map "/lobster" do
+   use Rack::BaseUri
+   run Rack::Lobster.new
+ end
+== REQUIREMENTS:
+* Rack
+* Hpricot
+== INSTALL:
+TBD
+== LICENSE:
+(The MIT License)
+Copyright (c) 2008 FIX
+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/lib/rack_base_uri.rb ADDED

@@ -0,0 +1,38 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require 'rubygems'
+require 'rack'
+require 'hpricot'
+module Rack
+  class BaseUri
+    def initialize(app)
+      @app = app
+    end
+    def call(env)
+      host    = env.fetch('HTTP_HOST') {
+        env['rack.url_scheme'] + '://' + env['SERVER_NAME']  + ':' + env['SERVER_PORT']
+      }
+      base    = host + env['SCRIPT_NAME']
+      result  = @app.call(env)
+      headers = result[1]
+      doc     = Hpricot(result[2].to_s)
+      case headers['Content-Type']
+      when 'text/html'
+        (doc/'head').append("<base href='#{base}'>")
+      when 'application/xhtml+xml', 'text/xml'
+        root = doc.root
+        if root.name.downcase == 'html'
+          root['xml:base'] = base
+        end
+      end
+      return [
+        result[0],
+        result[1],
+        Array(doc.to_s)
+      ]
+    end
+  end
+end

data/lib/rack_base_uri/version.rb ADDED

@@ -0,0 +1,9 @@
+class Rack::BaseUri #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 2
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/spec/rack_base_uri_spec.rb ADDED

@@ -0,0 +1,99 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'rubygems'
+require 'rack/mock'
+require 'rack/urlmap'
+require 'hpricot'
+describe Rack::BaseUri do
+  before :each do
+    @headers = {'Content-Type' => 'text/html'}
+    @body    = <<-HTML
+      <html>
+        <head>
+          <title>Test Page</title>
+        </head>
+         <body>Hello World</body>
+      </html>
+    HTML
+    @result  = [
+      200,
+      @headers,
+      [@body]
+    ]
+    @app     = stub("app", :call => @result)
+    @it      = Rack::BaseUri.new(@app)
+    @base    = 'http://example.org/subdir'
+  end
+  def do_request
+    @map      = Rack::URLMap.new({@base => @it})
+    @request  = Rack::MockRequest.new(@map)
+    @response = @request.get("/subdir/foo", 'HTTP_HOST' => 'http://example.org')
+    @doc      = Hpricot(@response.body)
+  end
+  describe "with HTML content" do
+    it "should add a base element to the HTML" do
+      do_request
+      @response.should be_ok
+      tag = @doc.at("head base")
+      tag.should_not be_nil
+      tag['href'].should == "http://example.org/subdir"
+    end
+  end
+  describe "with application/xhtml+xml content type" do
+    before :each do
+      @headers['Content-Type'] = 'application/xhtml+xml'
+    end
+    it "should add a base element to the HTML" do
+      do_request
+      @response.should be_ok
+      html = @doc.at("html")
+      html.should_not be_nil
+      html['xml:base'].should == "http://example.org/subdir"
+    end
+  end
+  describe "with text/xml content type" do
+    before :each do
+      @headers['Content-Type'] = 'text/xml'
+    end
+    it "should add a base element to the HTML" do
+      do_request
+      @response.should be_ok
+      html = @doc.at("html")
+      html.should_not be_nil
+      html['xml:base'].should == "http://example.org/subdir"
+    end
+  end
+  describe "with text/xml content type but non-HTML content" do
+    before :each do
+      @headers['Content-Type'] = 'text/xml'
+      @content = "<foo></foo>"
+      @body.replace(@content)
+    end
+    it "should leave the content alone" do
+      do_request
+      @response.should be_ok
+      @response.body.should == @content
+    end
+  end
+  describe "with text/html content type but plain text content" do
+    before :each do
+      @headers['Content-Type'] = 'text/html'
+      @content = "Not HTML"
+      @body.replace(@content)
+    end
+    it "should leave the content alone" do
+      do_request
+      @response.should be_ok
+      @response.body.should == @content
+    end
+  end
+end

data/spec/spec_helper.rb ADDED

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'rack_base_uri'

metadata ADDED

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: avdi-rack_base_uri
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Avdi Grimm
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2008-07-08 00:00:00 -07:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    version:
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "="
+      - !ruby/object:Gem::Version
+        version: "0.6"
+    version:
+description: A middleware to automatically set the base URI for [X]HTML documents. This is useful when you want to mount a web application on a subdirectory, e.g. http://example.org/myapp/
+email: avdi@avdi.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README
+- lib/rack_base_uri.rb
+- lib/rack_base_uri/version.rb
+- spec/spec_helper.rb
+- spec/rack_base_uri_spec.rb
+has_rdoc: true
+homepage: http://github.com/avdi/rack_base_uri/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.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 plugin for automatically setting document base URIs in [X]HTML
+test_files: []