Merge pull request #238 from rfestag/add_named_captures_support

Added support for named captures

Author: seancribbs

documentation/routes.md

@@ -20,6 +20,21 @@ App = Webmachine::Application.new do |app|
     # but will not provide any path_info
     add ["orders", :*], OrderResource
 
+    # Will map to any path that matches the given components and regular expression
+    # Any capture groups specified in the regex will be made available in
+    # request.path_info[:captures. In this case, you would get one or two
+    # values in :captures depending on whether your request looked like:
+    # /orders/1/cancel
+    # or
+    # /orders/1/cancel.json
+    add ["orders", :id, /([^.]*)\.?(.*)?/], OrderResource
+
+    # You can even use named captures with regular expressions. This will 
+    # automatically put the captures into path_info. In the below example,
+    # you would get :id from the symbol, along with :action and :format
+    # from the regex. :format in this case would be optional.
+    add ["orders", :id, /(?<action>)[^.]*)\.?(?<format>.*)?/], OrderResource
+
     # will map to any path
     add [:*], DefaultResource
   end
@@ -94,4 +109,4 @@ end
 request.path_info[:foo]
 => "bar"
 
-```
+```

lib/webmachine/dispatcher/route.rb

@@ -122,7 +122,14 @@ def bind(tokens, bindings)
           when Regexp === spec.first
             matches = spec.first.match URI.decode(tokens.first)
             if matches
-              bindings[:captures] = (bindings[:captures] || []) + matches.captures
+              if spec.first.named_captures.empty?
+                bindings[:captures] = (bindings[:captures] || []) + matches.captures
+              else
+                spec.first.named_captures.reduce(bindings) do |bindings, (name, idxs)|
+                  bindings[name.to_sym] = matches.captures[idxs.first-1]
+                  bindings
+                end
+              end
             else
               return false
             end

spec/webmachine/dispatcher/route_spec.rb

@@ -219,6 +219,14 @@ def call(request)
           expect(request.path_info).to eq({:captures => ["bar", "json"]})
         end
       end
+      context "with named capture regex" do
+        subject { described_class.new(['foo', :bar, /(?<baz>[^.]+)\.(?<format>.*)/], resource) }
+        let(:uri) { URI.parse("http://localhost:8080/foo/bar/baz.json") }
+
+        it "should assign the captures path variables" do
+          expect(request.path_info).to eq({bar: 'bar', baz: 'baz', format: "json"})
+        end
+      end
 
       context "with a splat" do
         subject { described_class.new(['foo', :*], resource) }