scorched 0.24 → 0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a269c05d699e75919261edd1b0fa291753e9cb9
-  data.tar.gz: 7b4789f2fd5f3c38e2004fcb1417a53591112326
+  metadata.gz: 10528e9accf1667188d5687163e6badbdab8ef5f
+  data.tar.gz: abfacc42fe2b69ffcf1152ca256cc31a4ec0130e
 SHA512:
-  metadata.gz: 724e1aa350acae90d82c1be43567c251ed04127105996486383e01bf6ffa6154d4bc7385ade5816b8a926319cc8387fa68403f43122014603b9be9ade81091db
-  data.tar.gz: 43d90ab9f5e30d2b35c47aaa871d1794368f517a56f3ea5aa37f4e6ab8f8cfe4e320252867443a9da8ed05730e9db1d343c0039a272e775da4cd7bd658a183f9
+  metadata.gz: d7a1e567e38bad8f7d08da253e4a396febbc9c9b5798120364ac55f8019870fb705d7d24d3042bdb5c9e1b777135f0f47e4c87bf25a3fa1a4942f3588041f02d
+  data.tar.gz: ad78af5c05b6a89e3721c100f87320a6f21ad02f6c7bfe1bbe6f794dad9a0c87f6788beccf849ae649148776f480093d742601222646c11c7fbe2d74b904f386

data/CHANGES.md

@@ -3,6 +3,10 @@ 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.25
+* Added symbol matchers, which are basically just named regex. Only two symbol matchers included by default, `:numeric` and `:alpha_numeric`. It's intended that users add their own as per their applications requirements. E.g. `symbol_matchers[:article_id] = /[a-f][0-9]{4}/`. A symbol matcher can optionally take a two-element array, where the first element is the regex, and the second is a proc for the sake of coercing the matched value into the desired form, such as an integer.
+* Changed Rack::Logger to Rack::CommonLogger.
+
 ### v0.24
 *  Query string is now preserved when stripping trailing slashes with `config[:strip_trailing_slash] = :redirect`, e.g. `/search/?query=cats` now becomes `/search?query=cats` instead of just `/search`.
 * `absolute` method now returns as-is anything not starting with a forward slash, e.g. `absolute("./view") => "./view"`

data/README.md

@@ -1,4 +1,4 @@
-[Simple, Powerful, Scorched](http://scorchedrb.com)
+[Simple, Powerful, Scorched](https://scorchedrb.com)
 ==========================
 
 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.
@@ -109,12 +109,12 @@ This API shouldn't look too foreign to anyone familiar with frameworks like Sina
 
 Comparisons with other frameworks
 ---------------------------------
-Refer to the [comparisons](https://github.com/Wardrop/Scorched/tree/master/comparisons) directory in the repo to compare a simple example app written in frameworks similar to Scorched.
+Refer to the [comparisons](https://github.com/Wardrop/Scorched/tree/master/comparison) directory in the repo to compare a simple example app written in frameworks similar to Scorched.
 
 Links
 -----
-* [Website](http://scorchedrb.com)
-* [Online API Reference](http://rubydoc.info/gems/scorched)
-* [GitHub Project](http://github.com/wardrop/Scorched)
-* [Issue Tracker](http://github.com/wardrop/Scorched/issues)
+* [Website](https://scorchedrb.com)
+* [Online API Reference](https://rubydoc.info/gems/scorched)
+* [GitHub Project](https://github.com/wardrop/Scorched)
+* [Issue Tracker](https://github.com/wardrop/Scorched/issues)
 * [Discussion/Mailing List](https://groups.google.com/d/forum/scorched)

data/TODO.md

@@ -11,3 +11,10 @@ These features are unlikely to be implemented unless someone provides good enoug
 * 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.
+
+Refactor Considerations
+=======================
+If I undergo a significant refactor of Scorched, here's a list of things I'd like to improve:
+
+* Create a basic plugin system for optional features which may incur a performance and/or complexity overhead, e.g. Symbol matchers, content for. This will also negate the need for any kind of `contrib` library.
+* Make route dispatching more modular, perhaps by simply breaking it out into more individual methods, making it more practical to override default behaviour.

data/docs/02_fundamentals/03_routing.md

@@ -41,8 +41,7 @@ In the latter of the two examples above, a `:method` condition defines what meth
 
 Pattern Matching
 ----------------
-All patterns attempt to match the remaining unmatched portion of the _request path_; the _request path_ being Rack's
-`path_info` request variable. The unmatched path will always begin with a forward slash if the previously matched portion of the path ended immediately before, or included as the last character, a forward slash. As an example, if the request was to "/article/21", then both "/article/" => "/21" and "/article" => "/21" would match.
+All patterns attempt to match the remaining unmatched portion of the _request path_; the _request path_ being Rack's `path_info` request variable. The unmatched path will always begin with a forward slash if the previously matched portion of the path ended immediately before, or included as the last character, a forward slash. As an example, if the request was to "/article/21", then both "/article/" => "/21" and "/article" => "/21" would match.
 
 The `path_info` used to match against is unescaped, meaning percent-codes are resolved, e.g. `%20` resolves to a space. The two exceptions are the escaped forward-slash and percent sign, which remain escaped as `%2F` and `%25` respectively.
 
@@ -65,7 +64,30 @@ String patterns are compiled into Regexp patterns corresponding to the following
 * `$` - 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. 
+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.
+
+###Symbol Matchers
+Symbol matchers were added in v0.25 as a way to conveniently name and re-use regular expressions for matching. Additionally, symbol matchers allow one to define a Proc to pre-process the matched string. This can be used to coerce a value into a particular type (such as an integer), or to manipulate the string in some other way.
+
+Two symbol matchers are included. `:numeric` and `:alpha_numeric`. These are more for example sake than anything else, as it's intended users will implement symbol matchers specific to their application. For example:
+
+```ruby
+symbol_matchers[:article_id] = /[a-z0-9\-]+-[0-9]{1,6}/
+```
+
+The above symbol matcher would match an article id in a typical blog friendly-URL, e.g. hello-world-453. We can further improve this symbol matcher by using a Proc to remove everything but the numeric id at the end, converting it to an integer at the same time.
+
+```ruby
+symbol_matchers[:article_id] =[/[a-z0-9\-]+-([0-9]{1,6})/, proc { |v| v.split('-').last.to_i }]
+```
+
+One limitation to be aware of is that like named captures, if you use the same symbol matcher more than once in a single pattern, you only be able to access the first capture.
+
+```ruby
+get '/:article_id/:article_id' do
+  captures[:article_id] #=> Will always equal the value of whatever first :article_id captured.
+end
+```
 
 Captures
 --------

data/lib/scorched/controller.rb

@@ -7,6 +7,7 @@ module Scorched
     include Scorched::Options('config')
     include Scorched::Options('render_defaults')
     include Scorched::Options('conditions')
+    include Scorched::Options('symbol_matchers')
     include Scorched::Collection('middleware')
     include Scorched::Collection('before_filters')
     include Scorched::Collection('after_filters', true)
@@ -84,13 +85,18 @@ module Scorched
       },
     }
 
+    symbol_matchers << {
+      numeric: [/(\d+)/, proc { |x| x.to_i }],
+      alpha_numeric: /([\da-z]+)/i
+    }
+
     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::CommonLogger, controller.config[:logger] if controller.config[:logger]
       use Rack::ShowExceptions if controller.config[:show_exceptions]
     }
 
@@ -228,7 +234,13 @@ module Scorched
             if %w{* **}.include? match
               match == '*' ? "([^/]#{op})" : "(.#{op})"
             elsif match
-              match[0..1] == '::' ? "(?<#{match[2..-1]}>.#{op})" : "(?<#{match[1..-1]}>[^/]#{op})"
+              if match[0..1] == '::'
+                "(?<#{match[2..-1]}>.#{op})"
+              else
+                name = match[1..-1].to_sym
+                regexp = symbol_matchers[name] ? [*symbol_matchers[name]][0] : "[^/]"
+                "(?<#{name}>#{regexp}#{op})"
+              end
             else
               ''
             end
@@ -351,7 +363,10 @@ module Scorched
             if match_data.names.empty?
               captures = match_data.captures
             else
-              captures = Hash[match_data.names.map{|v| v.to_sym}.zip match_data.captures]
+              captures = Hash[match_data.names.map {|v| v.to_sym}.zip(match_data.captures)]
+              captures.each do |k,v|
+                captures[k] = symbol_matchers[k][1].call(v) if Array === symbol_matchers[k]
+              end
             end
             Match.new(mapping, captures, match_data.to_s, check_for_failed_condition(mapping[:conditions]))
           end

data/lib/scorched/version.rb

@@ -1,3 +1,3 @@
 module Scorched
-  VERSION = '0.24'
+  VERSION = '0.25'
 end

data/spec/controller_spec.rb

@@ -176,6 +176,22 @@ module Scorched
         req.captures.should == {name: 'jeff', infliction: 'has/crabs'}
       end
 
+      it "can use symbol matchers" do
+        app << {pattern: '/:numeric', target: proc { |env| [200, {}, ['ok']] }}
+        rt.get('/45').status.should == 200
+        rt.get('/dog45').status.should == 404
+        req = nil
+        app << {pattern: '/:alpha_numeric', target: proc { |env| req = request; [200, {}, ['ok']] }}
+        rt.get('/dog45').status.should == 200
+        req.captures[:alpha_numeric].should == 'dog45'
+        rt.get('/_dog45').status.should == 404
+      end
+
+      it "can coerce symbol-matched values" do
+        app << {pattern: '/:numeric', target: proc { |env| [200, {}, [request.captures[:numeric].class.name]] }}
+        rt.get('/45').body.should == 'Fixnum'
+      end
+
       it "matches routes based on priority, otherwise giving precedence to those defined first" do
         order = []
         app << {pattern: '/', priority: -1, target: proc { |env| order << 'four'; [200, {}, ['ok']] }}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorched
 version: !ruby/object:Gem::Version
-  version: '0.24'
+  version: '0.25'
 platform: ruby
 authors:
 - Tom Wardrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-10 00:00:00.000000000 Z
+date: 2016-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Light-weight, DRY as a desert, web framework for Ruby