mynyml-rack-abstract-format 0.9

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/README

@@ -0,0 +1,28 @@
+SUMMARY
+
+Strips the extension from the requested path (env['PATH_INFO']) and stores it
+into env['request.format']. 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 from the requested format.
+
+USAGE
+
+use Rack::AbstractFormat
+run app
+
+The request:
+
+  GET /path/resource.xml
+
+will become:
+
+  GET /path/resource
+  env['request.format'] #=> 'xml'
+
+TIP
+
+To make sure there is always an extension, as well as to retrieve format
+information from the request's Accept header, use together with rack-contrib's
+Rack::AcceptFormat middleware.

data/Rakefile

@@ -0,0 +1,66 @@
+# --------------------------------------------------
+# based on thin's Rakefile (http://github.com/macournoyer/thin)
+# --------------------------------------------------
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'pathname'
+require 'yaml'
+
+RUBY_1_9  = RUBY_VERSION =~ /^1\.9/
+WIN       = (RUBY_PLATFORM =~ /mswin|cygwin/)
+SUDO      = (WIN ? "" : "sudo")
+
+def gem
+  RUBY_1_9 ? 'gem19' : 'gem'
+end
+
+def all_except(res)
+  Dir['**/*'].reject do |path|
+    Array(res).any? {|re| path.match(re) }
+  end
+end
+
+spec = Gem::Specification.new do |s|
+  s.name            = 'rack-abstract-format'
+  s.version         = '0.9'
+  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          = "Martin Aumont"
+  s.email           = 'mynyml@gmail.com'
+  s.homepage        = ''
+  s.has_rdoc        = true
+  s.require_path    = "lib"
+  s.files           = all_except([/doc\/.*/, /pkg\/*/])
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+desc "Remove package products"
+task :clean => :clobber_package
+
+desc "Update the gemspec for GitHub's gem server"
+task :gemspec do
+  Pathname("#{spec.name}.gemspec").open('w') {|f| f << YAML.dump(spec) }
+end
+
+desc "Install gem"
+task :install => [:clobber, :package] do
+  sh "#{SUDO} #{gem} install pkg/#{spec.full_name}.gem"
+end
+
+desc "Uninstall gem"
+task :uninstall => :clean do
+  sh "#{SUDO} #{gem} uninstall -v #{spec.version} -x #{spec.name}"
+end
+
+desc "Generate rdoc documentation."
+Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.title    = "Simple Router - Document"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}

data/examples/app.rb

@@ -0,0 +1,19 @@
+# run me with:
+#   $rackup examples/app.rb
+#
+require 'rubygems'
+require 'rack'
+require 'rack/abstract_format'
+
+class App
+  def call(env)
+    body = <<-TXT
+      env['PATH_INFO']      #=> #{env['PATH_INFO'].inspect}
+      env['request.format'] #=> #{env['request.format'].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,17 @@
+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['request.format'] = path.extname.sub(/^\./,'')
+      @app.call(env)
+    end
+  end
+end

data/simple_router.gemspec

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: simple_router
+version: !ruby/object:Gem::Version 
+  version: 0.8.1
+platform: ruby
+authors: 
+- Martin Aumont
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-21 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Rack middleware that abstracts format information (extension) away from the path (into env)
+email: mynyml@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- test
+- test/test_abstract_format.rb
+- test/test_helper.rb
+- lib
+- lib/rack
+- lib/rack/abstract_format.rb
+- LICENSE
+- README
+has_rdoc: true
+homepage: ""
+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: 
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: Rack middleware that abstracts format information (extension) away from the path (into env)
+test_files: []
+

data/test/test_abstract_format.rb

@@ -0,0 +1,31 @@
+require 'test/test_helper'
+
+App = Rack::Builder.new {
+  use Rack::Lint
+  use Rack::AbstractFormat
+  run lambda {|env| [200, {'Content-Type' => 'text/html'}, ['']] }
+}.to_app
+
+class AbstractFormatTest < Test::Unit::TestCase
+
+  def get(path)
+    env = Rack::MockRequest.env_for(path)
+    App.call(env).last
+    env
+  end
+
+  test "strips extension" do
+    env = get('/path/resource.xml')
+    assert_equal '/path/resource', env['PATH_INFO']
+  end
+
+  test "doesn't get confused with dots in path" do
+    env = get('/path.to/resource.xml')
+    assert_equal '/path.to/resource', env['PATH_INFO']
+  end
+
+  test "stores format in environment" do
+    env = get('/path.to/resource.xml')
+    assert_equal 'xml', env['request.format']
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require 'pathname'
+require 'test/unit'
+require 'rubygems'
+require 'rack'
+begin
+  require 'ruby-debug'
+rescue LoadError, RuntimeError
+end
+
+root = Pathname(__FILE__).dirname.parent.expand_path
+$:.unshift(root.join('lib'))
+
+require 'rack/abstract_format'
+
+class Test::Unit::TestCase
+  def self.test(name, &block)
+    name = :"test_#{name.gsub(/\s/,'_')}"
+    define_method(name, &block)
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: mynyml-rack-abstract-format
+version: !ruby/object:Gem::Version 
+  version: "0.9"
+platform: ruby
+authors: 
+- Martin Aumont
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-20 21:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Rack middleware that abstracts format (extension) away from the path (into env)
+email: mynyml@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- test
+- test/test_abstract_format.rb
+- test/test_helper.rb
+- examples
+- examples/app.rb
+- simple_router.gemspec
+- lib
+- lib/rack
+- lib/rack/abstract_format.rb
+- LICENSE
+- README
+has_rdoc: true
+homepage: ""
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Rack middleware that abstracts format (extension) away from the path (into env)
+test_files: []
+