scorched 0.16 → 0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f2b6b091aaaea15a4bd11fbcc7d70fc27e783d1
-  data.tar.gz: db2e3b73d7b0f2aa82472f90299915cdfa3e2c4a
+  metadata.gz: 5ad267343b4c7040dda32f6c394418bf9494dbcf
+  data.tar.gz: e8161cbafa5becf64f73ee970ac247a2ed43ef5f
 SHA512:
-  metadata.gz: e937339dd3d1470e201050a395d68f4cf3635c355683c5fee6a4570cc12044e7f584dd57bed84fb01c89ac3cc89ac73f026a1b88cd9dc06dd08fdd79bdf748d7
-  data.tar.gz: 3fb1e340771264fe6738d6ea030e0387cea91fc716fa6b651883194973b12b498dd7b0bee27a6994d64ea126a936c47da057fc45f8f6698793fad553685c58b5
+  metadata.gz: d8184c8ba998ffc82d2292b089fccbb0ce60e9e6c89e35679b0e8a14121ff3da46ad338cb33296b0139a98ba4fe226228d83387f34f1f424567f8620c26a1278
+  data.tar.gz: 723fd6f62103871197a99b39912677ebff7c4bc77d1e3cf707efc842e948da8c79aa4c8806cefe0cdc88d843c6aa9df89ea4e804bb54cf5e54f0c786606db194

data/CHANGES.md

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+### v0.17
+* Fixes an issue introduced in v0.16 where joining `SCRIPT_NAME` and `PATH_INFO` would sometimes produce a path with two forward slashes, and a related issue where `PATH_INFO` would sometimes be missing a leading forward slash when it should have had one.
+* Mappings are now sorted by the best matching `media type` in addition to the existing logic that included definition order and priority. This required that mappings be sorted at request-time rather than at the time they're mapped. Note, because of limitations of `rack-accept`, this doesn't completely respect the HTTP spec when it comes to prioritising which media type to serve for a given request. Full support for the HTTP spec is intended for a future release.
+* File path references to views are now joined to the view directory using #expand_path. This allows views to be specified with an absolute path (effectively ignoring the view directory), and better support for relative paths.
+
 ### v0.16
 * A copy of the Rack env hash is now handed off to sub-controllers and other Rack-callable objects, with `PATH_INFO` and `SCRIPT_NAME` now set to appropriate values, bring Scorched inline with the Rack specification. This differs from the original behaviour which was to just forward on the original env hash unmodified.
 * URL helper method `absolute` and `url` now use the new env property `scorched.root_path` as their base path, rather than `SCRIPT_NAME`.

data/lib/scorched/controller.rb

@@ -72,7 +72,7 @@ module Scorched
       handled: proc { |bool|
         @_handled == bool
       },
-      proc: proc { |*blocks|
+      proc: proc { |blocks|
         [*blocks].all? { |b| instance_exec(&b) }
       },
       user_agent: proc { |user_agent| 
@@ -127,14 +127,12 @@ module Scorched
       # Raises ArgumentError if required key values are not provided.
       def map(pattern: nil, priority: nil, conditions: {}, target: nil)
         raise ArgumentError, "Mapping must specify url pattern and target" unless pattern && target
-        priority = priority.to_i
-        insert_pos = mappings.take_while { |v| priority <= v[:priority]  }.length
-        mappings.insert(insert_pos, {
+        mappings << {
           pattern: compile(pattern),
-          priority: priority,
+          priority: priority.to_i,
           conditions: conditions,
           target: target
-        })
+        }
       end
       alias :<< :map
       
@@ -242,8 +240,6 @@ module Scorched
         env
       end
       env['scorched.root_path'] ||= env['SCRIPT_NAME']
-      env['scorched.path_info'] ||= env['PATH_INFO']
-      env['scorched.script_name'] ||= env['SCRIPT_NAME']
       @request = Request.new(env)
       @response = Response.new
     end
@@ -267,7 +263,16 @@ module Scorched
           pass if config[:auto_pass] && eligable_matches.empty?
           run_filters(:before)
           begin
-            eligable_matches.each { |match|
+            # Re-order matches based on media_type, ensuring priority and definition order are respected appropriately.
+            eligable_matches.each_with_index.sort_by { |m,idx|
+              [
+                m.mapping[:priority] || 0,
+                [*m.mapping[:conditions][:media_type]].map { |type|
+                  env['rack-accept.request'].media_type.qvalue(type)
+                }.max || 0,
+                -idx
+              ]
+            }.reverse.each { |match,|
               request.breadcrumb << match
               break if catch(:pass) {
                 target = match.mapping[:target]
@@ -276,8 +281,8 @@ module Scorched
                     instance_exec(&target)
                   else
                     target.call(env.merge(
-                      'SCRIPT_NAME' => request.matched_path,
-                      'PATH_INFO' => request.unmatched_path[match.path.length..-1]
+                      'SCRIPT_NAME' => request.matched_path.chomp('/'),
+                      'PATH_INFO' => request.unmatched_path[match.path.chomp('/').length..-1]
                     ))
                   end
                 end
@@ -431,7 +436,7 @@ module Scorched
       template = if Symbol === string_or_file
         file = string_or_file.to_s
         file = file << ".#{engine}" unless derived_engine
-        file = File.join(dir, file) if dir
+        file = File.expand_path(file, dir) if dir
         # Tilt still has unresolved file encoding issues. Until that's fixed, we read the file manually.
         template_cache.fetch(:file, tilt_engine, file, tilt_options) do
           tilt_engine.new(file, nil, tilt_options)

data/lib/scorched/request.rb

@@ -5,7 +5,7 @@ module Scorched
     # Keeps track of the matched URL portions and what object handled them. Useful for debugging and building
     # breadcrumb navigation.
     def breadcrumb
-      env['breadcrumb'] ||= []
+      env['scorched.breadcrumb'] ||= []
     end
     
     # Returns a hash of captured strings from the last matched URL in the breadcrumb.
@@ -25,7 +25,7 @@ module Scorched
     
     # The remaining portion of the path that has yet to be matched by any mappings.
     def unmatched_path
-      path = unescaped_path.dup
+      path = unescaped_path
       path[0,0] = '/' if (path[0] != '/' && matched_path[-1] == '/') || path.empty?
       path
     end
@@ -35,6 +35,7 @@ module Scorched
     def unescaped_path
       path_info.split(/(%25|%2F)/i).each_slice(2).map { |v, m| URI.unescape(v) << (m || '') }.join('')
     end
+    
   private
     
     # Joins an array of path segments ensuring a single forward slash seperates them.

data/lib/scorched/version.rb

@@ -1,3 +1,3 @@
 module Scorched
-  VERSION = '0.16'
+  VERSION = '0.17'
 end

data/spec/controller_spec.rb

@@ -159,14 +159,29 @@ module Scorched
       end
       
       it "matches routes based on priority, otherwise giving precedence to those defined first" do
-        app << {pattern: '/', priority: -1, target: proc { |env| self.class.mappings.shift; [200, {}, ['four']] }}
-        app << {pattern: '/', target: proc { |env| self.class.mappings.shift; [200, {}, ['two']] }}
-        app << {pattern: '/', target: proc { |env| self.class.mappings.shift; [200, {}, ['three']] }}
-        app << {pattern: '/', priority: 2, target: proc { |env| self.class.mappings.shift; [200, {}, ['one']] }}
-        rt.get('/').body.should == 'one'
-        rt.get('/').body.should == 'two'
-        rt.get('/').body.should == 'three'
-        rt.get('/').body.should == 'four'
+        order = []
+        app << {pattern: '/', priority: -1, target: proc { |env| order << 'four'; [200, {}, ['ok']] }}
+        app << {pattern: '/', target: proc { |env| order << 'two'; throw :pass }}
+        app << {pattern: '/', target: proc { |env| order << 'three'; throw :pass }}
+        app << {pattern: '/', priority: 2, target: proc { |env| order << 'one'; throw :pass }}
+        rt.get('/').body.should == 'ok'
+        order.should == %w{one two three four}
+      end
+      
+      it "finds the best match for media type whilst respecting priority and definition order" do
+        app << {pattern: '/', conditions: {media_type: 'text/html'}, target: proc { |env|
+          [200, {}, ['text/html']]
+        }}
+        app << {pattern: '/', conditions: {media_type: 'application/json'}, target: proc { |env|
+          [200, {}, ['application/json']]
+        }}
+        app << {pattern: '/', priority: 1, target: proc { |env|
+          [200, {}, ['anything']]
+        }}
+        rt.get('/', media_type: 'application/json, */*;q=0.5').body.should == 'anything'
+        app.mappings.pop
+        rt.get('/', {}, 'HTTP_ACCEPT' => 'text/html;q=0.5, application/json').body.should == 'application/json'
+        rt.get('/', {}, 'HTTP_ACCEPT' =>  'text/html, */*;q=0.5').body.should == 'text/html'
       end
     end
     
@@ -267,24 +282,37 @@ module Scorched
         rt.get('/article/hello-world').body.should == 'hello-world'
       end
 
-      they "have access to original unmangled PATH_INFO via 'scorched.path_info'" do
-        app << {pattern: '/article', target: Class.new(Scorched::Controller) do
-          get('/name') {
-            env['scorched.path_info']
-          }
-        end}
-        rt.get('/article/name').body.should == '/article/name'
-      end
-
-      it "propagates correclty mangles escaped PATH_INFO before passing to sub-controller" do
-        app << {pattern: '/:category', target: Class.new(Scorched::Controller) do
-          get('/:name') {
+      it "copies env, modifying PATH_INFO and SCRIPT_NAME, before passing onto Rack-callable object" do
+        inner_env, outer_env = nil, nil
+        app.before { outer_env = env }
+        app.controller '/article' do
+          get '/name' do
+            inner_env = env
             'hello'
-          }
-        end}
-        resp = rt.get('/big%20articles/article%20name')
+          end
+        end
+        
+        resp = rt.get('/article/name')
         resp.status.should == 200
-        resp.body.should == 'hello'
+        outer_env['SCRIPT_NAME'].should == ''
+        outer_env['PATH_INFO'].should == '/article/name'
+        inner_env['SCRIPT_NAME'].should == '/article'
+        inner_env['PATH_INFO'].should == '/name'
+      end
+      
+      example "PATH_INFO and SCRIPT_NAME joined, should produce a full path" do
+        app.controller '/article/' do
+          get '/name' do
+            env['SCRIPT_NAME'] + env['PATH_INFO']
+          end
+        end
+        app.controller '/blah' do
+          get '/baz' do
+            env['SCRIPT_NAME'] + env['PATH_INFO']
+          end
+        end
+        rt.get('/article/name').body.should == '/article/name'
+        rt.get('/blah/baz').body.should == '/blah/baz'
       end
 
       describe "controller helper" do
@@ -895,7 +923,7 @@ module Scorched
         app.render_defaults.each { |k,v| app.render_defaults[k] = nil }
       end
 
-      it "can render a file, relative to the application root" do
+      it "can render a file, relative to the working directory" do
         app.get('/') do
           render(:'views/main.erb').should == "3 for me"
         end
@@ -909,12 +937,24 @@ module Scorched
         rt.get('/')
       end
 
-      it "takes an optional view directory, relative to the application root" do
+      it "takes an optional view directory, relative to the working directory" do
         app.get('/') do
           render(:'main.erb', dir: 'views').should == "3 for me"
         end
         rt.get('/')
       end
+      
+      it "properly respects absolute and relative file paths in respect to the view directory" do
+        app.get('/relative') do
+          render(:'../views/main.erb', dir: 'views')
+        end
+        app.get('/absolute') do
+          File.dirname(__FILE__)
+          render(:"#{File.dirname(__FILE__)}/views/main.erb", dir: 'views')
+        end
+        rt.get('/relative').body.should == "3 for me"
+        rt.get('/absolute').body.should == "3 for me"
+      end
 
       it "takes an optional block to be yielded by the view" do
         app.get('/') do
@@ -1014,6 +1054,15 @@ module Scorched
         builder.to_app
       end
       
+      it "can determine the root path of the current Scorched application" do
+        my_app.controller '/article' do
+          get '/name' do
+            env['scorched.root_path']
+          end
+        end
+        rt.get('/myapp/article/name').body.should == '/myapp'
+      end
+      
       describe "url" do
         it "returns the fully qualified URL" do
           my_app.get('/') { url }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorched
 version: !ruby/object:Gem::Version
-  version: '0.16'
+  version: '0.17'
 platform: ruby
 authors:
 - Tom Wardrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-06 00:00:00.000000000 Z
+date: 2013-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack