scorched 0.22 → 0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f796c21d65c86f604be0aea1a3dbcecdff2abe0
-  data.tar.gz: 7c192c6f91c1e00fd97cb32865b5c8f610cc1916
+  metadata.gz: 1007cc5234411333f49d1cacda15b2a384eb0a0c
+  data.tar.gz: 41e412b90cddee3e91c4f8785fecc0b73a394977
 SHA512:
-  metadata.gz: 506421a43fcc2fa091978a349d910b3e016696b437ab26aaca12e258219455ba38f9a3483e99f83970df030c649ce2965598eff7c885b5185adfad7dc06d66b9
-  data.tar.gz: cc0b1638943da206f905d46834ae0f2df3151459a1de60ff537028f3fd69f5732f57ae8d8e921bed302d639e7047a4239e9a5aa42edd4d181900f27fa628be2a
+  metadata.gz: 604562e9030f0e52a95a56ff61a43094de84c519daa5ee9f7d40a35734528d8dddcf4f52fc2fd73437a0069661fadab49b3a1ca24d40346ba95fd3eea6dac5e3
+  data.tar.gz: fbc6efbbd4508f04526d3910553a40136f037780d129f48298170eea136deeafb73b6cc7c28f8bef092413a82a44a992cd2643035c7eefdb9267bb8c4ee01d26

data/CHANGES.md

@@ -3,6 +3,11 @@ Changelog
 
 _Note that Scorched is yet to reach a v1.0 release. This means breaking changes may still be made. If upgrading the version of Scorched for your project, review this changelog carefully._
 
+### v0.23
+* Now using _scorched-accept_ for accept header parsing and logic, which fixes issues with the `:media_type` condition.
+* Exceptions caught by Scorched are now assigned to env['rack.exception'].
+* Implemented `respond_to_missing?` on Scorched::Controller.
+
 ### v0.22
 * The `redirect` method now passes the given URL through `absolute`.
 * The error page filter now always runs at the end-point controller so `:show_http_error_pages` behaves as expected when overriden in sub-controllers.
@@ -16,7 +21,7 @@ _Note that Scorched is yet to reach a v1.0 release. This means breaking changes
 
 ### 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. 
+* 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.
 * Named captures are now passed to route proc's as a single hash argument. The previous behaviour was an oversight.
 * Halting within an error filter is now swallowed if the error filter is invoked by an error raised in a before or after filter.
 * The `controller` helper can now be used to map predefined controllers simply by omitting the block, which is now optional. This a more convenient means of mapping controllers as compared to the more barebones `map` method.
@@ -59,7 +64,7 @@ _Note that Scorched is yet to reach a v1.0 release. This means breaking changes
 * Bumped Tilt dependancy to v1.4 and removed work-around for Tilt encoding issue.
 
 ### v0.11
-* Route wildcards '*' and '**' (and their named equivalents) now match zero or more characters, instead of one or more. This means `/*` will now match both `/` and `/about` for example. 
+* Route wildcards '*' and '**' (and their named equivalents) now match zero or more characters, instead of one or more. This means `/*` will now match both `/` and `/about` for example.
 * Conditions can now be inverted by appending an exclamation mark to the condition, e.g. `method!: 'GET'` matches all HTTP methods, excluding GET.
 * While not strictly Scorched related, one planned feature for Scorched was to implement a simple form population mechanism. This has instead been implemented as a stand-alone project, [Formless](https://github.com/Wardrop/Formless), which can be used with any framework or application, including Scorched.
 
@@ -123,7 +128,7 @@ _Note that Scorched is yet to reach a v1.0 release. This means breaking changes
 * Added specs for each configuration option.
 * Using Ruby 2.0 features where applicable. No excuse not to be able to deploy on 2.0 by the time Scorched is ready for production.
     * Keyword arguments instead of `*args`ombined with ` `Hash === args.last`  * Replaced instances of `__FILE__`ith ` `__dir__`Added expected Rack middleware, Rack::MethodOverride and Rack::Head.
-    
+
 ### v0.4
 * Make filters behave like middleware. Inheritable, but are only executed once.
 * Improved implementation of Options and Collection classes
@@ -143,4 +148,3 @@ _Note that Scorched is yet to reach a v1.0 release. This means breaking changes
     * Added redirect helping for halting and redirecting request
 * Mechanism for handling exceptions in routes and before/after filters.
 * Added static resource serving. E.g. public folder.
-

data/Gemfile

@@ -1,2 +1,2 @@
 source 'https://rubygems.org'
-gemspec
+gemspec

data/TODO.md

@@ -8,6 +8,6 @@ Unlikely
 These features are unlikely to be implemented unless someone provides good enough justification.
 
 * Mutex locking option - I'm of the opinion that the web server should be configured for the concurrency model of the application, rather than the framework.
-* Using Rack::Protection by default - The problem here is that a good portion of Rack::Protection involves sessions, and given that Scorched doesn't itself load any session middleware, these components of Rack::Protection would have to be excluded. I wouldn't want to lull anyone into a false sense of security
+* Using Rack::Protection by default - The problem here is that a good portion of Rack::Protection involves sessions, and given that Scorched doesn't itself load any session middleware, these components of Rack::Protection would have to be excluded. I wouldn't want to lull anyone into a false sense of security.
 * Filter priorities - They're technically possible, but I believe it would introduce the potential for _filter hell_; badly written filters and mass hysteria. Filter order has to be logical and predictable. Adding prioritisation would undermine that, and make for lazy use of filters. By not having prioritisation, there's incentive to design filters to be order-agnostic.
 * Verbose logging - I originally intended to add some form of debug-style logging to show the complete flow of a request as it traverses through filters and controllers, etc. For a couple of reasons, I've decided to leave this out of Scorched. For those unfamiliar with the order in which filters and routes are invoked, it's better to learn through first-hand experience writing little test applications, rather than depending on debug logging.

data/examples/restful_controller.ru

@@ -0,0 +1,51 @@
+require File.expand_path('../../lib/scorched.rb', __FILE__)
+
+class App < Scorched::Controller
+end
+
+module Scorched
+  module RestActions
+
+    def self.included(klass)
+      klass.get('/') { invoke_action :index }
+      klass.get('/new') { invoke_action :new }
+      klass.post('/') { invoke_action :create }
+      klass.get('/:id') { |id| invoke_action :show, id }
+      klass.get('/:id/edit') { |id| invoke_action :edit, id }
+      klass.route('/:id', method: ['PATCH', 'PUT']) { |id| invoke_action :update, id }
+      klass.delete('/:id') { |id| invoke_action :destroy, id }
+    end
+
+    def invoke_action(action, *captures)
+      respond_to?(action) ? send(action, *captures) : pass
+    end
+
+  end
+end
+
+class Root < App
+  include Scorched::RestActions
+
+  def index
+    'Hello'
+  end
+
+end
+
+class Customer < App
+  include Scorched::RestActions
+
+  def index
+    'Hello customer'
+  end
+
+  def show(id)
+    "Hello customer #{id}"
+  end
+
+end
+
+App.controller '/customer', Customer
+App.controller '/', Root
+
+run App

data/examples/simple.ru

@@ -1,14 +1,14 @@
-require 'scorched'
+require File.expand_path('../../lib/scorched.rb', __FILE__)
 
 class App < Scorched::Controller
   get '/:name' do
     @message = greeting(captures[:name])
     render :hello
   end
-  
+
   def greeting(name)
     "Howdy #{name}"
   end
 end
 
-run App
+run App

data/lib/scorched.rb

@@ -3,6 +3,7 @@ ENV['RACK_ENV'] ||= 'development'
 # Gems
 require 'rack'
 require 'rack/accept'
+require 'scorched/accept'
 require 'tilt'
 
 # Stdlib
@@ -18,4 +19,4 @@ require_relative 'scorched/controller'
 require_relative 'scorched/error'
 require_relative 'scorched/request'
 require_relative 'scorched/response'
-require_relative 'scorched/version'
+require_relative 'scorched/version'

data/lib/scorched/controller.rb

@@ -2,7 +2,7 @@ require 'forwardable'
 
 module Scorched
   TemplateCache = Tilt::Cache.new
-  
+
   class Controller
     include Scorched::Options('config')
     include Scorched::Options('render_defaults')
@@ -13,7 +13,7 @@ module Scorched
     include Scorched::Collection('error_filters')
 
     attr_reader :request, :response
-    
+
     config << {
       :auto_pass => false, # Automatically _pass_ request back to outer controller if no route matches.
       :cache_templates => true,
@@ -22,9 +22,9 @@ module Scorched
       :show_http_error_pages => false, # If true, shows the default Scorched HTTP error page.
       :static_dir => false, # The directory Scorched should serve static files from. Set to false if web server or anything else is serving static files.
       :strip_trailing_slash => :redirect, # :redirect => Strips and redirects URL ending in forward slash, :ignore => internally ignores trailing slash, false => does nothing.
-      
+
     }
-    
+
     render_defaults << {
       :dir => 'views', # The directory containing all the view templates, relative to the current working directory.
       :layout => false, # The default layout template to use, relative to the view directory. Set to false for no default layout.
@@ -32,14 +32,14 @@ module Scorched
       :locals => {},
       :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'
       config[:show_exceptions] = true
       config[:static_dir] = 'public'
       config[:cache_templates] = false
       config[:show_http_error_pages] = true
     end
-    
+
     conditions << {
       charset: proc { |charsets|
         [*charsets].any? { |charset| env['rack-accept.request'].charset? charset }
@@ -58,16 +58,16 @@ module Scorched
           [*conditions].include? matches.first.failed_condition[0]
         end
       },
-      host: proc { |host| 
-        (Regexp === host) ? host =~ request.host : host == request.host 
+      host: proc { |host|
+        (Regexp === host) ? host =~ request.host : host == request.host
       },
       language: proc { |languages|
         [*languages].any? { |language| env['rack-accept.request'].language? language }
       },
       media_type: proc { |types|
-        [*types].any? { |type| env['rack-accept.request'].media_type? type }
+        [*types].any? { |type| env['scorched.accept'][:accept].acceptable? type }
       },
-      method: proc { |methods| 
+      method: proc { |methods|
         [*methods].include?(request.request_method)
       },
       handled: proc { |bool|
@@ -76,33 +76,34 @@ module Scorched
       proc: proc { |blocks|
         [*blocks].all? { |b| instance_exec(&b) }
       },
-      user_agent: proc { |user_agent| 
-        (Regexp === user_agent) ? user_agent =~ request.user_agent : user_agent == request.user_agent 
+      user_agent: proc { |user_agent|
+        (Regexp === user_agent) ? user_agent =~ request.user_agent : user_agent == request.user_agent
       },
-      status: proc { |statuses| 
+      status: proc { |statuses|
         [*statuses].include?(response.status)
       },
     }
-    
+
     middleware << proc { |controller|
       use Rack::Head
       use Rack::MethodOverride
       use Rack::Accept
+      use Scorched::Accept::Rack
       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
-      
+
       def mappings
         @mappings ||= []
       end
-      
+
       def filters
         @filters ||= {before: before_filters, after: after_filters, error: error_filters}
       end
-      
+
       def call(env)
         loaded = env['scorched.middleware'] ||= Set.new
         app = lambda do |env|
@@ -117,7 +118,7 @@ module Scorched
         builder.run(app)
         builder.call(env)
       end
-      
+
       # Generates and assigns mapping hash from the given arguments.
       #
       # Accepts the following keyword arguments:
@@ -136,10 +137,10 @@ module Scorched
         }
       end
       alias :<< :map
-      
+
       # Maps a new ad-hoc or predefined controller.
       #
-      # If a block is given, creates a new controller as a sub-class of _klass_ (_self_ by default), otherwise maps 
+      # If a block is given, creates a new controller as a sub-class of _klass_ (_self_ by default), otherwise maps
       # _klass_ itself. Returns the new anonymous controller class if a block is given, or _klass_ otherwise.
       def controller(pattern = '/', klass = self, **mapping, &block)
         if block_given?
@@ -151,7 +152,7 @@ module Scorched
         self << {pattern: pattern, target: controller}.merge(mapping)
         controller
       end
-      
+
       # Generates and returns a new route proc from the given block, and optionally maps said proc using the given args.
       # Helper methods are provided for each HTTP method which automatically define the appropriate _:method_
       # condition.
@@ -176,7 +177,7 @@ module Scorched
         end
         target
       end
-      
+
       ['get', 'post', 'put', 'delete', 'head', 'options', 'patch', 'link', 'unlink'].each do |method|
         methods = (method == 'get') ? ['GET', 'HEAD'] : [method.upcase]
         define_method(method) do |*args, **conds, &block|
@@ -184,36 +185,36 @@ module Scorched
           route(*args, **conds, &block)
         end
       end
-      
-      # Defines a filter of +type+. 
+
+      # Defines a filter of +type+.
       # +args+ is used internally by Scorched for passing additional arguments to some filters, such as the exception in
-      # the case of error filters. 
+      # the case of error filters.
       def filter(type, args: nil, force: nil, conditions: nil, **more_conditions, &block)
         more_conditions.merge!(conditions || {})
         filters[type.to_sym] << {args: args, force: force, conditions: more_conditions, proc: block}
       end
-      
+
       # Syntactic sugar for defining a before filter.
       # If +force+ is true, the filter is run even if another filter halts the request.
       def before(force: false, **conditions, &block)
         filter(:before, force: force, conditions: conditions, &block)
       end
-      
+
       # Syntactic sugar for defining an after filter.
       # If +force+ is true, the filter is run even if another filter halts the request.
       def after(force: false, **conditions, &block)
         filter(:after, force: force, conditions: conditions, &block)
       end
-      
+
       # Syntactic sugar for defining an error filter.
       # Takes one or more optional exception classes for which this error filter should handle. Handles all exceptions
       # by default.
       def error(*classes, **conditions, &block)
         filter(:error, args: classes, conditions: conditions, &block)
       end
-      
+
     private
-    
+
       # Parses and compiles the given URL string pattern into a regex if not already, returning the resulting regexp
       # object. Accepts an optional _match_to_end_ argument which will ensure the generated pattern matches to the end
       # of the string.
@@ -237,15 +238,19 @@ module Scorched
         Regexp.new(compiled)
       end
     end
-    
+
     after(failed_condition: :host) { response.status = 404 }
     after(failed_condition: :method) { response.status = 405 }
     after(failed_condition: %i{charset encoding language media_type}) { response.status = 406 }
-    
-    def method_missing(method, *args, &block)
-      (self.class.respond_to? method) ? self.class.__send__(method, *args, &block) : super
+
+    def method_missing(method_name, *args, &block)
+      (self.class.respond_to? method_name) ? self.class.__send__(method_name, *args, &block) : super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      self.class.respond_to? method_name
     end
-    
+
     def initialize(env)
       define_singleton_method :env do
         env
@@ -254,13 +259,13 @@ module Scorched
       @request = Request.new(env)
       @response = Response.new
     end
-    
+
     # 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|
+        (env['rack.exception'] = e && raise) unless filters[:error].any? do |f|
           if !f[:args] || f[:args].empty? || f[:args].any? { |type| e.is_a?(type) }
             instance_exec(e, &f[:proc]) unless check_for_failed_condition(f[:conditions])
           end
@@ -281,7 +286,7 @@ module Scorched
               [
                 m.mapping[:priority] || 0,
                 [*m.mapping[:conditions][:media_type]].map { |type|
-                  env['rack-accept.request'].media_type.qvalue(type)
+                  env['scorched.accept'][:accept].rank(type, true)
                 }.max || 0,
                 -idx
               ]
@@ -313,7 +318,7 @@ module Scorched
       end
       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)
@@ -329,7 +334,7 @@ module Scorched
         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.
     #
@@ -352,7 +357,7 @@ module Scorched
         end
       }.compact
     end
-    
+
     # Tests the given conditions, returning the name of the first failed condition, or nil otherwise.
     def check_for_failed_condition(conds)
       failed = (conds || []).find { |c, v| !check_condition?(c, v) }
@@ -361,7 +366,7 @@ module Scorched
       end
       failed
     end
-    
+
     # Test the given condition, returning true if the condition passes, or false otherwise.
     def check_condition?(c, v)
       c = c[0..-2].to_sym if invert = (c[-1] == '!')
@@ -369,13 +374,13 @@ module Scorched
       retval = instance_exec(v, &self.conditions[c])
       invert ? !retval : !!retval
     end
-    
+
     # Redirects to the specified path or URL. An optional HTTP status is also accepted.
     def redirect(url, status = (env['HTTP_VERSION'] == 'HTTP/1.1') ? 303 : 302)
       response['Location'] = absolute(url)
       halt(status)
     end
-    
+
     # call-seq:
     #     halt(status=nil, body=nil)
     #     halt(body)
@@ -388,20 +393,20 @@ module Scorched
       response.body = body if body
       throw :halt
     end
-    
+
     def pass
       throw :pass
     end
-    
+
     # Convenience method for accessing Rack session.
     def session
       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.
@@ -417,11 +422,11 @@ module Scorched
       end
       session[key]
     end
-    
+
     after(force: true) do
       env['scorched.flash'].each { |k,v| session[k] = v } if session && env['scorched.flash']
     end
-    
+
     # Serves as a thin layer of convenience to Rack's built-in method: Request#cookies, Response#set_cookie, and
     # Response#delete_cookie.
     #
@@ -442,7 +447,7 @@ module Scorched
         end
       end
     end
-    
+
     # Renders the given string or file path using the Tilt templating library.
     # Each option defaults to the corresponding value defined in _render_defaults_ attribute. Unrecognised options are
     # passed through to Tilt, but a `:tilt` option is also provided for passing options directly to Tilt.
@@ -464,12 +469,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
-        
+
         template_cache.fetch(:file, tilt_engine, file, tilt_options) do
           tilt_engine.new(file, nil, tilt_options)
         end
@@ -478,7 +483,7 @@ module Scorched
           tilt_engine.new(nil, nil, tilt_options) { string_or_file }
         end
       end
-    
+
       # The following is responsible for preventing the rendering of layouts within views.
       begin
         original_no_default_layout = @_no_default_layout
@@ -487,7 +492,7 @@ module Scorched
       ensure
         @_no_default_layout = original_no_default_layout
       end
-      
+
       if layout
         render(layout, dir: dir, layout: false, engine: engine, locals: locals, tilt: tilt, **options) { output }
       else
@@ -512,7 +517,7 @@ module Scorched
         uri.to_s
       end
     end
-    
+
     # Takes an optional path, relative to the applications root URL, and returns an absolute path.
     # Example: absolute('/style.css') #=> /myapp/style.css
     def absolute(path = nil)
@@ -524,7 +529,7 @@ module Scorched
       end
       return_path[0] == '/' ? return_path : return_path.insert(0, '/')
     end
-    
+
     # We always want this filter to run at the end-point controller, hence we include the conditions within the body of
     # the filter.
     after do
@@ -557,9 +562,9 @@ module Scorched
       end
     end
 
-    
+
   private
-  
+
     def run_filters(type, forced_only = false)
       tracker = env['scorched.executed_filters'] ||= {before: Set.new, after: Set.new}
       filters[type].reject{ |f| tracker[type].include?(f) || (forced_only && !f[:force]) }.each do |f|
@@ -575,7 +580,7 @@ module Scorched
         end
       end
     end
-    
+
     def log(type = nil, message = nil)
       config[:logger].progname ||= 'Scorched'
       if(type)