mustermann-grape 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55697b38c24285593dccd82d84d78475a68e9f85c097215dd34361755a532c0d
-  data.tar.gz: 10c154f103a904e122a996423225981f3f00e3ec831737b7c34ef9db85ed8d23
+  metadata.gz: 6ccb4995f214f92cb170ebaaf19eb1eb25936ab3d578020cf08a36a0adf50101
+  data.tar.gz: fb6d1a61a8ab987fba38e6b356c4ff6dffb59961de9767a03cde70f0b41b3b95
 SHA512:
-  metadata.gz: f62d87d318ea717f8da907fd77be82b80ec4332c8912f4a6b28ac771b9c83fe35a2f70503c99c224a5e661d6e5ca8d5bd3b8b2d5ce2d74e028bafef220089d81
-  data.tar.gz: 72de2d4f7012efa3f5054065d1585f5aca004c60f7567353959bb0d380f8f4f2fb11a25f02155eb6cec247d10bc9253e9050aba66602af76d1d8df0c1d2c02cb
+  metadata.gz: da5216e8f3905d70bf4f42893c67519171cf538f13c380fc4e1ea07ba516ba2b5b5e1ac728d76da7a5abdc72449ee6c2fcebea708a15346e70d4492dab150175
+  data.tar.gz: 34259f47c0ac7accb57e222cd47290bb8a45981a169ed4399ab321321e65c90f27a878475d25f57fd50aa6c952c373b10a40b212df3eb07d5a11486d5da2ae65

data/.github/workflows/tests.yml

@@ -0,0 +1,22 @@
+name: tests
+on:
+  [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### 1.1.0 (2023/11/24)
+
+#### Fixes
+
+* [#21](https://github.com/ruby-grape/mustermann-grape/pull/21): Introducing the `params` option to `Mustermann::Grape` to enhance matching by offering detailed information regarding the parameter types. - [@jcagarcia](https://github.com/jcagarcia).

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright Mustermann-Grape Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -2,17 +2,22 @@
 
 This gem implements the `grape` pattern type for Mustermann.
 
-[![Build Status](https://travis-ci.org/ruby-grape/mustermann-grape.svg?branch=master)](https://travis-ci.org/ruby-grape/mustermann-grape)
+[![tests](https://github.com/ruby-grape/mustermann-grape/workflows/tests/badge.svg)](https://github.com/ruby-grape/mustermann-grape/actions?query=workflow%3Atests)
 
 ## Overview
 
 **Supported options:**
-`capture`, `except`, `greedy`, `space_matches_plus`, `uri_decode`, `converters` and `ignore_unknown_options`
+`capture`, `converters`, `except`, `greedy`, `ignore_unknown_options`, `params`, `space_matches_plus` and `uri_decode`
 
 ``` ruby
 require 'mustermann/grape'
 
 Mustermann.new('/:id', type: :grape).params('/foo') # => { id: 'foo' }
+
+# Providing params option
+Mustermann.new('/:id', type: :grape, params: {"id"=>{:type=>"Integer"}}).params('/1') # => { id: '1'}
+Mustermann.new('/:id', type: :grape, params: {"id"=>{:type=>"Integer"}}).params('/foo') # => nil
+Mustermann.new('/:id', type: :grape, params: {"id"=>{:type=>"String"}}).params('/foo') # => { id: 'foo'}
 ```
 
 ## Syntax

data/lib/mustermann/grape/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MustermannGrape
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/lib/mustermann/grape.rb

@@ -13,11 +13,28 @@ module Mustermann
   # @see file:README.md#grape Syntax description in the README
   class Grape < AST::Pattern
     register :grape
+    supported_options :params
 
     on(nil, '?', ')') { |c| unexpected(c) }
 
     on('*')  { |_c| scan(/\w+/) ? node(:named_splat, buffer.matched) : node(:splat) }
-    on(':')  { |_c| node(:capture, constraint: "[^/\\?#\.]") { scan(/\w+/) } }
+    on(':')  do |_c|
+      param_name = scan(/\w+/)
+      return node(:capture, param_name, constraint: "[^/\\?#\.]") { scan(/\w+/) } unless pattern
+
+      params_opt = pattern.options[:params]
+      if params_opt && params_opt[param_name] && params_opt[param_name][:type]
+        param_type = params_opt[param_name][:type]
+        case(param_type)
+        when "Integer"
+          node(:capture, param_name, constraint: /\d/) { scan(/\w+/) }
+        else
+          node(:capture, param_name, constraint: "[^/\\?#\.]") { scan(/\w+/) }
+        end
+      else
+        node(:capture, param_name, constraint: "[^/\\?#\.]") { scan(/\w+/) }
+      end
+    end
     on('\\') { |_c| node(:char, expect(/./)) }
     on('(')  { |_c| node(:optional, node(:group) { read unless scan(')') }) }
     on('|')  { |_c| node(:or) }

data/spec/grape_spec.rb

@@ -751,4 +751,33 @@ describe Mustermann::Grape do
       example { pattern.peek_params('/foo bar')       .should be_nil }
     end
   end
+
+  context 'when params option is provided' do
+    context 'and they contain parameters information' do
+      pattern '/foo/:id', params: {"id"=>{:type=>"Integer"}} do
+        it { should     match('/foo/1')     }
+        it { should_not match('/foo/bar') }
+      end
+
+      context 'and inherit routes are present' do
+        pattern '/foo/:id/bar/:reference', params: {"id"=>{:type=>"Integer"}, "reference"=>{:type=>"String"}} do
+          it { should     match('/foo/1/bar/wadus')     }
+          it { should_not match('/foo/bar/bar/wadus') }
+        end
+
+        pattern '/foo/:id/bar/:reference', params: {"id"=>{:type=>"Integer"}, "reference"=>{:type=>"Integer"}} do
+          it { should     match('/foo/1/bar/1')     }
+          it { should_not match('/foo/1/bar/wadus') }
+          it { should_not match('/foo/bar/bar/1') }
+        end
+      end
+    end
+
+    context 'and they do NOT contain parameters information' do
+      pattern '/foo/:id' do
+        it { should match('/foo/1') }
+        it { should match('/foo/bar') }
+      end
+    end
+  end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: mustermann-grape
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - namusyaka
 - Konstantin Haase
 - Daniel Doubrovkine
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2023-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustermann
@@ -32,9 +32,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".travis.yml"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - lib/mustermann/grape.rb
@@ -46,7 +49,7 @@ homepage: https://github.com/ruby-grape/mustermann-grape
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -61,8 +64,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Grape syntax for Mustermann
 test_files:

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-
-cache: bundler

data/Gemfile.lock

@@ -1,98 +0,0 @@
-GIT
-  remote: https://github.com/sinatra/mustermann.git
-  revision: db86e25f786c717dbe937d862a5ba0d35a58797b
-  specs:
-    mustermann (1.1.0)
-      ruby2_keywords (~> 0.0.1)
-    support (0.0.1)
-      addressable
-      coveralls
-      rack-test
-      rake
-      redcarpet
-      rspec
-      rspec-its
-      simplecov
-      sinatra (~> 1.4)
-      tool (~> 0.2)
-      yard
-
-PATH
-  remote: .
-  specs:
-    mustermann-grape (1.0.1)
-      mustermann (>= 1.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    coveralls (0.7.2)
-      multi_json (~> 1.3)
-      rest-client (= 1.6.7)
-      simplecov (>= 0.7)
-      term-ansicolor (= 1.2.2)
-      thor (= 0.18.1)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    json (2.3.0)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
-    multi_json (1.14.1)
-    public_suffix (4.0.2)
-    rack (1.6.12)
-    rack-protection (1.5.5)
-      rack
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rake (13.0.1)
-    redcarpet (3.5.0)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-its (1.3.0)
-      rspec-core (>= 3.0.0)
-      rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.9.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    ruby2_keywords (0.0.1)
-    simplecov (0.17.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    sinatra (1.4.8)
-      rack (~> 1.5)
-      rack-protection (~> 1.4)
-      tilt (>= 1.3, < 3)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
-    thor (0.18.1)
-    tilt (2.0.10)
-    tins (0.13.2)
-    tool (0.2.3)
-    yard (0.9.20)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  mustermann-grape!
-  rake
-  rspec-core
-  support!
-
-BUNDLED WITH
-   2.1.2