mustermann-contrib 3.1.0 → 4.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3990aa843c8c57b75fc5e7a5a8fa0b0d56f6f46c6a8e4ad8a5b408066b3ee96
-  data.tar.gz: 82b5f3729b4ae440bb94be9117558bd83dbead5b07599254dc3255104cab3f5e
+  metadata.gz: ba766f2be34c126a5c87154b9e9ff3e6d5f5e2f8080f2b29a30850f5634fa91d
+  data.tar.gz: 3a62549ac2e49145dca087f9b082fb1957d50293fadb3ef5c84911cdb43b80ee
 SHA512:
-  metadata.gz: bd18842741789080329166170db2b904af298f2bd80e797e259bb02740aab45ea313f3009f0570079db11cf0d3728b38fb8833c94004b52f43123a27835a3035
-  data.tar.gz: 7d7a909d1970370e86097380bbd0ca47c04e2d34ef2e41ed10d2da1ce60a21976e3b7a814b2d549cd4cbdcee6f6ba3398ba1922a524c7e8d87b0d88336c1c8b3
+  metadata.gz: acc416d7cbeddec35cad710634f66a77dc9adbc89a80d493fd6b6e99336c266dca4bc6ee2a9d09fdbf2e358fa6666303016750bd455c620f06381a5d55cf2eb3
+  data.tar.gz: 8bccefca2caf7829bf3aa2d8a57fcadf7bed1e4a0ae0d17142a241ba1ffa94d0fd63f01a1cf44f6d2816a446ad048090e20bfe85fd26ff7211f5725170ea0518

data/LICENSE

@@ -1,5 +1,4 @@
-Copyright (c) 2013-2017 Konstantin Haase
-Copyright (c) 2016-2017 Zachary Scott
+Copyright (c) Konstantin Haase
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -27,177 +27,13 @@ end
 <a name="-mustermann-cake"></a>
 # CakePHP Syntax for Mustermann
 
-This gem implements the `cake` pattern type for Mustermann. It is compatible with [CakePHP](http://cakephp.org/) 2.x and 3.x.
-
-## Overview
-
-**Supported options:**
-`capture`, `except`, `greedy`, `space_matches_plus`, `uri_decode`, and `ignore_unknown_options`.
-
-**External documentation:**
-[CakePHP 2.0 Routing](http://book.cakephp.org/2.0/en/development/routing.html),
-[CakePHP 3.0 Routing](http://book.cakephp.org/3.0/en/development/routing.html)
-
-CakePHP patterns feature captures and unnamed splats. Captures are prefixed with a colon and splats are either a single asterisk (parsing segments into an array) or a double asterisk (parsing segments as a single string).
-
-``` ruby
-require 'mustermann/cake'
-
-Mustermann.new('/:name/*',  type: :cake).params('/a/b/c') # => { name: 'a', splat: ['b', 'c'] }
-Mustermann.new('/:name/**', type: :cake).params('/a/b/c') # => { name: 'a', splat: 'b/c' }
-
-pattern = Mustermann.new('/:name')
-
-pattern.respond_to? :expand # => true
-pattern.expand(name: 'foo') # => '/foo'
-
-pattern.respond_to? :to_templates # => true
-pattern.to_templates              # => ['/{name}']
-```
-
-## Syntax
-
-<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 <tt>capture</tt> and <tt>greedy</tt> option.
-      </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 it more than once in a pattern.
-      </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 it more than once in a pattern.
-        The value matching a single <tt>**</tt> will be split at slashes when parsed into <tt>params</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 other character</i></td>
-      <td>Matches exactly that character or a URI encoded version of it.</td>
-    </tr>
-  </tbody>
-</table>
+See [docs/patterns/cake.md](../docs/patterns/cake.md).
 
 
 <a name="-mustermann-express"></a>
 # Express Syntax for Mustermann
 
-This gem implements the `express` pattern type for Mustermann. It is compatible with [Express](http://expressjs.com/) and [pillar.js](https://pillarjs.github.io/).
-
-## Overview
-
-**Supported options:**
-`capture`, `except`, `greedy`, `space_matches_plus`, `uri_decode`, and `ignore_unknown_options`.
-
-**External documentation:**
-[path-to-regexp](https://github.com/pillarjs/path-to-regexp#path-to-regexp),
-[live demo](http://forbeslindesay.github.io/express-route-tester/)
-
-Express patterns feature named captures (with repetition support via suffixes) that start with a colon and can have an optional regular expression constraint or unnamed captures that require a constraint.
-
-``` ruby
-require 'mustermann/express'
-
-Mustermann.new('/:name/:rest+', type: :express).params('/a/b/c') # => { name: 'a', rest: 'b/c' }
-
-pattern = Mustermann.new('/:name', type: :express)
-
-pattern.respond_to? :expand # => true
-pattern.expand(name: 'foo') # => '/foo'
-
-pattern.respond_to? :to_templates # => true
-pattern.to_templates              # => ['/{name}']
-```
-
-## Syntax
-
-<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 <tt>capture</tt> and <tt>greedy</tt> option.
-      </td>
-    </tr>
-    <tr>
-      <td><b>:</b><i>name</i><b>+</b></td>
-      <td>
-        Captures one or more segments (with segments being separated by forward slashes).
-        Capture is named <i>name</i>.
-        Capture behavior can be modified with <tt>capture</tt> option.
-      </td>
-    </tr>
-    <tr>
-      <td><b>:</b><i>name</i><b>*</b></td>
-      <td>
-        Captures zero or more segments (with segments being separated by forward slashes).
-        Capture is named <i>name</i>.
-        Capture behavior can be modified with <tt>capture</tt> option.
-      </td>
-    </tr>
-    <tr>
-      <td><b>:</b><i>name</i><b>?</b></td>
-      <td>
-        Captures anything but a forward slash in a semi-greedy fashion. Capture is named <i>name</i>.
-        Also matches an empty string.
-        Capture behavior can be modified with <tt>capture</tt> and <tt>greedy</tt> option.
-      </td>
-    </tr>
-    <tr>
-      <td><b>:</b><i>name</i><b>(</b><i>regexp</i><b>)</b></td>
-      <td>
-        Captures anything matching the <i>regexp</i> regular expression. Capture is named <i>name</i>.
-        Capture behavior can be modified with <tt>capture</tt>.
-      </td>
-    </tr>
-    <tr>
-      <td><b>(</b><i>regexp</i><b>)</b></td>
-      <td>
-        Captures anything matching the <i>regexp</i> regular expression. Capture is named splat.
-        Capture behavior can be modified with <tt>capture</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 other character</i></td>
-      <td>Matches exactly that character or a URI encoded version of it.</td>
-    </tr>
-  </tbody>
-</table>
+See [docs/patterns/express.md](../docs/patterns/express.md).
 
 <a name="-mustermann-fileutils"></a>
 # FileUtils for Mustermann
@@ -258,573 +94,72 @@ Mustermann::FileUtils.cp_r(':base.:ext' => ':base.bak.:ext')
 Mustermann::FileUtils.ln_s('lib/:name.rb' => 'bin/:name')
 ```
 
-<a name="-mustermann-flask"></a>
-# Flask Syntax for Mustermann
-
-This gem implements the `flask` pattern type for Mustermann. It is compatible with [Flask](http://flask.pocoo.org/) and [Werkzeug](http://werkzeug.pocoo.org/).
+<a name="-mustermann-mapper"></a>
+# Mapper for Mustermann
 
 ## Overview
 
-**Supported options:**
-`capture`, `except`, `greedy`, `space_matches_plus`, `uri_decode`, `converters` and `ignore_unknown_options`
-
-**External documentation:**
-[Werkzeug: URL Routing](http://werkzeug.pocoo.org/docs/0.9/routing/)
+`Mustermann::Mapper` transforms strings according to a set of pattern mappings. Each mapping pairs an input pattern (used to extract parameters) with one or more output patterns (used to expand the result). All mappings that match are applied in insertion order.
 
 ``` ruby
-require 'mustermann/flask'
-
-Mustermann.new('/<prefix>/<path:page>', type: :flask).params('/a/b/c') # => { prefix: 'a', page: 'b/c' }
-
-pattern = Mustermann.new('/<name>', type: :flask)
-
-pattern.respond_to? :expand # => true
-pattern.expand(name: 'foo') # => '/foo'
-
-pattern.respond_to? :to_templates # => true
-pattern.to_templates              # => ['/{name}']
-```
-
-## Syntax
-
-<table>
-  <thead>
-    <tr>
-      <th>Syntax Element</th>
-      <th>Description</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td><b>&lt;</b><i>name</i><b>&gt;</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 <tt>capture</tt> and <tt>greedy</tt> option.
-      </td>
-    </tr>
-    <tr>
-      <td><b>&lt;</b><i>converter</i><b>:</b><i>name</i><b>&gt;</b></td>
-      <td>
-        Captures depending on the converter constraint. Capture is named <i>name</i>.
-        Capture behavior can be modified with <tt>capture</tt> and <tt>greedy</tt> option.
-        See below.
-      </td>
-    </tr>
-    <tr>
-      <td><b>&lt;</b><i>converter</i><b>(</b><i>arguments</i><b>):</b><i>name</i><b>&gt;</b></td>
-      <td>
-        Captures depending on the converter constraint. Capture is named <i>name</i>.
-        Capture behavior can be modified with <tt>capture</tt> and <tt>greedy</tt> option.
-        Arguments are separated by comma. An argument can be a simple string, a string enclosed
-        in single or double quotes, or a key value pair (keys and values being separated by an
-        equal sign). See below.
-      </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>
-
-## Converters
-
-### Builtin Converters
-
-#### `string`
-
-Possible arguments: `minlength`, `maxlength`, `length`
-
-Captures anything but a forward slash in a semi-greedy fashion.
-Capture behavior can be modified with <tt>capture</tt> and <tt>greedy</tt> option.
-
-This is also the default converter.
-
-Examples:
+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"
 ```
-<name>
-<string:name>
-<string(minlength=3,maxlength=10):slug>
-<string(length=10):slug>
-```
-
-#### `int`
-
-Possible arguments: `min`, `max`, `fixed_digits`
 
-Captures digits.
-Captured value will be converted to an Integer.
-
-Examples:
-
-```
-<int:id>
-<int(min=1,max=5):page>
-<int(fixed_digits=16):uuid>
-```
-
-#### `float`
-
-Possible arguments: `min`, `max`
-
-Captures digits with a dot.
-Captured value will be converted to an Float.
-
-Examples:
-
-```
-<float:precision>
-<float(min=0,max=1):precision>
-```
-
-#### `path`
-
-Captures anything in a non-greedy fashion.
-
-Example:
-
-```
-<path:rest>
-```
-
-#### `any`
-
-Possible arguments: List of accepted strings.
-
-Captures anything that matches one of the arguments exactly.
-
-Example:
-
-```
-<any(home,search,contact):page>
-```
-
-### Custom Converters
-
-[Flask patterns](#-pattern-details-flask) support registering custom converters.
-
-A converter object may implement any of the following methods:
-
-* `convert`: Should return a block converting a string value to whatever value should end up in the `params` hash.
-* `constraint`: Should return a regular expression limiting which input string will match the capture.
-* `new`: Returns an object that may respond to `convert` and/or `constraint` as described above. Any arguments used for the converter inside the pattern will be passed to `new`.
+You can also pass additional values at conversion time to supplement or override captured parameters:
 
 ``` ruby
-require 'mustermann/flask'
-
-SimpleConverter = Struct.new(:constraint, :convert)
-id_converter    = SimpleConverter.new(/\d/, -> s { s.to_i })
-
-class NumConverter
-  def initialize(base: 10)
-    @base = Integer(base)
-  end
-
-  def convert
-    -> s { s.to_i(@base) }
-  end
-
-  def constraint
-    @base > 10 ? /[\da-#{(@base-1).to_s(@base)}]/ : /[0-#{@base-1}]/
-  end
-end
-
-pattern = Mustermann.new('/<id:id>/<num(base=8):oct>/<num(base=16):hex>',
-  type: :flask, converters: { id: id_converter, num: NumConverter})
-
-pattern.params('/10/12/f1') # => {"id"=>10, "oct"=>10, "hex"=>241}
+mapper = Mustermann::Mapper.new("/:example" => "(/:prefix)?/:example.html")
+mapper['/foo', prefix: 'en']  # => "/en/foo.html"
 ```
 
-### Global Converters
+## Building a Mapper
 
-It is also possible to register a converter for all flask patterns, using `register_converter`:
+Mappings can be supplied as a hash, added via `[]=`, or built with a block:
 
 ``` ruby
-Mustermann::Flask.register_converter(:id,  id_converter)
-Mustermann::Flask.register_converter(:num, NumConverter)
+# Hash argument
+mapper = Mustermann::Mapper.new("/:a" => "/:a.html", "/:a/:b" => "/:b/:a")
 
-pattern = Mustermann.new('/<id:id>/<num(base=8):oct>/<num(base=16):hex>', type: :flask)
-pattern.params('/10/12/f1') # => {"id"=>10, "oct"=>10, "hex"=>241}
-```
-
-There is a handy syntax for quickly creating new converter classes: When you pass a block instead of a converter object, it will yield a generic converter with setters and getters for `convert` and `constraint`, and any arguments passed to the converter.
+# Block (zero-argument, returns a hash)
+mapper = Mustermann::Mapper.new { { "/:a" => "/:a.html" } }
 
-``` ruby
-require 'mustermann/flask'
-
-Mustermann::Flask.register_converter(:id) do |converter|
-  converter.constraint = /\d/
-  converter.convert    = -> s { s.to_i }
+# Block (one-argument, imperative)
+mapper = Mustermann::Mapper.new do |m|
+  m["/:a"] = "/:a.html"
 end
 
-Mustermann::Flask.register_converter(:num) do |converter, base: 10|
-  converter.constraint = base > 10 ? /[\da-#{(@base-1).to_s(base)}]/ : /[0-#{base-1}]/
-  converter.convert    = -> s { s.to_i(base) }
-end
-
-pattern = Mustermann.new('/<id:id>/<num(base=8):oct>/<num(base=16):hex>', type: :flask)
-pattern.params('/10/12/f1') # => {"id"=>10, "oct"=>10, "hex"=>241}
+# Incremental
+mapper = Mustermann::Mapper.new
+mapper["/:a"] = "/:a.html"
 ```
 
-### Subclassing
-
-Registering global converters will make these available for all Flask patterns. It might even override already registered converters. This global state might break unrelated code.
-
-It is therefore recommended that, if you don't want to pass in the converters option for every pattern, you create your own subclass of `Mustermann::Flask`.
-
-``` ruby
-require 'mustermann/flask'
-
-MyFlask = Class.new(Mustermann::Flask)
+The output value may be a String, a `Mustermann::Pattern`, an `Array` of either (tried in order until one expands successfully), or a `Mustermann::Expander` directly.
 
-MyFlask.register_converter(:id) do |converter|
-  converter.constraint = /\d/
-  converter.convert    = -> s { s.to_i }
-end
-
-MyFlask.register_converter(:num) do |converter, base: 10|
-  converter.constraint = base > 10 ? /[\da-#{(@base-1).to_s(base)}]/ : /[0-#{base-1}]/
-  converter.convert    = -> s { s.to_i(base) }
-end
-
-pattern = MyFlask.new('/<id:id>/<num(base=8):oct>/<num(base=16):hex>')
-pattern.params('/10/12/f1') # => {"id"=>10, "oct"=>10, "hex"=>241}
-```
-
-You can even register this type for usage with `Mustermann.new`:
+<a name="-mustermann-flask"></a>
+# Flask Syntax for Mustermann
 
-``` ruby
-Mustermann.register(:my_flask, MyFlask)
-pattern = Mustermann.new('/<id:id>/<num(base=8):oct>/<num(base=16):hex>', type: :my_flask)
-pattern.params('/10/12/f1') # => {"id"=>10, "oct"=>10, "hex"=>241}
-```
+See [docs/patterns/flask.md](../docs/patterns/flask.md).
 
 <a name="-mustermann-pyramid"></a>
 # Pyramid Syntax for Mustermann
 
-This gem implements the `pyramid` pattern type for Mustermann. It is compatible with [Pyramid](http://www.pylonsproject.org/projects/pyramid/about) and [Pylons](http://www.pylonsproject.org/projects/pylons-framework/about).
-
-## Overview
-
-**Supported options:**
-`capture`, `except`, `greedy`, `space_matches_plus`, `uri_decode` and `ignore_unknown_options`
-
-**External Documentation:** [Pylons Framework: URL Configuration](http://docs.pylonsproject.org/projects/pylons-webframework/en/latest/configuration.html#url-config), [Pylons Book: Routes in Detail](http://pylonsbook.com/en/1.0/urls-routing-and-dispatch.html#routes-in-detail), [Pyramid: Route Pattern Syntax](http://docs.pylonsproject.org/projects/pyramid/en/1.5-branch/narr/urldispatch.html#route-pattern-syntax)
-
-``` ruby
-require 'mustermann/pyramid'
-
-Mustermann.new('/{prefix}/*suffix', type: :pyramid).params('/a/b/c') # => { prefix: 'a', suffix: ['b', 'c'] }
-
-pattern = Mustermann.new('/{name}', type: :pyramid)
-
-pattern.respond_to? :expand # => true
-pattern.expand(name: 'foo') # => '/foo'
-
-pattern.respond_to? :to_templates # => true
-pattern.to_templates              # => ['/{name}']
-```
-
-## Syntax
-
-
-<table>
-  <thead>
-    <tr>
-      <th>Syntax Element</th>
-      <th>Description</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td><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 <tt>capture</tt> and <tt>greedy</tt> option.
-      </td>
-    </tr>
-    <tr>
-      <td><b>&#123;</b><i>name</i><b>:</b><i>regexp</i><b>&#125;</b></td>
-      <td>
-        Captures anything matching the <i>regexp</i> regular expression. Capture is named <i>name</i>.
-        Capture behavior can be modified with <tt>capture</tt>.
-      </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></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="-mustermann-rails"></a>
-# Rails Syntax for Mustermann
-
-This gem implements the `rails` pattern type for Mustermann. It is compatible with [Ruby on Rails](http://rubyonrails.org/), [Journey](https://github.com/rails/journey), the [http_router gem](https://github.com/joshbuddy/http_router), [Lotus](http://lotusrb.org/) and [Scalatra](http://scalatra.org/) (if [configured](http://scalatra.org/2.3/guides/http/routes.html#toc_248))</td>
-
-## Overview
-
-**Supported options:**
-`capture`, `except`, `greedy`, `space_matches_plus`, `uri_decode`, `version`, and `ignore_unknown_options`.
-
-**External documentation:**
-[Ruby on Rails Guides: Routing](http://guides.rubyonrails.org/routing.html).
-
-``` 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" }
-```
-
-## Rails Compatibility
-
-Rails syntax changed over time. You can target different Ruby on Rails versions by setting the `version` option to the desired Rails version.
-
-The default is `4.2`. Versions prior to `2.3` are not supported.
-
-``` ruby
-require 'mustermann'
-Mustermann.new('/', type: :rails, version: "2.3")
-Mustermann.new('/', type: :rails, version: "3.0.0")
-
-require 'rails'
-Mustermann.new('/', type: :rails, version: Rails::VERSION::STRING)
-```
-
-## Syntax
-
-<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 tt>capture</tt> and <tt>greedy</tt> 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. Not available in 2.3 compatibility mode.</td>
-    </tr>
-    <tr>
-      <td><b>/</b></td>
-      <td>
-        Matches forward slash. Does not match URI encoded version of forward slash.
-      </td>
-    </tr>
-    <tr>
-      <td><b>\</b><i>x</i></td>
-      <td>
-        In 3.x compatibility mode and starting with 4.2:
-        Matches <i>x</i> or URI encoded version of <i>x</i>. For instance <tt>\*</tt> matches <tt>*</tt>.<br>
-        In 4.0 or 4.1 compatibility mode:
-        <b>\</b> is ignored, <i>x</i> is parsed normally.<br>
-      </td>
-    </tr>
-    <tr>
-      <td><i>expression</i> <b>|</b> <i>expression</i></td>
-      <td>
-        3.2+ mode: This will raise a `Mustermann::ParseError`. While Ruby on Rails happily parses this character, it will result in broken routes due to a buggy implementation.<br>
-        5.0 mode: It will match if any of the nested expressions matches.
-      </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>
+See [docs/patterns/pyramid.md](../docs/patterns/pyramid.md).
 
 <a name="-mustermann-shell"></a>
 # Shell Syntax for Mustermann
 
-This gem implements the `shell` pattern type for Mustermann. It is compatible with common Unix shells (like bash or zsh).
-
-## Overview
-
-**Supported options:** `uri_decode` and `ignore_unknown_options`.
-
-**External documentation:** [Ruby's fnmatch](http://www.ruby-doc.org/core-2.1.4/File.html#method-c-fnmatch), [Wikipedia: Glob (programming)](http://en.wikipedia.org/wiki/Glob_(programming))
-
-``` ruby
-require 'mustermann'
-
-pattern = Mustermann.new('/*', type: :shell)
-pattern === "/foo.bar" # => true
-pattern === "/foo/bar" # => false
-
-pattern = Mustermann.new('/**/*', type: :shell)
-pattern === "/foo.bar" # => true
-pattern === "/foo/bar" # => true
-
-pattern = Mustermann.new('/{foo,bar}', type: :shell)
-pattern === "/foo"     # => true
-pattern === "/bar"     # => true
-pattern === "/baz"     # => false
-```
-
-## Syntax
-
-<table>
-  <thead>
-    <tr>
-      <th>Syntax Element</th>
-      <th>Description</th>
-    </tr>
-  </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>
-    </tr>
-  </tbody>
-</table>
+See [docs/patterns/shell.md](../docs/patterns/shell.md).
 
 
 <a name="-mustermann-simple"></a>
 # Simple Syntax for Mustermann
 
-This gem implements the `simple` pattern type for Mustermann. It is compatible with [Sinatra](http://www.sinatrarb.com/) (1.x), [Scalatra](http://scalatra.org/) and [Dancer](http://perldancer.org/).
-
-## Overview
-
-**Supported options:**
-`greedy`, `space_matches_plus`, `uri_decode` and `ignore_unknown_options`.
-
-This is useful for porting an application that relies on this behavior to a later Sinatra version and to make sure Sinatra 2.0 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'
-
-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"] }
-```
-
-## Syntax
-
-<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 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>
-    </tr>
-  </tbody>
-</table>
+See [docs/patterns/simple.md](../docs/patterns/simple.md).
 
 <a name="-mustermann-strscan"></a>
 # String Scanner for Mustermann
@@ -866,91 +201,47 @@ You can also pass in default options for ad hoc patterns when creating the scann
 scanner = Mustermann::StringScanner.new(input, type: :shell)
 ```
 
-<a name="-mustermann-uri-template"></a>
-# URI Template Syntax for Mustermann
-
-This gem implements the `uri-template` (or `template`) pattern type for Mustermann. It is compatible with [RFC 6570](https://tools.ietf.org/html/rfc6570) (level 4), [JSON API](http://jsonapi.org/), [JSON Home Documents](http://tools.ietf.org/html/draft-nottingham-json-home-02) and [many more](https://code.google.com/p/uri-templates/wiki/Implementations)
+<a name="-mustermann-to-pattern"></a>
+# `to_pattern` for Mustermann
 
 ## Overview
 
-**Supported options:**
-`capture`, `except`, `greedy`, `space_matches_plus`, `uri_decode`, and `ignore_unknown_options`.
-
-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"*
+`mustermann/to_pattern` adds a `to_pattern` method to `String`, `Symbol`, `Regexp`, `Array`, and `Mustermann::Pattern`, and provides the `Mustermann::ToPattern` mixin so you can add the same method to your own classes.
 
 ``` ruby
-require 'mustermann'
+require 'mustermann/to_pattern'
 
-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"}
+"/foo".to_pattern               # => #<Mustermann::Sinatra:"/foo">
+"/foo".to_pattern(type: :rails) # => #<Mustermann::Rails:"/foo">
+%r{/foo}.to_pattern             # => #<Mustermann::Regular:"\\/foo">
+"/foo".to_pattern.to_pattern    # => #<Mustermann::Sinatra:"/foo">
 ```
 
-## Generating URI Templates
+## `Mustermann::ToPattern` mixin
 
-You do not need to use URI templates (and this gem) if all you want is reusing them for hypermedia links. Most other pattern types support generating these (via `#to_pattern`):
+Include `Mustermann::ToPattern` in any class to get a `to_pattern` method driven by its `to_s` output:
 
 ``` ruby
-require 'mustermann'
-
-Mustermann.new('/:name').to_templates # => ['/{name}']
-```
+require 'mustermann/to_pattern'
 
-Moreover, Mustermann's default pattern type implements a subset of URI templates (`{capture}` and `{+capture}`) and can therefore also be used for simple templates/
+class MyRoute
+  include Mustermann::ToPattern
 
-``` ruby
-require 'mustermann'
+  def to_s
+    "/users/:id"
+  end
+end
 
-Mustermann.new('/{name}').expand(name: "example") # => "/example"
+MyRoute.new.to_pattern               # => #<Mustermann::Sinatra:"/users/:id">
+MyRoute.new.to_pattern(type: :rails) # => #<Mustermann::Rails:"/users/:id">
 ```
 
-## Syntax
-
-<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.
-
-Note that it differs from URI templates in that it takes the unescaped version of special character instead of the escaped version.
-
-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 your class wraps another object (via `__getobj__`, as in `Delegator` subclasses), `to_pattern` will unwrap it before converting.
+
+<a name="-mustermann-uri-template"></a>
+# URI Template Syntax for Mustermann
+
+See [docs/patterns/template.md](../docs/patterns/template.md).
 
 
 <a name="-mustermann-visualizer"></a>
@@ -1127,15 +418,6 @@ The **s-expression like syntax** looks as follows:
 * Full strings are Ruby strings enclosed by double quotes.
 * Spaces before or after parens are optional.
 
-### IRB/Pry integration
-
-When `mustermann` is being loaded from within an IRB or Pry session, it will automatically load `mustermann/visualizer` too, if possible.
-When displayed as result, it will be highlighted.
-
-![](irb.png)
-
-In Pry, this will even work when nested inside other objects (like as element on an array).
-
 ## Tree Rendering
 
 ![](tree.png)
@@ -1152,4 +434,3 @@ For patterns not based on an AST (shell, simple, regexp), it will print out a si
     pattern (not AST based)  "/example"
 
 It will display a tree for identity patterns. While these are not based on an AST internally, Mustermann supports generating an AST for these patterns.
-

data/lib/mustermann/flask.rb

@@ -106,7 +106,7 @@ module Mustermann
 
     # Allows you to register your own converters.
     #
-    # It is reommended to use this on a subclass, so to not influence other subsystems
+    # It is recommended to use this on a subclass, so to not influence other subsystems
     # using flask templates.
     #
     # The object passed in as converter can implement #convert and/or #constraint.
@@ -135,7 +135,7 @@ module Mustermann
     #   MyPattern.new("/<up:name>").params('/foo') # => { "name" => "FOO" }
     #
     # @example with converter class
-    #   require 'mustermann/flasl'
+    #   require 'mustermann/flask'
     #
     #   class MyPattern < Mustermann::Flask
     #     class Converter

data/lib/mustermann/mapper.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+require 'mustermann'
+require 'mustermann/expander'
+require 'mustermann/set'
+
+module Mustermann
+  # A mapper allows mapping one string to another based on pattern parsing and expanding.
+  #
+  # @example
+  #   require 'mustermann/mapper'
+  #   mapper = Mustermann::Mapper.new("/:foo" => "/:foo.html")
+  #   mapper['/example'] # => "/example.html"
+  class Mapper
+    # Creates a new mapper.
+    #
+    # @overload initialize(**options)
+    #   @param options [Hash] options The options hash
+    #   @yield block for generating mappings as a hash
+    #   @yieldreturn [Hash] see {#update}
+    #
+    #   @example
+    #     require 'mustermann/mapper'
+    #     Mustermann::Mapper.new(type: :rails) {{
+    #       "/:foo" => ["/:foo.html", "/:foo.:format"]
+    #     }}
+    #
+    # @overload initialize(**options)
+    #   @param  options [Hash] options The options hash
+    #   @yield block for generating mappings as a hash
+    #   @yieldparam mapper [Mustermann::Mapper] the mapper instance
+    #
+    #   @example
+    #     require 'mustermann/mapper'
+    #     Mustermann::Mapper.new(type: :rails) do |mapper|
+    #       mapper["/:foo"] = ["/:foo.html", "/:foo.:format"]
+    #     end
+    #
+    # @overload initialize(map = {}, **options)
+    #   @param map [Hash] see {#update}
+    #   @param [Hash] options The options hash
+    #
+    #   @example map before options
+    #     require 'mustermann/mapper'
+    #     Mustermann::Mapper.new({"/:foo" => "/:foo.html"}, type: :rails)
+    def initialize(map = {}, additional_values: :ignore, **options, &block)
+      @options           = options
+      @additional_values = additional_values
+      @set               = Set.new(use_trie: false, use_cache: false, **options)
+      block.arity == 0 ? update(yield) : yield(self) if block
+      update(map) if map
+    end
+
+    # Add multiple mappings.
+    #
+    # @param map [Hash{String, Pattern: String, Pattern, Arry<String, Pattern>, Expander}] the mapping
+    def update(map)
+      map.to_h.each_pair do |input, output|
+        output = Expander.new(*output, additional_values: @additional_values, **@options) unless output.is_a? Expander
+        @set.add(input, output)
+      end
+    end
+
+    # @return [Hash{Patttern: Expander}] Hash version of the mapper.
+    def to_h = @set.patterns.to_h { [_1, @set[_1]] }
+
+    # Convert a string according to mappings. You can pass in additional params.
+    #
+    # @example mapping with and without additional parameters
+    #   mapper = Mustermann::Mapper.new("/:example" => "(/:prefix)?/:example.html")
+    #
+    def convert(input, values = {})
+      @set.match_all(input).inject(input) do |current, m|
+        params = Hash[values.merge(m.params).map { |k, v| [k.to_s, v] }]
+        m.value.expandable?(params) ? m.value.expand(params) : current
+      end
+    end
+
+    # Add a single mapping.
+    #
+    # @param key [String, Pattern] format of the input string
+    # @param value [String, Pattern, Arry<String, Pattern>, Expander] format of the output string
+    def []=(key, value)
+      update key => value
+    end
+
+    alias_method :[], :convert
+  end
+end

data/lib/mustermann/pattern_cache.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require 'set'
+require 'thread'
+require 'mustermann'
+
+module Mustermann
+  # A simple, persistent cache for creating repositories.
+  #
+  # @example
+  #   require 'mustermann/pattern_cache'
+  #   cache = Mustermann::PatternCache.new
+  #
+  #   # use this instead of Mustermann.new
+  #   pattern = cache.create_pattern("/:name", type: :rails)
+  #
+  # @note
+  #   {Mustermann::Pattern.new} (which is used by {Mustermann.new}) will reuse instances that have
+  #   not yet been garbage collected. You only need an extra cache if you do not keep a reference to
+  #   the patterns around.
+  #
+  # @api private
+  class PatternCache
+    # @param [Hash] pattern_options default options used for {#create_pattern}
+    def initialize(**pattern_options)
+      @cached          = ::Set.new
+      @mutex           = Mutex.new
+      @pattern_options = pattern_options
+    end
+
+    # @param (see Mustermann.new)
+    # @return (see Mustermann.new)
+    # @raise (see Mustermann.new)
+    # @see Mustermann.new
+    def create_pattern(string, **pattern_options)
+      pattern = Mustermann.new(string, **pattern_options, **@pattern_options)
+      @mutex.synchronize { @cached.add(pattern) } unless @cached.include? pattern
+      pattern
+    end
+
+    # Removes all pattern instances from the cache.
+    def clear
+      @mutex.synchronize { @cached.clear }
+    end
+
+    # @return [Integer] number of currently cached patterns
+    def size
+      @mutex.synchronize { @cached.size }
+    end
+  end
+end

data/lib/mustermann/shell.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 require 'mustermann'
 require 'mustermann/pattern'
-require 'mustermann/simple_match'
 
 module Mustermann
   # Matches strings that are identical to the pattern.

data/lib/mustermann/to_pattern.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+require 'mustermann'
+
+module Mustermann
+  # Mixin for adding {#to_pattern} ducktyping to objects.
+  #
+  # @example
+  #   require 'mustermann/to_pattern'
+  #
+  #   class Foo
+  #     include Mustermann::ToPattern
+  #
+  #     def to_s
+  #       ":foo/:bar"
+  #     end
+  #   end
+  #
+  #   Foo.new.to_pattern # => #<Mustermann::Sinatra:":foo/:bar">
+  #
+  # By default included into String, Symbol, Regexp, Array and {Mustermann::Pattern}.
+  module ToPattern
+    PRIMITIVES = [String, Symbol, Array, Regexp, Mustermann::Pattern]
+    private_constant :PRIMITIVES
+
+    # Converts the object into a {Mustermann::Pattern}.
+    #
+    # @example converting a string
+    #   ":name.png".to_pattern # => #<Mustermann::Sinatra:":name.png">
+    #
+    # @example converting a string with options
+    #   "/*path".to_pattern(type: :rails) # => #<Mustermann::Rails:"/*path">
+    #
+    # @example converting a regexp
+    #   /.*/.to_pattern # => #<Mustermann::Regular:".*">
+    #
+    # @example converting a pattern
+    #   Mustermann.new("foo").to_pattern # => #<Mustermann::Sinatra:"foo">
+    #
+    # @param [Hash] options The options hash.
+    # @return [Mustermann::Pattern] pattern corresponding to object.
+    def to_pattern(**options)
+      input   = self if PRIMITIVES.any? { |p| self.is_a? p }
+      input ||= __getobj__ if respond_to?(:__getobj__)
+      Mustermann.new(input || to_s, **options)
+    end
+
+    PRIMITIVES.each do |klass|
+      append_features(klass)
+    end
+  end
+end

data/lib/mustermann/visualizer/pattern_extension.rb

@@ -44,26 +44,12 @@ module Mustermann
         caller_locations.first.label == 'puts' ? to_ansi : super
       end
 
-      # If invoked directly by IRB, same as {#color_inspect}, otherwise same as  {Mustermann::Pattern#inspect}.
-      def inspect
-        caller_locations.first.base_label == '<module:IRB>' ? color_inspect : super
-      end
-
       # @return [String] ANSI colorized version of {Mustermann::Pattern#inspect}
       def color_inspect(base_color = nil, **theme)
         base_color ||= Highlight::DEFAULT_THEME[:base01]
         template = is_a?(Composite) ? "*#<%p:(*%s*)>*" : "*#<%p:*%s*>*"
         Hansi.render(template, self.class, to_ansi(inspect: true, **theme), {"*" => base_color})
       end
-
-      # If invoked directly by IRB, same as {#color_inspect}, otherwise same as Object#pretty_print.
-      def pretty_print(q)
-        if q.class.name.to_s[/[^:]+$/] == "ColorPrinter"
-          q.text(color_inspect, inspect.length)
-        else
-          super
-        end
-      end
     end
   end
 end

metadata

@@ -1,10 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: mustermann-contrib
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0.alpha
 platform: ruby
 authors:
 - Konstantin Haase
+- Kunpei Sakai
+- Patrik Ragnarsson
+- Jordan Owens
 - Zachary Scott
 bindir: bin
 cert_chain: []
@@ -16,14 +19,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 4.0.0.alpha
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 4.0.0.alpha
 - !ruby/object:Gem::Dependency
   name: hansi
   requirement: !ruby/object:Gem::Requirement
@@ -52,12 +55,15 @@ files:
 - lib/mustermann/file_utils/glob_pattern.rb
 - lib/mustermann/fileutils.rb
 - lib/mustermann/flask.rb
+- lib/mustermann/mapper.rb
+- lib/mustermann/pattern_cache.rb
 - lib/mustermann/pyramid.rb
 - lib/mustermann/shell.rb
 - lib/mustermann/simple.rb
 - lib/mustermann/string_scanner.rb
 - lib/mustermann/strscan.rb
 - lib/mustermann/template.rb
+- lib/mustermann/to_pattern.rb
 - lib/mustermann/uri_template.rb
 - lib/mustermann/visualizer.rb
 - lib/mustermann/visualizer/highlight.rb
@@ -78,7 +84,11 @@ files:
 homepage: https://github.com/sinatra/mustermann
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/sinatra/mustermann/issues
+  changelog_uri: https://github.com/sinatra/mustermann/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/sinatra/mustermann/tree/main/mustermann-contrib#readme
+  source_code_uri: https://github.com/sinatra/mustermann/tree/main/mustermann-contrib
 rdoc_options: []
 require_paths:
 - lib
@@ -86,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="