grape-path-helpers 1.4.0 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6a9a810d64b890207e58f89f7da7a104827f733953c85e8487d10f45caf14d6
-  data.tar.gz: b76980cef67c4967fc4b4f49bb736603e67d74579624738ed5affd11317fa681
+  metadata.gz: 2bc6c862d4ba4b9cedabaafaf461382721dd87e45cc7796ff13d9a7c643d1d46
+  data.tar.gz: d1198670aad0447e4b50821a19e460daced596a51de2ddc0155fd6adea5146aa
 SHA512:
-  metadata.gz: 990b3eebe65bae4d982c98900e7a44d9b5a5b992383354bb696612fd27ba90c1738ae28c06c3f679ca854098e03bfbdc2fa30a3471f1e7da03a19006f5262b2e
-  data.tar.gz: 27e9befba4f4a89a61372bceadc45c27f55d492012cdfa56519e1aed030690c1cdb97591635f317baf225ef6a63788adbcd091e7e37c3abd4ef919ee938bb177
+  metadata.gz: 729437ba35e3b8d4e2133dc96d11c9b5eca8a40965099acee11c7795f0514248bf7d45a824bc13cfceeb02e31fff0057f1a8ead11bc9e2f6d629af1b17910ed3
+  data.tar.gz: 520a330a0d892189dc2bd4862a717b41423f7c98794082592a961fdddbdee4342b1dbad0a94a9a4a98dbee2fa05c58bdc4c6ff398cddfbd74ad206622fb09fce

data/.gitlab-ci.yml

@@ -1,8 +1,9 @@
-image: "ruby:2.6-alpine"
+image: "ruby:3.0-alpine"
 
 cache:
   paths:
     - vendor/ruby
+  key: ruby-3.0
 
 before_script:
   - apk add --update git

data/.rubocop.yml

@@ -8,3 +8,7 @@ Metrics/MethodLength:
 
 Style/FileName:
  Enabled: false
+
+# Removed in newer versions of Rubocop
+Lint/SplatKeywordArguments:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 1.6.3
+
+* [Fix route matcher when method ends in path and arg isn't a Hash](https://gitlab.com/gitlab-org/grape-path-helpers/-/merge_requests/35)
+
+## 1.6.2
+
+* [Improve performance of route matching](https://gitlab.com/gitlab-org/grape-path-helpers/-/merge_requests/33)
+
+## 1.6.1
+
+* [Use ruby2_keywords to fix 2.7 warning](https://gitlab.com/gitlab-org/grape-path-helpers/-/merge_requests/31)
+
+## 1.6.0
+
+* [Extract kwargs to fix 2.7 warnings](https://gitlab.com/gitlab-org/grape-path-helpers/-/merge_requests/29)
+
+## 1.5.0
+
+* [Relax rake dependency](https://gitlab.com/gitlab-org/grape-path-helpers/-/merge_requests/27)
+
 ## 1.4.0
 
 * [Support using a base class other than Grape::API::Instance](https://gitlab.com/gitlab-org/grape-path-helpers/-/merge_requests/23)

data/Gemfile.lock

@@ -1,58 +1,55 @@
 PATH
   remote: .
   specs:
-    grape-path-helpers (1.4.0)
+    grape-path-helpers (1.6.3)
       activesupport
       grape (~> 1.3)
-      rake (~> 12)
+      rake (> 12)
+      ruby2_keywords (~> 0.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.4)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.0)
     builder (3.2.4)
     coderay (1.1.2)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.3)
-    dry-configurable (0.11.6)
+    dry-configurable (0.12.1)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-      dry-equalizer (~> 0.2)
+      dry-core (~> 0.5, >= 0.5.0)
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
+    dry-core (0.5.0)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
-    dry-logic (1.0.8)
+    dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-types (1.4.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-types (1.5.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
-      dry-core (~> 0.4, >= 0.4.4)
-      dry-equalizer (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    grape (1.5.0)
+    grape (1.5.3)
       activesupport
       builder
       dry-types (>= 1.1)
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     method_source (0.9.0)
-    minitest (5.14.2)
+    minitest (5.14.4)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     mustermann-grape (1.0.1)
@@ -68,7 +65,7 @@ GEM
     rack-accept (0.4.5)
       rack (>= 0.4)
     rainbow (3.0.0)
-    rake (12.3.3)
+    rake (13.0.3)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -90,12 +87,11 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
-    ruby2_keywords (0.0.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    ruby2_keywords (0.0.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.3.3)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -107,4 +103,4 @@ DEPENDENCIES
   rubocop (~> 0.56)
 
 BUNDLED WITH
-   1.17.3
+   2.2.3

data/grape-path-helpers.gemspec

@@ -13,7 +13,8 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'activesupport'
   gem.add_runtime_dependency 'grape', '~> 1.3'
-  gem.add_runtime_dependency 'rake', '~> 12'
+  gem.add_runtime_dependency 'rake', '> 12'
+  gem.add_runtime_dependency 'ruby2_keywords', '~> 0.0.2'
 
   gem.add_development_dependency 'pry', '~> 0.11'
   gem.add_development_dependency 'rspec', '~> 3.7'

data/lib/grape-path-helpers/decorated_route.rb

@@ -147,10 +147,10 @@ module GrapePathHelpers
     def uses_segments_in_path_helper?(segments)
       segments = segments.reject { |x| special_keys.include?(x) }
 
-      if required_helper_segments.empty? && segments.any?
+      if helper_arguments.empty? && segments.any?
         false
       else
-        required_helper_segments.all? { |x| segments.include?(x) }
+        helper_arguments.all? { |x| segments.include?(x) }
       end
     end
 

data/lib/grape-path-helpers/named_route_matcher.rb

@@ -3,21 +3,26 @@ module GrapePathHelpers
   # to unknown methods will look for a route with a matching
   # helper function name
   module NamedRouteMatcher
-    def method_missing(method_id, *arguments)
+    def method_missing(method_id, *args)
       return super unless method_id.to_s =~ /_path$/
 
-      segments = arguments.first || {}
+      segments = args.first || {}
+
+      return super unless segments.is_a?(Hash)
+
+      requested_segments = segments.keys.map(&:to_s)
 
       route = Grape::API::Instance.decorated_routes.detect do |r|
-        route_match?(r, method_id, segments)
+        route_match?(r, method_id, requested_segments)
       end
 
       if route
-        route.send(method_id, *arguments)
+        route.send(method_id, *args)
       else
         super
       end
     end
+    ruby2_keywords(:method_missing)
 
     def respond_to_missing?(method_name, _include_private = false)
       return super unless method_name =~ /_path$/
@@ -29,12 +34,9 @@ module GrapePathHelpers
       super
     end
 
-    def route_match?(route, method_name, segments)
+    def route_match?(route, method_name, requested_segments)
       return false unless route.respond_to?(method_name)
-      # rubocop:disable Metrics/LineLength
-      raise ArgumentError, 'Helper options must be a hash' unless segments.is_a?(Hash)
-      # rubocop:enable Metrics/LineLength
-      requested_segments = segments.keys.map(&:to_s)
+
       route.uses_segments_in_path_helper?(requested_segments)
     end
   end

data/lib/grape-path-helpers/version.rb

@@ -1,4 +1,4 @@
 # Gem version
 module GrapePathHelpers
-  VERSION = '1.4.0'.freeze
+  VERSION = '1.6.3'.freeze
 end

data/spec/grape_path_helpers/named_route_matcher_spec.rb

@@ -30,8 +30,8 @@ describe GrapePathHelpers::NamedRouteMatcher do
     fake_class = Class.new do
       prepend GrapePathHelpers::NamedRouteMatcher
 
-      def method_missing(_method_id, *_args)
-        'whatever' || super
+      def method_missing(method_id, *args, **kwargs)
+        [method_id, args, kwargs] || super
       end
 
       def respond_to_missing?(_method_name, _include_private = false)
@@ -46,13 +46,29 @@ describe GrapePathHelpers::NamedRouteMatcher do
     it 'returns super method_missing if the method does not end with path' do
       expect(Grape::API::Instance).not_to receive(:decorated_routes)
 
-      helper_class.test_method
+      expect(helper_class.test_method(:arg1, kwarg1: :kwarg1))
+        .to eq([:test_method, [:arg1], { kwarg1: :kwarg1 }])
     end
 
-    it 'search for the route if the method ends with path' do
-      expect(Grape::API::Instance).to receive(:decorated_routes).and_call_original # rubocop:disable Metrics/LineLength
+    context 'when method ends with path' do
+      it 'returns super method_missing if first arg is not a hash' do
+        expect(Grape::API::Instance).not_to receive(:decorated_routes)
+
+        expect(helper_class.test_method_path(:arg1, kwarg1: :kwarg1))
+          .to eq([:test_method_path, [:arg1], { kwarg1: :kwarg1 }])
+      end
+
+      it 'search for the route if there are no args' do
+        expect(Grape::API::Instance).to receive(:decorated_routes).and_call_original # rubocop:disable Metrics/LineLength
+
+        helper_class.test_method_path
+      end
+
+      it 'search for the route if the first arg is a hash' do
+        expect(Grape::API::Instance).to receive(:decorated_routes).and_call_original # rubocop:disable Metrics/LineLength
 
-      helper_class.test_method_path
+        helper_class.test_method_path(id: 5)
+      end
     end
   end
 
@@ -62,14 +78,6 @@ describe GrapePathHelpers::NamedRouteMatcher do
       let(:method_name) { :api_v1_ping_path }
       let(:segments) { {} }
 
-      context 'when segments is not a hash' do
-        it 'raises an ArgumentError' do
-          expect do
-            route_match?(route, method_name, 1234)
-          end.to raise_error(ArgumentError)
-        end
-      end
-
       it 'returns true' do
         is_match = route_match?(route, method_name, segments)
         expect(is_match).to eq(true)
@@ -105,7 +113,7 @@ describe GrapePathHelpers::NamedRouteMatcher do
         context 'when route requires the requested segments' do
           let(:route) { show_route }
           let(:method_name) { :api_v1_cats_path }
-          let(:segments) { { id: 1 } }
+          let(:segments) { { 'id' => 1 } }
 
           it 'returns true' do
             is_match = route_match?(route, method_name, segments)
@@ -114,7 +122,7 @@ describe GrapePathHelpers::NamedRouteMatcher do
         end
 
         context 'when route does not require the requested segments' do
-          let(:segments) { { some_option: 'some value' } }
+          let(:segments) { { 'some_option' => 'some value' } }
 
           it 'returns false' do
             is_match = route_match?(route, method_name, segments)
@@ -124,7 +132,7 @@ describe GrapePathHelpers::NamedRouteMatcher do
       end
 
       context 'when segments contains unexpected options' do
-        let(:segments) { { some_option: 'some value' } }
+        let(:segments) { { 'some_option' => 'some value' } }
 
         it 'returns false' do
           is_match = route_match?(route, method_name, segments)
@@ -189,14 +197,6 @@ describe GrapePathHelpers::NamedRouteMatcher do
         path = api_v1_ping_path
         expect(path).to eq('/api/v1/ping.json')
       end
-
-      context 'when argument to the helper is not a hash' do
-        it 'raises an ArgumentError' do
-          expect do
-            api_v1_ping_path(1234)
-          end.to raise_error(ArgumentError)
-        end
-      end
     end
 
     context 'when method name does not match a Grape::Route path helper name' do

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: grape-path-helpers
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.3
 platform: ruby
 authors:
 - Drew Blessing
 - Harper Henn
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-14 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,16 +43,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '12'
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -131,7 +145,7 @@ homepage: https://gitlab.com/gitlab-org/grape-path-helpers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -146,8 +160,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Route path helpers for Grape
 test_files: []