mustermann 1.0.1 → 1.0.2.rc1

data/mustermann-contrib/lib/mustermann/strscan.rb

@@ -0,0 +1 @@
+require 'mustermann/string_scanner'

data/mustermann-contrib/lib/mustermann/template.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+require 'mustermann'
+require 'mustermann/ast/pattern'
+
+module Mustermann
+  # URI template pattern implementation.
+  #
+  # @example
+  #   Mustermann.new('/{foo}') === '/bar' # => true
+  #
+  # @see Mustermann::Pattern
+  # @see file:README.md#template Syntax description in the README
+  # @see http://tools.ietf.org/html/rfc6570 RFC 6570
+  class Template < AST::Pattern
+    include Concat::Native
+    register :template, :uri_template
+
+    on ?{ do |char|
+      variable = proc do
+        start  = pos
+        match  = expect(/(?<name>\w+)(?:\:(?<prefix>\d{1,4})|(?<explode>\*))?/)
+        node(:variable, match[:name], prefix: match[:prefix], explode: match[:explode], start: start)
+      end
+
+      operator   = buffer.scan(/[\+\#\.\/;\?\&\=\,\!\@\|]/)
+      expression = node(:expression, [variable[]], operator: operator) { variable[] if scan(?,) }
+      expression if expect(?})
+    end
+
+    on(?}) { |c| unexpected(c) }
+
+    # @!visibility private
+    def compile(*args, **options)
+      @split_params = {}
+      super(*args, split_params: @split_params, **options)
+    end
+
+    # @!visibility private
+    def map_param(key, value)
+      return super unless variable = @split_params[key]
+      value = value.split variable[:separator]
+      value.map! { |e| e.sub(/\A#{key}=/, '') } if variable[:parametric]
+      value.map! { |e| super(key, e) }
+    end
+
+    # @!visibility private
+    def always_array?(key)
+      @split_params.include? key
+    end
+
+    # Identity patterns support generating templates (the logic is quite complex, though).
+    #
+    # @example (see Mustermann::Pattern#to_templates)
+    # @param (see Mustermann::Pattern#to_templates)
+    # @return (see Mustermann::Pattern#to_templates)
+    # @see Mustermann::Pattern#to_templates
+    def to_templates
+      [to_s]
+    end
+
+    private :compile, :map_param, :always_array?
+  end
+end

data/mustermann-contrib/lib/mustermann/uri_template.rb

@@ -0,0 +1 @@
+require 'mustermann/template'

data/mustermann-contrib/lib/mustermann/versions.rb

@@ -0,0 +1,47 @@
+# 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/lib/mustermann/visualizer.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require 'mustermann'
+require 'mustermann/visualizer/highlight'
+require 'mustermann/visualizer/tree_renderer'
+require 'mustermann/visualizer/pattern_extension'
+
+module Mustermann
+  # Namespace for Mustermann visualization logic.
+  module Visualizer
+    extend self
+
+    # @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
+    # @param (see Mustermann::Visualizer::Highlight#initialize)
+    def highlight(pattern, **options)
+      Highlight.new(pattern, **options)
+    end
+
+    # @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
+    def tree(pattern, **options)
+      TreeRenderer.render(pattern, **options)
+    end
+  end
+end

data/mustermann-contrib/lib/mustermann/visualizer/highlight.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+require 'hansi'
+require 'mustermann'
+require 'mustermann/visualizer/highlighter'
+require 'mustermann/visualizer/renderer/ansi'
+require 'mustermann/visualizer/renderer/hansi_template'
+require 'mustermann/visualizer/renderer/html'
+require 'mustermann/visualizer/renderer/sexp'
+
+module Mustermann
+  module Visualizer
+    # Meta class for highlight objects.
+    # @see Mustermann::Visualizer#highlight
+    class Highlight
+      # @!visibility private
+      attr_reader :pattern, :theme
+
+      # @!visibility private
+      DEFAULT_THEME = Hansi::Theme.new(:solarized, {
+        default:   :base0,
+        separator: :base1,
+        escaped:   :base1,
+        capture:   :orange,
+        name:      :yellow,
+        special:   :blue,
+        quote:     :red,
+        illegal:   :darkred
+      })
+
+      # @!visibility private
+      BASE_THEME = Hansi::Theme.new({
+        special:     :default,
+        capture:     :special,
+        char:        :default,
+        expression:  :capture,
+        composition: :special,
+        group:       :composition,
+        union:       :composition,
+        optional:    :special,
+        root:        :default,
+        separator:   :char,
+        splat:       :capture,
+        named_splat: :splat,
+        variable:    :capture,
+        escaped:     :char,
+        quote:       :special,
+        type:        :special,
+        illegal:     :special
+      })
+
+      # @!visibility private
+      def initialize(pattern, type: nil, inspect: nil, **theme)
+        @pattern = Mustermann.new(pattern, type: type)
+        @inspect = inspect.nil? ? pattern.is_a?(Mustermann::Composite) : inspect
+        theme    = theme.any? ? Hansi::Theme.new(theme) : DEFAULT_THEME
+        @theme   = BASE_THEME.merge(theme)
+      end
+
+      # @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
+      def to_hansi_template(**options)
+        render_with(Renderer::HansiTemplate, **options)
+      end
+
+      # @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
+      def to_ansi(**options)
+        render_with(Renderer::ANSI, **options)
+      end
+
+      # @example
+      #   require 'mustermann/visualizer'
+      #
+      #   pattern   = Mustermann.new('/:name')
+      #   highlight = Mustermann::Visualizer.highlight(pattern)
+      #
+      #   puts highlight.to_html
+      #
+      # @return [String] HTML rendering of the pattern
+      def to_html(**options)
+        render_with(Renderer::HTML, **options)
+      end
+
+      # @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
+      def to_sexp(**options)
+        render_with(Renderer::Sexp, **options)
+      end
+
+      # @return [Mustermann::Pattern] the pattern used to create the highlight object
+      def to_pattern
+        pattern
+      end
+
+      # @return [String] string representation of the pattern
+      def to_s
+        pattern.to_s
+      end
+
+      # @return [String] stylesheet for HTML output from the pattern
+      def stylesheet(**options)
+        Renderer::HTML.new(self, **options).stylesheet
+      end
+
+      # @!visibility private
+      def render_with(renderer, **options)
+        options[:inspect] = @inspect if options[:inspect].nil?
+        renderer.new(self, **options).render
+      end
+
+      # @!visibility private
+      def render(renderer)
+        Highlighter.highlight(pattern, renderer)
+      end
+    end
+  end
+end

data/mustermann-contrib/lib/mustermann/visualizer/highlighter.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require 'mustermann/visualizer/highlighter/ast'
+require 'mustermann/visualizer/highlighter/ad_hoc'
+require 'mustermann/visualizer/highlighter/composite'
+require 'mustermann/visualizer/highlighter/dummy'
+require 'mustermann/visualizer/highlighter/regular'
+
+module Mustermann
+  module Visualizer
+    # @!visibility private
+    module Highlighter
+      extend self
+
+      # @return [String] highlighted string
+      # @!visibility private
+      def highlight(pattern, renderer)
+        highlighter_for(pattern).highlight(pattern, renderer)
+      end
+
+      # @return [#highlight] Highlighter for given pattern
+      # @!visibility private
+      def highlighter_for(pattern)
+        return pattern.highlighter if pattern.respond_to? :highlighter and pattern.highlighter
+        consts      = constants.map { |name| const_get(name) }
+        highlighter = consts.detect { |c| c.respond_to? :highlight? and c.highlight? pattern }
+        highlighter || Dummy
+      end
+
+      # Used to generate highlighting rules on the fly.
+      # @see {Mustermann::Shell#highlighter}
+      # @see {Mustermann::Simple#highlighter}
+      # @!visibility private
+      def create(&block)
+        Class.new(AdHoc, &block)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+require 'strscan'
+
+module Mustermann
+  module Visualizer
+    # @!visibility private
+    module Highlighter
+      # Used to generate highlighting rules on the fly.
+      # @see {Mustermann::Shell#highlighter}
+      # @see {Mustermann::Simple#highlighter}
+      # @!visibility private
+      class AdHoc
+        # @!visibility private
+        def self.highlight(pattern, renderer)
+          new(pattern, renderer).highlight
+        end
+
+        # @!visibility private
+        def self.rules
+          @rules ||= {}
+        end
+
+        # @!visibility private
+        def self.on(regexp, type = nil, &callback)
+          return regexp.map  { |key, value| on(key, value, &callback) } if regexp.is_a? Hash
+          raise ArgumentError, 'needs type or callback' unless type or callback
+          callback    ||= proc { |matched| element(type, matched) }
+          regexp        = Regexp.new(Regexp.escape(regexp)) unless regexp.is_a? Regexp
+          rules[regexp] = callback
+        end
+
+        # @!visibility private
+        attr_reader :pattern, :renderer, :rules, :output, :scanner
+        def initialize(pattern, renderer)
+          @pattern  = pattern
+          @renderer = renderer
+          @output   = String.new
+          @rules    = self.class.rules
+          @scanner  = ::StringScanner.new(pattern.to_s)
+        end
+
+        # @!visibility private
+        def highlight(stop = /\Z/)
+          output << renderer.pre(:root)
+          until scanner.eos? or scanner.check(stop)
+            position = scanner.pos
+            apply(scanner)
+            read_char(scanner) if position == scanner.pos and not scanner.check(stop)
+          end
+          output << renderer.post(:root)
+        end
+
+        # @!visibility private
+        def apply(scanner)
+          rules.each do |regexp, callback|
+            next unless result = scanner.scan(regexp)
+            instance_exec(result, &callback)
+          end
+        end
+
+        # @!visibility private
+        def read_char(scanner)
+          return unless char = scanner.getch
+          type = char == ?/ ? :separator : :char
+          element(type, char)
+        end
+
+        # @!visibility private
+        def escaped(content = ?\\, char)
+          element(:escaped, content) { element(:escaped_char, char) }
+        end
+
+        # @!visibility private
+        def nested(type, opening, closing, *separators)
+          element(type, opening) do
+            char = nil
+            until char == closing or scanner.eos?
+              highlight(Regexp.union(closing, *separators))
+              char = scanner.getch
+              output << char if char
+            end
+          end
+        end
+
+        # @!visibility private
+        def element(type, content = nil)
+          output << renderer.pre(type)
+          output << renderer.escape(content) if content
+          yield if block_given?
+          output << renderer.post(type)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+require 'mustermann/ast/translator'
+
+module Mustermann
+  module Visualizer
+    # @!visibility private
+    module Highlighter
+      # Provides highlighting for AST based patterns
+      # @!visibility private
+      class AST
+        Index   = Struct.new(:type, :start, :stop, :payload) { undef :to_a }
+        Indexer = Mustermann::AST::Translator.create do
+          translate(:node)  { |i| Index.new(type, start, stop, Array(t(payload, i)).flatten.compact) }
+          translate(Array)  { |i| map { |e| t(e, i) } }
+          translate(Object) { |i| }
+
+          translate(:with_look_ahead) do |input|
+            [t(head, input), *t(payload, input)]
+          end
+
+          translate(:expression) do |input|
+            index = Index.new(type, start, stop, Array(t(payload, input)).compact)
+            index.payload.delete_if { |e| e.type == :separator }
+            index
+          end
+
+          translate(:capture) do |input|
+            substring   = input[start, length]
+            if substart = substring.index(name)
+              substart += start
+              substop   = substart + name.length
+              payload   = [Index.new(:name, substart, substop, [])]
+            end
+            Index.new(type, start, stop, payload || [])
+          end
+
+          translate(:char) do |input|
+            substring = input[start, length]
+            if payload == substring
+              Index.new(type, start, stop, [])
+            elsif substart = substring.index(payload)
+              substart    += start
+              substop      = substart + payload.length
+              Index.new(:escaped, start, stop, [Index.new(:escaped_char, substart, substop, [])])
+            else
+              Index.new(:escaped, start, stop, [])
+            end
+          end
+        end
+
+        private_constant(:Index, :Indexer)
+
+        # @!visibility private
+        def self.highlight?(pattern)
+          pattern.respond_to? :to_ast
+        end
+
+        # @!visibility private
+        def self.highlight(pattern, renderer)
+          new(pattern, renderer).highlight
+        end
+
+        # @!visibility private
+        def initialize(pattern, renderer)
+          @ast      = pattern.to_ast
+          @string   = pattern.to_s
+          @renderer = renderer
+        end
+
+        # @!visibility private
+        def highlight
+          index = Indexer.translate(@ast, @string)
+          inject_literals(index)
+          render(index)
+        end
+
+        # @!visibility private
+        def render(index)
+          return @renderer.escape(@string[index.start..index.stop-1]) if index.type == :literal
+          payload = index.payload.map { |i| render(i) }.join
+          "#{ @renderer.pre(index.type) }#{ payload }#{ @renderer.post(index.type) }"
+        end
+
+        # @!visibility private
+        def inject_literals(index)
+          start, old_payload, index.payload = index.start, index.payload, []
+          old_payload.each do |element|
+            index.payload << literal(start, element.start) if start < element.start
+            index.payload << element
+            inject_literals(element)
+            start = element.stop
+          end
+          index.payload << literal(start, index.stop) if start < index.stop
+        end
+
+        # @!visibility private
+        def literal(start, stop)
+          Index.new(:literal, start, stop, [])
+        end
+      end
+    end
+  end
+end