mustermann-contrib 1.0.0.beta2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6ef2cc24604b7944b3b4e9a97fd7eacd331f4af
-  data.tar.gz: d4d0031aff198de4a190cda57c5cf25a0bade3b5
+  metadata.gz: 99342e7d083221ed24c4a9357879b0a7473d26e0
+  data.tar.gz: 4f033729683186897e6dad66b394cfca6de74529
 SHA512:
-  metadata.gz: 339f192ae2f720a0a5882d962c855c2d9f6285524db013b2fe56fb0e351cf88c13cbbff9c2d2cc84f42d740204f4c8ccf1ae965db577d5c11e8cd9211f5b279d
-  data.tar.gz: 42293a657b0de5cda8d6a317108f59a138542fa2c88f0e317b02022d71e425ff7780e021dc42edd7e5df4ab6b3808a0841e8ab2239a90e3d0c1a48801b7dc267
+  metadata.gz: 242b9b216aa2418f988300c1bf351dd295947a85f2834541e84a3a972313303446865672b05d6b0f1292f6491e20f649679a2117d75f9162320c368070e511e2
+  data.tar.gz: 5769b306efcc6874caecb7ab7ce34074d35c59f2d851e8d5b98d2f56ee3d7a65524a4634f42e5729334cefd9f20ec20df8babb6d79b7e4fe1ad2182fd60328de

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2013-2017 Konstantin Haase
+Copyright (c) 2016-2017 Zachary Scott
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -24,21 +24,7 @@ github 'sinatra/mustermann' do
 end
 ```
 
-Below is the documentation for all extensions, including:
-
-* mustermann-cake
-* mustermann-express
-* mustermann-fileutils
-* mustermann-flask
-* mustermann-grape
-* mustermann-pyramid
-* mustermann-rails
-* mustermann-shell
-* mustermann-simple
-* mustermann-strscan
-* mustermann-uri-template
-* mustermann-visualizer
-
+<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.
@@ -115,6 +101,7 @@ pattern.to_templates              # => ['/{name}']
 </table>
 
 
+<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/).
@@ -212,6 +199,7 @@ pattern.to_templates              # => ['/{name}']
   </tbody>
 </table>
 
+<a name="-mustermann-fileutils"></a>
 # FileUtils for Mustermann
 
 This gem implements efficient file system operations for Mustermann patterns.
@@ -270,6 +258,7 @@ 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/).
@@ -517,85 +506,7 @@ pattern = Mustermann.new('/<id:id>/<num(base=8):oct>/<num(base=16):hex>', type:
 pattern.params('/10/12/f1') # => {"id"=>10, "oct"=>10, "hex"=>241}
 ```
 
-# Grape Syntax for Mustermann
-
-This gem implements the `grape` pattern type for Mustermann.
-
-## Overview
-
-**Supported options:**
-`capture`, `except`, `greedy`, `space_matches_plus`, `uri_decode`, `converters` and `ignore_unknown_options`
-
-``` ruby
-require 'mustermann/grape'
-
-Mustermann.new('/:id', type: :grape).params('/foo') # => { id: 'foo' }
-```
-
-## Syntax
-
-<table>
-  <thead>
-    <tr>
-      <th>Syntax Element</th>
-      <th>Description</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <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 <tt>capture</tt> and <tt>greedy</tt> option.
-      </td>
-    </tr>
-    <tr>
-      <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> <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 it more than once in a pattern.
-      </td>
-    </tr>
-    <tr>
-      <td><b>(</b><i>expression</i><b>)</b></td>
-      <td>
-        Enclosed <i>expression</i> is optional.
-      </td>
-    </tr>
-    <tr>
-      <td><i>expression</i><b>|</b><i>expression</i><b>|</b><i>...</i></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>
-    </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>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>
-
-
+<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).
@@ -665,7 +576,7 @@ pattern.to_templates              # => ['/{name}']
   </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://www.scalatra.org/) (if [configured](http://www.scalatra.org/2.3/guides/http/routes.html#toc_248))</td>
@@ -771,6 +682,7 @@ Mustermann.new('/', type: :rails, version: Rails::VERSION::STRING)
   </tbody>
 </table>
 
+<a name="-mustermann-shell"></a>
 # Shell Syntax for Mustermann
 
 This gem implements the `rails` pattern type for Mustermann. It is compatible with common Unix shells (like bash or zsh).
@@ -836,6 +748,7 @@ pattern === "/baz"     # => false
 </table>
 
 
+<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://www.scalatra.org/) and [Dancer](http://perldancer.org/).
@@ -913,6 +826,7 @@ pattern.params("/foo/bar") # => { "splat" => ["foo/bar"] }
   </tbody>
 </table>
 
+<a name="-mustermann-strscan"></a>
 # String Scanner for Mustermann
 
 This gem implements `Mustermann::StringScanner`, a tool inspired by Ruby's [`StringScanner`]() class.
@@ -952,6 +866,7 @@ 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)
@@ -1038,6 +953,7 @@ If you reuse the exact same templates and expose them via an external API meant
 you should set `uri_decode` to `false` in order to conform with the specification.
 
 
+<a name="-mustermann-visualizer"></a>
 # Mustermann Pattern Visualizer
 
 With this gem, you can visualize the internal structure of a Mustermann pattern:

data/lib/mustermann/cake.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mustermann'
 require 'mustermann/ast/pattern'
 

data/lib/mustermann/express.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mustermann'
 require 'mustermann/ast/pattern'
 

data/lib/mustermann/file_utils.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mustermann'
 require 'mustermann/file_utils/glob_pattern'
 require 'mustermann/mapper'

data/lib/mustermann/file_utils/glob_pattern.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mustermann/ast/translator'
 
 module Mustermann

data/lib/mustermann/flask.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mustermann'
 require 'mustermann/ast/pattern'
 

data/lib/mustermann/pyramid.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mustermann'
 require 'mustermann/ast/pattern'
 

data/lib/mustermann/rails.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mustermann'
 require 'mustermann/ast/pattern'
 require 'mustermann/versions'

data/lib/mustermann/shell.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mustermann'
 require 'mustermann/pattern'
 require 'mustermann/simple_match'

data/lib/mustermann/simple.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mustermann'
 require 'mustermann/regexp_based'
 

data/lib/mustermann/string_scanner.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mustermann'
 require 'mustermann/pattern_cache'
 require 'delegate'

data/lib/mustermann/template.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mustermann'
 require 'mustermann/ast/pattern'
 

data/lib/mustermann/versions.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Mustermann
   # Mixin that adds support for multiple versions of the same type.
   # @see Mustermann::Rails
@@ -43,4 +44,4 @@ module Mustermann
       name
     end
   end
-end
+end

data/lib/mustermann/visualizer.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mustermann'
 require 'mustermann/visualizer/highlight'
 require 'mustermann/visualizer/tree_renderer'
@@ -10,10 +11,10 @@ module Mustermann
 
     # @example creating a highlight object
     #   require 'mustermann/visualizer'
-    #   
+    #
     #   pattern   = Mustermann.new('/:name')
     #   highlight = Mustermann::Visualizer.highlight(pattern)
-    #   
+    #
     #   puts highlight.to_ansi
     #
     # @return [Mustermann::Visualizer::Highlight] highlight object for given pattern
@@ -24,10 +25,10 @@ module Mustermann
 
     # @example creating a tree object
     #   require 'mustermann/visualizer'
-    #   
+    #
     #   pattern = Mustermann.new('/:name')
     #   tree    = Mustermann::Visualizer.tree(pattern)
-    #   
+    #
     #   puts highlight.to_s
     #
     # @return [Mustermann::Visualizer::Tree] tree object for given pattern

data/lib/mustermann/visualizer/highlight.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'hansi'
 require 'mustermann'
 require 'mustermann/visualizer/highlighter'
@@ -57,10 +58,10 @@ module Mustermann
 
       # @example
       #   require 'mustermann/visualizer'
-      #   
+      #
       #   pattern   = Mustermann.new('/:name')
       #   highlight = Mustermann::Visualizer.highlight(pattern)
-      #   
+      #
       #   puts highlight.to_hansi_template
       #
       # @return [String] Hansi template representation of the pattern
@@ -70,10 +71,10 @@ module Mustermann
 
       # @example
       #   require 'mustermann/visualizer'
-      #   
+      #
       #   pattern   = Mustermann.new('/:name')
       #   highlight = Mustermann::Visualizer.highlight(pattern)
-      #   
+      #
       #   puts highlight.to_ansi
       #
       # @return [String] ANSI colorized version of the pattern
@@ -83,10 +84,10 @@ module Mustermann
 
       # @example
       #   require 'mustermann/visualizer'
-      #   
+      #
       #   pattern   = Mustermann.new('/:name')
       #   highlight = Mustermann::Visualizer.highlight(pattern)
-      #   
+      #
       #   puts highlight.to_html
       #
       # @return [String] HTML rendering of the pattern
@@ -96,10 +97,10 @@ module Mustermann
 
       # @example
       #   require 'mustermann/visualizer'
-      #   
+      #
       #   pattern   = Mustermann.new('/:name')
       #   highlight = Mustermann::Visualizer.highlight(pattern)
-      #   
+      #
       #   puts highlight.to_sexp
       #
       # @return [String] s-expression like representation of the pattern

data/lib/mustermann/visualizer/highlighter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mustermann/visualizer/highlighter/ast'
 require 'mustermann/visualizer/highlighter/ad_hoc'
 require 'mustermann/visualizer/highlighter/composite'

data/lib/mustermann/visualizer/highlighter/ad_hoc.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'strscan'
 
 module Mustermann
@@ -33,7 +34,7 @@ module Mustermann
         def initialize(pattern, renderer)
           @pattern  = pattern
           @renderer = renderer
-          @output   = ""
+          @output   = String.new
           @rules    = self.class.rules
           @scanner  = ::StringScanner.new(pattern.to_s)
         end

data/lib/mustermann/visualizer/highlighter/ast.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'mustermann/ast/translator'
 
 module Mustermann

data/lib/mustermann/visualizer/highlighter/composite.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Mustermann
   module Visualizer
     # @!visibility private
@@ -42,4 +43,4 @@ module Mustermann
       end
     end
   end
-end
+end

data/lib/mustermann/visualizer/highlighter/dummy.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Mustermann
   module Visualizer
     # @!visibility private
@@ -7,7 +8,7 @@ module Mustermann
       module Dummy
         # @!visibility private
         def self.highlight(pattern, renderer)
-          output = ""
+          output = String.new
           output << renderer.pre(:root) << renderer.pre(:unknown)
           output << renderer.escape(pattern.to_s)
           output << renderer.post(:unknown) << renderer.post(:root)

data/lib/mustermann/visualizer/highlighter/regular.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'strscan'
 
 module Mustermann
@@ -27,7 +28,7 @@ module Mustermann
         # @!visibility private
         def initialize(renderer)
           @renderer = renderer
-          @output   = ""
+          @output   = String.new
         end
 
         # @!visibility private