rack-abstract-format 0.9.8 → 0.9.9

data/.gitignore

@@ -1 +1,2 @@
 pkg/
+*.gem

data/Manifest

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

data/README.md

@@ -0,0 +1,55 @@
+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'
+
+AbstractFormat also accepts an optional argument, used to set the default
+format that should be assumed when none is specified on the URL:
+
+    use Rack::AbstractFormat, 'text/html'
+    #=> GET /path/resource      # requested
+    #=> GET /path/resource.html # assumed
+
+See Also
+--------
+
+* [simple_router][1]
+* [rack-respond_to][2]
+
+Links
+-----
+
+* code: <http://github.com/mynyml/rack-abstract-format>
+* docs: <http://rdoc.info/projects/mynyml/rack-abstract-format>
+* wiki: <http://wiki.github.com/mynyml/rack-abstract-format>
+* bugs: <http://github.com/mynyml/rack-abstract-format/issues>
+
+
+[1]: http://github.com/mynyml/simple_router
+[2]: http://github.com/mynyml/rack-respond_to
+

data/Rakefile

@@ -23,5 +23,3 @@ task(:yardoc) do
   YARD::CLI::Yardoc.run *(options + files)
 end
 
-
-

data/lib/rack/abstract_format.rb

@@ -3,14 +3,14 @@ require 'pathname'
 module Rack
   class AbstractFormat
 
-    def initialize(app)
-      @app = app
+    def initialize(app, default = nil)
+      @app, @default = app, default
     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))
+      env['HTTP_ACCEPT'] = concat(env['HTTP_ACCEPT'], Rack::Mime.mime_type(path.extname, @default))
       @app.call(env)
     end
 

data/rack-abstract-format.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name                = 'rack-abstract-format'
-  s.version             = "0.9.8"
+  s.version             = "0.9.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              = "mynyml"

data/specs.watchr

@@ -0,0 +1,20 @@
+# Run me with:
+#   $ watchr specs.watchr
+
+# --------------------------------------------------
+# Watchr Rules
+# --------------------------------------------------
+watch( '^(lib|test)/.*\.rb' ) { rake }
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+Signal.trap('QUIT') { rake }        # Ctrl-\
+Signal.trap('INT' ) { abort("\n") } # Ctrl-C
+
+# --------------------------------------------------
+# Helpers
+# --------------------------------------------------
+def rake(task='')
+  system "rake -s #{task}"
+end

data/test/test_abstract_format.rb

@@ -1,6 +1,6 @@
 require 'test/test_helper'
 
-App = Rack::Builder.new {
+@app = Rack::Builder.new {
   use Rack::Lint
   use Rack::AbstractFormat
   run lambda {|env| [200, {'Content-Type' => 'text/html'}, ['']] }
@@ -8,7 +8,7 @@ App = Rack::Builder.new {
 
 def get(path, opts={})
   env = Rack::MockRequest.env_for(path, opts)
-  App.call(env)
+  @app.call(env)
   env
 end
 
@@ -28,3 +28,13 @@ assert { 'text/html,application/xml' == env['HTTP_ACCEPT'] }
 env = get('/path/resource', 'HTTP_ACCEPT' => 'text/html')
 assert { 'text/html' == env['HTTP_ACCEPT'] }
 
+# test: default format
+@app = Rack::Builder.new {
+  use Rack::Lint
+  use Rack::AbstractFormat, 'text/html'
+  run lambda {|env| [200, {'Content-Type' => 'text/html'}, ['']] }
+}.to_app
+
+env = get('/path/resource', 'HTTP_ACCEPT' => 'application/xml')
+assert { 'text/html,application/xml' == env['HTTP_ACCEPT'] }
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rack-abstract-format
 version: !ruby/object:Gem::Version 
-  version: 0.9.8
+  version: 0.9.9
 platform: ruby
 authors: 
 - mynyml
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-06 00:00:00 -05:00
+date: 2010-01-07 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,11 +44,12 @@ files:
 - .gitignore
 - LICENSE
 - Manifest
-- README
+- README.md
 - Rakefile
 - examples/app.ru
 - lib/rack/abstract_format.rb
 - rack-abstract-format.gemspec
+- specs.watchr
 - test/test_abstract_format.rb
 - test/test_helper.rb
 has_rdoc: false

data/README

@@ -1,27 +0,0 @@
-===== 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'