rack-abstract-format 0.9.8

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2009 Martin Aumont (mynyml)
+
+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/Manifest

@@ -0,0 +1,10 @@
+.gitignore
+LICENSE
+Manifest
+README
+Rakefile
+examples/app.ru
+lib/rack/abstract_format.rb
+rack-abstract-format.gemspec
+test/test_abstract_format.rb
+test/test_helper.rb

data/README

@@ -0,0 +1,27 @@
+===== Summary
+
+Strips the extension from the requested path (env['PATH_INFO']), casts it to
+media type, and prepends it to env['HTTP_ACCEPT']. This allows dealing with path
+information separately from format information, which are often different
+concerns.
+
+This is especially useful when dealing with routes as it allows a resource to
+always point to the same action independently of the requested format.
+
+===== Usage
+
+require 'rack'
+require 'rack/abstract_format'
+
+use Rack::AbstractFormat
+run app
+
+The request:
+
+  GET /path/resource.xml
+  Accept: text/html
+
+will become:
+
+  GET /path/resource
+  env['HTTP_ACCEPT'] #=> 'application/xml,text/html'

data/Rakefile

@@ -0,0 +1,27 @@
+def gem_opt
+  defined?(Gem) ? "-rubygems" : ""
+end
+
+# --------------------------------------------------
+# Tests
+# --------------------------------------------------
+task(:default => :test)
+
+desc "Run tests"
+task(:test) do
+  exit system("ruby #{gem_opt} test/test_abstract_format.rb")
+end
+
+# --------------------------------------------------
+# Docs
+# --------------------------------------------------
+desc "Generate YARD Documentation"
+task(:yardoc) do
+  require 'yard'
+  files   = %w( lib/**/*.rb )
+  options = %w( -o doc/yard --readme README --files LICENSE )
+  YARD::CLI::Yardoc.run *(options + files)
+end
+
+
+

data/examples/app.ru

@@ -0,0 +1,28 @@
+# run me with:
+#   $rackup examples/app.ru -p 3000
+#
+# and try different url extensions:
+#		localhost:3000/foo.html
+#		localhost:3000/foo.xml
+#		localhost:3000/foo.txt
+#		...
+#
+require 'pathname'
+require 'rack'
+
+$:.unshift Pathname(__FILE__).dirname.parent + 'lib'
+require 'rack/abstract_format'
+
+class App
+  def call(env)
+    body = <<-TXT
+      env['PATH_INFO']    #=> #{env['PATH_INFO'].inspect}
+      env['HTTP_ACCEPT']  #=> #{env['HTTP_ACCEPT'].inspect}
+    TXT
+    [200, {'Content-Type' => 'text/plain'}, [body]]
+  end
+end
+
+use Rack::AbstractFormat
+run App.new
+

data/lib/rack/abstract_format.rb

@@ -0,0 +1,22 @@
+require 'pathname'
+
+module Rack
+  class AbstractFormat
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      path = Pathname(env['PATH_INFO'])
+      env['PATH_INFO'] = path.to_s.sub(/#{path.extname}$/,'')
+      env['HTTP_ACCEPT'] = concat(env['HTTP_ACCEPT'], Rack::Mime.mime_type(path.extname, nil))
+      @app.call(env)
+    end
+
+    private
+      def concat(accept, type)
+        (accept || '').split(',').unshift(type).compact.join(',')
+      end
+  end
+end

data/rack-abstract-format.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name                = 'rack-abstract-format'
+  s.version             = "0.9.8"
+  s.summary             = "Rack middleware that abstracts format (extension) away from the path (into env)"
+  s.description         = "Rack middleware that abstracts format (extension) away from the path (into env)."
+  s.author              = "mynyml"
+  s.email               = "mynyml@gmail.com"
+  s.homepage            = "http://github.com/mynyml/rack-abstract-format"
+  s.rubyforge_project   = "rack-abstract-format"
+  s.has_rdoc            =  false
+  s.require_path        = "lib"
+  s.files               =  File.read("Manifest").strip.split("\n")
+
+  s.add_development_dependency 'rack'
+  s.add_development_dependency 'nanotest'
+end

data/test/test_abstract_format.rb

@@ -0,0 +1,30 @@
+require 'test/test_helper'
+
+App = Rack::Builder.new {
+  use Rack::Lint
+  use Rack::AbstractFormat
+  run lambda {|env| [200, {'Content-Type' => 'text/html'}, ['']] }
+}.to_app
+
+def get(path, opts={})
+  env = Rack::MockRequest.env_for(path, opts)
+  App.call(env)
+  env
+end
+
+# test: strips extension
+env = get('/path/resource.xml')
+assert { '/path/resource' == env['PATH_INFO'] }
+
+# test: doesn't get confused with dots in path
+env = get('/path.to/resource.xml')
+assert { '/path.to/resource' == env['PATH_INFO'] }
+
+# test: prepends requested media type to Accept header
+env = get('/path/resource.html', 'HTTP_ACCEPT' => 'application/xml')
+assert { 'text/html,application/xml' == env['HTTP_ACCEPT'] }
+
+# test: url without extension
+env = get('/path/resource', 'HTTP_ACCEPT' => 'text/html')
+assert { 'text/html' == env['HTTP_ACCEPT'] }
+

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'pathname'
+
+require 'rack'
+require 'nanotest'
+begin
+  require 'ruby-debug'
+  require 'redgreen'        # gem install mynyml-redgreen
+  require 'nanotest/focus'  # gem install nanotest_extensions
+  require 'nanotest/stats'  # gem install nanotest_extensions
+rescue LoadError, RuntimeError
+end
+
+$:.unshift Pathname(__FILE__).dirname.parent + 'lib'
+require 'rack/abstract_format'
+
+include Nanotest

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: rack-abstract-format
+version: !ruby/object:Gem::Version 
+  version: 0.9.8
+platform: ruby
+authors: 
+- mynyml
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-06 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nanotest
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Rack middleware that abstracts format (extension) away from the path (into env).
+email: mynyml@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- LICENSE
+- Manifest
+- README
+- Rakefile
+- examples/app.ru
+- lib/rack/abstract_format.rb
+- rack-abstract-format.gemspec
+- test/test_abstract_format.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/mynyml/rack-abstract-format
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: rack-abstract-format
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rack middleware that abstracts format (extension) away from the path (into env)
+test_files: []
+