mustermann-cake 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b67e070f799e3a83b1420f4b14232664d0f0d1c
+  data.tar.gz: 8f2f5810ea3f2f9f6d709472ec9f3c377213489d
+SHA512:
+  metadata.gz: ccbe8220e866c11c742c49f3fb4fa8320f554e40551f45841c39d82e5bae325543216df9a448b2efc8d25cb6a2b84419390932881c05ff2621a85bc9d450e797
+  data.tar.gz: f96e25b053018916c04561878d38462a4c154ed7903a9d10e4c33a240f45584fad4396d397df743d7885641ecb807c7c26e1314939177ac613333e468f948ebf

data/README.md

@@ -0,0 +1,74 @@
+# 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.
+
+## Overview
+
+**Supported options:**
+`capture`, `except`, `greedy`, `space_matches_plus`, `uri_decode`, and `ignore_unknown_options`.
+
+**External documentation:**
+[CakePHP 2.0 Routing](http://book.cakephp.org/2.0/en/development/routing.html),
+[CakePHP 3.0 Routing](http://book.cakephp.org/3.0/en/development/routing.html)
+
+CakePHP patterns feature captures and unnamed splats. Captures are prefixed with a colon and splats are either a single asterisk (parsing segments into an array) or a double asterisk (parsing segments as a single string).
+
+``` ruby
+require 'mustermann/cake'
+
+Mustermann.new('/:name/*',  type: :cake).params('/a/b/c') # => { name: 'a', splat: ['b', 'c'] }
+Mustermann.new('/:name/**', type: :cake).params('/a/b/c') # => { name: 'a', splat: 'b/c' }
+
+pattern = Mustermann.new('/:name')
+
+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></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></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.
+        The value matching a single <tt>**</tt> will be split at slashes when parsed into <tt>params</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/cake.rb

@@ -0,0 +1,18 @@
+require 'mustermann'
+require 'mustermann/ast/pattern'
+
+module Mustermann
+  # CakePHP style pattern implementation.
+  #
+  # @example
+  #   Mustermann.new('/:foo', type: :cake) === '/bar' # => true
+  #
+  # @see Mustermann::Pattern
+  # @see file:README.md#cake Syntax description in the README
+  class Cake < AST::Pattern
+    register :cake
+
+    on(?:) { |c| node(:capture) { scan(/\w+/) } }
+    on(?*) { |c| node(:splat, convert: (-> e { e.split('/') } unless scan(?*))) }
+  end
+end

data/mustermann-cake.gemspec

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path("../../mustermann/lib", __FILE__)
+require "mustermann/version"
+
+Gem::Specification.new do |s|
+  s.name                  = "mustermann-cake"
+  s.version               = Mustermann::VERSION
+  s.author                = "Konstantin Haase"
+  s.email                 = "konstantin.mailinglists@googlemail.com"
+  s.homepage              = "https://github.com/rkh/mustermann"
+  s.summary               = %q{CakePHP syntax for Mustermann}
+  s.description           = %q{Adds CakePHP 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/cake_spec.rb

@@ -0,0 +1,90 @@
+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

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: mustermann-cake
+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 CakePHP style patterns to Mustermman
+email: konstantin.mailinglists@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/mustermann/cake.rb
+- mustermann-cake.gemspec
+- spec/cake_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: CakePHP syntax for Mustermann
+test_files:
+- spec/cake_spec.rb
+has_rdoc: