scorched 0.11.1 → 0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 215f4c437938c37e309b465ec6fd685887e41fd5
-  data.tar.gz: 38795c31fe7f0395a78ebddc403e2fef586dcd9a
+  metadata.gz: 83445d0e97b4717ff0d830c7e72f09bf0c8f8fa1
+  data.tar.gz: eb90cc0893a4b53d180d7dca083f04340026b964
 SHA512:
-  metadata.gz: 4117536f2e361a2c432b49386f2def80528340d4d28055a50e5713e316fecdeffd93b2daa843af8dfdb8df447eb38b5379fa7fa7fc4253518ba7ad3129213829
-  data.tar.gz: 70dab536b62e324347442e19ca08fc7a13c02e7102d5fcdb051a41e32aa3c3286d008bf3fdea73b0f508360ce5cbc9cb1989d9401e1928b63c3705c2351cd725
+  metadata.gz: d90ea66b9a3a280fa2746d0a9cf12a0697c6169e035fdcba9753612bf3297bd01c87b4ca7fa286740c24441e6ec539105cb4621c99a4b28facacdfe2deedeade
+  data.tar.gz: db597065e5a9d1dd93be4a738f998bea0cc85be0b057cd8b107eaad98f5932cc4ebf51aefc03a7b11c5ee412672f2c695e687e755cab5ed69c5f1c93f200d522

data/{Milestones.md → CHANGES.md}

@@ -1,10 +1,12 @@
-Milestones
-==========
-
 Changelog
----------
+=========
+
+### v0.12
+* Halt can now take an optional response body (typically a string).
+* Controller now returns a valid rack array, rather than a Scorched::Response.
+
 ### v0.11.1
-* Fixed issue where multiple nested render calls would incorrectly render the layout (issue #9).
+* Fixed an issue where subsequent nested render calls would render the default layout, which they shouldn't (issue #9).
 * Bumped Tilt dependancy to v1.4 and removed work-around for Tilt encoding issue.
 
 ### v0.11
@@ -93,24 +95,3 @@ Changelog
 * Mechanism for handling exceptions in routes and before/after filters.
 * Added static resource serving. E.g. public folder.
 
-
-
-To Do
------
-Some of these remaining features may be reconsidered and either left out, or put into some kind of contrib library.
-
-* If one or more matches are found, but their conditions don't pass, a 403 should be returned instead of a 404.
-* Make specs for Collection and Options classes more thorough, e.g. test all non-reading modifiers such as clear, delete, etc.
-
-
-Unlikely
---------
-These features are unlikely to be implemented unless someone provides a good reason.
-
-* 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 invoke 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 confusion. 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.
-
-
-More things will be added as they're thought of and considered.

data/Gemfile

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

data/README.md

@@ -3,7 +3,7 @@
 
 Scorched is a generic, unopinionated, DRY, light-weight web framework for Ruby. It provides a generic yet powerful set of constructs for processing HTTP requests, with which websites and applications of almost any scale can be built.
 
-If you've used a light-weight DSL-based Ruby web framework before, such as Sinatra, it should look familiar. Scorched is a true evolutionary enhancement of Sinatra, with more power, focus, and less clutter.
+If you've used a light-weight DSL-based Ruby web framework before, such as Sinatra, Scorched should look quite familiar. Scorched is a true evolutionary enhancement of Sinatra, with more power, focus, and less clutter.
 
 Getting Started
 ---------------
@@ -35,7 +35,7 @@ $ rackup hello_world.ru
 
 #### A Note on Requirements
 
-Scorched requires Ruby 2.0 as it makes use of a few new features. It is however, important to ensure your version of Ruby 2.0 includes [changeset 39919](http://bugs.ruby-lang.org/projects/ruby-trunk/repository/revisions/39919) in order to avoid suffering from [random segmentation faults](http://bugs.ruby-lang.org/issues/8100). The first official patch release of 2.0.0 should include the fix, otherwise you can patch it during installation with RVM.
+Scorched requires Ruby 2.0 or above. It's important to ensure your version of Ruby 2.0 includes [changeset 39919](http://bugs.ruby-lang.org/projects/ruby-trunk/repository/revisions/39919) in order to avoid suffering from [random segmentation faults](http://bugs.ruby-lang.org/issues/8100). Ruby 2.0.0-p195 and newer include the fix, otherwise you can manually patch it during installation.
 
 The Errors of Our Past
 ----------------------
@@ -107,11 +107,6 @@ This API shouldn't look too foreign to anyone familiar with frameworks like Sina
 * Conditions - Conditions are merely procs defined on the controller which are inherited (and can be overriden) by child controllers. When a request comes in, mappings that match the requested URL, first have their conditions evaluated in the context of the controller instance, before control is handed off to the target associated with that mapping. It's a very simple implementation that comes with a lot of flexibility.
 
 
-Development Progress
---------------------
-Please refer to [Milestones.md](Milestones.md) for a breakdown of development progress.
-
-
 Links
 -----
 * [Website](http://scorchedrb.com)

data/TODO.md

@@ -0,0 +1,17 @@
+To Do
+=====
+* If one or more matches are found, but their conditions don't pass, a 403 should be returned instead of a 404.
+* Make specs for Collection and Options classes more thorough, e.g. test all non-reading modifiers such as clear, delete, etc.
+
+
+Unlikely
+========
+These features are unlikely to be implemented unless someone provides a good reason.
+
+* 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 invoke 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 confusion. 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.
+
+
+More things will be added as they're thought of and considered.

data/docs/02_fundamentals/03_routing.md

@@ -85,7 +85,7 @@ As of v0.11, Scorched also supports inverted/negated conditions by adding a trai
 Like configuration options, conditions are implemented using the `Scorched::Options` class, so they're inherited and can be overridden by child classes. You may easily add your own conditions as the example below demonstrates.
 
 ```ruby
-condition[:has_permission] = proc { |v|
+conditions[:has_permission] = proc { |v|
   user.has_permission == v
 }
 

data/lib/scorched/controller.rb

@@ -100,8 +100,7 @@ module Scorched
       def call(env)
         loaded = env['scorched.middleware'] ||= Set.new
         app = lambda do |env|
-          instance = self.new(env)
-          instance.action
+          self.new(env).action
         end
 
         builder = Rack::Builder.new
@@ -151,6 +150,18 @@ module Scorched
       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.
+      #
+      # :call-seq:
+      #     route(pattern = nil, priority = nil, **conds, &block)
+      #     get(pattern = nil, priority = nil, **conds, &block)
+      #     post(pattern = nil, priority = nil, **conds, &block)
+      #     put(pattern = nil, priority = nil, **conds, &block)
+      #     delete(pattern = nil, priority = nil, **conds, &block)
+      #     head(pattern = nil, priority = nil, **conds, &block)
+      #     options(pattern = nil, priority = nil, **conds, &block)
+      #     patch(pattern = nil, priority = nil, **conds, &block)
       def route(pattern = nil, priority = nil, **conds, &block)
         target = lambda do |env|
           env['scorched.response'].body = instance_exec(*env['scorched.request'].captures, &block)
@@ -159,7 +170,7 @@ module Scorched
         self << {pattern: compile(pattern, true), priority: priority, conditions: conds, target: target} if pattern
         target
       end
-
+      
       ['get', 'post', 'put', 'delete', 'head', 'options', 'patch'].each do |method|
         methods = (method == 'get') ? ['GET', 'HEAD'] : [method.upcase]
         define_method(method) do |*args, **conds, &block|
@@ -168,11 +179,18 @@ module Scorched
         end
       end
       
+      # Defines a filter of +type+. Helper methods are provided as syntactic sugar for each filter type.
+      # +args+ is used internally by Scorched for passing additional arguments to the filter, such as the exception in
+      # the case of error blocks.
+      # :call-seq:
+      #     filter(type, *args, **conds, &block)
+      #     before(*args, **conds, &block)
+      #     after(*args, **conds, &block)
+      #     error(*args, **conds, &block)
       def filter(type, *args, **conds, &block)
         filters[type.to_sym] << {args: args, conditions: conds, proc: block}
       end
       
-      # A bit of syntactic sugar for #filter.
       ['before', 'after', 'error'].each do |type|
         define_method(type) do |*args, &block|
           filter(type, *args, &block)
@@ -218,6 +236,8 @@ module Scorched
       end
       env['scorched.request'] ||= Request.new(env)
       env['scorched.response'] ||= Response.new
+      @_log_prefix = ' ' * (4 * request.breadcrumb.length)
+      log :debug, "#{log_object(self)} instantiated"
     end
     
     def action
@@ -236,6 +256,7 @@ module Scorched
             redirect(request.path.chomp('/'))
           end
           
+          log :debug, :matches
           if matches.all? { |m| m.failed_condition }
             pass if config[:auto_pass]
             response.status = matches.empty? ? 404 : 403
@@ -246,21 +267,23 @@ module Scorched
             @_matched = true == matches.each { |match|
               next if match.failed_condition
               request.breadcrumb << match
+              target = match.mapping[:target]
               break if catch(:pass) {
-                target = match.mapping[:target]
+                log :debug, "Invoking target: #{log_object(target)}"
                 response.merge! (Proc === target) ? instance_exec(env, &target) : target.call(env)
               }
               request.breadcrumb.pop
+              log :debug, "#{log_object(target)} passed the request"
             }
           rescue => inner_error
             rescue_block.call(inner_error)
           end
           run_filters(:after)
-        end
+        end || log(:debug, "Request halted")
       rescue => outer_error
         outer_error == inner_error ? raise : rescue_block.call(outer_error)
       end
-      response
+      response.finish
     end
     
     # Finds mappings that match the unmatched portion of the request path, returning an array of `Match` objects, or an
@@ -308,8 +331,16 @@ module Scorched
       halt(status)
     end
     
-    def halt(status = 200)
-      response.status = status
+    # call-seq:
+    #     halt(status=nil, body=nil)
+    #     halt(body)
+    def halt(status=nil, body=nil)
+      unless status.nil? || Integer === status
+        body = status
+        status = nil
+      end
+      response.status = status if status
+      response.body = body if body
       throw :halt
     end
     
@@ -489,18 +520,52 @@ module Scorched
   
     def run_filters(type)
       tracker = env['scorched.executed_filters'] ||= {before: Set.new, after: Set.new}
-      filters[type].reject{ |f| tracker[type].include? f }.each do |f|
-        unless check_for_failed_condition(f[:conditions])
-          tracker[type] << f
-          instance_exec(&f[:proc])
+      eligable = filters[type].reject{ |f| tracker[type].include? f || check_for_failed_condition(f[:conditions])}
+      log :debug, "Running #{eligable.length} eligable #{type} filters:"
+      eligable.each do |f|
+        log :debug, "  #{f[:conditions]} => #{log_object f[:proc]}"
+        tracker[type] << f
+        instance_exec(&f[:proc])
+      end
+    end
+    
+    def log(type, message = nil, *args)
+      if config[:logger]
+        logger = config[:logger]
+        type = Logger.const_get(type.to_s.upcase)
+        logger.progname ||= 'Scorched'
+        
+        case message
+        when :matches
+          message = []
+          eligable = matches.reject { |m| m.failed_condition }
+          message << "#{matches.length} mappings matched #{request.unmatched_path.inspect}:"
+          matches.each do |m|
+            message << "  #{m.mapping[:pattern].inspect} => #{log_object m.mapping[:target]}"
+          end
+          message << "#{eligable.length} of which are eligable:"
+          eligable.each do |m|
+            message << "  #{m.mapping[:pattern].inspect} => #{log_object m.mapping[:target]}"
+          end
+        end
+
+        [*message].each do |v|
+          v.insert(0, @_log_prefix)
+          logger.add(type, v)
         end
       end
+      true # Makes it safe to use in conditions
     end
     
-    def log(type, message)
-      config[:logger].progname ||= 'Scorched'
-      type = Logger.const_get(type.to_s.upcase)
-      config[:logger].add(type, message)
+    def log_object(obj)
+      case obj
+      when Proc
+        "<Proc @#{obj.source_location.join(':')}>"
+      when Array
+        obj.map { |v| log_object(v) }.inspect
+      else
+        obj.class.name || Controller === obj.class ? 'Anonymous controller' : 'Anonymous class'
+      end
     end
   end
 end

data/lib/scorched/error.rb

@@ -1,5 +1,4 @@
 module Scorched
-  class Error < StandardError
-    
+  class Error < RuntimeError
   end
 end

data/lib/scorched/response.rb

@@ -5,26 +5,32 @@ module Scorched
     def merge!(response)
       return self if response == self
       if Rack::Response === response
-        response.finish
-        self.status = response.status
-        self.header.merge!(response.header)
-        self.body = []
-        response.each { |v| self.body << v }
-      else
-        self.status, @header, self.body = response
+        response = [response.status, response.header, response]
       end
+      self.status, self.body = response[0], response[2]
+      self.header.merge!(response[1])
+      self
     end
     
     # Automatically wraps the assigned value in an array if it doesn't respond to ``each``.
     # Also filters out non-true values and empty strings.
     def body=(value)
-      value = []  if !value || value == ''
+      value = [] if !value || value == ''
       super(value.respond_to?(:each) ? value : [value.to_s])
     end
     
+    # Override finish to avoid using BodyProxy
     def finish(*args, &block)
       self['Content-Type'] ||= 'text/html;charset=utf-8'
-      super
+      @block = block if block
+      if [204, 205, 304].include?(status.to_i)
+        header.delete "Content-Type"
+        header.delete "Content-Length"
+        close
+        [status.to_i, header, []]
+      else
+        [status.to_i, header, body]
+      end
     end
     
     alias :to_a :finish

data/lib/scorched/version.rb

@@ -1,3 +1,3 @@
 module Scorched
-  VERSION = '0.11.1'
+  VERSION = '0.12'
 end

data/scorched.gemspec

@@ -2,11 +2,12 @@ $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 require 'scorched/version'
 
 Gem::Specification.new 'scorched', Scorched::VERSION do |s|
-  s.summary           = "Light-weight, DRY as a desert, web framework for Ruby"
-  s.description       = "A lightweight Sinatra-inspired web framework for web sites and applications of any size."
-  s.authors           = ["Tom Wardrop"]
-  s.email             = "tom@tomwardrop.com"
-  s.homepage          = "http://scorchedrb.com"
+  s.summary           = 'Light-weight, DRY as a desert, web framework for Ruby'
+  s.description       = 'A light-weight Sinatra-inspired web framework for web sites and applications of any size.'
+  s.authors           = ['Tom Wardrop']
+  s.email             = 'tom@tomwardrop.com'
+  s.homepage          = 'http://scorchedrb.com'
+  s.license           = 'MIT'
   s.files             = Dir.glob(`git ls-files`.split("\n") - %w[.gitignore])
   s.test_files        = Dir.glob('spec/**/*_spec.rb')
   s.rdoc_options      = %w[--line-numbers --inline-source --title Scorched --encoding=UTF-8]

data/spec/controller_spec.rb

@@ -537,6 +537,17 @@ module Scorched
         rt.get('/').status.should == 401
       end
       
+      it "takes an optional response body" do
+        app.get('/') { halt 'cool' }
+        rt.get('/').body.should == 'cool'
+      end
+      
+      it "can take a status and a response body" do
+        app.get('/') { halt 401, 'cool' }
+        rt.get('/').status.should == 401
+        rt.get('/').body.should == 'cool'
+      end
+      
       it "skips processing filters" do
         app.after { response.status = 403 }
         app.get('/') { halt }
@@ -546,7 +557,7 @@ module Scorched
       it "short circuits filters if halted within filter" do
         app.before { halt }
         app.after { response.status = 403 }
-        rt.get('/').status.should == 200
+        rt.get('/').status.should_not == 403
       end
     end
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorched
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: '0.12'
 platform: ruby
 authors:
 - Tom Wardrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-10 00:00:00.000000000 Z
+date: 2013-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -80,17 +80,18 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.9'
-description: A lightweight Sinatra-inspired web framework for web sites and applications
+description: A light-weight Sinatra-inspired web framework for web sites and applications
   of any size.
 email: tom@tomwardrop.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGES.md
 - Gemfile
 - LICENSE
-- Milestones.md
 - README.md
+- TODO.md
 - docs/01_preface.md
 - docs/02_fundamentals/01_the_controller.md
 - docs/02_fundamentals/02_configuration.md
@@ -131,7 +132,8 @@ files:
 - spec/views/other.str
 - spec/views/partial.erb
 homepage: http://scorchedrb.com
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: