scorched 0.20 → 0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b78f42bbcf1ea4018406b7fcf95f31c78ed1c4e
-  data.tar.gz: 3a86547b8e623c089ec67a1a45f65a4ce2b1554d
+  metadata.gz: be73ae01518b83ec6ae0d6d84b693810dad8be8f
+  data.tar.gz: 67a18fa26a948a71c9c283deec4d064fc1575746
 SHA512:
-  metadata.gz: 2ff3c8bc993bffc2d5d94682fc53288a6293edfe94f9f7e9341efb08f6af71cd868cc6614541b286add86c2d0c2ff2c80021115957d088c7afc3bd1c8de075e6
-  data.tar.gz: e96714a418248738c3bb78d76bed6d8a41b28055bed3d1840bca2e2c1430bfb67960e8e5d6fcb6341dbec244bf06172cd2513d20c031c9fe950d311931a3ab9f
+  metadata.gz: bb3f359dcbe1f20fdfe70c029ab4beb8bcfc28c8242b5ceb7b9d8b239738c9b2a49f771a11524aaf232b896c7f4b4342ebad996cbf7ae4c06f7bbc307621a4c9
+  data.tar.gz: f89933d08e8e8f3348221b8e16471433c2819de51ad4ed1088505edfa0ec9aef6a21aefbed6d00443e472c5182ae54dd42f7b29e61572cf88662cc60302e0738

data/CHANGES.md

@@ -3,6 +3,13 @@ Changelog
 
 _Note that Scorched is yet to reach a v1.0 release. This means breaking changes may still be made. If upgrading Scorched version for your project, review this changelog carefully._
 
+### v0.21
+* Named captures have changed again. The values are now passed as arguments to route proc's in favor of using the new `captures` convenience method for accessing named arguments as a hash.
+* The `:redirect` option for `:strip_trailing_slashes` no longer cause a redirection loop when the request path is set to two or more forward slashes, e.g. '//'
+* Changed default value of `render_defaults[:tilt]` to `{default_encoding: 'UTF-8'}`. This defaults _Tilt_ to using UTF-8 for loading template files, which is desirable 99% of the time.
+* The `action` method has been split out into two new methods, `process` and `dispatch`. This provides the oppurtunity to override the dispatch logic where more control is needed over how mapping targets are invoked.
+* `:failed_condition` condition now takes into account whether any mapping has actually handled the request. This allows for example, the correct status to be set when a mapping has been matched, but has `pass`ed the request.
+
 ### v0.20
 * _After_ filters are now still processed when a request is halted. This restores the original behaviour prior to version 0.8. This fixes an issue where halting the request after setting flash session data would cause the request to bomb-out.
 * As an extension of the change above, filters can now be marked as _forced_ using the new `force` option, which if true, means the filter will run even if the request is halted within another filter (including within another forced filter). This ensures a particular filter is run for every request. This required changing the public interface for the _filter_ method. The sugar methods _before_, _after_, and _error_ have remained backwards compatible. 

data/README.md

@@ -39,9 +39,9 @@ Scorched requires Ruby 2.0 or above. If you've got Ruby 2.0.0-p195 and newer, yo
 
 The Errors of Our Past (and Present!)
 ----------------------
-One of the mistakes made by a lot of other Ruby frameworks is to not leverage the power of the class. Consequentially, this makes for some awkwardness. Helpers, for example, are a classical reinvention of what classes and modules are already made to solve. Scorched implements Controllers as classes, which, in addition to having their own DSL, allow you to define and call whatever you need as standard instance methods. The decision to allow developers to implement helpers and other common functionality as standard instance methods not only makes Controllers somewhat more predictable and familiar, but also allows for such helpers to be inheritable via plain old class inheritance.
+One of the mistakes made by a lot of other Ruby frameworks is to not leverage the power of the class. Consequently, this makes for some awkwardness. Helpers for example, are a classic reinvention of what classes and modules are already made to solve. Scorched implements Controllers as classes, which in addition to having their own DSL, allow you to define and call whatever you need as standard instance methods. The decision to allow developers to implement helpers and other common functionality as standard instance methods not only makes Controllers somewhat more predictable and familiar, but also allows for such helpers to be inheritable via plain old class inheritance.
 
-Another design oversight of other frameworks is the lack of consideration for the hierarchical nature of websites and the fact that sub-directories are often expected to inherit attributes of their parents. Scorched supports sub-controllers to any arbitrary depth, with each controller's configuration, filters, route conditions, etc. applied along the way. This can help in many areas of web development, including security, restful interfaces, and interchangeable content types.
+Another design oversight of other frameworks is the lack of consideration for the hierarchical nature of websites and the fact that it's often desireable for sub-directories to inherit attributes of their parents. Scorched supports sub-controllers to any arbitrary depth, with each controller's configuration, filters, route conditions, etc. applied along the way. This can help in many areas of web development, including security, restful interfaces, and interchangeable content types.
 
 
 Design Philosophy

data/docs/02_fundamentals/03_routing.md

@@ -27,7 +27,7 @@ route '/' do
 end
 
 route '/*', 5, method: ['POST', 'PUT', 'DELETE'] do |capture|
-  "Hmm trying to change #{capture} I see"
+  "Hmm, I see you're trying to change the resource #{capture}"
 end
 ```
 
@@ -62,11 +62,26 @@ String patterns are compiled into Regexp patterns corresponding to the following
 * `:param` - Same as `*` except the capture is named to whatever the string following the single-colon.
 * `::param` - Same as `**` except the capture is named to whatever the string following the double-colon.
 * `?` - If placed directly after a wildcard capture, matches zero or more characters instead of one or more. For example, the patterns `/*?` and `/::title?` would match both `/` and `/about`.
-* `$` - If placed at the end of a pattern, the pattern only matches if it matches the entire path. For patterns defined using the route helpers, e.g. `Controller.route`, `Controller.get`, this is implied. 
+* `$` - If placed at the end of a pattern, the pattern only matches if it matches the entire path. For patterns defined using the route helpers, e.g. `Controller.route`, `Controller.get`, this is implied.
 
 ###Regex Patterns
 Regex patterns offer more power and flexibility than string patterns (naturally). The rules for Regex patterns are identical to String patterns, e.g. they must match from the beginning of the path, etc. 
 
+Captures
+--------
+Captures can be accessed as arguments on the route proc, or via the `captures` helper method, which is shorthand for `request.captures`.
+
+```ruby
+get '/:id' do |id|
+  id == captures[:id]
+end
+
+get '/*/*' do |id, title|
+  [id, title] == captures
+end
+```
+
+The above examples demonstrates the two methods of accessing captures, for both named and anonymous captures. You may notice that while named and anonymous captures are passed to the proc as arguments in the exact same way, the `captures` helper either returns either a `Hash` or an `Array` depending on whether the captures are named or not.
 
 Conditions
 ----------

data/examples/rails_style_routing.ru

@@ -0,0 +1,47 @@
+require File.expand_path('../../lib/scorched.rb', __FILE__)
+
+class App < Scorched::Controller
+end
+
+class Base < App
+  def self.inherited(klass)
+    klass.get('/') { invoke_action :index }
+    klass.post('/') { invoke_action :create }
+    klass.get('/:id') { invoke_action :show }
+    klass.get('/:id/edit') { invoke_action :edit }
+    klass.route('/:id', method: ['PATCH', 'PUT']) { invoke_action :update }
+    klass.delete('/:id') { invoke_action :delete }
+  end
+  
+  def invoke_action(action)
+    respond_to?(action) ? send(action) : pass
+  end
+end
+
+class Root < Base
+  def index
+    'Hello'
+  end
+  
+  def create
+    'Creating it now'
+  end
+end
+
+class Customer < Base
+  def index
+    'Hello customer'
+  end
+end
+
+class Order < Base
+  def index
+    'Me order'
+  end
+end
+
+App.controller '/customer', Customer
+App.controller '/order', Order
+App.controller '/', Root
+
+run App

data/lib/scorched/controller.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 module Scorched
   TemplateCache = Tilt::Cache.new
   
@@ -28,7 +30,7 @@ module Scorched
       :layout => false, # The default layout template to use, relative to the view directory. Set to false for no default layout.
       :engine => :erb,
       :locals => {},
-      :tilt => {}, # Options intended for Tilt. This gets around potentialkey name conflicts between Scorched and the renderer invoked by Tilt. For example, if you had to specify an `:engine` for the renderer, this allows you to do that without.
+      :tilt => {default_encoding: 'UTF-8'}, # Options intended for Tilt. This gets around potential key name conflicts between Scorched and the renderer invoked by Tilt.
     }
     
     if ENV['RACK_ENV'] == 'development'
@@ -52,7 +54,7 @@ module Scorched
         [*encodings].any? { |encoding| env['rack-accept.request'].encoding? encoding }
       },
       failed_condition: proc { |conditions|
-        if !matches.empty? && matches.all? { |m| m.failed_condition }
+        if !matches.empty? && matches.any? { |m| m.failed_condition } && !@_handled
           [*conditions].include? matches.first.failed_condition[0]
         end
       },
@@ -82,13 +84,13 @@ module Scorched
       },
     }
     
-    middleware << proc { |this|
+    middleware << proc { |controller|
       use Rack::Head
       use Rack::MethodOverride
       use Rack::Accept
-      use Scorched::Static, this.config[:static_dir] if this.config[:static_dir]
-      use Rack::Logger, this.config[:logger] if this.config[:logger]
-      use Rack::ShowExceptions if this.config[:show_exceptions]
+      use Scorched::Static, controller.config[:static_dir] if controller.config[:static_dir]
+      use Rack::Logger, controller.config[:logger] if controller.config[:logger]
+      use Rack::ShowExceptions if controller.config[:show_exceptions]
     }
     
     class << self
@@ -104,7 +106,7 @@ module Scorched
       def call(env)
         loaded = env['scorched.middleware'] ||= Set.new
         app = lambda do |env|
-          self.new(env).action
+          self.new(env).process
         end
 
         builder = Rack::Builder.new
@@ -165,7 +167,8 @@ module Scorched
       #     patch(pattern = nil, priority = nil, **conds, &block)
       def route(pattern = nil, priority = nil, **conds, &block)
         target = lambda do
-          response.body = instance_exec(*[request.captures].flatten, &block)
+          args = captures.respond_to?(:values) ? captures.values : captures
+          response.body = instance_exec(*args, &block)
           response
         end
         [*pattern].compact.each do |pattern|
@@ -252,8 +255,9 @@ module Scorched
       @response = Response.new
     end
     
-    # This is where the magic happens.
-    def action
+    # This is where the magic happens. Applies filters, matches mappings, applies error handlers, catches :halt and
+    # :pass, etc.
+    def process
       inner_error = nil
       rescue_block = proc do |e|
         raise unless filters[:error].any? do |f|
@@ -265,7 +269,7 @@ module Scorched
 
       begin
         catch(:halt) do
-          if config[:strip_trailing_slash] == :redirect && request.path =~ %r{./$}
+          if config[:strip_trailing_slash] == :redirect && request.path =~ %r{[^/]/+$}
             redirect(request.path.chomp('/'), 307)
           end
           eligable_matches = matches.reject { |m| m.failed_condition }
@@ -284,18 +288,8 @@ module Scorched
             }.reverse.each { |match,idx|
               request.breadcrumb << match
               catch(:pass) {
-                target = match.mapping[:target]
                 catch(:halt) do
-                  response.merge! begin
-                    if Proc === target
-                      instance_exec(&target)
-                    else
-                      target.call(env.merge(
-                        'SCRIPT_NAME' => request.matched_path.chomp('/'),
-                        'PATH_INFO' => request.unmatched_path[match.path.chomp('/').length..-1]
-                      ))
-                    end
-                  end
+                  dispatch(match)
                 end
                 @_handled = true
               }
@@ -320,11 +314,27 @@ module Scorched
       response.finish
     end
     
+    # Dispatches the request to the matched target.
+    # Overriding this method provides the oppurtunity for one to have more control over how mapping targets are invoked.
+    def dispatch(match)
+      target = match.mapping[:target]
+      response.merge! begin
+        if Proc === target
+          instance_exec(&target)
+        else
+          target.call(env.merge(
+            'SCRIPT_NAME' => request.matched_path.chomp('/'),
+            'PATH_INFO' => request.unmatched_path[match.path.chomp('/').length..-1]
+          ))
+        end
+      end
+    end
+    
     # Finds mappings that match the unmatched portion of the request path, returning an array of `Match` objects, or an
     # empty array if no matches were found.
     #
     # 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.
+    # The result is cached for the life time of the controller instance, for the sake of effecient recalling.
     def matches
       return @_matches if @_matches
       to_match = request.unmatched_path
@@ -387,6 +397,10 @@ module Scorched
       env['rack.session']
     end
     
+    # Delegate a few common `request` methods for conveniance.
+    extend Forwardable
+    def_delegators :request, :captures
+    
     # Flash session storage helper.
     # Stores session data until the next time this method is called with the same arguments, at which point it's reset.
     # The typical use case is to provide feedback to the user on the previous action they performed.
@@ -449,11 +463,12 @@ module Scorched
       tilt_options = options.merge(tilt || {})
       tilt_engine = (derived_engine = Tilt[string_or_file.to_s]) || Tilt[engine]
       raise Error, "Invalid or undefined template engine: #{engine.inspect}" unless tilt_engine
+      
       template = if Symbol === string_or_file
         file = string_or_file.to_s
         file = file << ".#{engine}" unless derived_engine
         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)
         end
@@ -463,7 +478,7 @@ module Scorched
         end
       end
     
-      # The following chunk of code is responsible for preventing the rendering of layouts within views.
+      # The following is responsible for preventing the rendering of layouts within views.
       begin
         original_no_default_layout = @_no_default_layout
         @_no_default_layout = true

data/lib/scorched/version.rb

@@ -1,3 +1,3 @@
 module Scorched
-  VERSION = '0.20'
+  VERSION = '0.21'
 end

data/spec/controller_spec.rb

@@ -271,12 +271,14 @@ module Scorched
       end
       
       it "provides wildcard captures as arguments" do
-        app.get('/*/**') { |a,b| "#{a}#{b}" }
-        rt.get('/hello/there/dude').body.should == 'hellothere/dude'
+        app.get('/*/**') { |a,b| "#{a} #{b}" }
+        rt.get('/hello/there/dude').body.should == 'hello there/dude'
       end
       
-      it "provides named captures as a single hash argument" do
-        app.get('/:given_name/::surname') { |h| "#{h[:given_name]} #{h[:surname]}" }
+      it "provides named captures as individual arguments for each value" do
+        app.get('/:given_name') { |a| a }
+        app.get('/:given_name/::surname') { |a,b| "#{a} #{b}" }
+        rt.get('/bob').body.should == 'bob'
         rt.get('/bob/smith').body.should == 'bob smith'
       end
       
@@ -1217,6 +1219,13 @@ module Scorched
         end
       end
     end
+    
+    describe "delegators" do
+      it "delegates captures" do
+        app.get('/:id') { captures[:id] }
+        rt.get('/587').body.should == '587'
+      end
+    end
 
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorched
 version: !ruby/object:Gem::Version
-  version: '0.20'
+  version: '0.21'
 platform: ruby
 authors:
 - Tom Wardrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-22 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -123,6 +123,7 @@ files:
 - docs/03_further_reading/running_unit_tests.md
 - examples/file_upload.ru
 - examples/media_types.ru
+- examples/rails_style_routing.ru
 - examples/simple.ru
 - lib/scorched.rb
 - lib/scorched/collection.rb
@@ -172,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Light-weight, DRY as a desert, web framework for Ruby