mustermann-express 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c6795ad5822893caa59d2f3a3221c837d689fc3
+  data.tar.gz: 08d87ec97b358dc5ccb159f21e57b1559bd73dc6
+SHA512:
+  metadata.gz: fd5a13bbba9b2701fbc0666d7329edd2f8aae9380ca9dac0e62936d14d439dc8b895b50c97a54da5d647683fbff2268a92f42e167d11e8044e04681d504c18ea
+  data.tar.gz: fce9833ea4809b93e30c75696763b8bf390e272b0e95115a3f6e671108d009726b57f955cd8229564a826b3d1e2a9a8cd465c3b7ba29e52583c1bc591271e40e

data/README.md

@@ -0,0 +1,96 @@
+# 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/).
+
+## Overview
+
+**Supported options:**
+`capture`, `except`, `greedy`, `space_matches_plus`, `uri_decode`, and `ignore_unknown_options`.
+
+**External documentation:**
+[path-to-regexp](https://github.com/pillarjs/path-to-regexp#path-to-regexp),
+[live demo](http://forbeslindesay.github.io/express-route-tester/)
+
+Express patterns feature named captures (with repetition support via suffixes) that start with a colon and can have an optional regular expression constraint or unnamed captures that require a constraint.
+
+``` ruby
+require 'mustermann/express'
+
+Mustermann.new('/:name/:rest+', type: :express).params('/a/b/c') # => { name: 'a', rest: 'b/c' }
+
+pattern = Mustermann.new('/:name', type: :express)
+
+pattern.respond_to? :expand # => true
+pattern.expand(name: 'foo') # => '/foo'
+
+pattern.respond_to? :to_templates # => true
+pattern.to_templates              # => ['/{name}']
+```
+
+## 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><b>+</b></td>
+      <td>
+        Captures one or more segments (with segments being separated by forward slashes).
+        Capture is named <i>name</i>.
+        Capture behavior can be modified with <tt>capture</tt> option.
+      </td>
+    </tr>
+    <tr>
+      <td><b>:</b><i>name</i><b>*</b></td>
+      <td>
+        Captures zero or more segments (with segments being separated by forward slashes).
+        Capture is named <i>name</i>.
+        Capture behavior can be modified with <tt>capture</tt> option.
+      </td>
+    </tr>
+    <tr>
+      <td><b>:</b><i>name</i><b>?</b></td>
+      <td>
+        Captures anything but a forward slash in a semi-greedy fashion. Capture is named <i>name</i>.
+        Also matches an empty string.
+        Capture behavior can be modified with <tt>capture</tt> and <tt>greedy</tt> option.
+      </td>
+    </tr>
+    <tr>
+      <td><b>:</b><i>name</i><b>(</b><i>regexp</i><b>)</b></td>
+      <td>
+        Captures anything matching the <i>regexp</i> regular expression. Capture is named <i>name</i>.
+        Capture behavior can be modified with <tt>capture</tt>.
+      </td>
+    </tr>
+    <tr>
+      <td><b>(</b><i>regexp</i><b>)</b></td>
+      <td>
+        Captures anything matching the <i>regexp</i> regular expression. Capture is named splat.
+        Capture behavior can be modified with <tt>capture</tt>.
+      </td>
+    </tr>
+    <tr>
+      <td><b>/</b></td>
+      <td>
+        Matches forward slash. Does not match URI encoded version of forward slash.
+      </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/express.rb

@@ -0,0 +1,37 @@
+require 'mustermann'
+require 'mustermann/ast/pattern'
+
+module Mustermann
+  # Express style pattern implementation.
+  #
+  # @example
+  #   Mustermann.new('/:foo', type: :express) === '/bar' # => true
+  #
+  # @see Mustermann::Pattern
+  # @see file:README.md#flask Syntax description in the README
+  class Express < AST::Pattern
+    register :express
+
+    on(nil, ??, ?+, ?*, ?)) { |c| unexpected(c) }
+    on(?:) { |c| node(:capture) { scan(/\w+/) } }
+    on(?() { |c| node(:splat, constraint: read_brackets(?(, ?))) }
+
+    suffix ??, after: :capture do |char, element|
+      unexpected(char) unless element.is_a? :capture
+      node(:optional, element)
+    end
+
+    suffix ?*, after: :capture do |match, element|
+      node(:named_splat, element.name)
+    end
+
+    suffix ?+, after: :capture do |match, element|
+      node(:named_splat, element.name, constraint: ".+")
+    end
+
+    suffix ?(, after: :capture do |match, element|
+      element.constraint = read_brackets(?(, ?))
+      element
+    end
+  end
+end

data/mustermann-express.gemspec

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path("../../mustermann/lib", __FILE__)
+require "mustermann/version"
+
+Gem::Specification.new do |s|
+  s.name                  = "mustermann-express"
+  s.version               = Mustermann::VERSION
+  s.author                = "Konstantin Haase"
+  s.email                 = "konstantin.mailinglists@googlemail.com"
+  s.homepage              = "https://github.com/rkh/mustermann"
+  s.summary               = %q{Express.js syntax for Mustermann}
+  s.description           = %q{Adds express.js style patterns to Mustermman}
+  s.license               = 'MIT'
+  s.required_ruby_version = '>= 2.1.0'
+  s.files                 = `git ls-files`.split("\n")
+  s.test_files            = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables           = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.add_dependency 'mustermann', Mustermann::VERSION
+end

data/spec/express_spec.rb

@@ -0,0 +1,209 @@
+require 'support'
+require 'mustermann/express'
+
+describe Mustermann::Express 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 '/:foo+' do
+    it { should_not match('/') }
+    it { should match('/foo')     .capturing foo: 'foo' }
+    it { should match('/foo/bar') .capturing foo: 'foo/bar' }
+
+    it { should expand                  .to('/')        }
+    it { should expand(foo:  nil)       .to('/')        }
+    it { should expand(foo:  '')        .to('/')        }
+    it { should expand(foo: 'foo')      .to('/foo')     }
+    it { should expand(foo: 'foo/bar')  .to('/foo/bar') }
+    it { should expand(foo: 'foo.bar')  .to('/foo.bar') }
+
+    it { should generate_template('/{+foo}') }
+  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 match('/') }
+
+    it { should_not match('/foo?')    }
+    it { should_not match('/foo/bar') }
+    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 == {"foo" => 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 expand                 .to('/')          }
+
+    it { should_not expand(foo: 'foo', bar: 'bar') }
+    it { should_not expand(bar: 'bar') }
+
+    it { should generate_template('/{foo}') }
+    it { should generate_template('/')      }
+  end
+
+  pattern '/:foo*' do
+    it { should match('/')        .capturing foo: '' }
+    it { should match('/foo')     .capturing foo: 'foo' }
+    it { should match('/foo/bar') .capturing foo: 'foo/bar' }
+
+    it { should expand                  .to('/')        }
+    it { should expand(foo:  nil)       .to('/')        }
+    it { should expand(foo:  '')        .to('/')        }
+    it { should expand(foo: 'foo')      .to('/foo')     }
+    it { should expand(foo: 'foo/bar')  .to('/foo/bar') }
+    it { should expand(foo: 'foo.bar')  .to('/foo.bar') }
+
+    it { should generate_template('/{+foo}') }
+  end
+
+  pattern '/:foo(.*)' do
+    it { should match('/')        .capturing foo: '' }
+    it { should match('/foo')     .capturing foo: 'foo' }
+    it { should match('/foo/bar') .capturing foo: 'foo/bar' }
+
+    it { should expand(foo:  '')        .to('/')        }
+    it { should expand(foo: 'foo')      .to('/foo')     }
+    it { should expand(foo: 'foo/bar')  .to('/foo/bar') }
+    it { should expand(foo: 'foo.bar')  .to('/foo.bar') }
+
+    it { should generate_template('/{foo}') }
+  end
+
+  pattern '/:foo(\d+)' do
+    it { should_not match('/')    }
+    it { should_not match('/foo') }
+    it { should match('/15') .capturing foo: '15' }
+    it { should generate_template('/{foo}') }
+  end
+
+  pattern '/:foo(\d+|bar)' do
+    it { should_not match('/')    }
+    it { should_not match('/foo') }
+    it { should match('/15')  .capturing foo: '15' }
+    it { should match('/bar') .capturing foo: 'bar' }
+    it { should generate_template('/{foo}') }
+  end
+
+  pattern '/:foo(\))' do
+    it { should_not match('/')    }
+    it { should_not match('/foo') }
+    it { should match('/)').capturing foo: ')' }
+    it { should generate_template('/{foo}') }
+  end
+
+  pattern '/:foo(prefix(\d+|bar))' do
+    it { should_not match('/prefix')    }
+    it { should_not match('/prefixfoo') }
+    it { should match('/prefix15')  .capturing foo: 'prefix15' }
+    it { should match('/prefixbar') .capturing foo: 'prefixbar' }
+    it { should generate_template('/{foo}') }
+  end
+
+  pattern '/(.+)' do
+    it { should_not match('/') }
+    it { should match('/foo')     .capturing splat: 'foo' }
+    it { should match('/foo/bar') .capturing splat: 'foo/bar' }
+    it { should generate_template('/{+splat}') }
+  end
+
+  pattern '/(foo(a|b))' do
+    it { should_not match('/') }
+    it { should match('/fooa') .capturing splat: 'fooa' }
+    it { should match('/foob') .capturing splat: 'foob' }
+    it { should generate_template('/{+splat}') }
+  end
+
+  context 'invalid syntax' do
+    example 'unexpected closing parenthesis' do
+      expect { Mustermann::Express.new('foo)bar') }.
+        to raise_error(Mustermann::ParseError, 'unexpected ) while parsing "foo)bar"')
+    end
+
+    example 'missing closing parenthesis' do
+      expect { Mustermann::Express.new('foo(bar') }.
+        to raise_error(Mustermann::ParseError, 'unexpected end of string while parsing "foo(bar"')
+    end
+
+    example 'unexpected ?' do
+      expect { Mustermann::Express.new('foo?bar') }.
+        to raise_error(Mustermann::ParseError, 'unexpected ? while parsing "foo?bar"')
+    end
+
+    example 'unexpected *' do
+      expect { Mustermann::Express.new('foo*bar') }.
+        to raise_error(Mustermann::ParseError, 'unexpected * while parsing "foo*bar"')
+    end
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: mustermann-express
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Konstantin Haase
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mustermann
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+description: Adds express.js style patterns to Mustermman
+email: konstantin.mailinglists@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/mustermann/express.rb
+- mustermann-express.gemspec
+- spec/express_spec.rb
+homepage: https://github.com/rkh/mustermann
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Express.js syntax for Mustermann
+test_files:
+- spec/express_spec.rb
+has_rdoc: