scorched 0.13 → 0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 097dc690273075ecec2044e7ef6cc9ef285e4c03
-  data.tar.gz: ceac380dfda10425b551488c953e34efc4d681a6
+  metadata.gz: 2583f96bd04c7a31f7edf598acd84eaa11689feb
+  data.tar.gz: 8148c65523e21d3aaa68b6dd2dd7ce0ac62eddac
 SHA512:
-  metadata.gz: 8b67fe3315887ef8cc9863c1353a803ff27e82d9f5c6ecb6b3d1b611077c1ec2ffad754e175e8adecaba2fb50f1ad7d96f3f3e5ce27f83c4005a5b5c44df8745
-  data.tar.gz: 4d68ca06da03b5cf45d25191b6786008591066f85e2bceb246e82e6ffccbef6d21a357e2534ee5114855e81015712cf3de584cb2ba93145fa213dc80c926b779
+  metadata.gz: 73ed932ce8783845f70c041da390eca59f9bb487b834191a31863a2e8f23290457317db4a8fccf574aaaba3d17530d5e8cd36a739491af61bda024daaab75086
+  data.tar.gz: 8ac3bd00774d449e68e40d90639a937c5b7963c9630b5aa86a478b283b8eb6f5586188bc7cc5bc85d48c6b7c8630b1c22a43aad551ad6488e47ebf6b529abafc

data/CHANGES.md

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+### v0.14
+* If a matched mapping _passes_ the request and there are no other matching mappings, a 404 status is now set by default, rather than a 200 status.
+* Renamed `matched` condition to `handled` to be less ambiguous.
+
 ### v0.13
 * Added `content_type` condition, corresponding to the `Content-Type` request header.
 * Reverted rogue commit containing experimental debugging logging that I didn't plan to merge. Fixes issue #12.

data/Rakefile

@@ -0,0 +1,25 @@
+require 'fileutils'
+require 'rspec'
+require 'rspec/core/rake_task'
+require 'rake/clean'
+require './lib/scorched/version'
+
+CLEAN.include "pkg"
+
+task :default => :spec
+task :test => :spec
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :release => [:spec, :'gem:install', :commit_version, :'gem:release', :clean]
+
+task :commit_version do
+  sh "git commit --allow-empty -a -m 'v#{Scorched::VERSION} release.'  &&
+    git tag -a #{Scorched::VERSION} -m 'v#{Scorched::VERSION} release.'  &&
+    git push &&
+    git push --tags"
+end
+
+namespace :gem do
+  require "bundler/gem_tasks"
+end

data/docs/02_fundamentals/03_routing.md

@@ -75,7 +75,7 @@ Conditions are essentially just pre-requisites that must be met before a mapping
 * `:host` - The host name (i.e. domain name) used in the request.
 * `:language` - Languages accepted by the client.
 * `:media_type` - Media types (i.e. content types) accepted by the client.
-* `:matched` - Whether a mapping in the controller instance was invoked as the target for the request.
+* `:handled` - Whether a mapping in the controller instance was invoked as the target for the request. A mapping that _passes_ a request is not considered a match.
 * `:method` - The request method used, e.g. GET, POST, PUT, ... .
 * `:proc` - An on-the-fly condition to be evaluated in the context of the controller instance. Should return true if the condition was satisfied, or false otherwise.
 * `:user_agent` - The user agent string provided with the request. Takes a Regexp or String.

data/docs/02_fundamentals/04_requests_and_responses.md

@@ -13,7 +13,7 @@ Scorched Extras
 ---------------
 As mentioned, Scorched tacks a few extras onto it's `Scorched::Request` and `Scorched::Response` classes. Most of these extras were added as a requirement of the Scorched controller, but they're just as useful to other developers.
 
-Refer to the generated API documentation for `Scorched::Request` and `Scorched::Response`.
+Refer to the API documentation for `Scorched::Request` and `Scorched::Response`.
 
 
 Halting Requests
@@ -22,13 +22,15 @@ There may be instances we're you want to shortcut out-of processing the current
 
 When `halt` is called within a route, it simply exists out of that route, and begins processing any _after_ filters. Halt can also be used within a _before_ or _after_ filter, in which case any remaining filters in the current controller are skipped.
 
-Calls to `halt` don't propagate up the controller chain. They're local to the controller. A call to `halt` is equivalent to doing a `throw :halt`. Calling `halt` is often preferred though because as well as being shorter, it can take an optional argument to set the response status, which is something you typically want to do when halting a request.
+Calls to `halt` don't propagate up the controller chain. They're local to the controller. A call to `halt` is equivalent to doing a manual `throw :halt`. Calling `halt` is often preferred though because as well as being syntactically sweeter, it can take an optional argument to set the response status and body, which is something you likely want to do when halting a request.
 
 
 Passing Requests
 ----------------
 A route may _pass_ a request to the next matching route. _passing_ is very similar to halting, except an opportunity is given to other matching routes to fulfil the request. This is implemented as a throw/catch mechanism, much the same as `halt`. You can do a `throw :pass` manually, or use the helper method `pass`.
 
+If a target passes a request, the request is still considered _unmatched_ or _unsatisfied_. Hence, if no other target matches the passed request, a 404 is returned as the response status by default.
+
 
 Redirections
 ------------

data/examples/test.ru

@@ -0,0 +1,13 @@
+require File.expand_path('../../lib/scorched.rb', __FILE__)
+
+class MyApp < Scorched::Controller
+  controller '/' do
+
+  end
+  
+  after do
+    p @_matched
+  end
+end
+    
+run MyApp

data/lib/scorched/controller.rb

@@ -67,8 +67,8 @@ module Scorched
       method: proc { |methods| 
         [*methods].include?(request.request_method)
       },
-      matched: proc { |bool|
-        @_matched == bool
+      handled: proc { |bool|
+        @_handled == bool
       },
       proc: proc { |*blocks|
         [*blocks].all? { |b| instance_exec(&b) }
@@ -256,23 +256,22 @@ module Scorched
           if config[:strip_trailing_slash] == :redirect && request.path =~ %r{./$}
             redirect(request.path.chomp('/'))
           end
-          
-          if matches.all? { |m| m.failed_condition }
-            pass if config[:auto_pass]
-            response.status = matches.empty? ? 404 : 403
-          end
-          
+          eligable_matches = matches.reject { |m| m.failed_condition }
+          pass if config[:auto_pass] && eligable_matches.empty?
           run_filters(:before)
           begin
-            @_matched = true == matches.each { |match|
-              next if match.failed_condition
+            eligable_matches.each { |match|
               request.breadcrumb << match
               break if catch(:pass) {
                 target = match.mapping[:target]
                 response.merge! (Proc === target) ? instance_exec(env, &target) : target.call(env)
+                @_handled = true
               }
               request.breadcrumb.pop
             }
+            unless @_handled
+              response.status = (!matches.empty? && eligable_matches.empty?) ? 403 : 404
+            end
           rescue => inner_error
             rescue_block.call(inner_error)
           end
@@ -290,10 +289,10 @@ module Scorched
     # The `:eligable` attribute of the `Match` object indicates whether the conditions for that mapping passed.
     # The result is cached for the life time of the controller instance, for the sake of effecient-recalling.
     def matches
-      return @matches if @matches
+      return @_matches if @_matches
       to_match = request.unmatched_path
       to_match = to_match.chomp('/') if config[:strip_trailing_slash] == :ignore && to_match =~ %r{./$}
-      @matches = mappings.map { |mapping|
+      @_matches = mappings.map { |mapping|
         mapping[:pattern].match(to_match) do |match_data|
           if match_data.pre_match == ''
             if match_data.names.empty?

data/lib/scorched/version.rb

@@ -1,3 +1,3 @@
 module Scorched
-  VERSION = '0.13'
+  VERSION = '0.14'
 end

data/scorched.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new 'scorched', Scorched::VERSION do |s|
   s.add_dependency 'tilt', '~> 1.4'
   s.add_development_dependency 'rack-test', '~> 0.6'
   s.add_development_dependency 'rspec', '~> 2.9'
+  s.add_development_dependency 'rake', '>= 10'
 end

data/spec/controller_spec.rb

@@ -166,7 +166,7 @@ module Scorched
       end
       
       it "executes route only if all conditions return true" do
-        app << {pattern: '/', conditions: {method: 'POST'}, target: generic_handler}
+        app << {pattern: '/$', conditions: {method: 'POST'}, target: generic_handler}
         response = rt.get "/"
         response.status.should be_between(400, 499)
         response = rt.post "/"
@@ -582,13 +582,24 @@ module Scorched
         rt.get('/sub').body.should == 'hello there'
       end
       
-      it "passing within filter of root controller results in uncaught symbol" do
+      it "results in uncaught symbol if passing within filter of root controller " do
         app.before { pass }
         expect {
           app.get('/') { }
           rt.get('/')
         }.to raise_error(ArgumentError)
       end
+      
+      it "is not considered a match if a mapping passes the request" do
+        app.get('/*') { pass }
+        app.get('/nopass') {  }
+        handled = nil
+        app.after { handled = @_handled }
+        rt.get('/').status.should == 404 # 404 if matched, but passed
+        handled.should_not be_true
+        rt.get('/nopass').status.should == 200
+        handled.should be_true
+      end
     end
     
     describe "status codes" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorched
 version: !ruby/object:Gem::Version
-  version: '0.13'
+  version: '0.14'
 platform: ruby
 authors:
 - Tom Wardrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-14 00:00:00.000000000 Z
+date: 2013-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '10'
 description: A light-weight Sinatra-inspired web framework for web sites and applications
   of any size.
 email: tom@tomwardrop.com
@@ -91,6 +105,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - TODO.md
 - docs/01_preface.md
 - docs/02_fundamentals/01_the_controller.md
@@ -108,6 +123,7 @@ files:
 - docs/03_further_reading/running_unit_tests.md
 - examples/file_upload.ru
 - examples/media_types.ru
+- examples/test.ru
 - lib/scorched.rb
 - lib/scorched/collection.rb
 - lib/scorched/controller.rb