mustermann 4.0.0.beta1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a382e55dcc3919ca87dfa480d405b5fc126435c8081ce37e270a63e5907e7517
-  data.tar.gz: 4ec389e09c7a625fc83acf00fa9ff98a08e05cb58c1fb5c43772b14605a92e02
+  metadata.gz: a1787d2b11e609844ac6a3085ca8943c1b94e9026b14f7efadded04f63f6d299
+  data.tar.gz: f8fb8748dbd82305d12b23cc4a227c210e3f748cd6e23fdb97b1126ea582c62d
 SHA512:
-  metadata.gz: 7c8595c1df98b37d768691d0e1b591edd5a7b219aeff7569ee6e7e925b29ef2065125e7845d487e4b3aab68e2b7c06ffc7d696c74433a82b0d6012dd80a1d88e
-  data.tar.gz: 8f4bf30d82cd54534a5f4e31c1843868e1a0fe0112be8656167321b6554baac4d8455e947146c3ec5f9340f8af20ca8edd79499630a571b2a39851ddaef55f38
+  metadata.gz: 5a429bddc03f3744c091f8b322c799f71276f35db5e190818ec57890012f52d4d3248c388b1db2997bd7d8c18bdb13fad58808e9961e1cd4accb832d8ddf9251
+  data.tar.gz: ac56fdcb2c30b07578ffa163af51a402190ec9ee75be89378347c2e9954caaadf942340ce15819f291bac4a1139d2e239fab4ff058df35c719777902f521620a

data/README.md

@@ -42,7 +42,7 @@ pattern.params('/a/b.c') # => { "prefix" => "a", splat => ["b", "c"] }
 These features are included in the library, but not loaded by default
 
 * **[Pattern Set](#-pattern-set):** A collection of patterns with associated values, designed for building routing tables that dispatch efficiently as the number of routes grows.
-* **Mustermann::Router:** A very basic rack router built on top of `Mustermann::Set` for demonstration purposes. Simple and fast.
+* **Mustermann::Router:** A very basic rack router built on top of `Mustermann::Set` for demonstration purposes or small-footprint routing in Rack middleware. Simple and fast.
 
 <a name="-pattern-types"></a>
 ## Pattern Types
@@ -120,7 +120,7 @@ require 'mustermann'
 
 pattern = Mustermann.new('/:page')
 pattern.match('/')     # => nil
-pattern.match('/home') # => #<MatchData "/home" page:"home">
+pattern.match('/home') # => #<Mustermann::Match>
 pattern =~ '/home'     # => 0
 pattern === '/home'    # => true (this allows using it in case statements)
 
@@ -723,10 +723,10 @@ Semi-greedy behavior is not specific to dots, it works with all characters or st
 
 ``` ruby
 pattern = Mustermann.new(':a.:b', greedy: true)
-pattern.match('a.b.c.d') # => #<MatchData a:"a.b.c" b:"d">
+pattern.match('a.b.c.d') # => #<Mustermann::Match>
 
 pattern = Mustermann.new(':a.:b', greedy: false)
-pattern.match('a.b.c.d') # => #<MatchData a:"a" b:"b.c.d">
+pattern.match('a.b.c.d') # => #<Mustermann::Match>
 ```
 
 <a name="-available-options--space_matches_plus"></a>

data/lib/mustermann/ast/fast_pattern.rb

@@ -26,17 +26,6 @@ module Mustermann
 
       private_constant :SIMPLE, :ENCODED, :SEGMENT_SCAN
 
-      # Bypasses the generic build_match overhead for simple patterns: uses
-      # MatchData#named_captures directly and avoids match.to_s / post_match /
-      # pre_match calls (all no-ops for \A…\Z anchored regexps).
-      def match(string)
-        return super unless @fast_match
-        return unless match = @regexp.match(string)
-        params = match.named_captures
-        params.transform_values! { |v| unescape(v) } if string.include?('%')
-        Match.new(self, match, params:)
-      end
-
       # Public override: fast path for simple patterns, falls through to super otherwise.
       # Must remain public to match AST::Pattern#to_ast visibility.
       def to_ast
@@ -46,8 +35,24 @@ module Mustermann
         ast
       end
 
+      def params(string = nil)
+        return super unless @fast_match
+        return unless md = @regexp.match(string)
+        result = md.named_captures
+        result.transform_values! { |v| v.include?('%') ? unescape(v) : v } if string.include?('%')
+        result
+      end
+
       private
 
+      def build_match(regexp, string)
+        return super unless @fast_match
+        return unless match = regexp.match(string)
+        params = match.named_captures
+        params.transform_values! { |v| v.include?('%') ? unescape(v) : v } if string.include?('%')
+        Match.new(self, match, params: params)
+      end
+
       def simple_pattern?
         options[:capture].nil?  &&
           options[:except].nil? &&

data/lib/mustermann/ast/pattern.rb

@@ -138,7 +138,8 @@ module Mustermann
       # @see Mustermann::Pattern#map_param
       def map_param(key, value)
         return super unless param_converters.include? key
-        param_converters[key][super]
+        converted = super
+        converted.nil? ? converted : param_converters[key][converted]
       end
 
       # @!visibility private

data/lib/mustermann/composite.rb

@@ -29,6 +29,11 @@ module Mustermann
       @patterns = patterns.flat_map { |p| patterns_from(p, **options) }
     end
 
+    # @see Mustermann::Pattern#names
+    def names
+      @names ||= patterns.flat_map { |p| p.respond_to?(:names) ? p.names : [] }.uniq
+    end
+
     # @see Mustermann::Pattern#==
     def ==(pattern)
       patterns == patterns_from(pattern)
@@ -79,19 +84,33 @@ module Mustermann
     end
 
     # @return [String] the string representation of the pattern
-    def to_s
-      simple_inspect
-    end
+    def to_s = inspect
 
     # @!visibility private
     def inspect
-      "#<%p:%s>" % [self.class, simple_inspect]
+      "(#{simple_inspect})"
     end
 
     # @!visibility private
     def simple_inspect
-      pattern_strings = patterns.map { |p| p.simple_inspect }
-      "(#{pattern_strings.join(" #{operator} ")})"
+      patterns.map { |p| p.is_a?(Composite) ? p.inspect : p.simple_inspect }.join(" #{operator} ")
+    end
+
+    # @!visibility private
+    def pretty_print(q)
+      q.group(1, "(", ")") do
+        patterns.each_with_index do |pattern, index|
+          unless index == 0
+            q.text " #{operator}"
+            q.breakable " "
+          end
+          if pattern.is_a?(Composite)
+            q.pp pattern
+          else
+            q.text pattern.simple_inspect
+          end
+        end
+      end
     end
 
     # @!visibility private

data/lib/mustermann/concat.rb

@@ -14,8 +14,8 @@ module Mustermann
           concat = (self + patterns.inject(:+))
           concat + other.patterns.slice(patterns.length..-1).inject(:+)
         else
-          return super unless native = native_concat(other)
-          self.class.new(native, **options)
+          native, opts = native_concat(other)
+          native ? self.class.new(native, **options, **opts.to_h) : super
         end
       end
 

data/lib/mustermann/expander.rb

@@ -159,6 +159,23 @@ module Mustermann
       end
     end
 
+    # @!visibility private
+    def inspect
+      return "#<#{self.class.name}>" if @patterns.empty?
+      "#<#{self.class.name}: #{@patterns.map { |p| p.to_s.inspect }.join(", ")}>"
+    end
+
+    # @!visibility private
+    def pretty_print(q)
+      q.text "#<#{self.class.name}"
+      q.group(1, "", ">") do
+        @patterns.each_with_index do |pattern, index|
+          q.breakable(index == 0 ? " " : ", ")
+          q.pp pattern.to_s
+        end
+      end
+    end
+
     # @see Object#==
     def ==(other)
       return false unless other.class == self.class

data/lib/mustermann/match.rb

@@ -132,5 +132,24 @@ module Mustermann
 
     alias == eql?
     alias to_h params
+
+    # @!visibility private
+    def inspect
+      params_str = params.map { |k, v| " #{k}:#{v.inspect}" }.join
+      "#<#{self.class.name}: #{@matched.inspect}#{params_str}>"
+    end
+
+    # @!visibility private
+    def pretty_print(q)
+      q.group(1, "#<#{self.class.name}:", ">") do
+        q.breakable
+        q.pp @matched
+        params.each do |key, value|
+          q.breakable
+          q.text("#{key}:")
+          q.pp value
+        end
+      end
+    end
   end
 end

data/lib/mustermann/pattern.rb

@@ -90,6 +90,9 @@ module Mustermann
       Match.new(self, string) if self === string
     end
 
+    # @return [Array<String>] list of named captures in the pattern
+    def names = []
+
     # @param [String] string The string to match against
     # @return [Integer, nil] nil if pattern does not match the string, zero if it does.
     # @see http://ruby-doc.org/core-2.0/Regexp.html#method-i-3D-7E Regexp#=~
@@ -339,6 +342,13 @@ module Mustermann
       method(method).owner != Mustermann::Pattern
     end
 
+    # @!visibility private
+    def pretty_print(q)
+      q.text "#<%p:" % self.class
+      q.pp(@string)
+      q.text ">"
+    end
+
     # @!visibility private
     def inspect
       "#<%p:%p>" % [self.class, @string]

data/lib/mustermann/rails.rb

@@ -45,5 +45,19 @@ module Mustermann
 
     # Rails 5.0 fixes |
     version('5', '6', '7', '8') { on(?|) { |c| node(:or) }}
+
+    # (see Mustermann::Pattern#|)
+    def |(other) = combine(other, :|) { super }
+
+    # (see Mustermann::Pattern#+)
+    def +(other) = combine(other, :+) { super }
+
+    private
+
+    def combine(other, operator)
+      return yield unless hybrid = Mustermann[:hybrid].try_convert(self, **options)
+      native = hybrid.public_send(operator, other)
+      native.is_a?(Composite) ? yield : native
+    end
   end
 end

data/lib/mustermann/regexp_based.rb

@@ -11,15 +11,37 @@ module Mustermann
     attr_reader :regexp
     alias_method :to_regexp, :regexp
 
+    # @api private
+    supported_options :cache
+
     # @param (see Mustermann::Pattern#initialize)
     # @return (see Mustermann::Pattern#initialize)
     # @see (see Mustermann::Pattern#initialize)
     def initialize(string, **options)
+      cache = options.delete(:cache) { true }
+
       super
-      regexp       = compile(**options)
-      @peek_regexp = /\A#{regexp}/
-      @regexp      = /\A#{regexp}\Z/
+      regexp           = compile(**options)
+      @peek_regexp     = /\A#{regexp}/
+      @regexp          = /\A#{regexp}\Z/
       @simple_captures = @regexp.named_captures.none? { |name, positions| positions.size > 1 || always_array?(name) }
+
+      cache_class = ObjectSpace::WeakKeyMap if defined?(ObjectSpace::WeakKeyMap)
+
+      case cache
+      when true
+        @match_cache = cache_class&.new || false
+        @peek_cache  = cache_class&.new || false
+      when false
+        @match_cache = false
+        @peek_cache  = false
+      when Hash
+        @match_cache = cache[:match] || cache_class&.new || false
+        @peek_cache  = cache[:peek]  || cache_class&.new || false
+      else
+        @match_cache = cache.new
+        @peek_cache  = cache.new
+      end
     end
 
     # @param (see Mustermann::Pattern#peek_size)
@@ -33,20 +55,38 @@ module Mustermann
     # @param (see Mustermann::Pattern#peek_match)
     # @return (see Mustermann::Pattern#peek_match)
     # @see (see Mustermann::Pattern#peek_match)
-    def peek_match(string) = build_match(@peek_regexp.match(string))
+    def peek_match(string) = cache_match(@peek_cache, @peek_regexp, string)
 
     # @param (see Mustermann::Pattern#match)
     # @return (see Mustermann::Pattern#match)
     # @see (see Mustermann::Pattern#match)
-    def match(string) = build_match(@regexp.match(string))
+    def match(string) = cache_match(@match_cache, @regexp, string)
+
+    # Extracts params directly from the regexp without allocating a Match object or
+    # populating the match cache — significant GC savings when called in hot loops.
+    # @param (see Mustermann::Pattern#params)
+    # @return (see Mustermann::Pattern#params)
+    def params(string = nil)
+      return unless md = @regexp.match(string)
+      build_params(md)
+    end
 
     extend Forwardable
     def_delegators :regexp, :===, :=~, :names
 
     private
 
-    def build_match(match)
-      return unless match
+    def cache_match(cache, regexp, string)
+      if cache
+        return cache[string] if cache.key?(string)
+        cache[string] = build_match(regexp, string)
+      else
+        build_match(regexp, string)
+      end
+    end
+
+    def build_match(regexp, string)
+      return unless match = regexp.match(string)
       Match.new(self, match, params: build_params(match))
     end
 

data/lib/mustermann/set.rb

@@ -185,6 +185,11 @@ module Mustermann
     # @return [self]
     # @raise [ArgumentError] if the pattern is not AST-based, or if a reserved symbol is used as a value
     def add(pattern, *values)
+      if pattern.is_a? Composite and pattern.operator == :|
+        pattern.patterns.each { |p| add(p, *values) }
+        return self
+      end
+
       pattern = Mustermann.new(pattern, **options)
       raise ArgumentError, "Non-AST patterns are not supported" unless pattern.respond_to? :to_ast
 
@@ -380,6 +385,38 @@ module Mustermann
     # Runs trie optimizations pro-actively and explicitly rather than at match time.
     def optimize! = @matcher&.optimize!
 
+    # @!visibility private
+    def inspect # :nodoc:
+      mapping = @mapping.map do |pattern, values|
+        if values.size > 1 or values.first.is_a? Array
+          "%p => %p" % [pattern.to_s, values]
+        elsif values.first != nil
+          "%p => %p" % [pattern.to_s, values.first]
+        else
+          "%p" % pattern.to_s
+        end
+      end
+      "#<#{self.class.name}: #{mapping.join(", ")}>"
+    end
+
+    # @!visibility private
+    def pretty_print(q) # :nodoc:
+      q.text "#<#{self.class.name}"
+      q.group(1, "", ">") do
+        @mapping.each_with_index do |(pattern, values), index|
+          q.breakable(index == 0 ? " " : ", ")
+          q.pp(pattern.to_s)
+          if values.size > 1 or values.first.is_a? Array
+            q.text " => "
+            q.pp(values)
+          elsif values.first != nil
+            q.text " => "
+            q.pp(values.first)
+          end
+        end
+      end
+    end
+
     protected
 
     attr_reader :mapping

data/lib/mustermann/sinatra/try_convert.rb

@@ -6,24 +6,34 @@ module Mustermann
     class TryConvert < AST::Translator
       # @return [Mustermann::Sinatra, nil]
       # @!visibility private
-      def self.convert(input, **options)
-        new(options).translate(input)
+      def self.convert(type, input, **options)
+        new(type, **options).translate(input)
       end
 
+      # Reserved variable names.
+      # @!visibility private
+      attr_reader :names
+
       # Expected options for the resulting pattern.
       # @!visibility private
       attr_reader :options
 
+      # Expected pattern type for the resulting pattern.
+      # @!visibility private
+      attr_reader :type
+
       # @!visibility private
-      def initialize(options)
+      def initialize(type, names: [], **options)
+        @names   = names
         @options = options
+        @type    = type
       end
 
       # @return [Mustermann::Sinatra]
       # @!visibility private
-      def new(input, escape = false)
+      def new(input, escape: false, **opts)
         input = Mustermann::Sinatra.escape(input) if escape
-        Mustermann::Sinatra.new(input, **options)
+        type.new(input, **opts, **options, ignore_unknown_options: true)
       end
 
       # @return [true, false] whether or not expected pattern should have uri_decode option set
@@ -32,15 +42,43 @@ module Mustermann
         options.fetch(:uri_decode, true)
       end
 
-      translate(Object) { nil               }
-      translate(String) { t.new(self, true) }
+      # @return [true, false] whether or not the given options are compatible with the expected options
+      # @!visibility private
+      def compatible_options?(other_options)
+        other_options.all? do |key, value|
+          case key
+          when :capture then compatible_capture_option?(value)
+          else value == options[key]
+          end
+        end
+      end
 
-      translate(Identity) { t.new(self, true) if uri_decode == t.uri_decode }
-      translate(Sinatra)  { node              if options    == t.options    }
+      # @return [true, false] whether or not the given capture option is compatible with the expected capture option
+      # @!visibility private
+      def compatible_capture_option?(capture)
+        return true if names.empty?
+        case capture
+        when Hash  then capture.all? { |n, o| !names.include?(n.to_s) and compatible_capture_option?(o) }
+        when Array then capture.all? { |o| compatible_capture_option?(o) }
+        else true
+        end
+      end
+
+      translate(Object) { nil }
+      translate(String) { t.new(self, escape: true) }
+      translate(Identity) { t.new(self, escape: true) if uri_decode == t.uri_decode }
+
+      translate(Sinatra) do
+        if node.class == t.type and t.options == options
+          node
+        elsif t.compatible_options? options
+          t.new(to_s, **options)
+        end
+      end
 
       translate AST::Pattern do
-        next unless options == t.options
-        t.new(SafeRenderer.translate(to_ast)) rescue nil
+        next unless t.compatible_options? options
+        t.new(SafeRenderer.translate(to_ast), **options) rescue nil
       end
     end
 

data/lib/mustermann/sinatra.rb

@@ -37,13 +37,13 @@ module Mustermann
     # @return [Mustermann::Sinatra, nil] the converted pattern, if possible
     # @!visibility private
     def self.try_convert(input, **options)
-      TryConvert.convert(input, **options)
+      TryConvert.convert(self, input, **options)
     end
 
     # Creates a pattern that matches any string matching either one of the patterns.
     # If a string is supplied, it is treated as a fully escaped Sinatra pattern.
     #
-    # If the other pattern is also a Sintara pattern, it might join the two to a third
+    # If the other pattern is also a Sinatra pattern, it might join the two to a third
     # sinatra pattern instead of generating a composite for efficiency reasons.
     #
     # This only happens if the sinatra pattern behaves exactly the same as a composite
@@ -59,12 +59,12 @@ module Mustermann
     # @return [Mustermann::Pattern] a composite pattern
     # @see Mustermann::Pattern#|
     def |(other)
-      return super unless converted = self.class.try_convert(other, **options)
-      return super unless converted.names.empty? or names.empty?
-      self.class.new(safe_string + "|" + converted.safe_string, **options)
+      return super unless converted = try_convert(other)
+      return super if converted.names.any? { |name| names.include?(name) }
+      self.class.new(safe_string + "|" + converted.safe_string, **converted.options)
     end
 
-    # Generates a string represenation of the pattern that can safely be used for def interpolation
+    # Generates a string representation of the pattern that can safely be used for def interpolation
     # without changing its semantics.
     #
     # @example
@@ -72,19 +72,41 @@ module Mustermann
     #   unsafe = Mustermann.new("/:name")
     #
     #   Mustermann.new("#{unsafe}bar").params("/foobar") # => { "namebar" => "foobar" }
-    #   Mustermann.new("#{unsafe.safe_string}bar").params("/foobar") # => { "name" => "bar" }
+    #   Mustermann.new("#{unsafe.safe_string}bar").params("/foobar") # => { "name" => "foo" }
     #
-    # @return [String] string representatin of the pattern
+    # @return [String] string representations of the pattern
     def safe_string
       @safe_string ||= SafeRenderer.translate(to_ast)
     end
 
     # @!visibility private
     def native_concat(other)
-      return unless converted = self.class.try_convert(other, **options)
-      safe_string + converted.safe_string
+      return unless converted = try_convert(other)
+      [safe_string + converted.safe_string, converted.options]
     end
 
-    private :native_concat
+    # @!visibility private
+    def normalize_capture(pattern)
+      case capture = pattern.options[:capture]
+      when Hash then capture.slice(*pattern.names.map(&:to_sym))
+      when nil  then {}
+      else pattern.names.to_h { |name| [name.to_sym, capture] }
+      end
+    end
+
+    # @!visibility private
+    def try_convert(other)
+      options = self.options
+
+      if other.is_a? Pattern and other.names.any?
+        capture = normalize_capture(other).merge(normalize_capture(self))
+        capture = nil if capture.empty?
+        options = options.merge(capture:)
+      end
+
+      self.class.try_convert(other, names:, **options)
+    end
+
+    private :native_concat, :normalize_capture, :try_convert
   end
 end

data/lib/mustermann/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Mustermann
-  VERSION ||= '4.0.0.beta1'
+  VERSION ||= '4.0.0'
 end

metadata

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