cehoffman-sinatra-respond_to 0.3.4 → 0.3.5

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 4
+:patch: 5
 :major: 0
 :minor: 3

data/lib/sinatra/respond_to.rb

@@ -1,6 +1,6 @@
 require 'sinatra/base'
 
-# Simple note, accept header parsing was looked at but deamed
+# Accept header parsing was looked at but deemed
 # too much of an irregularity to deal with.  Problems with the header
 # differences from IE, Firefox, Safari, and every other UA causes
 # problems with the expected output.  The general expected behavior
@@ -25,9 +25,9 @@ module Sinatra
     def self.registered(app)
       app.helpers RespondTo::Helpers
 
-      app.set :default_charset, 'utf-8' unless app.respond_to?(:default_charset)
-      app.set :default_content, :html unless app.respond_to?(:default_content)
-      app.set :assume_xhr_is_js, true unless app.respond_to?(:assume_xhr_is_js)
+      app.set :default_charset, 'utf-8'
+      app.set :default_content, :html
+      app.set :assume_xhr_is_js, true
 
       # We remove the trailing extension so routes
       # don't have to be of the style
@@ -38,35 +38,25 @@ module Sinatra
       #
       #   get '/resource'
       #
-      # and the format will automatically be available in as <tt>format</tt>
+      # and the format will automatically be available in <tt>format</tt>
       app.before do
-        unless options.static? && options.public? && ["GET", "HEAD"].include?(request.request_method) && static_file?(request.path_info)
-          request.path_info.gsub! %r{\.([^\./]+)$}, ''
-          format $1 || options.default_content
+        unless options.static? && options.public? && (request.get? || request.head?) && static_file?(request.path_info)
+          request.path_info.sub! %r{\.([^\./]+)$}, ''
 
-          # For the oh so common case of actually wanting Javascript from an XmlHttpRequest
-          format :js if request.xhr? && options.assume_xhr_is_js?
+          format request.xhr? && options.assume_xhr_is_js? ? :js : $1 || options.default_content
 
           charset options.default_charset if TEXT_MIME_TYPES.include? format
         end
       end
 
-      # Replace all routes that have an ending extension with one that doesn't
-      # Most generally a fix for the __sinatra__ routes in development
-      # app.routes.each_pair do |verb, subroutes|
-      #   subroutes.each do |subroute|
-      #     subroute[0] = Regexp.new(subroute[0].source.gsub(/\\\.[^\.\/]+\$$/, '$'))
-      #   end
-      # end
-
-     app.configure :development do
+     app.configure :development do |dev|
         # Very, very, very hackish but only for development at least
         # Modifies the regex matching /__sinatra__/:image.png to not have the extension
         ["GET", "HEAD"].each do |verb|
-          app.routes[verb][1][0] = Regexp.new(app.routes[verb][1][0].source.gsub(/\\\.[^\.\/]+\$$/, '$'))
+          dev.routes[verb][1][0] = Regexp.new(dev.routes[verb][1][0].source.gsub(/\\\.[^\.\/]+\$$/, '$'))
         end
 
-        app.error UnhandledFormat do
+        dev.error UnhandledFormat do
           content_type :html, :charset => 'utf-8'
 
           (<<-HTML).gsub(/^ {10}/, '')
@@ -91,18 +81,18 @@ module Sinatra
           HTML
         end
 
-        app.error MissingTemplate do
+        dev.error MissingTemplate do
           content_type :html, :charset => 'utf-8'
-          response.status = 500 # If I can find out how to reference the error code from the exception, I would
+          response.status = request.env['sinatra.error'].code
 
-          engine = request.env['sinatra.error'].message[/\.([^\.]+)$/, 1]
+          engine = request.env['sinatra.error'].message.split('.').last
           engine = 'haml' unless ['haml', 'builder', 'erb'].include? engine
-          
-          path = request.path_info[/([^\/]+)$/, 1]
+
+          path = File.basename(request.path_info)
           path = "root" if path.nil? || path.empty?
-          
+
           format = engine == 'builder' ? 'xml' : 'html'
-          
+
           layout = case engine
                    when 'haml' then "!!!\n%html\n  %body= yield"
                    when 'erb' then "<html>\n  <body>\n    <%= yield %>\n  </body>\n</html>"
@@ -128,7 +118,7 @@ module Sinatra
             <img src='/__sinatra__/500.png'>
             <div id="c">
               Try this:<br />
-              #{layout if layout}
+              #{layout}
               <small>#{path}.#{format}.#{engine}</small>
               <pre>Hello World!</pre>
               <small>application.rb</small>
@@ -153,7 +143,7 @@ module Sinatra
           alias_method :render, :render_with_format
 
           def lookup_layout_with_format(*args)
-            args[1] = "#{args[1]}.#{format}".to_sym if args
+            args[1] = "#{args[1]}.#{format}".to_sym if args[1].is_a?(::Symbol)
             lookup_layout_without_format *args
           end
           alias_method :lookup_layout_without_format, :lookup_layout
@@ -164,53 +154,53 @@ module Sinatra
     module Helpers
       def format(val=nil)
         unless val.nil?
-          new_mime_type = media_type(val.to_sym)
-          fail "Unknown media type #{val}\nTry registering the extension with a mime type" if new_mime_type.nil?
+          mime_type = media_type(val)
+          fail "Unknown media type #{val}\nTry registering the extension with a mime type" if mime_type.nil?
 
-          request.env['sinatra.respond_to.format'] = val.to_sym
-          old_mime_type, params = response['Content-Type'].split(';', 2)
-          response['Content-Type'] = [new_mime_type, params].join(';')
+          @format = val.to_sym
+          response['Content-Type'].sub!(/^[^;]+/, mime_type)
         end
 
-        request.env['sinatra.respond_to.format']
+        @format
       end
 
+      # This is mostly just a helper so request.path_info isn't changed when
+      # serving files from the public directory
       def static_file?(path)
-        return false unless path =~ /.*[^\/]$/
         public_dir = File.expand_path(options.public)
         path = File.expand_path(File.join(public_dir, unescape(path)))
-        return false if path[0, public_dir.length] != public_dir
-        File.file?(path)
+
+        path[0, public_dir.length] == public_dir && File.file?(path)
       end
 
       def charset(val=nil)
         fail "Content-Type must be set in order to specify a charset" if response['Content-Type'].nil?
 
-        if response['Content-Type'] =~ /charset=[^ ;,]+/
-          response['Content-Type'].gsub!(/charset=[^ ;,]+/, (val == '' && '') || "charset=#{val}")
+        if response['Content-Type'] =~ /charset=[^;]+/
+          response['Content-Type'].sub!(/charset=[^;]+/, (val == '' && '') || "charset=#{val}")
         else
           response['Content-Type'] += ";charset=#{val}"
         end unless val.nil?
 
-        response['Content-Type'][/charset=([^ ;,]+)/, 1]
+        response['Content-Type'][/charset=([^;]+)/, 1]
       end
 
       def respond_to(&block)
         wants = {}
-        def wants.method_missing(type, *args, &block)
+        def wants.method_missing(type, *args, &handler)
           Sinatra::Base.send(:fail, "Unknown media type for respond_to: #{type}\nTry registering the extension with a mime type") if Sinatra::Base.media_type(type).nil?
-          options = args.pop if args.last.is_a?(::Hash)
-          self[type] = block
+          self[type] = handler
         end
 
         yield wants
 
-        handler = wants[format]
-        raise UnhandledFormat  if handler.nil?
-        handler.call
+        raise UnhandledFormat  if wants[format].nil?
+        wants[format].call
       end
     end
   end
 
+  # Get around before filter problem for classic applications by registering
+  # with the context they are run in explicitly instead of Sinatra::Default
   Sinatra::Application.register RespondTo
-end
+end

data/spec/extension_spec.rb

@@ -1,6 +1,10 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe Sinatra::RespondTo do
+  def media_type(sym)
+    Sinatra::Base.media_type(sym)
+  end
+
   describe "options" do
     it "should initialize with :default_charset set to 'utf-8'" do
       TestApp.default_charset.should == 'utf-8'
@@ -21,7 +25,7 @@ describe Sinatra::RespondTo do
 
       get '/resource'
 
-      last_response['Content-Type'].should =~ %r{#{Rack::Mime.mime_type(".js")}}
+      last_response['Content-Type'].should =~ %r{#{media_type(:js)}}
     end
 
     it "should not set the content type to application/javascript for an XMLHttpRequest when assume_xhr_is_js is false" do
@@ -29,7 +33,7 @@ describe Sinatra::RespondTo do
       header 'HTTP_X_REQUESTED_WITH', 'XMLHttpRequest'
       get '/resource'
 
-      last_response['Content-Type'].should_not =~ %r{#{Rack::Mime.mime_type(".js")}}
+      last_response['Content-Type'].should_not =~ %r{#{media_type(:js)}}
 
       # Put back the option, no side effects here
       TestApp.enable :assume_xhr_is_js
@@ -72,7 +76,7 @@ describe Sinatra::RespondTo do
     it "should set the appropriate content-type for route with an extension" do
       get "/resource.xml"
 
-      last_response['Content-Type'].should =~ %r{#{Rack::Mime.mime_type('.xml')}}
+      last_response['Content-Type'].should =~ %r{#{media_type(:xml)}}
     end
 
     it "should set the character set to the default character set" do
@@ -137,7 +141,7 @@ describe Sinatra::RespondTo do
     it "should set the default content type when no extension" do
       get "/normal-no-respond_to"
 
-      last_response['Content-Type'].should =~ %r{#{Rack::Mime.mime_type(".#{TestApp.default_content}")}}
+      last_response['Content-Type'].should =~ %r{#{media_type(TestApp.default_content)}}
     end
 
     it "should set the default character when no extension" do
@@ -149,31 +153,63 @@ describe Sinatra::RespondTo do
     it "should set the appropriate content type when given an extension" do
       get "/normal-no-respond_to.css"
 
-      last_response['Content-Type'].should =~ %r{#{Rack::Mime.mime_type(".css")}}
+      last_response['Content-Type'].should =~ %r{#{media_type(:css)}}
     end
 
     it "should set the default charset when given an extension" do
       get "/normal-no-respond_to.css"
 
-      last_response['Content-Type'].should =~ %r{#{Rack::Mime.mime_type(".css")}}
+      last_response['Content-Type'].should =~ %r{charset=#{TestApp.default_charset}}
     end
   end
 
-  describe "error pages in development:" do
+  describe "error pages in production" do
+    class ProductionErrorApp < Sinatra::Base
+      set :environment, :production
+      register Sinatra::RespondTo
+      get '/missing-template' do
+        respond_to do |wants|
+          wants.html { haml :missing }
+        end
+      end
+    end
+
+    before(:each) do
+      @app = Rack::Builder.new { run ProductionErrorApp }
+    end
+
     describe Sinatra::RespondTo::MissingTemplate do
-      it "should return 500 status when looking for a missing template" do
+      it "should return 404 status when looking for a missing template in production" do
         get '/missing-template'
 
-        last_response.status.should == 500
+        last_response.status.should == 404
+        last_response.body.should_not =~ /Sinatra can't find/
+      end
+    end
+
+    describe Sinatra::RespondTo::UnhandledFormat do
+      it "should return with a 404 when an extension is not supported in production" do
+        get '/missing-template.txt'
+
+        last_response.status.should == 404
+        last_response.body.should_not =~ /respond_to/
       end
+    end
+  end
+
+  describe "error pages in development:" do
+
+    it "should allow access to the /__sinatra__/*.png images" do
+      get '/__sinatra__/404.png'
 
-      it "should return 500 status when looking for a missing template in production" do
-        TestApp.set :environment, :production
+      last_response.should be_ok
+    end
+
+    describe Sinatra::RespondTo::MissingTemplate do
+      it "should return 500 status when looking for a missing template" do
         get '/missing-template'
 
         last_response.status.should == 500
-
-        TestApp.set :environment, :development
       end
 
       it "should provide a helpful error message for a missing template when in development" do
@@ -219,15 +255,6 @@ describe Sinatra::RespondTo do
         last_response.status.should == 404
       end
 
-      it "should return with a 404 when an extension is not support in production" do
-        TestApp.set :environment, :production
-        get '/missing-template.txt'
-
-        last_response.status.should == 404
-
-        TestApp.set :environment, :development
-      end
-
       it "should provide a helpful error message for an unhandled format" do
         get '/missing-template.txt'
 
@@ -276,21 +303,25 @@ describe Sinatra::RespondTo do
 
         lambda { charset }.should raise_error
       end
+
+      it "should not modify the Content-Type when given no argument" do
+        response['Content-Type'] = "text/html;charset=iso-8859-1"
+
+        charset
+
+        response['Content-Type'].should == "text/html;charset=iso-8859-1"
+      end
     end
 
     describe "format" do
       before(:each) do
-        stub!(:request).and_return(Rack::Request.new({}))
-      end
-
-      def media_type(sym)
-        Sinatra::Base.media_type(sym)
+        stub!(:request).and_return(Sinatra::Request.new({}))
       end
 
       it "should set the correct mime type when given an extension" do
         format :xml
 
-        response['Content-Type'].split(';').should include(Rack::Mime.mime_type(".xml"))
+        response['Content-Type'].split(';').should include(media_type(:xml))
       end
 
       it "should fail when set to an unknown extension type" do
@@ -302,6 +333,14 @@ describe Sinatra::RespondTo do
 
         format.should == :js
       end
+
+      it "should not modify the Content-Type when given no argument" do
+        response['Content-Type'] = "application/xml;charset=utf-8"
+
+        format
+
+        response['Content-Type'].should == "application/xml;charset=utf-8"
+      end
     end
 
     describe "static_file?" do
@@ -336,5 +375,29 @@ describe Sinatra::RespondTo do
         static_file?(@static_folder).should be_false
       end
     end
+
+    describe "respond_to" do
+      before(:each) do
+        stub!(:request).and_return(Sinatra::Request.new({}))
+      end
+
+      it "should fail for an unknown extension" do
+        lambda do
+          respond_to do |wants|
+            wants.bogus
+          end
+        end.should raise_error
+      end
+
+      it "should call the block corresponding to the current format" do
+        format :html
+
+        respond_to do |wants|
+          wants.js { "Some JS" }
+          wants.html { "Some HTML" }
+          wants.xml { "Some XML" }
+        end.should == "Some HTML"
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -9,7 +9,7 @@ require File.join(File.dirname(__FILE__), 'app', 'test_app')
 
 Spec::Runner.configure do |config|
   def app
-    @app = Rack::Builder.new do
+    @app ||= Rack::Builder.new do
       run TestApp
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cehoffman-sinatra-respond_to
 version: !ruby/object:Gem::Version 
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors: 
 - Chris Hoffman
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-13 00:00:00 -07:00
+date: 2009-05-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency