mustermann-contrib 3.0.4 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c0c40b0826ffa45cc63ae438017ecee316750c370d6bfeac1470c3c9f00fbbd
-  data.tar.gz: 1312ab31f470e624148c3bb26bc020db1723940b161b85c080a05cc8e1b2b787
+  metadata.gz: 4eef1534d55e9ec6be2c9bc3170114a40c2f0114b05102d4c0c4503daf97724a
+  data.tar.gz: 4d4b0f26fb7834945887ef7c9ce16292ca2090a9585cad9579d03f4fbe2769d3
 SHA512:
-  metadata.gz: 75a1d17dfba9808fb7b2c2c5cfeb2ef76622f09aba6d90dc373b6f712cd4e9493624713ec42113d529dffb5dd363d4e54ddf6ad8990cfccacc2503ed639aec6b
-  data.tar.gz: 845a5141b2260ed0b6182bcf98ebd2c7279a32dbee50fe916301e20477815e8c793721009af74440577eedfa40a37ac61d6227551840580fec7dcc8ea820a593
+  metadata.gz: e2cef5fe3354e2cf9c81a558138fb3ed563b6bc5fa3ec292c87dc8986e1ff55b970d1035824c3f8eb1ae322fde9a812051d3f49773dc8c2a49cda379700e3b09
+  data.tar.gz: f028d0897f58ec0cf68206c01d22a271fb8a03ce49ec431b5c51957a9777c6284d2d5943ae1c934059c3a84a5e529d213aeca97637d9efad48d7e0820166aab9

data/README.md

@@ -534,7 +534,6 @@ pattern.to_templates              # => ['/{name}']
 
 ## Syntax
 
-
 <table>
   <thead>
     <tr>
@@ -576,112 +575,6 @@ 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://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>
-
 <a name="-mustermann-shell"></a>
 # Shell Syntax for Mustermann
 
@@ -1127,15 +1020,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 +1036,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/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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mustermann-contrib
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.1.1
 platform: ruby
 authors:
 - Konstantin Haase
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.4
+        version: 3.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.4
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: hansi
   requirement: !ruby/object:Gem::Requirement
@@ -46,9 +46,6 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- examples/highlighting.rb
-- highlighting.png
-- irb.png
 - lib/mustermann/cake.rb
 - lib/mustermann/express.rb
 - lib/mustermann/file_utils.rb
@@ -56,14 +53,12 @@ files:
 - lib/mustermann/fileutils.rb
 - lib/mustermann/flask.rb
 - lib/mustermann/pyramid.rb
-- lib/mustermann/rails.rb
 - lib/mustermann/shell.rb
 - lib/mustermann/simple.rb
 - lib/mustermann/string_scanner.rb
 - lib/mustermann/strscan.rb
 - lib/mustermann/template.rb
 - lib/mustermann/uri_template.rb
-- lib/mustermann/versions.rb
 - lib/mustermann/visualizer.rb
 - lib/mustermann/visualizer/highlight.rb
 - lib/mustermann/visualizer/highlighter.rb
@@ -80,22 +75,6 @@ files:
 - lib/mustermann/visualizer/renderer/sexp.rb
 - lib/mustermann/visualizer/tree.rb
 - lib/mustermann/visualizer/tree_renderer.rb
-- mustermann-contrib.gemspec
-- spec/cake_spec.rb
-- spec/express_spec.rb
-- spec/file_utils_spec.rb
-- spec/flask_spec.rb
-- spec/flask_subclass_spec.rb
-- spec/pattern_extension_spec.rb
-- spec/pyramid_spec.rb
-- spec/rails_spec.rb
-- spec/shell_spec.rb
-- spec/simple_spec.rb
-- spec/string_scanner_spec.rb
-- spec/template_spec.rb
-- spec/visualizer_spec.rb
-- theme.png
-- tree.png
 homepage: https://github.com/sinatra/mustermann
 licenses:
 - MIT
@@ -107,14 +86,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Collection of extensions for Mustermann
 test_files: []

data/examples/highlighting.rb

@@ -1,35 +0,0 @@
-require 'bundler/setup'
-require 'mustermann/visualizer'
-
-Hansi.mode = ARGV[0].to_i if ARGV.any?
-
-def self.example(type, *patterns)
-  print Hansi.render(:bold, "  #{type}: ".ljust(14))
-  patterns.each do |pattern|
-    pattern     = Mustermann.new(pattern, type: type)
-    space_after = pattern.to_s.size > 24 ? " " : " " * (25 - pattern.to_s.size)
-    highlight   = Mustermann::Visualizer.highlight(pattern, inspect: true)
-    print highlight.to_ansi + space_after
-  end
-  puts
-end
-
-puts
-example(:cake,     '/:prefix/**')
-example(:express,  '/:prefix+/:id(\d+)', '/:page/:slug+')
-example(:flask,    '/<prefix>/<int:id>', '/user/<int(min=0):id>')
-example(:identity, '/image.png')
-example(:pyramid,  '/{prefix:.*}/{id}',  '/{page}/*slug')
-example(:rails,    '/:slug(.:ext)')
-example(:regexp,   '/(?<slug>[^/]+)',    '/(?:page|user)/(\d+)')
-example(:shell,    '/**/*',              '/\{a,b\}/{a,b}')
-example(:simple,   '/:page/*slug')
-example(:sinatra,  '/:page/*slug',         '/users/{id}?')
-example(:template, '/{+pre}/{page}{?q,p}', '/users/{id}?')
-puts
-
-example(:composition)
-composite = Mustermann.new("/{a}", "/{b}/{c}")
-puts "  " + composite.to_ansi
-puts "  " + (Mustermann.new("/") ^ composite).to_ansi
-puts

data/lib/mustermann/rails.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-require 'mustermann'
-require 'mustermann/ast/pattern'
-require 'mustermann/versions'
-
-module Mustermann
-  # Rails style pattern implementation.
-  #
-  # @example
-  #   Mustermann.new('/:foo', type: :rails) === '/bar' # => true
-  #
-  # @see Mustermann::Pattern
-  # @see file:README.md#rails Syntax description in the README
-  class Rails < AST::Pattern
-    extend Versions
-    register :rails
-
-    # first parser, no optional parts
-    version('2.3') do
-      on(nil) { |c| unexpected(c) }
-      on(?*)  { |c| node(:named_splat) { scan(/\w+/) } }
-      on(?:)  { |c| node(:capture) { scan(/\w+/) } }
-    end
-
-    # rack-mount
-    version('3.0', '3.1') do
-      on(?))  { |c| unexpected(c) }
-      on(?()  { |c| node(:optional, node(:group) { read unless scan(?)) }) }
-      on(?\\) { |c| node(:char, expect(/./)) }
-    end
-
-    # stand-alone journey
-    version('3.2') do
-      on(?|)  { |c| raise ParseError, "the implementation of | is broken in ActionDispatch, cannot compile compatible pattern" }
-      on(?\\) { |c| node(:char, c) }
-    end
-
-    # embedded journey, broken (ignored) escapes
-    version('4.0', '4.1') { on(?\\) { |c| read } }
-
-    # escapes got fixed in 4.2
-    version('4.2') { on(?\\) { |c| node(:char, expect(/./)) } }
-
-    # Rails 5.0 fixes |
-    version('5.0') { on(?|) { |c| node(:or) }}
-  end
-end

data/lib/mustermann/versions.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-module Mustermann
-  # Mixin that adds support for multiple versions of the same type.
-  # @see Mustermann::Rails
-  # @!visibility private
-  module Versions
-    # Checks if class has mulitple versions available and picks one that matches the version option.
-    # @!visibility private
-    def new(*args, version: nil, **options)
-      return super(*args, **options) unless versions.any?
-      self[version].new(*args, **options)
-    end
-
-    # @return [Hash] version to subclass mapping.
-    # @!visibility private
-    def versions
-      @versions ||= {}
-    end
-
-    # Defines a new version.
-    # @!visibility private
-    def version(*list, inherit_from: nil, &block)
-      superclass = self[inherit_from] || self
-      subclass   = Class.new(superclass, &block)
-      list.each { |v| versions[v] = subclass }
-    end
-
-    # Resolve a subclass for a given version string.
-    # @!visibility private
-    def [](version)
-      return versions.values.last unless version
-      detected = versions.detect { |v,_| version.start_with?(v) }
-      raise ArgumentError, 'unsupported version %p' % version unless detected
-      detected.last
-    end
-
-    # @!visibility private
-    def name
-      super || superclass.name
-    end
-
-    # @!visibility private
-    def inspect
-      name
-    end
-  end
-end

data/mustermann-contrib.gemspec

@@ -1,18 +0,0 @@
-$:.unshift File.expand_path("../../mustermann/lib", __FILE__)
-require "mustermann/version"
-
-Gem::Specification.new do |s|
-  s.name                  = "mustermann-contrib"
-  s.version               = Mustermann::VERSION
-  s.authors               = ["Konstantin Haase", "Zachary Scott"]
-  s.email                 = "sinatrarb@googlegroups.com"
-  s.homepage              = "https://github.com/sinatra/mustermann"
-  s.summary               = %q{Collection of extensions for Mustermann}
-  s.description           = %q{Adds many plugins to Mustermann}
-  s.license               = 'MIT'
-  s.required_ruby_version = '>= 2.6.0'
-  s.files                 = `git ls-files`.split("\n")
-  s.test_files            = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.add_dependency 'mustermann', Mustermann::VERSION
-  s.add_dependency 'hansi', '~> 0.2.0'
-end

data/spec/cake_spec.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-require 'support'
-require 'mustermann/cake'
-
-describe Mustermann::Cake do
-  extend Support::Pattern
-
-  pattern '' do
-    it { should     match('')  }
-    it { should_not match('/') }
-
-    it { should expand.to('') }
-    it { should_not expand(a: 1) }
-
-    it { should generate_template('') }
-
-    it { should respond_to(:expand)       }
-    it { should respond_to(:to_templates) }
-  end
-
-  pattern '/' do
-    it { should     match('/')    }
-    it { should_not match('/foo') }
-
-    it { should expand.to('/') }
-    it { should_not expand(a: 1) }
-  end
-
-  pattern '/foo' do
-    it { should     match('/foo')     }
-    it { should_not match('/bar')     }
-    it { should_not match('/foo.bar') }
-
-    it { should expand.to('/foo') }
-    it { should_not expand(a: 1) }
-  end
-
-  pattern '/foo/bar' do
-    it { should     match('/foo/bar')   }
-    it { should_not match('/foo%2Fbar') }
-    it { should_not match('/foo%2fbar') }
-
-    it { should expand.to('/foo/bar') }
-    it { should_not expand(a: 1) }
-  end
-
-  pattern '/:foo' do
-    it { should match('/foo')       .capturing foo: 'foo'       }
-    it { should match('/bar')       .capturing foo: 'bar'       }
-    it { should match('/foo.bar')   .capturing foo: 'foo.bar'   }
-    it { should match('/%0Afoo')    .capturing foo: '%0Afoo'    }
-    it { should match('/foo%2Fbar') .capturing foo: 'foo%2Fbar' }
-
-    it { should_not match('/foo?')    }
-    it { should_not match('/foo/bar') }
-    it { should_not match('/')        }
-    it { should_not match('/foo/')    }
-
-    example { pattern.params('/foo')   .should be == {"foo" => "foo"} }
-    example { pattern.params('/f%20o') .should be == {"foo" => "f o"} }
-    example { pattern.params('').should be_nil }
-
-    it { should expand(foo: 'bar')     .to('/bar')       }
-    it { should expand(foo: 'b r')     .to('/b%20r')     }
-    it { should expand(foo: 'foo/bar') .to('/foo%2Fbar') }
-
-    it { should_not expand(foo: 'foo', bar: 'bar') }
-    it { should_not expand(bar: 'bar') }
-    it { should_not expand }
-
-    it { should generate_template('/{foo}') }
-  end
-
-  pattern '/*' do
-    it { should match('/')        }
-    it { should match('/foo')     }
-    it { should match('/foo/bar') }
-
-    example { pattern.params('/foo/bar') .should be == {"splat" => ["foo", "bar"]}}
-    it { should generate_template('/{+splat}') }
-  end
-
-  pattern '/**' do
-    it { should match('/')        .capturing splat: ''        }
-    it { should match('/foo')     .capturing splat: 'foo'     }
-    it { should match('/foo/bar') .capturing splat: 'foo/bar' }
-
-    example { pattern.params('/foo/bar') .should be == {"splat" => ["foo/bar"]} }
-    it { should generate_template('/{+splat}') }
-  end
-end