mynyml-rack-respond_to 0.9.6 → 0.9.7

data/README

@@ -11,6 +11,7 @@ preference (see http://github.com/mynyml/rack-accept-media-types).
 
 * Based on familiar API (Rails)
 * Cascades down priority list of accepted media types
+* Handles wildcard media types
 * Simple to use
 * Simple code (~50 LOCs)
 * Flexible (standalone use)

data/Rakefile

@@ -22,7 +22,7 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name            = 'rack-respond_to'
-  s.version         = '0.9.6'
+  s.version         = '0.9.7'
   s.summary         = "Rack middleware port of Rails's respond_to feature"
   s.description     = "Rack middleware port of Rails's respond_to feature"
   s.author          = "Martin Aumont"
@@ -60,7 +60,7 @@ end
 desc "Generate rdoc documentation."
 Rake::RDocTask.new("rdoc") { |rdoc|
   rdoc.rdoc_dir = 'doc/rdoc'
-  rdoc.title    = "Simple Router - Document"
+  rdoc.title    = "Rack::RespondTo"
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.options << '--charset' << 'utf-8'
   rdoc.rdoc_files.include('README')

data/TODO

@@ -1,27 +0,0 @@
-o handle wildcard content-types
-  e.g. */* matches first format block
-
-    Rack::RespondTo.mime_type = '*/*'
-
-    body = respond_to do |format|
-      format.html { 'html' }
-      format.xml  { 'xml' }
-    end
-    body #=> 'html'
-
-    body = respond_to do |format|
-      format.xml  { 'xml' }
-      format.html { 'html' }
-    end
-    body #=> 'xml'
-
-x cascade down accept types priority instead of only responding to prefered
-  type. e.g:
-
-    env['HTTP_ACCEPT'] #=> 'text/plain,text/html;q=0.9,application/xml;q=0.8'
-
-    body = respond_to do |format|
-      format.html { 'html' }
-      format.xml  { 'xml' }
-    end
-    body #=> 'html'

data/lib/rack/respond_to.rb

@@ -97,6 +97,12 @@ module Rack
       # cascade down the RespondTo.media_types list until it finds a match.
       # Returns nil if there is no match.
       #
+      # Wildcard media types (*/*, text/*, etc.) will trigger the first
+      # matching format definition, so order matters if you expect the Accept
+      # header to contain any (a nil Accept header, for instance, will be
+      # turned into '*/*' as per rfc2616-sec14.1). Simply define the 'default'
+      # handler first (usually html), and it will work like a charm.
+      #
       # ===== Examples
       #
       #   RespondTo.media_types = ['text/html', 'application/xml']
@@ -123,19 +129,64 @@ module Rack
       #   end
       #   #=> nil
       #
+      #   RespondTo.media_types = ['*/*']
+      #
+      #   respond_to do |format|
+      #     format.html { 'html' }
+      #     format.xml  { 'xml'  }
+      #   end
+      #   #=> 'html'
+      #
+      #   RespondTo.media_types = ['*/*']
+      #
+      #   respond_to do |format|
+      #     format.xml  { 'xml'  }
+      #     format.html { 'html' }
+      #   end
+      #   #=> 'xml'
+      #
+      #   RespondTo.media_types = ['text/*']
+      #
+      #   respond_to do |format|
+      #     format.xml  { 'xml'  } # application/xml  (skip)
+      #     format.html { 'html' } # text/html        (match)
+      #     format.txt  { 'txt'  }
+      #   end
+      #   #=> 'html'
+      #
       def respond_to
         format = Format.new
         yield format
-        type = RespondTo.media_types.detect {|type| format[type] }
+        type, handler = Helpers.match(RespondTo.media_types, format)
         RespondTo.selected_media_type = type
-        handler = format[type]
         handler.nil? ? nil : handler.call
       end
     end
 
-    class Format < Hash #:nodoc:
+    # Helper methods, kept in a seperate namespace to avoid pollution.
+    module Helpers #:nodoc:
+      extend self
+
+      # TODO refactor
+      def match(media_types, format)
+        selected = []
+        accepted_types = media_types.map {|type| type.gsub(/\*/,'.*') }
+        accepted_types.each do |at|
+          format.each do |ht, handler|
+            (selected = [ht, handler]) and break if ht.match(at)
+          end
+          break unless selected.empty?
+        end
+        selected
+      end
+    end
+
+    # NOTE
+    # Array instead of hash because order matters (wildcard type matches first
+    # handler)
+    class Format < Array #:nodoc:
       def method_missing(format, *args, &handler)
-        self[RespondTo::MediaType(format.to_s)] = handler
+        self << [RespondTo::MediaType(format.to_s), handler]
       end
     end
   end

data/rack-respond_to.gemspec

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rack-respond_to
 version: !ruby/object:Gem::Version 
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors: 
 - Martin Aumont

data/test/test_respond_to.rb

@@ -126,4 +126,45 @@ class TestRespondTo < Test::Unit::TestCase
     assert_equal 'txt', body
     assert_equal 'text/plain', Rack::RespondTo.selected_media_type
   end
+
+  ## wildcard media types
+
+  test "wildcard type matches first handler" do
+    Rack::RespondTo.media_types = %w( */* )
+
+    body = App.respond_to do |format|
+      format.xml { 'xml' }
+      format.txt { 'txt' }
+    end
+    assert_equal 'xml', body
+
+    body = App.respond_to do |format|
+      format.txt { 'txt' }
+      format.xml { 'xml' }
+    end
+    assert_equal 'txt', body
+  end
+
+  test "wildcard subtype matches first handler for type" do
+    Rack::RespondTo.media_types = %w( text/* )
+
+    body = App.respond_to do |format|
+      format.xml { 'xml' }
+      format.txt { 'txt' }
+      format.htm { 'htm' }
+    end
+    assert_equal 'txt', body
+
+    body = App.respond_to do |format|
+      format.xml { 'xml' }
+      format.htm { 'htm' }
+      format.txt { 'txt' }
+    end
+    assert_equal 'htm', body
+
+    body = App.respond_to do |format|
+      format.xml { 'xml' }
+    end
+    assert_equal nil, body
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mynyml-rack-respond_to
 version: !ruby/object:Gem::Version 
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors: 
 - Martin Aumont