mustermann-grape 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53d8315ebe7d6f7d074dc0477fdac54e0f8c420450f30406c8d742f274dfd72f
-  data.tar.gz: a9bc253a7d11d2c84d027703b186a1e7b04b980820416565af140024f65e6b2f
+  metadata.gz: 6ccb4995f214f92cb170ebaaf19eb1eb25936ab3d578020cf08a36a0adf50101
+  data.tar.gz: fb6d1a61a8ab987fba38e6b356c4ff6dffb59961de9767a03cde70f0b41b3b95
 SHA512:
-  metadata.gz: acde3ddbc4e0580de9232ae572f9a94cc5b80b5a56a9c5e75edbd7abb165dfeef1cd59ea40bf00aa3231beb8565d68273980af99fe817f1da5d58b47af77f41b
-  data.tar.gz: b804417c751c40c11bae887170748f640a7973c2343e26a9b3c15af466f963e7d67439f264d8b3b813ab61f6da347360cd9d85f656e620e52ab867861f81fc1d
+  metadata.gz: da5216e8f3905d70bf4f42893c67519171cf538f13c380fc4e1ea07ba516ba2b5b5e1ac728d76da7a5abdc72449ee6c2fcebea708a15346e70d4492dab150175
+  data.tar.gz: 34259f47c0ac7accb57e222cd47290bb8a45981a169ed4399ab321321e65c90f27a878475d25f57fd50aa6c952c373b10a40b212df3eb07d5a11486d5da2ae65

data/.github/workflows/tests.yml

@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: ['2.5', '2.6', '2.7']
+        ruby-version: ['2.6', '2.7', '3.0']
 
     steps:
       - uses: actions/checkout@v3
@@ -19,5 +19,4 @@ jobs:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true
       - name: Run tests
-        run: bundle exec rake
-        
+        run: bundle exec rspec

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/README.md

@@ -7,12 +7,17 @@ This gem implements the `grape` pattern type for Mustermann.
 ## 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.2'
+  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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mustermann-grape
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - namusyaka
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2023-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustermann
@@ -34,6 +34,8 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/tests.yml"
 - ".gitignore"
+- ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -62,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Grape syntax for Mustermann