scorched 0.7 → 0.8

data/docs/02_fundamentals/09_sharing_request_state.md

@@ -6,11 +6,12 @@ The only data exchanged between controllers is the Rack environment hash. Using
 
 The Rack idiom is to namespace your keys, typically with your project name, using dots as delimiters. You can further group your keys using more dot-delimited namespaces. Perhaps an example is due:
 
-    # ruby
-    before user_agent: /MSIE|Windows/ do
-      env['myapp.dangerous_request'] = true
-    end
-    
-    get '/' do
-      "Welcome to #{env['myapp.settings.site_name']}!"
-    end
+```ruby
+before user_agent: /MSIE|Windows/ do
+  env['myapp.dangerous_request'] = true
+end
+
+get '/' do
+  "Welcome to #{env['myapp.settings.site_name']}!"
+end
+```

data/docs/03_further_reading/be_creative.md

@@ -6,37 +6,38 @@ Effortless REST
 ---------------
 An DRY way to serve multiple content-types:
 
-    # ruby
-    class App < Scorched::Controller
-      def view(view = nil)
-        view ? env['app.view'] = view : env['app.view']
-      end
-      
-      after do
-        data = response.body.join('')
-        response['Content-type'] = 'text/html'
-        if check_condition?(:media_type, 'text/html')
-          response.body = render(view, locals: {data: data})
-        elsif check_condition?(:media_type, 'application/json')
-          response['Content-type'] = 'application/json'
-          response.body = data.to_json
-        elsif check_condition?(:media_type, 'application/pdf')
-          response['Content-type'] = 'text/plain'
-          response.status = 406
-          response.body = 'PDF rendering service currently unavailable.'
-        else
-          response.body = render(view, locals: {data: data})
-        end
-      end
-      
-      get '/' do
-        view :index
-        [
-          {title: 'Sweet Purple Unicorns', date: '08/03/2013'},
-          {title: 'Mellow Grass Men', date: '21/03/2013'}
-        ]
-      end
+```ruby
+class App < Scorched::Controller
+  def view(view = nil)
+    view ? env['app.view'] = view : env['app.view']
+  end
+  
+  after do
+    data = response.body.join('')
+    response['Content-type'] = 'text/html'
+    if check_condition?(:media_type, 'text/html')
+      response.body = render(view, locals: {data: data})
+    elsif check_condition?(:media_type, 'application/json')
+      response['Content-type'] = 'application/json'
+      response.body = data.to_json
+    elsif check_condition?(:media_type, 'application/pdf')
+      response['Content-type'] = 'text/plain'
+      response.status = 406
+      response.body = 'PDF rendering service currently unavailable.'
+    else
+      response.body = render(view, locals: {data: data})
     end
+  end
+  
+  get '/' do
+    view :index
+    [
+      {title: 'Sweet Purple Unicorns', date: '08/03/2013'},
+      {title: 'Mellow Grass Men', date: '21/03/2013'}
+    ]
+  end
+end
+```
   
 
 Authentication and Permissions

data/docs/03_further_reading/code_reloading.md

@@ -7,7 +7,7 @@ A sub-set of the most popular application reloaders are detailed below.
 
 Rerun
 -----
-Rerun is a general purpose gem (``gem install rerun``) for watching files and rerunning some command when any of those files change. The following example uses rerun to watch for changes to ".rb" and ".ru" files anywhere in the current directory tree. If a change is made, any previous instance of ``rackup`` are shutdown and restarted.
+Rerun is a general purpose gem (``gem install rerun``) for watching files and rerunning some command when any of those files change. The following example uses rerun to watch for changes to ".rb" and ".ru" files anywhere in the current directory tree. If a change is made, any previous instance of `rackup` are shutdown and restarted.
 
     rerun -p "**/*.{rb,ru}" rackup
 
@@ -21,4 +21,4 @@ Phusion Passenger
 -----------------
 The popular Apache/Nginx module for hosting Rack applications, Phusion Passenger, can be configured to reload your application on every request much like Shotgun does. Passenger can be faster that Shogun, as you can let the underlying web server (Apache or Nginx) to take care of the static file serving, which avoids having to reload your application for every static file request.
 
-To have Passenger automatically restart your application on every request, create a file named ``tmp/always_restart.txt`` in the root of your application directory. Passenger will automatically detect this file and behave as intended.
+To have Passenger automatically restart your application on every request, create a file named `tmp/always_restart.txt` in the root of your application directory. Passenger will automatically detect this file and behave as intended.

data/docs/03_further_reading/running_unit_tests.md

@@ -1,6 +1,6 @@
 Running Unit Tests
 ==================
 
-If doing any development on Scorched, such as if you want to fork it or contribute patches to it, you will probably want to run the suite of tests that accompany it. The few dependancies required for running the Scorched unit tests are installed either when you install the Scorched gem, or by running ``bundle`` in the root of the Scorched source tree.
+If doing any development on Scorched, such as if you want to fork it or contribute patches to it, you will probably want to run the suite of tests that accompany it. The few dependancies required for running the Scorched unit tests are installed either when you install the Scorched gem, or by running `bundle` in the root of the Scorched source tree.
 
-All unit tests have been written using RSpec. To run the tests, ``cd`` into the root of the Scorched source tree from a terminal, and run ``rspec``.
+All unit tests have been written using RSpec. To run the tests, `cd` into the root of the Scorched source tree from a terminal, and run `rspec`.

data/examples/media_types.ru

@@ -11,13 +11,13 @@ class MediaTypesExample < Scorched::Controller
     HTML
   end
   
-  controller pattern: '/*' do
+  controller '/*' do
     get '/*' do |*captures|
       request.breadcrumb.inspect
     end
   end
   
-  get '/,', media_type: 'application/json' do
+  get '/', media_type: 'application/json' do
     {name: 'John Falkon', age: 39, occupation: 'Carpet Cleaner'}.to_json
   end
   

data/lib/scorched/controller.rb

@@ -12,7 +12,8 @@ module Scorched
       :strip_trailing_slash => :redirect, # :redirect => Strips and redirects URL ending in forward slash, :ignore => internally ignores trailing slash, false => does nothing.
       :static_dir => 'public', # The directory Scorched should serve static files from. Set to false if web server or anything else is serving static files.
       :logger => nil,
-      :show_exceptions => false
+      :show_exceptions => false,
+      :auto_pass => false, # Automatically _pass_ request back to outer controller if no route matches.
     }
     
     render_defaults << {
@@ -114,15 +115,16 @@ module Scorched
       # Creates a new controller as a sub-class of self (by default), mapping it to self using the provided mapping
       # hash if one is provided. Returns the new anonymous controller class.
       #
-      # Takes two optional arguments and a block: a parent class from which the generated controller class inherits
-      # from, a mapping hash to automatically map the new controller, and of course a block which defines the
+      # Takes three optional arguments and a block: a pattern, a parent class from which the generated controller class 
+      # inherits from, a mapping hash for setting conditions and so on, and of course a block which defines the
       # controller class.
       #
       # It's worth noting, however obvious, that the resulting class will only be a controller if the parent class is
       # (or inherits from) a Scorched::Controller.
-      def controller(parent_class = self, **mapping, &block)
+      def controller(pattern = '/', parent_class = self, **mapping, &block)
         c = Class.new(parent_class, &block)
-        self << {pattern: '/', target: c}.merge(mapping)
+        c.config[:auto_pass] = true if parent_class < Scorched::Controller
+        self << {pattern: pattern, target: c}.merge(mapping)
         c
       end
       
@@ -199,28 +201,31 @@ module Scorched
           (f[:args].empty? || f[:args].any? { |type| e.is_a?(type) }) && check_conditions?(f[:conditions]) && instance_exec(e, &f[:proc])
         end
       end
-      
-      match = matches(true).first
+
       begin
         catch(:halt) do
           if config[:strip_trailing_slash] == :redirect && request.path =~ %r{./$}
             redirect(request.path.chomp('/'))
           end
           
+          all_matches = matches
+          if all_matches.empty?
+            pass if config[:auto_pass]
+            response.status = 404
+          end
+          
           run_filters(:before)
-          if match
-            request.breadcrumb << match
-            # Proc's are executed in the context of this controller instance.
-            target = match[:mapping][:target]
-            begin
-              catch(:halt) do
+          begin
+            all_matches.each do |match|
+              request.breadcrumb << match
+              processed = catch(:pass) {
+                target = match[:mapping][:target]
                 response.merge! (Proc === target) ? instance_exec(request.env, &target) : target.call(request.env)
-              end
-            rescue => inner_error
-              rescue_block.call(inner_error)
+              }
+              processed ? break : request.breadcrumb.pop
             end
-          else
-            response.status = 404
+          rescue => inner_error
+            rescue_block.call(inner_error)
           end
           run_filters(:after)
         end
@@ -281,6 +286,10 @@ module Scorched
       throw :halt
     end
     
+    def pass
+      throw :pass
+    end
+    
     # Convenience method for accessing Rack request.
     def request
       env['scorched.request']

data/lib/scorched/version.rb

@@ -1,3 +1,3 @@
 module Scorched
-  VERSION = '0.7'
+  VERSION = '0.8'
 end

data/scorched.gemspec

@@ -11,6 +11,8 @@ Gem::Specification.new 'scorched', Scorched::VERSION do |s|
   s.test_files        = Dir.glob('spec/**/*_spec.rb')
   s.rdoc_options      = %w[--line-numbers --inline-source --title Scorched --encoding=UTF-8]
 
+  s.required_ruby_version = '>= 2.0.0'
+
   s.add_dependency 'rack', '~> 1.4'
   s.add_dependency 'rack-accept', '~> 0.4'
   s.add_dependency 'tilt', '~> 1.3'

data/spec/controller_spec.rb

@@ -217,34 +217,57 @@ module Scorched
     end
     
     describe "sub-controllers" do
-      it "can be given no arguments" do
-        app.controller do
-          get('/') { 'hello' }
-        end
-        response = rt.get('/')
-        response.status.should == 200
-        response.body.should == 'hello'
+      it "should ignore the already matched portions of the path" do
+        app << {pattern: '/article', target: Class.new(Scorched::Controller) do
+          get('/*') { |title| title }
+        end}
+        rt.get('/article/hello-world').body.should == 'hello-world'
       end
       
-      it "can take mapping options" do
-        app.controller priority: -1, conditions: {methods: 'POST'} do
-          route('/') { 'ok' }
+      describe "controller helper" do
+        it "can be given no arguments" do
+          app.controller do
+            get('/') { 'hello' }
+          end
+          response = rt.get('/')
+          response.status.should == 200
+          response.body.should == 'hello'
         end
-        app.mappings.first[:priority].should == -1
-        rt.get('/').status.should == 404
-        rt.post('/').body.should == 'ok'
-      end
       
-      it "should ignore the already matched portions of the path" do
-        app.controller pattern: '/article' do
-          get('/*') { |title| title }
+        it "can be given a pattern" do
+          app.controller '/dog' do
+            get('/') { 'roof' }
+          end
+          response = rt.get('/dog')
+          response.status.should == 200
+          response.body.should == 'roof'
         end
-        rt.get('/article/hello-world').body.should == 'hello-world'
-      end
       
-      it "inherits from parent class, or any other class" do
-        app.controller.superclass.should == app
-        app.controller(String).superclass.should == String
+        it "inherits from parent class, or any other class" do
+          app.controller.superclass.should == app
+          app.controller('/', String).superclass.should == String
+        end
+      
+        it "can take mapping options" do
+          app.controller priority: -1, conditions: {methods: 'POST'} do
+            route('/') { 'ok' }
+          end
+          app.mappings.first[:priority].should == -1
+          rt.get('/').status.should == 404
+          rt.post('/').body.should == 'ok'
+        end
+        
+        it "automatically passes to the outer controller when no match" do
+          filters_run = 0
+          app.controller do
+            before { filters_run += 1 }
+            get('/sub') { 'goodbye' }
+            after { filters_run += 1 }
+          end
+          app.get('/') { 'hello' }
+          rt.get('/').body.should == 'hello'
+          filters_run.should == 0
+        end
       end
     end
     
@@ -311,7 +334,10 @@ module Scorched
         example "before filters run from outermost to inner" do
           order = []
           app.before { order << :outer }
-          app.controller { before { order << :inner } }
+          app.controller do
+            before { order << :inner }
+            get('/') { }
+          end
           rt.get('/')
           order.should == [:outer, :inner]
         end
@@ -319,7 +345,10 @@ module Scorched
         example "after filters run from innermost to outermost" do
           order = []
           app.after { order << :outer }
-          app.controller { after { order << :inner } }
+          app.controller do
+            get('/') { }
+            after { order << :inner }
+          end
           rt.get('/')
           order.should == [:inner, :outer]
         end
@@ -419,7 +448,7 @@ module Scorched
           get '/'do
             request.env['scorched.simple_counter']
           end
-          controller pattern: '/sub_controller' do
+          controller '/sub_controller' do
             get '/' do
               request.env['scorched.simple_counter']
             end
@@ -452,10 +481,10 @@ module Scorched
         rt.get('/').status.should == 401
       end
       
-      it "still processes filters" do
+      it "skips processing filters" do
         app.after { response.status = 403 }
         app.get('/') { halt }
-        rt.get('/').status.should == 403
+        rt.get('/').status.should == 200
       end
       
       it "short circuits filters if halted within filter" do
@@ -465,6 +494,36 @@ module Scorched
       end
     end
     
+    describe "passing" do
+      it "invokes the next match" do
+        app.get('/') { response.body << 'hello'; pass }
+        app.get('/') { response.body << ' there'; pass }
+        app.get('/') { response.body << ' sir' }
+        app.get('/') { response.body << '!' } # Shouldn't be hit
+        rt.get('/').body.should == 'hello there sir'
+      end
+      
+      it "invokes the next match in parent controller if passed from filter" do
+        app.controller '/sub' do
+          get('/') { }
+          after do
+            response.body << 'hello'
+            pass
+          end
+        end
+        app.get('/sub') { response.body << ' there' }
+        rt.get('/sub').body.should == 'hello there'
+      end
+      
+      it "passing within filter of root controller results in uncaught symbol" do
+        app.before { pass }
+        expect {
+          app.get('/') { }
+          rt.get('/')
+        }.to raise_error(ArgumentError)
+      end
+    end
+    
     describe "configuration" do
       describe "strip_trailing_slash" do
         it "can be set to strip trailing slash and redirect" do
@@ -525,6 +584,27 @@ module Scorched
           }.to raise_error(RuntimeError)
         end
       end
+      
+      describe "auto_pass" do
+        it "if no match, passes to the outer controller without running any filters" do
+          sub = Class.new(Scorched::Controller) do
+            config[:auto_pass] = true
+            before { response.status = 600 }
+            get('/hello') { 'hello' }
+            after { response.status = 600 }
+          end
+          app << {pattern: '/', target: sub}
+          app.get('/') { 'ok' }
+          rt.get('/').body.should == 'ok'
+          rt.get('/').status.should == 200
+          rt.get('/hello').body.should == 'hello'
+          rt.get('/hello').status.should == 600
+          
+          sub.config[:auto_pass] = false
+          rt.get('/').body.should == ''
+          rt.get('/').status.should == 600
+        end
+      end
     end
     
     describe "sessions" do