mustermann 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0b15c2c5c75d712dde03df8b83d4f0b646455aa892eb59365f1b09ce01bfa7c
-  data.tar.gz: 358ce50be0eb8638e47ea8bb3cd65512f57e10eb65b93600098145214a2f6d39
+  metadata.gz: b56ff4d495f7e79eb6deff2145be811154fa646813a21af4de4f21de27666bb1
+  data.tar.gz: fc15e2c23029429dbcf0fe0ba17d4189304edd60d50e9f010312fa1d198ebbbf
 SHA512:
-  metadata.gz: 3360ad1465989d2179b97d67c64261d7a68cf22ca1cea2a02f2450bd5b0894948efd4d99581b7d7609dc7698d4ed0595d85613b67d79dce3ce79b84d08e614ff
-  data.tar.gz: 8c32fae7ff72697598dacf54c1ddae95ea80a48814fa887c61d91e18bca6a0a1c79768a981fba0cd4d60d986db76c0961a3f6dae5c5a7a8b8276978428fb105e
+  metadata.gz: fa699c65cb5921435ed6e8f210bbf07110e8babedc5aa71efb0f012eb094cf4d6f530511e1bc08ff54b324a4fd5608078fa01bffd23846a6dee7f65cd40c6793
+  data.tar.gz: a0a8c22f1d075e3c980830fa2c3e16f56b2b19cb333f625c27f2c6160b9e8fe83b0bdb3fb16f1f8682d9683f73884ed589a2f07ff38a522634065b859e2dbc2b

data/README.md

@@ -311,7 +311,7 @@ require 'mustermann'
 
 Mustermann.new("/:name").to_templates                   # => ["/{name}"]
 Mustermann.new("/:foo(@:bar)?/*baz").to_templates       # => ["/{foo}@{bar}/{+baz}", "/{foo}/{+baz}"]
-Mustermann.new("/{name}", type: :template).to_templates # => ["/{name}"
+Mustermann.new("/{name}", type: :template).to_templates # => ["/{name}"]
 ```
 
 Union Composite patterns (with the | operator) support template generation if all patterns they are composed of also support it.
@@ -828,3 +828,115 @@ Using anchors will break [peeking](#-peeking) and [concatenation](#-concatenatio
     </tr>
   </tbody>
 </table>
+
+<a name="-rails-pattern"></a>
+### `rails`
+
+Mustermann also implements the `rails` pattern. 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>
+
+**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),
+[`version`](#-rails-pattern--version),
+[`ignore_unknown_options`](#-available-options--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" }
+```
+
+<a name="-rails-pattern--version"></a>
+#### `version`
+
+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 `5.0`. 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>

data/lib/mustermann/pattern.rb

@@ -110,7 +110,7 @@ module Mustermann
     # Used by Ruby internally for hashing.
     # @return [Integer] same has value for patterns that are equal
     def hash
-      self.class.hash | @string.hash | options.hash
+      self.class.hash ^ @string.hash ^ options.hash
     end
 
     # Two patterns are considered equal if they are of the same type, have the same pattern string

data/lib/mustermann/sinatra/safe_renderer.rb

@@ -2,7 +2,7 @@
 module Mustermann
   class Sinatra < AST::Pattern
     # Generates a string that can safely be concatenated with other strings
-    # without chaning its semantics
+    # without changing its semantics
     # @see #safe_string
     # @!visibility private
     SafeRenderer = AST::Translator.create do

data/lib/mustermann/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Mustermann
-  VERSION ||= '3.1.0'
+  VERSION ||= '3.1.1'
 end

data/lib/mustermann.rb

@@ -122,12 +122,3 @@ module Mustermann
     require 'mustermann/extension'
   end
 end
-
-# :nocov:
-begin
-  require 'mustermann/visualizer' if defined?(Pry) or defined?(IRB)
-rescue LoadError => error
-  raise error unless error.path == 'mustermann/visualizer'
-  $stderr.puts(error.message) if caller_locations[1].absolute_path =~ %r{/lib/pry/|/irb/|^\((?:irb|pry)\)$}
-end
-# :nocov:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mustermann
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Konstantin Haase