truss-router 0.0.2 → 0.0.3

data/README.md

@@ -1,5 +1,5 @@
-[![Build Status](https://travis-ci.org/truss-io/router.png)](https://travis-ci.org/truss-io/router)
 # Truss Router
+[![Build Status](https://travis-ci.org/truss-io/router.png)](https://travis-ci.org/truss-io/router)
 
 Truss Router is the first released part of Truss - a new wrapper around Rack to make writing performant Ruby web endpoints easier.
 Truss Router is currently considered alpha software, and as such please don't use in any production environment, but feel free to
@@ -34,7 +34,7 @@ it doesn't actually support much, but features will come!
 
 So, how do I use it? Basically, just require the gem, and then ```draw``` a map of your routes. Routes are evaluated from top to bottom, so routes at the top of the route block will match and return before routes below them. The route builder takes the following arguments:
 
-1. path, e.g. "/home" (currently only exact matches match, dynamic segments coming soon!)
+1. path, e.g. "/home" or "/posts/:id"
 2. rack app, e.g. ```->(env){[200, {'Content-Type' => 'text/plain'}, ["Hi, I'm a Rack App"]]}```
 3. an optional hash of options (currently not used!)
 
@@ -46,8 +46,16 @@ Truss::Router.draw do |r|
     r.post("/login", LoginApp)
     r.patch("/update", DhhApp)
     r.delete("/goodbye", RemoveThisApp)
+    r.get("/posts/:id", PostApp) # :id is a dynamic segment
 end
 ```
+Any valid Rack endpoint is supported as an endpoint in this map, but please be aware that Truss Router will pass a 
+Truss::Router::Request object (a thin layer over Rack::Request) into the rack app rather than just the env hash. This 
+allows for passing segment options and similar without too much drama.
+
+Any dynamic segments (declared by prefixing that segment with ```:```) will be passed into the application as part of the Truss
+Request object, available under ```#routing_params``` for now, which is a simple hash of the segment name to the value. All keys 
+are strings and no attempt is made to coerce values, so they are all strings as well.
 
 Finally, you can then run the Truss Router as a rack app:
 
@@ -63,7 +71,10 @@ request methods to different endpoints on the same path.
 
 Having said that, there isn't much point in having candy if it makes it slow. HTTP Router inspired me to include benchmarks within
 the repo that make it easy to check how performant the solution is. I'll include the current benchmark output in the wiki for each
-supported platform (1.9.3/2.0.0/JRuby1.7/RBX) and update with each release to keep things current.
+supported platform ([1.9.3](https://github.com/truss-io/router/wiki/Benchmarks-MRI-1.9.3) / [2.0.0](https://github.com/truss-io/router/wiki/Benchmarks-MRI-2.0.0) / [JRuby1.7](https://github.com/truss-io/router/wiki/Benchmarks-JRuby) / [RBX](https://github.com/truss-io/router/wiki/Benchmarks-RBX)) and update with each release to keep things current.
+
+Currently, 2.0.0 is by far the slowest, which is somewhat curious - I had expected it to lose to JRuby and possibly RBX but not to
+MRI 1.9.3, which is worth investigating.
 
 ## Contributing
 

data/benchmarks/simple_bench.rb

@@ -20,7 +20,7 @@ end
 
 puts "Benchmarking in progress with 50k iterations, please wait\n\n"
 
-Benchmark.bm(12) do |x|
+Benchmark.bmbm(12) do |x|
     x.report("Plain app")    { TIMES.times{ app.call(REQUEST) } }
     x.report("Single route") { TIMES.times { Truss::Router.call(REQUEST) } }
 end
@@ -44,9 +44,9 @@ end
 
 HOME_REQUEST = Rack::MockRequest.env_for("/home", method: "GET")
 
-Benchmark.bm(12) do |x|
+Benchmark.bmbm(10) do |x|
     x.report("Plain app")    { TIMES.times{ app.call(REQUEST) } }
-    x.report("Single route") { TIMES.times { Truss::Router.call(HOME_REQUEST) } }
+    x.report("Last route") { TIMES.times { Truss::Router.call(HOME_REQUEST) } }
 end
 
 
@@ -67,8 +67,23 @@ Truss::Router.draw do |route|
     route.get("/home", app2)
 end
 
-Benchmark.bm(10) do |x|
+Benchmark.bmbm(10) do |x|
     x.report("Plain app")  { TIMES.times{ app.call(REQUEST) } }
     x.report("Last route") { TIMES.times { Truss::Router.call(HOME_REQUEST) } }
 end
 
+puts "\n\nBenchmarking 1 dynamic segment with 50k requests\n\n"
+Truss::Router.reset!
+
+Truss::Router.draw do |route|
+    route.get("/posts/:id", app)
+end
+
+POSTS_REQUEST = Rack::MockRequest.env_for("/posts/9", method: "GET")
+
+Benchmark.bmbm(11) do |x|
+    x.report("Plain app")   { TIMES.times{ app.call(REQUEST) } }
+    x.report("One Dynamic") { TIMES.times { Truss::Router.call(POSTS_REQUEST) } }
+end
+
+

data/lib/truss/router/node.rb

@@ -1,15 +1,25 @@
 module Truss
     module Router
         class Node
-            attr_accessor :request_method, :path, :endpoint, :matchable_regex, :options
+            attr_accessor :request_method, :path, :has_dynamic_segments, 
+                          :endpoint, :matchable_regex, :options
             def initialize(method, path, endpoint, options={})
                 @request_method, @path, @endpoint = method, path, endpoint
+                @has_dynamic_segments = false 
                 @matchable_regex = build_matchable_regex(method, path, options)
                 @options = options
             end
 
             def matches? request
-                matchable_regex.match(request.routing_path)
+                if has_dynamic_segments
+                    match = matchable_regex.match(request.routing_path)
+                    if match
+                        request.routing_params = Hash[match.names.zip(match.captures)]
+                    end
+                    match
+                else
+                    matchable_regex.match(request.routing_path)
+                end
             end
 
             def call request
@@ -18,7 +28,12 @@ module Truss
 
             private
             def build_matchable_regex(method, path, options)
-                %r[\A#{method_group(method)}#{path}\Z]
+                if path.include?(":")
+                    self.has_dynamic_segments = true
+                    /\A#{method_group(method)}#{segment_string(path)}\Z/
+                else
+                    %r[\A#{method_group(method)}#{path}\Z]
+                end
             end
 
             def method_group(method)
@@ -31,6 +46,17 @@ module Truss
                     "(#{method.to_s.upcase}|OPTIONS)"
                 end
             end
+
+            def segment_string(path)
+                components = path.split("/").map do |comp|
+                    if comp[0] == ":"
+                        "(?<#{comp[1..-1]}>[\\w\\-]+)"
+                    else
+                        comp
+                    end
+                end
+                "#{components.join('/')}"
+            end
         end
     end
 end

data/lib/truss/router/request.rb

@@ -1,6 +1,13 @@
 module Truss
     module Router
         class Request < Rack::Request
+            attr_accessor :routing_params
+            
+            def initialize(*args)
+                @routing_params = {}
+                super(*args)
+            end
+
             def routing_path
                 "#{request_method}#{path}"
             end

data/lib/truss/router/version.rb

@@ -1,5 +1,5 @@
 module Truss
   module Router
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/lib/truss/dynamic_matcher_spec.rb

@@ -0,0 +1,20 @@
+require 'truss/router'
+
+describe Truss::Router do
+    context "dynamic matchers instantiate routing_params in the request object" do
+        subject { described_class }
+        let(:app) { ->(env){ [200, {'Content-Type' => 'text/plain'}, [env.routing_params['id']]] } }
+        let(:env) { Rack::MockRequest.env_for("/posts/9", method: "GET") }
+        before :each do
+            Truss::Router.reset!
+            Truss::Router.draw do |r|
+                r.get("/posts/:id", app)
+            end
+        end
+
+        it "should return the id as the body of the request" do
+            response = subject.call(env)
+            response[2].first.should eq("9")
+        end
+    end
+end

data/spec/lib/truss/router/node_spec.rb

@@ -46,6 +46,17 @@ describe Truss::Router::Node do
             subject { Truss::Router::Node.new(:delete, "/home", app) }
             its(:matchable_regex) { should eq(%r[\A(DELETE|OPTIONS)/home\Z]) }
         end
-    
     end
+
+    describe "dynamic segments" do
+        context "single dynamic matcher" do
+            subject { Truss::Router::Node.new(:delete, "/:id", app) }
+            its(:matchable_regex) { should eq(/\A(DELETE|OPTIONS)\/(?<id>[\w\-]+)\Z/) }
+        end
+        
+        context "multiple dynamic matchers" do
+            subject { Truss::Router::Node.new(:delete, "/posts/:post_id/comments/:id", app) }
+            its(:matchable_regex) { should eq(/\A(DELETE|OPTIONS)\/posts\/(?<post_id>[\w\-]+)\/comments\/(?<id>[\w\-]+)\Z/) }
+        end
+   end
 end

data/spec/lib/truss/{request_spec.rb → router/request_spec.rb}

@@ -5,4 +5,7 @@ describe Truss::Router::Request do
     subject { described_class.new(env) }
 
     it { should be_kind_of(Rack::Request) }
+    it { should respond_to(:routing_path) }
+    it { should respond_to(:routing_params) }
+    its(:routing_params) { should eq({}) }
 end

metadata

@@ -1,71 +1,80 @@
 --- !ruby/object:Gem::Specification
 name: truss-router
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
+  prerelease:
 platform: ruby
 authors:
 - John Maxwell
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-05-25 00:00:00.000000000 Z
+date: 2013-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+    none: false
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  prerelease: false
+  type: :development
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.0
+    none: false
+  prerelease: false
+  type: :runtime
 description: Truss Router is a modular Rack Router for Truss
 email:
 - john@musicglue.com
@@ -96,9 +105,10 @@ files:
 - lib/truss/router/routeset.rb
 - lib/truss/router/version.rb
 - spec/lib/truss/draw_routes_spec.rb
-- spec/lib/truss/request_spec.rb
+- spec/lib/truss/dynamic_matcher_spec.rb
 - spec/lib/truss/route_dispatch_spec.rb
 - spec/lib/truss/router/node_spec.rb
+- spec/lib/truss/router/request_spec.rb
 - spec/lib/truss/router/routes/delete_spec.rb
 - spec/lib/truss/router/routes/get_spec.rb
 - spec/lib/truss/router/routes/head_spec.rb
@@ -114,8 +124,7 @@ files:
 homepage: http://truss-io.github.io
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -123,23 +132,32 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
+      segments:
+      - 0
       version: '0'
+      hash: 2
+  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
+      segments:
+      - 0
       version: '0'
+      hash: 2
+  none: false
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.3
-signing_key: 
-specification_version: 4
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
 summary: Truss Router is a modular Rack Router for Truss
 test_files:
 - spec/lib/truss/draw_routes_spec.rb
-- spec/lib/truss/request_spec.rb
+- spec/lib/truss/dynamic_matcher_spec.rb
 - spec/lib/truss/route_dispatch_spec.rb
 - spec/lib/truss/router/node_spec.rb
+- spec/lib/truss/router/request_spec.rb
 - spec/lib/truss/router/routes/delete_spec.rb
 - spec/lib/truss/router/routes/get_spec.rb
 - spec/lib/truss/router/routes/head_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 9b56c1774dc9e3e09defdd552298a3a10bfc61bd
-  data.tar.gz: 76018cd3ef0a703260177cc158ca4223f91bcbd1
-SHA512:
-  metadata.gz: d3c1fc3a28002932edb13878189dca29d9b7a3cc60d76d2907263238f6d39edb6ff20b46395a00f151f98f1c5a7f7e38ddad91f1f4428e27767156b1afd21066
-  data.tar.gz: f02753a22f37ea3837d34c819dcae69964a53c8e2aabca5cac9bfe1069f3983e2e8b0497d1d33852246ce61b6f32b816a7eb91486d720bb8774ce1016f214b39