mustermann 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c6a1504081dfaf03cfb2842c71d2295306771a8
-  data.tar.gz: 18e9f9ea774fa6f668529502e36fe0f18a09374f
+  metadata.gz: d7452f3272ea2fe09869f438b2cef90dcba6bf4b
+  data.tar.gz: 5d79d32db97549662b82ef1b589d6d35f1f9df80
 SHA512:
-  metadata.gz: 8f7813109fbc6b146f078dc1562d4a3a40e9ba1385500bbabee888e125910fde8f2788523355802a3d5c8525df4b6aa0b5cb81a8c6116e3e36a850de95863d84
-  data.tar.gz: c1ccd011b168a821f974eb6dd9f42f9f8f6cbe9abf0b8adbf81a7ae3913e428083acba1b8902c07859246621af20a939d2734a5f0562c3d884eb8cc6ef55a6bb
+  metadata.gz: 22ad9c7d0bfb6ae62a339cbfbe2581a91a9f860e4ba2f035ea26157ec0e31e16125d9f159561f43f821e2a07f239eda9e3df318ef3c29d63296a9107bcf65265
+  data.tar.gz: 5394bb963e310669de6e569b06bc690f90060dded1ecbb991d9307c904f5dcb4d6a1c39da7683be8e79eec4782ec28502c716ae9bc528c4221ea7ae0e708434a

data/README.md

@@ -1,15 +1,8 @@
 # The Amazing Mustermann
 
-[![Build Status](https://travis-ci.org/rkh/mustermann.svg?branch=master)](https://travis-ci.org/rkh/mustermann) [![Coverage Status](http://img.shields.io/coveralls/rkh/mustermann.svg?branch=master)](https://coveralls.io/r/rkh/mustermann) [![Code Climate](http://img.shields.io/codeclimate/github/rkh/mustermann.svg)](https://codeclimate.com/github/rkh/mustermann) [![Dependency Status](https://gemnasium.com/rkh/mustermann.svg)](https://gemnasium.com/rkh/mustermann) [![Gem Version](http://img.shields.io/gem/v/mustermann.svg)](https://rubygems.org/gems/mustermann)
-[![Inline docs](http://inch-ci.org/github/rkh/mustermann.svg)](http://inch-ci.org/github/rkh/mustermann)
-[![Documentation](http://img.shields.io/:yard-docs-38c800.svg)](http://rubydoc.info/gems/mustermann/frames)
-[![License](http://img.shields.io/:license-MIT-38c800.svg)](http://rkh.mit-license.org)
-[![Badges](http://img.shields.io/:badges-9/9-38c800.svg)](http://img.shields.io) 
-
-
 *Make sure you view the correct docs: [latest release](http://rubydoc.info/gems/mustermann/frames), [master](http://rubydoc.info/github/rkh/mustermann/master/frames).*
 
-Welcome to [Mustermann](http://en.wikipedia.org/wiki/List_of_placeholder_names_by_language#German). Mustermann is your personal string matching expert. As an expert in the field of strings and patterns, Mustermann also has no runtime dependencies and is fully covered with specs and documentation.
+Welcome to [Mustermann](http://en.wikipedia.org/wiki/List_of_placeholder_names_by_language#German). Mustermann is your personal string matching expert. As an expert in the field of strings and patterns, Mustermann keeps its runtime dependencies to a minimum and is fully covered with specs and documentation.
 
 Given a string pattern, Mustermann will turn it into an object that behaves like a regular expression and has comparable performance characteristics.
 
@@ -23,139 +16,358 @@ when Mustermann.new('foo/*') then puts "prefixed with foo"
 when Mustermann.new('*.pdf') then puts "it's a PDF"
 when Mustermann.new('*.png') then puts "it's an image"
 end
+
+pattern = Mustermann.new('/:prefix/*.*')
+pattern.params('/a/b.c') # => { "prefix" => "a", splat => ["b", "c"] }
+```
+
+## Overview
+
+### Features
+
+* **[Pattern Types](#-pattern-types):** Mustermann supports a wide variety of different pattern types, making it compatible with a large variety of existing software.
+* **[Fine Grained Control](#-available-options):** You can easily adjust matching behavior and add constraints to the placeholders and capture groups.
+* **[Binary Operators](#-binary-operators):** Patterns can be combined into composite patterns using binary operators.
+* **[Regexp Look Alike](#-regexp-look-alike):** Mustermann patterns can be used as a replacement for regular expressions.
+* **[Parameter Parsing](#-parameter-parsing):** Mustermann can parse matched parameters into a Sinatra-style "params" hash, including type casting.
+* **[Peeking](#-peeking):** Lets you check if the beginning of a string matches a pattern.
+* **[Expanding](#-expanding):** Besides parsing a parameters from an input string, a pattern object can also be used to generate a string from a set of parameters.
+* **[Generating Templates](#-generating-templates):** This comes in handy when wanting to hand on patterns rather than fully expanded strings as part of an external API.
+* **[Proc Look Alike](#-proc-look-alike):** Pass on a pattern instead of a block.
+* **[Duck Typing](#-duck-typing):** You can create your own pattern-like objects by implementing `to_pattern`.
+* **[Performance](#-performance):** Patterns are implemented with both performance and a low memory footprint in mind.
+
+### Additional Tooling
+
+These features are included in the library, but not loaded by default
+
+* **[Mapper](#-mapper):** A simple tool for mapping one string to another based on patterns.
+* **[Routers](#-routers):** Model execution flow based on pattern matching. Comes with a simple Rack router.
+* **[Sinatra Integration](#-sinatra-integration):** Mustermann can be used as a [Sinatra](http://www.sinatrarb.com/) extension. Sinatra 2.0 and beyond will use Mustermann by default.
+
+<a name="-pattern-types"></a>
+## Pattern Types
+
+Mustermann support multiple pattern types. A pattern type defines the syntax, matching semantics and whether certain features, like [expanding](#-expanding) and [generating templates](#-generating-templates), are available.
+
+You can create a pattern of a certain type by passing `type` option to `Mustermann.new`:
+
+``` ruby
+require 'mustermann'
+pattern = Mustermann.new('/*/**', type: :shell)
+```
+
+Note that this will use the type as suggestion: When passing in a string argument, it will create a pattern of the given type, but it might choose a different type for other objects (a regular expression argument will always result in a [regexp](#-pattern-details-regexp) pattern, a symbol always in a [sinatra](#-pattern-details-sinatra) pattern, etc).
+
+Alternatively, you can also load and instantiate the pattern type directly:
+
+``` ruby
+require 'mustermann/shell'
+pattern = Mustermann::Shell.new('/*/**')
+```
+
+Mustermann itself includes the [sinatra](#-sinatra-pattern), [identity](#-identity-pattern) and [regexp](#-regexp-pattern) pattern types. Other pattern types are available as separate gems.
+
+<a name="-binary-operators"></a>
+## Binary Operators
+
+Patterns can be combined via binary operators. These are:
+
+* `|` (or):  Resulting pattern matches if at least one of the input pattern matches.
+* `&` (and): Resulting pattern matches if all input patterns match.
+* `^` (xor): Resulting pattern matches if exactly one of the input pattern matches.
+
+``` ruby
+require 'mustermann'
+
+first  = Mustermann.new('/foo/:input')
+second = Mustermann.new('/:input/bar')
+
+first | second === "/foo/foo" # => true
+first | second === "/foo/bar" # => true
+
+first & second === "/foo/foo" # => false
+first & second === "/foo/bar" # => true
+
+first ^ second === "/foo/foo" # => true
+first ^ second === "/foo/bar" # => false
+```
+
+These resulting objects are fully functional pattern objects, allowing you to call methods like `params` or `to_proc` on them. Moreover, *or* patterns created solely from expandable patterns will also be expandable. The same logic also applies to generating templates from *or* patterns.
+
+<a name="-regexp-look-alike"></a>
+## Regexp Look Alike
+
+Pattern objects mimic Ruby's `Regexp` class by implementing `match`, `=~`, `===`, `names` and `named_captures`.
+
+``` ruby
+require 'mustermann'
+
+pattern = Mustermann.new('/:page')
+pattern.match('/')     # => nil
+pattern.match('/home') # => #<MatchData "/home" page:"home">
+pattern =~ '/home'     # => 0
+pattern === '/home'    # => true (this allows using it in case statements)
+pattern.names          # => ['page']
+pattern.names          # => {"page"=>[1]}
+
+pattern = Mustermann.new('/home', type: :identity)
+pattern.match('/')     # => nil
+pattern.match('/home') # => #<Mustermann::SimpleMatch "/home">
+pattern =~ '/home'     # => 0
+pattern === '/home'    # => true (this allows using it in case statements)
+pattern.names          # => []
+pattern.names          # => {}
 ```
 
+Moreover, patterns based on regular expressions (all but `identity` and `shell`) automatically convert to regular expressions when needed:
+
+``` ruby
+require 'mustermann'
+
+pattern = Mustermann.new('/:page')
+union   = Regexp.union(pattern, /^$/)
+
+union =~ "/foo" # => 0
+union =~ ""     # => 0
+
+Regexp.try_convert(pattern) # => /.../
+```
+
+This way, unless some code explicitly checks the class for a regular expression, you should be able to pass in a pattern object instead even if the code in question was not written with Mustermann in mind.
+
+<a name="-parameter-parsing"></a>
+## Parameter Parsing
+
 Besides being a `Regexp` look-alike, Mustermann also adds a `params` method, that will give you a Sinatra-style hash:
 
 ``` ruby
+require 'mustermann'
+
 pattern = Mustermann.new('/:prefix/*.*')
 pattern.params('/a/b.c') # => { "prefix" => "a", splat => ["b", "c"] }
 ```
 
-It's generally a good idea to reuse pattern objects, since as much computation as possible is happening during object creation, so that the actual matching or expanding is quite fast.
+For patterns with typed captures, it will also automatically convert them:
 
-## Types and Options
+``` ruby
+require 'mustermann'
 
-You can pass in additional options to take fine grained control over the pattern:
+pattern = Mustermann.new('/<prefix>/<int:id>', type: :flask)
+pattern.params('/page/10') # => { "prefix" => "page", "id" => 10 }
+```
+
+<a name="-peeking"></a>
+## Peeking
+
+Peeking gives the option to match a pattern against the beginning of a string rather the full string. Patterns come with four methods for peeking:
+
+* `peek` returns the matching substring.
+* `peek_size` returns the number of characters matching.
+* `peek_match` will return a `MatchData` or `Mustermann::SimpleMatch` (just like `match` does for the full string)
+* `peek_params` will return the `params` hash parsed from the substring and the number of characters.
+
+All of the above will turn `nil` if there was no match.
 
 ``` ruby
-Mustermann.new('/:foo.:bar', capture: :alpha) # :foo and :bar will only match alphabetic characters
+require 'mustermann'
+
+pattern = Mustermann.new('/:prefix')
+pattern.peek('/foo/bar')      # => '/foo'
+pattern.peek_size('/foo/bar') # => 4
+
+path_info    = '/foo/bar'
+params, size = patter.peek_params(path_info)  # params == { "prefix" => "foo" }
+rest         = path_info[size..-1]            # => "/bar"
 ```
 
-In fact, you can even completely change the pattern type:
+<a name="-expanding"></a>
+## Expanding
+
+Similarly to parsing, it is also possible to generate a string from a pattern by expanding it with a hash.
+For simple expansions, you can use `Pattern#expand`.
 
 ``` ruby
-Mustermann.new('/**/*.png', type: :shell)
+pattern = Mustermann.new('/:file(.:ext)?')
+pattern.expand(file: 'pony')             # => "/pony"
+pattern.expand(file: 'pony', ext: 'jpg') # => "/pony.jpg"
+pattern.expand(ext: 'jpg')               # raises Mustermann::ExpandError
 ```
 
-The available types are:
+Expanding can be useful for instance when implementing link helpers.
 
-<table>
-  <thead>
-    <tr>
-      <th>Type</th>
-      <th>Description</th>
-      <th>Example</th>
-      <th>Available Options</th>
-      <th>Additional Features</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <th><a href="#identity"><tt>identity</tt></a></th>
-      <td>URI unescaped input string has to match exactly</td>
-      <td><tt>/image.png</tt></td>
-      <td>
-        <a href="#ignore_unknown_options"><tt>ignore_unknown_options</tt></a>,
-        <a href="#uri_decode"><tt>uri_decode</tt></a>
-      </td>
-      <td></td>
-    </tr>
-    <tr>
-      <th><a href="#rails"><tt>rails</tt></a></th>
-      <td>Rails style patterns</td>
-      <td><tt>/:slug(.:ext)</tt></td>
-      <td>
-        <a href="#capture"><tt>capture</tt></a>,
-        <a href="#except"><tt>except</tt></a>,
-        <a href="#greedy"><tt>greedy</tt></a>,
-        <a href="#ignore_unknown_options"><tt>ignore_unknown_options</tt></a>,
-        <a href="#space_matches_plus"><tt>space_matches_plus</tt></a>,
-        <a href="#uri_decode"><tt>uri_decode</tt></a>
-      </td>
-      <td>
-        <a href="#pattern_expanding">Expanding</a>
-      </td>
-    </tr>
-    <tr>
-      <th><a href="#regexp"><tt>regexp</tt></a></th>
-      <td>Regular expressions as implemented by Ruby</td>
-      <td><tt>/(?&lt;slug&gt;.*)</tt></td>
-      <td>
-        <a href="#ignore_unknown_options"><tt>ignore_unknown_options</tt></a>,
-        <a href="#uri_decode"><tt>uri_decode</tt></a>
-      </td>
-      <td></td>
-    </tr>
-    <tr>
-      <th><a href="#shell"><tt>shell</tt></th>
-      <td>Unix style patterns</td>
-      <td><tt>/*.{png,jpg}</tt></td>
-      <td>
-        <a href="#ignore_unknown_options"><tt>ignore_unknown_options</tt></a>,
-        <a href="#uri_decode"><tt>uri_decode</tt></a>
-      </td>
-      <td></td>
-    </tr>
-    <tr>
-      <th><a href="#simple"><tt>simple</tt></a></th>
-      <td>Sinatra 1.3 style patterns</td>
-      <td><tt>/:slug.:ext</tt></td>
-      <td>
-        <a href="#greedy"><tt>greedy</tt></a>,
-        <a href="#ignore_unknown_options"><tt>ignore_unknown_options</tt></a>,
-        <a href="#space_matches_plus"><tt>space_matches_plus</tt></a>,
-        <a href="#uri_decode"><tt>uri_decode</tt></a>
-      </td>
-      <td></td>
-    </tr>
-    <tr>
-      <th><a href="#sinatra"><tt>sinatra</tt></a></th>
-      <td>Sinatra 2.0 style patterns (default)</td>
-      <td><tt>/:slug(.:ext)?</tt></td>
-      <td>
-        <a href="#capture"><tt>capture</tt></a>,
-        <a href="#except"><tt>except</tt></a>,
-        <a href="#greedy"><tt>greedy</tt></a>,
-        <a href="#ignore_unknown_options"><tt>ignore_unknown_options</tt></a>,
-        <a href="#space_matches_plus"><tt>space_matches_plus</tt></a>,
-        <a href="#uri_decode"><tt>uri_decode</tt></a>
-      </td>
-      <td>
-        <a href="#pattern_expanding">Expanding</a>
-      </td>
-    </tr>
-    <tr>
-      <th><a href="#template"><tt>template</tt></a></th>
-      <td><a href="http://tools.ietf.org/html/rfc6570">URI templates</a></td>
-      <td><tt>/dictionary/{term}</tt></td>
-      <td>
-        <a href="#capture"><tt>capture</tt></a>,
-        <a href="#except"><tt>except</tt></a>,
-        <a href="#greedy"><tt>greedy</tt></a>,
-        <a href="#ignore_unknown_options"><tt>ignore_unknown_options</tt></a>,
-        <a href="#space_matches_plus"><tt>space_matches_plus</tt></a>,
-        <a href="#uri_decode"><tt>uri_decode</tt></a>
-      </td>
-      <td>
-        <a href="#pattern_expanding">Expanding</a>
-      </td>
-    </tr>
-  </tbody>
-</table>
+### Expander Objects
+
+To get fine-grained control over expansion, you can use `Mustermann::Expander` directly.
+
+You can create an expander object directly from a string:
+
+``` ruby
+require 'mustermann/expander'
+expander = Mustermann::Expander("/:file.jpg")
+expander.expand(file: 'pony') # => "/pony.jpg"
+
+expander = Mustermann::Expander(":file(.:ext)", type: :rails)
+expander.expand(file: 'pony', ext: 'jpg') # => "/pony.jpg"
+```
+
+Or you can pass it a pattern instance:
+
+``` ruby
+require 'mustermann'
+pattern = Mustermann.new("/:file")
+
+require 'mustermann/expander'
+expander = Mustermann::Expander.new(pattern)
+```
+
+### Expanding Multiple Patterns
+
+You can add patterns to an expander object via `<<`:
+
+``` ruby
+require 'mustermann'
+
+expander = Mustermann::Expander.new
+expander << "/users/:user_id"
+expander << "/pages/:page_id"
+
+expander.expand(user_id: 15) # => "/users/15"
+expander.expand(page_id: 58) # => "/pages/58"
+```
+
+You can set pattern options when creating the expander:
+
+``` ruby
+require 'mustermann'
+
+expander = Mustermann::Expander.new(type: :template)
+expander << "/users/{user_id}"
+expander << "/pages/{page_id}"
+```
 
-See below for more details.
+Additionally, it is possible to combine patterns of different types:
 
+``` ruby
+require 'mustermann'
+
+expander = Mustermann::Expander.new
+expander << Mustermann.new("/users/{user_id}", type: :template)
+expander << Mustermann.new("/pages/:page_id",  type: :rails)
+```
+
+### Handling Additional Values
+
+The handling of additional values passed in to `expand` can be changed by setting the `additional_values` option:
+
+``` ruby
+require 'mustermann'
+
+expander = Mustermann::Expander.new("/:slug", additional_values: :raise)
+expander.expand(slug: "foo", value: "bar") # raises Mustermann::ExpandError
+
+expander = Mustermann::Expander.new("/:slug", additional_values: :ignore)
+expander.expand(slug: "foo", value: "bar") # => "/foo"
+
+expander = Mustermann::Expander.new("/:slug", additional_values: :append)
+expander.expand(slug: "foo", value: "bar") # => "/foo?value=bar"
+```
+
+It is also possible to pass this directly to the `expand` call:
+
+``` ruby
+require 'mustermann'
+
+pattern = Mustermann.new('/:slug')
+pattern.expand(:append, slug: "foo", value: "bar") # => "/foo?value=bar"
+```
+
+<a name="-generating-templates"></a>
+## Generating Templates
+
+... TODO ...
+
+<a name="-proc-look-alike"></a>
+## Proc Look Alike
+
+Patterns implement `to_proc`:
+
+``` ruby
+require 'mustermann'
+pattern  = Mustermann.new('/foo')
+callback = pattern.to_proc # => #<Proc>
+
+callback.call('/foo') # => true
+callback.call('/bar') # => false
+```
+
+They can therefore be easily passed to methods expecting a block:
+
+``` ruby
+require 'mustermann'
+
+list    = ["foo", "example@email.com", "bar"]
+pattern = Mustermann.new(":name@:domain.:tld")
+email   = list.detect(&pattern) # => "example@email.com"
+```
+
+<a name="-mapper"></a>
+## Mapper
+
+
+You can use a mapper to transform strings according to two or more mappings:
+
+``` ruby
+require 'mustermann/mapper'
+
+mapper = Mustermann::Mapper.new("/:page(.:format)?" => ["/:page/view.:format", "/:page/view.html"])
+mapper['/foo']     # => "/foo/view.html"
+mapper['/foo.xml'] # => "/foo/view.xml"
+mapper['/foo/bar'] # => "/foo/bar"
+```
+
+<a name="-routers"></a>
+## Routers
+
+Mustermann comes with basic router implementations that will call certain callbacks depending on the input.
+
+### Simple Router
+
+The simple router chooses callbacks based on an input string.
+
+``` ruby
+require 'mustermann/router/simple'
+
+router = Mustermann::Router::Simple.new(default: 42)
+router.on(':name', capture: :digit) { |string| string.to_i }
+router.call("23")      # => 23
+router.call("example") # => 42
+```
+
+### Rack Router
+
+This is not a full replacement for Rails, Sinatra, Cuba, etc, as it only cares about path based routing.
+
+``` ruby
+require 'mustermann/router/rack'
+
+router = Mustermann::Router::Rack.new do
+  on '/' do |env|
+    [200, {'Content-Type' => 'text/plain'}, ['Hello World!']]
+  end
+
+  on '/:name' do |env|
+    name = env['mustermann.params']['name']
+    [200, {'Content-Type' => 'text/plain'}, ["Hello #{name}!"]]
+  end
+
+  on '/something/*', call: SomeApp
+end
+
+# in a config.ru
+run router
+```
+<a name="-sinatra-integration"></a>
 ## Sinatra Integration
 
 All patterns implement `match`, which means they can be dropped into Sinatra and other Rack routers:
@@ -272,97 +484,17 @@ end
 * Sinatra 2.0 will use Mustermann internally
 * Better exceptions for broken route syntax
 
-### Why not include this in Sinatra 1.x?
-
-* It would introduce breaking changes, even though these would be minor
-* Like Sinatra 2.0, Mustermann requires Ruby 2.0 or newer
-
-<a name="pattern_expanding"></a>
-## Expanding
-
-Similarly to parsing, it is also possible to generate a string from a pattern by expanding it with a hash.
-For simple expansions, you can use `Pattern#expand`.
-
-``` ruby
-pattern = Mustermann.new('/:file(.:ext)?')
-pattern.expand(file: 'pony')             # => "/pony"
-pattern.expand(file: 'pony', ext: 'jpg') # => "/pony.jpg"
-pattern.expand(ext: 'jpg')               # raises Mustermann::ExpandError
-```
-
-Expanding can be useful for instance when implementing link helpers.
-
-### Expander Objects
-
-To get fine-grained control over expansion, you can use `Mustermann::Expander` directly.
-
-You can create an expander object directly from a string:
-
-``` ruby
-require 'mustermann/expander'
-expander = Mustermann::Expander("/:file.jpg")
-expander.expand(file: 'pony') # => "/pony.jpg"
-
-expander = Mustermann::Expander(":file(.:ext)", type: :rails)
-expander.expand(file: 'pony', ext: 'jpg') # => "/pony.jpg"
-```
-
-Or you can pass it a pattern instance:
-
-``` ruby
-require 'mustermann'
-pattern = Mustermann.new("/:file")
-
-require 'mustermann/expander'
-expander = Mustermann::Expander.new(pattern)
-```
-
-### Expanding Multiple Patterns
-
-You can add patterns to an expander object via `<<`:
-
-``` ruby
-expander = Mustermann::Expander.new
-expander << "/users/:user_id"
-expander << "/pages/:page_id"
-
-expander.expand(user_id: 15) # => "/users/15"
-expander.expand(page_id: 58) # => "/pages/58"
-```
-
-You can set pattern options when creating the expander:
-
-``` ruby
-expander = Mustermann::Expander.new(type: :template)
-expander << "/users/{user_id}"
-expander << "/pages/{page_id}"
-```
-
-Additionally, it is possible to combine patterns of different types:
-
-``` ruby
-expander = Mustermann::Expander.new
-expander << Mustermann.new("/users/{user_id}", type: :template)
-expander << Mustermann.new("/pages/:page_id",  type: :rails)
-```
-
-### Handling Additional Values
-
-The handling of additional values passed in to `expand` can be changed by setting the `additional_values` option:
-
-``` ruby
-expander = Mustermann::Expander.new("/:slug", additional_values: :raise)
-expander.expand(slug: "foo", value: "bar") # raises Mustermann::ExpandError
-
-expander = Mustermann::Expander.new("/:slug", additional_values: :ignore)
-expander.expand(slug: "foo", value: "bar") # => "/foo"
+### Why not include this in Sinatra 1.x?
 
-expander = Mustermann::Expander.new("/:slug", additional_values: :append)
-expander.expand(slug: "foo", value: "bar") # => "/foo?value=bar"
-```
+* It would introduce breaking changes, even though these would be minor
+* Like Sinatra 2.0, Mustermann requires Ruby 2.0 or newer
 
+<a name="-duck-typing"></a>
 ## Duck Typing
 
+<a name="-duck-typing-to-pattern"></a>
+### `to_pattern`
+
 All methods converting string input to pattern objects will also accept any arbitrary object that implements `to_pattern`:
 
 ``` ruby
@@ -405,28 +537,43 @@ end
 MyObject.new.to_pattern # => #<Mustermann::Sinatra:"/foo">
 ```
 
-## Partial Loading and Thread Safety
+<a name="-duck-typing-respond-to"></a>
+### `respond_to?`
 
-Pattern objects are generally assumed to be thread-safe. You can easily match strings against the same pattern object concurrently.
+You can and should use `respond_to?` to check if a pattern supports certain features.
 
-Mustermann will only load the pattern implementation you need. For example, `mustermann/rails` is loaded the first time you invoke `Mustermann.new(..., type: :rails)`. This part might not be thread-safe, depending on your Ruby implementation.
+``` ruby
+require 'mustermann'
+pattern = Mustermann.new("/")
 
-In the common use cases, that is Sinatra and similar, patterns are compiled on the main thread during the application load phase, so this is a non-issue there.
+puts "supports expanding"             if pattern.respond_to? :expand
+puts "supports generating templates"  if pattern.respond_to? :to_templates
+```
 
-To avoid this, you can load the pattern types you need manually:
+Alternatively, you can handle a `NotImplementedError` raised from such a method.
 
 ``` ruby
-require 'mustermann/sinatra'
-Mustermann::Sinatra.new('/:foo')
+require 'mustermann'
+pattern = Mustermann.new("/")
+
+begin
+  p pattern.to_templates
+rescue NotImplementedError
+  puts "does not support generating templates"
+end
 ```
 
-## Options
+This behavior corresponds to what Ruby does, for instance for [`fork`](http://ruby-doc.org/core-2.1.1/NotImplementedError.html).
+
+<a name="-available-options"></a>
+## Available Options
 
+<a name="-available-options--capture"></a>
 ### `capture`
 
-Supported by: `rails`, `sinatra`, `template`
+Supported by: All types except `identity`, `shell` and `simple` patterns.
 
-**Sinatra**, **URI template** and **Rails** patterns support changing the way named captures work via the `capture` options.
+Most pattern types support changing the strings named captures will match via the `capture` options.
 
 Possible values for a capture:
 
@@ -449,9 +596,10 @@ Mustermann.new('/:id.:ext', capture: { id: /\d+/, ext: ['png', 'jpg'] })
 
 Available POSIX character classes are: `:alnum`, `:alpha`, `:blank`, `:cntrl`, `:digit`, `:graph`, `:lower`, `:print`, `:punct`, `:space`, `:upper`, `:xdigit`, `:word` and `:ascii`.
 
+<a name="-available-options--except"></a>
 ### `except`
 
-Supported by: `rails`, `sinatra`, `template`
+Supported by: All types except `identity`, `shell` and `simple` patterns.
 
 Given you supply a second pattern via the except option. Any string that would match the primary pattern but also matches the except pattern will not result in a successful match. Feel free to read that again. Or just take a look at this example:
 
@@ -469,13 +617,15 @@ pattern === '/foo.jpg' # => true
 pattern === '/foo.png' # => false
 ```
 
+<a name="-available-options--greedy"></a>
 ### `greedy`
 
-Supported by: `rails`, `simple`, `sinatra`, `template`. Default value: `true`
+Supported by: All types except `identity` and `shell` patterns.
+Default value: `true`
 
 **Simple** patterns are greedy, meaning that for the pattern `:foo:bar?`, everything will be captured as `foo`, `bar` will always be `nil`. By setting `greedy` to `false`, `foo` will capture as little as possible (which in this case would only be the first letter), leaving the rest to `bar`.
 
-**Sinatra**, **URI template** and **Rails** patterns are semi-greedy. This means `:foo(.:bar)?` (`:foo(.:bar)` for Rails patterns) will capture everything before the *last* dot as `foo`. For these two pattern types, you can switch into non-greedy mode by setting the `greedy` option to false. In that case `foo` will only capture the part before the *first* dot.
+**All other** supported patterns are semi-greedy. This means `:foo(.:bar)?` (`:foo(.:bar)` for Rails patterns) will capture everything before the *last* dot as `foo`. For these two pattern types, you can switch into non-greedy mode by setting the `greedy` option to false. In that case `foo` will only capture the part before the *first* dot.
 
 Semi-greedy behavior is not specific to dots, it works with all characters or strings. For instance, `:a(foo:b)` will capture everything before the *last* `foo` as `a`, and `:foo(bar)?` will not capture a `bar` at the end.
 
@@ -487,11 +637,13 @@ pattern = Mustermann.new(':a.:b', greedy: false)
 pattern.match('a.b.c.d') # => #<MatchData a:"a" b:"b.c.d">
 ```
 
+<a name="-available-options--space_matches_plus"></a>
 ### `space_matches_plus`
 
-Supported by: `rails`, `simple`, `sinatra`, `template`. Default value: `true`
+Supported by: All types except `identity`, `regexp` and `shell` patterns.
+Default value: `true`
 
-**Sinatra**, **Simple**, **URI template** and **Rails** patterns will by default also match a plus sign for a space in the pattern:
+Most pattern types will by default also match a plus sign for a space in the pattern:
 
 ``` ruby
 Mustermann.new('a b') === 'a+b' # => true
@@ -511,9 +663,11 @@ pattern.match('a b')[:x] # => 'a b'
 pattern.match('a+b')[:x] # => 'a+b'
 ````
 
+<a name="-available-options--uri_decode"></a>
 ### `uri_decode`
 
-Supported by all patterns. Default value: `true`
+Supported by all pattern types.
+Default value: `true`
 
 Usually, characters in the pattern will also match the URI encoded version of these characters:
 
@@ -529,165 +683,49 @@ Mustermann.new('a b', uri_decode: false) === 'a b'   # => true
 Mustermann.new('a b', uri_decode: false) === 'a%20b' # => false
 ```
 
+<a name="-available-options--ignore_unknown_options"></a>
 ### `ignore_unknown_options`
 
-Supported by all patterns. Default value: `false`
+Supported by all patterns.
+Default value: `false`
 
 If you pass an option in that is not supported by the specific pattern type, Mustermann will raise an `ArgumentError`.
 By setting `ignore_unknown_options` to `true`, it will happily ignore the option.
 
-## Pattern Types
-
-### `identity`
-
-Identity patterns are strings that have to match the input exactly.
-
-``` ruby
-require 'mustermann'
-
-pattern = Mustermann.new('/:example', type: :identity)
-pattern === "/foo.bar"      # => false
-pattern === "/:example"     # => true
-pattern.params("/foo.bar")  # => nil
-pattern.params("/:example") # => {}
-```
-
-<table>
-  <thead>
-    <tr>
-      <th>Syntax Element</th>
-      <th>Description</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td><i>any character</i></td>
-      <td>Matches exactly that character or a URI escaped version of it.</td>
-    </tr>
-  </tbody>
-</table>
-
-### `rails`
-
-Patterns with the syntax used in Rails route definitions.
-
-``` ruby
-require 'mustermann'
-
-pattern = Mustermann.new('/:example', type: :rails)
-pattern === "/foo.bar"     # => true
-pattern === "/foo/bar"     # => false
-pattern.params("/foo.bar") # => { "example" => "foo.bar" }
-pattern.params("/foo/bar") # => nil
-
-pattern = Mustermann.new('/:example(/:optional)', type: :rails)
-pattern === "/foo.bar"     # => true
-pattern === "/foo/bar"     # => true
-pattern.params("/foo.bar") # => { "example" => "foo.bar", "optional" => nil   }
-pattern.params("/foo/bar") # => { "example" => "foo",     "optional" => "bar" }
-
-pattern = Mustermann.new('/*example', type: :rails)
-pattern === "/foo.bar"     # => true
-pattern === "/foo/bar"     # => true
-pattern.params("/foo.bar") # => { "example" => "foo.bar" }
-pattern.params("/foo/bar") # => { "example" => "foo/bar" }
-```
-
-<table>
-  <thead>
-    <tr>
-      <th>Syntax Element</th>
-      <th>Description</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td><b>:</b><i>name</i></td>
-      <td>
-        Captures anything but a forward slash in a semi-greedy fashion. Capture is named <i>name</i>.
-        Capture behavior can be modified with <a href="#capture"><tt>capture</tt></a> and <a href="#greedy"><tt>greedy</tt></a> option.
-      </td>
-    </tr>
-    <tr>
-      <td><b>*</b><i>name</i></td>
-      <td>
-        Captures anything in a non-greedy fashion. Capture is named <i>name</i>.
-      </td>
-    </tr>
-    <tr>
-      <td><b>(</b><i>expression</i><b>)</b></td>
-      <td>Enclosed <i>expression</i> is optional.</td>
-    </tr>
-    <tr>
-      <td><b>/</b></td>
-      <td>
-        Matches forward slash. Does not match URI encoded version of forward slash.
-      </td>
-    </tr>
-    <tr>
-      <td><i>any other character</i></td>
-      <td>Matches exactly that character or a URI encoded version of it.</td>
-    </tr>
-  </tbody>
-</table>
+<a name="-performance"></a>
+## Performance
 
-### `regexp`
+It's generally a good idea to reuse pattern objects, since as much computation as possible is happening during object creation, so that the actual matching or expanding is quite fast.
 
-Regular expression patterns, as used implemented by Ruby. Do not include characters for matching beginning or end of string/line.
-This pattern type is also known as `regular` and the pattern class is `Mustermann::Regular` (located in `mustermann/regular`).
+Pattern objects should be treated as immutable. Their internals have been designed for both performance and low memory usage. To reduce pattern compilation, `Mustermann.new` and `Mustermann::Pattern.new` might return the same instance when given the same arguments, if that instance has not yet been garbage collected. However, this is not guaranteed, so do not rely on object identity.
 
-``` ruby
-require 'mustermann'
+### String Matching
 
-pattern = Mustermann.new('/(?<example>.*)', type: :regexp)
-pattern === "/foo.bar"     # => true
-pattern === "/foo/bar"     # => true
-pattern.params("/foo.bar") # => { "example" => "foo.bar" }
-pattern.params("/foo/bar") # => { "example" => "foo/bar" }
-```
+When using a pattern instead of a regular expression for string matching, performance will usually be comparable.
 
-<table>
-  <thead>
-    <tr>
-      <th>Syntax Element</th>
-      <th>Description</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td><i>any string</i></td>
-      <td>Interpreted as regular expression.</td>
-    </tr>
-  </tbody>
-</table>
+In certain cases, Mustermann might outperform naive, equivalent regular expressions. It achieves this by using look-ahead and atomic groups in ways that work well with a backtracking, NFA-based regular expression engine (such as the Oniguruma/Onigmo engine used by Ruby). It can be difficult and error prone to construct complex regular expressions using these techniques by hand. This only applies to patterns generating an AST internally (all but [identity](#-pattern-details-identity), [shell](#-pattern-details-shell), [simple](#-pattern-details-simple) and [regexp](#-pattern-details-regexp) patterns).
 
-It is also possible to turn a proper Regexp instance into a pattern object by passing it to `Mustermann.new`:
+When using a Mustermann pattern as a direct Regexp replacement (ie, via methods like `=~`, `match` or `===`), the overhead will be a single method dispatch, which some Ruby implementations might even eliminate with method inlining. This only applies to patterns using a regular expression internally (all but [identity](#-pattern-details-identity) and [shell](#-pattern-details-shell) patterns).
 
-``` ruby
-require 'mustermann'
-Mustermann.new(/(?<example>.*)/).params("input") # => { "example" => "input" }
-```
+### Expanding
 
-### `shell`
+Pattern expansion significantly outperforms other, widely used Ruby tools for generating URLs from URL patterns in most use cases.
 
-Shell patterns, as used in Bash or with `Dir.glob`.
+This comes with a few trade-offs:
 
-``` ruby
-require 'mustermann'
+* As with pattern compilation, as much computation as possible has been shifted to compiling expansion rules. This will add compilation overhead, which is why patterns only generate these rules on the first invocation to `Mustermann::Pattern#expand`. Create a `Mustermann::Expander` instance yourself to get better control over the point in time this computation should happen.
+* Memory is sacrificed in favor of performance: The size of the expander object will grow linear with the number of possible combination for expansion keys ("/:foo/:bar" has one such combination, but "/(:foo/)?:bar?" has four)
+* Parsing a params hash from a string generated from another params hash might not result in two identical hashes, and vice versa. Specifically, expanding ignores capture constraints, type casting and greediness.
+* Partial expansion is (currently) not supported.
 
-pattern = Mustermann.new('/*', type: :shell)
-pattern === "/foo.bar" # => true
-pattern === "/foo/bar" # => false
+## Details on Pattern Types
 
-pattern = Mustermann.new('/**/*', type: :shell)
-pattern === "/foo.bar" # => true
-pattern === "/foo/bar" # => true
+<a name="-identity-pattern"></a>
+### `identity`
 
-pattern = Mustermann.new('/{foo,bar}', type: :shell)
-pattern === "/foo"     # => true
-pattern === "/bar"     # => true
-pattern === "/baz"     # => false
-```
+**Supported options:**
+[`uri_decode`](#-available-options--uri_decode),
+[`ignore_unknown_options`](#-available-options--ignore_unknown_options).
 
 <table>
   <thead>
@@ -698,57 +736,18 @@ pattern === "/baz"     # => false
   </thead>
   <tbody>
     <tr>
-      <td><b>*</b></td>
-      <td>Matches anything but a slash.</td>
-    </tr>
-    <tr>
-      <td><b>**</b></td>
-      <td>Matches anything.</td>
-    </tr>
-    <tr>
-      <td><b>[</b><i>set</i><b>]</b></td>
-      <td>Matches one character in <i>set</i>.</td>
-    </tr>
-    <tr>
-      <td><b>&#123;</b><i>a</i>,<i>b</i><b>&#125;</b></td>
-      <td>Matches <i>a</i> or <i>b</i>.</td>
-    </tr>
-    <tr>
-      <td><b>\</b><i>x</i></td>
-      <td>Matches <i>x</i> or URI encoded version of <i>x</i>. For instance <tt>\*</tt> matches <tt>*</tt>.</td>
-    </tr>
-    <tr>
-      <td><i>any other character</i></td>
-      <td>Matches exactly that character or a URI encoded version of it.</td>
+      <td><i>any character</i></td>
+      <td>Matches exactly that character or a URI escaped version of it.</td>
     </tr>
   </tbody>
 </table>
 
-### `simple`
-
-Patterns as used by Sinatra 1.3. Useful for porting an application that relies on this behavior to a later Sinatra version and to make sure [Sinatra 2.0](#sinatra) patterns do not decrease performance. Simple patterns internally use the same code older Sinatra versions used for compiling the pattern. Error messages for broken patterns will therefore not be as informative as for other pattern implementations.
-
-``` ruby
-require 'mustermann'
+<a name="-regexp-pattern"></a>
+### `regexp`
 
-pattern = Mustermann.new('/:example', type: :simple)
-pattern === "/foo.bar"     # => true
-pattern === "/foo/bar"     # => false
-pattern.params("/foo.bar") # => { "example" => "foo.bar" }
-pattern.params("/foo/bar") # => nil
-
-pattern = Mustermann.new('/:example/?:optional?', type: :simple)
-pattern === "/foo.bar"     # => true
-pattern === "/foo/bar"     # => true
-pattern.params("/foo.bar") # => { "example" => "foo.bar", "optional" => nil   }
-pattern.params("/foo/bar") # => { "example" => "foo",     "optional" => "bar" }
-
-pattern = Mustermann.new('/*', type: :simple)
-pattern === "/foo.bar"     # => true
-pattern === "/foo/bar"     # => true
-pattern.params("/foo.bar") # => { "splat" => ["foo.bar"] }
-pattern.params("/foo/bar") # => { "splat" => ["foo/bar"] }
-```
+**Supported options:**
+[`uri_decode`](#-available-options--uri_decode),
+[`ignore_unknown_options`](#-available-options--ignore_unknown_options).
 
 <table>
   <thead>
@@ -759,76 +758,22 @@ pattern.params("/foo/bar") # => { "splat" => ["foo/bar"] }
   </thead>
   <tbody>
     <tr>
-      <td><b>:</b><i>name</i></td>
-      <td>
-        Captures anything but a forward slash in a greedy fashion. Capture is named <i>name</i>.
-      </td>
-    </tr>
-    <tr>
-      <td><b>*</b></td>
-      <td>
-        Captures anything in a non-greedy fashion. Capture is named splat.
-        It is always an array of captures, as you can use <tt>*</tt> more than once in a pattern.
-      </td>
-    </tr>
-    <tr>
-      <td><i>x</i><b>?</b></td>
-      <td>Makes <i>x</i> optional. For instance <tt>foo?</tt> matches <tt>foo</tt> or <tt>fo</tt>.</td>
-    </tr>
-    <tr>
-      <td><b>/</b></td>
-      <td>
-        Matches forward slash. Does not match URI encoded version of forward slash.
-      </td>
-    </tr>
-    <tr>
-      <td><i>any special character</i></td>
-      <td>Matches exactly that character or a URI encoded version of it.</td>
-    </tr>
-    <tr>
-      <td><i>any other character</i></td>
-      <td>Matches exactly that character.</td>
+      <td><i>any string</i></td>
+      <td>Interpreted as regular expression.</td>
     </tr>
   </tbody>
 </table>
 
+<a name="-sinatra-pattern"></a>
 ### `sinatra`
 
-Sinatra 2.0 style patterns. The default used by Mustermann.
-
-``` ruby
-require 'mustermann'
-
-pattern = Mustermann.new('/:example')
-pattern === "/foo.bar"     # => true
-pattern === "/foo/bar"     # => false
-pattern.params("/foo.bar") # => { "example" => "foo.bar" }
-pattern.params("/foo/bar") # => nil
-
-pattern = Mustermann.new('/\:example')
-pattern === "/foo.bar"      # => false
-pattern === "/:example"     # => true
-pattern.params("/foo.bar")  # => nil
-pattern.params("/:example") # => {}
-
-pattern = Mustermann.new('/:example(/:optional)?')
-pattern === "/foo.bar"     # => true
-pattern === "/foo/bar"     # => true
-pattern.params("/foo.bar") # => { "example" => "foo.bar", "optional" => nil   }
-pattern.params("/foo/bar") # => { "example" => "foo",     "optional" => "bar" }
-
-pattern = Mustermann.new('/*')
-pattern === "/foo.bar"     # => true
-pattern === "/foo/bar"     # => true
-pattern.params("/foo.bar") # => { "splat" => ["foo.bar"] }
-pattern.params("/foo/bar") # => { "splat" => ["foo/bar"] }
-
-pattern = Mustermann.new('/*example')
-pattern === "/foo.bar"     # => true
-pattern === "/foo/bar"     # => true
-pattern.params("/foo.bar") # => { "example" => "foo.bar" }
-pattern.params("/foo/bar") # => { "example" => "foo/bar" }
-```
+**Supported options:**
+[`capture`](#-available-options--capture),
+[`except`](#-available-options--except),
+[`greedy`](#-available-options--greedy),
+[`space_matches_plus`](#-available-options--space_matches_plus),
+[`uri_decode`](#-available-options--uri_decode),
+[`ignore_unknown_options`](#-available-options--ignore_unknown_options).
 
 <table>
   <thead>
@@ -839,23 +784,23 @@ pattern.params("/foo/bar") # => { "example" => "foo/bar" }
   </thead>
   <tbody>
     <tr>
-      <td><b>:</b><i>name</i></td>
+      <td><b>:</b><i>name</i> <i><b>or</b></i> <b>&#123;</b><i>name</i><b>&#125;</b></td>
       <td>
         Captures anything but a forward slash in a semi-greedy fashion. Capture is named <i>name</i>.
-        Capture behavior can be modified with <a href="#capture"><tt>capture</tt></a> and <a href="#greedy"><tt>greedy</tt></a> option.
+        Capture behavior can be modified with <tt>capture</tt> and <tt>greedy</tt> option.
       </td>
     </tr>
     <tr>
-      <td><b>*</b><i>name</i></td>
+      <td><b>*</b><i>name</i> <i><b>or</b></i> <b>&#123;+</b><i>name</i><b>&#125;</b></td>
       <td>
         Captures anything in a non-greedy fashion. Capture is named <i>name</i>.
       </td>
     </tr>
     <tr>
-      <td><b>*</b></td>
+      <td><b>*</b> <i><b>or</b></i> <b>&#123;+splat&#125;</b></td>
       <td>
         Captures anything in a non-greedy fashion. Capture is named splat.
-        It is always an array of captures, as you can use <tt>*</tt> more than once in a pattern.
+        It is always an array of captures, as you can use it more than once in a pattern.
       </td>
     </tr>
     <tr>
@@ -865,9 +810,15 @@ pattern.params("/foo/bar") # => { "example" => "foo/bar" }
         or to separate two elements that would otherwise be parsed as one.
       </td>
     </tr>
+    <tr>
+      <td><b>(</b><i>expression</i><b>|</b><i>expression</i><b>|</b><i>...</i><b>)</b></td>
+      <td>
+        Will match anything matching the nested expressions. May contain any other syntax element, including captures.
+      </td>
+    </tr>
     <tr>
       <td><i>x</i><b>?</b></td>
-      <td>Makes <i>x</i> optional. For instance <tt>(foo)?</tt> matches <tt>foo</tt> or an empty string.</td>
+      <td>Makes <i>x</i> optional. For instance, <tt>(foo)?</tt> matches <tt>foo</tt> or an empty string.</td>
     </tr>
     <tr>
       <td><b>/</b></td>
@@ -885,197 +836,3 @@ pattern.params("/foo/bar") # => { "example" => "foo/bar" }
     </tr>
   </tbody>
 </table>
-
-### `template`
-
-Parses fully expanded URI templates as specified by [RFC 6570](http://tools.ietf.org/html/rfc6570).
-
-Note that it differs from URI templates in that it takes the unescaped version of special character instead of the escaped version.
-
-``` ruby
-require 'mustermann'
-
-pattern = Mustermann.new('/{example}', type: :template)
-pattern === "/foo.bar"     # => true
-pattern === "/foo/bar"     # => false
-pattern.params("/foo.bar") # => { "example" => "foo.bar" }
-pattern.params("/foo/bar") # => nil
-
-pattern = Mustermann.new("{/segments*}/{page}{.ext,cmpr:2}", type: :template)
-pattern.params("/a/b/c.tar.gz") # => {"segments"=>["a","b"], "page"=>"c", "ext"=>"tar", "cmpr"=>"gz"}
-```
-
-<table>
-  <thead>
-    <tr>
-      <th>Syntax Element</th>
-      <th>Description</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td><b>&#123;</b><i>o</i> <i>var</i> <i>m</i><b>,</b> <i>var</i> <i>m</i><b>,</b> ...<b>&#125;</b></td>
-      <td>
-        Captures expansion.
-        Operator <i>o</i>: <code>+ # . / ; ? &amp;</tt> or none.
-        Modifier <i>m</i>: <code>:num *</tt> or none.
-      </td>
-    </tr>
-    <tr>
-      <td><b>/</b></td>
-      <td>
-        Matches forward slash. Does not match URI encoded version of forward slash.
-      </td>
-    </tr>
-    <tr>
-      <td><i>any other character</i></td>
-      <td>Matches exactly that character or a URI encoded version of it.</td>
-    </tr>
-  </tbody>
-</table>
-
-The operators `+` and `#` will always match non-greedy, whereas all other operators match semi-greedy by default.
-All modifiers and operators are supported. However, it does not parse lists as single values without the *explode* modifier (aka *star*).
-Parametric operators (`;`, `?` and `&`) currently only match parameters in given order.
-
-Please keep the following in mind:
-
-> "Some URI Templates can be used in reverse for the purpose of variable matching: comparing the template to a fully formed URI in order to extract the variable parts from that URI and assign them to the named variables.  Variable matching only works well if the template expressions are delimited by the beginning or end of the URI or by characters that cannot be part of the expansion, such as reserved characters surrounding a simple string expression.  In general, regular expression languages are better suited for variable matching."
-> &mdash; *RFC 6570, Sec 1.5: "Limitations"*
-
-If you reuse the exact same templates and expose them via an external API meant for expansion,
-you should set `uri_decode` to `false` in order to conform with the specification.
-
-If you are looking for an alternative implementation that also supports expanding, check out [addressable](http://addressable.rubyforge.org/).
-
-## Mapper
-
-You can use a mapper to transform strings according to two or more mappings:
-
-``` ruby
-require 'mustermann/mapper'
-
-mapper = Mustermann::Mapper.new("/:page(.:format)?" => ["/:page/view.:format", "/:page/view.html"])
-mapper['/foo']     # => "/foo/view.html"
-mapper['/foo.xml'] # => "/foo/view.xml"
-mapper['/foo/bar'] # => "/foo/bar"
-```
-
-## Routers
-
-Mustermann comes with basic router implementations that will call certain callbacks depending on the input.
-
-### Simple Router
-
-The simple router chooses callbacks based on an input string.
-
-``` ruby
-require 'mustermann/router/simple'
-
-router = Mustermann::Router::Simple.new(default: 42)
-router.on(':name', capture: :digit) { |string| string.to_i }
-router.call("23")      # => 23
-router.call("example") # => 42
-```
-
-### Rack Router
-
-This is not a full replacement for Rails, Sinatra, Cuba, etc, as it only cares about path based routing.
-
-``` ruby
-require 'mustermann/router/rack'
-
-router = Mustermann::Router::Rack.new do
-  on '/' do |env|
-    [200, {'Content-Type' => 'text/plain'}, ['Hello World!']]
-  end
-
-  on '/:name' do |env|
-    name = env['mustermann.params']['name']
-    [200, {'Content-Type' => 'text/plain'}, ["Hello #{name}!"]]
-  end
-
-  on '/something/*', call: SomeApp
-end
-
-# in a config.ru
-run router
-```
-
-## Requirements
-
-Mustermann has no dependencies besides a Ruby 2.0 compatible Ruby implementation.
-
-It is known to work on **MRI 2.0** and **MRI trunk**.
-
-**JRuby** is not yet fully supported. It is possible to run large parts of Mustermann by passing in `--2.0 -X-C` starting from JRuby 1.7.4. See [issue #2](https://github.com/rkh/mustermann/issues/2) for up to date information.
-
-**Rubinius** is not yet able to parse the Mustermann source code. See [issue #14](https://github.com/rkh/mustermann/issues/14) for up to date information.
-
-## Release History
-
-Mustermann follows [Semantic Versioning 2.0](http://semver.org/). Anything documented in the README or via YARD and not declared private is part of the public API.
-
-### Stable Releases
-
-There have been no stable releases yet. The code base is considered solid but I don't know of anyone using it in production yet.
-As there has been no stable release yet, the API might still change, though I consider this unlikely.
-
-### Development Releases
-
-* **Mustermann 0.3.1** (2014-09-12)
-    * More Infos:
-      [RubyGems.org](http://rubygems.org/gems/mustermann/versions/0.3.1),
-      [RubyDoc.info](http://rubydoc.info/gems/mustermann/0.3.1/frames),
-      [GitHub.com](https://github.com/rkh/mustermann/tree/v0.3.1)
-    * Speed up pattern generation and matchin (thanks [Daniel Mendler](https://github.com/minad))
-    * Small change so `Mustermann === Mustermann.new('...')` returns `true`.
-* **Mustermann 0.3.0** (2014-08-18)
-    * More Infos:
-      [RubyGems.org](http://rubygems.org/gems/mustermann/versions/0.3.0),
-      [RubyDoc.info](http://rubydoc.info/gems/mustermann/0.3.0/frames),
-      [GitHub.com](https://github.com/rkh/mustermann/tree/v0.3.0)
-    * Add `regexp` pattern.
-    * Add named splats to Sinatra patterns.
-    * Add `Mustermann::Mapper`.
-    * Improve duck typing support.
-    * Improve documentation.
-* **Mustermann 0.2.0** (2013-08-24)
-    * More Infos:
-      [RubyGems.org](http://rubygems.org/gems/mustermann/versions/0.2.0),
-      [RubyDoc.info](http://rubydoc.info/gems/mustermann/0.2.0/frames),
-      [GitHub.com](https://github.com/rkh/mustermann/tree/v0.2.0)
-    * Add first class expander objects.
-    * Add params casting for expander.
-    * Add simple router and rack router.
-    * Add weak equality map to significantly improve performance.
-    * Fix Ruby warnings.
-    * Improve documentation.
-    * Refactor pattern validation, AST transformations.
-    * Increase test coverage (from 100%+ to 100%++).
-    * Improve JRuby compatibility.
-    * Work around bug in 2.0.0-p0.
-* **Mustermann 0.1.0** (2013-05-12)
-    * More Infos:
-      [RubyGems.org](http://rubygems.org/gems/mustermann/versions/0.1.0),
-      [RubyDoc.info](http://rubydoc.info/gems/mustermann/0.1.0/frames),
-      [GitHub.com](https://github.com/rkh/mustermann/tree/v0.1.0)
-    * Add `Pattern#expand` for generating strings from patterns.
-    * Add better internal API for working with the AST.
-    * Improved documentation.
-    * Avoids parsing the path twice when used as Sinatra extension.
-    * Better exceptions for unknown pattern types.
-    * Better handling of edge cases around extend.
-    * More specs to ensure API stability.
-    * Largely rework internals of Sinatra, Rails and Template patterns.
-* **Mustermann 0.0.1** (2013-04-27)
-    * More Infos:
-      [RubyGems.org](http://rubygems.org/gems/mustermann/versions/0.0.1),
-      [RubyDoc.info](http://rubydoc.info/gems/mustermann/0.0.1/frames),
-      [GitHub.com](https://github.com/rkh/mustermann/tree/v0.0.1)
-    * Initial Release.
-
-### Upcoming Releases
-
-* **Mustermann 1.0.0** (before Sinatra 2.0)
-    * First stable release.