grape-path-helpers 1.3.0 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d73093a0f054919e2ad15c91772f4e7efac0ce0197d49d3be5ad5175df80a98
-  data.tar.gz: a1e486c0b0c076edc6c6bc5411184c97fbd2e5e861b83747e1d273faffdf0ba3
+  metadata.gz: 8734d9daeae94b2a878f9fc18e9c178546e3228132df7ed03a0b3e1ab4de9a2c
+  data.tar.gz: 7151c3498b0957a40be8fdf9751aea18a62628c01379a5861116c5f855910c60
 SHA512:
-  metadata.gz: 5491f91f2177f6ee3ba5575255a1e693dd6edae69da9a1733a5479e8a2478007b2c07abe0f5d1ac8d01e234dfeae1f45c4ae1fcc3982bb23854a3da16f0def0a
-  data.tar.gz: f93f9038b288580fe66cc166993eb58dcfb1fa34cde384c49c03fde0d6f1c33961a6b98622a1ab16099dcd92a40b5217ecce965ba6c0649d80db4f5d276fd8fd
+  metadata.gz: 0fecfaaab23602b4cc8f50a4a9356e228d69909b36f799000bce239798e443f35cb3aa0d2367d9980a0e58c41dd4f5671c501dab08a6fb94bfffb5148652d200
+  data.tar.gz: a6c4dd8fb3cd7bb33a96687a94ac0e96733af8ecfe5096f781b32139c3518b96295763405086d05389f54adf66bf96bd4940352cf322c5135158f274f0420c11

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.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)
+
 ## 1.3.0
 
 * [Upgrade to Grape 1.3.1](https://gitlab.com/gitlab-org/grape-path-helpers/-/merge_requests/21)

data/Gemfile.lock

@@ -1,40 +1,39 @@
 PATH
   remote: .
   specs:
-    grape-path-helpers (1.3.0)
+    grape-path-helpers (1.6.2)
       activesupport
       grape (~> 1.3)
-      rake (~> 12)
+      rake (> 12)
+      ruby2_keywords (~> 0.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.1)
+    activesupport (6.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 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.6)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.3)
-    dry-configurable (0.11.3)
+    dry-configurable (0.12.0)
       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.6)
+    dry-logic (1.1.0)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
+      dry-core (~> 0.5, >= 0.5)
     dry-types (1.4.0)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
@@ -42,17 +41,17 @@ GEM
       dry-equalizer (~> 0.3)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    grape (1.3.1)
+    grape (1.5.1)
       activesupport
       builder
       dry-types (>= 1.1)
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-    i18n (1.8.2)
+    i18n (1.8.7)
       concurrent-ruby (~> 1.0)
     method_source (0.9.0)
-    minitest (5.14.0)
+    minitest (5.14.3)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     mustermann-grape (1.0.1)
@@ -64,11 +63,11 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (2.2.2)
+    rack (2.2.3)
     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)
@@ -91,11 +90,10 @@ GEM
       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.6)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.3.3)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -107,4 +105,4 @@ DEPENDENCIES
   rubocop (~> 0.56)
 
 BUNDLED WITH
-   1.17.3
+   2.2.3

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'bundler'
+require 'bundler/gem_tasks'
 
 Bundler.setup :default, :test, :development
 

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/all_routes.rb

@@ -11,7 +11,7 @@ module GrapePathHelpers
     end
 
     def all_routes
-      routes = subclasses.flat_map { |s| s.send(:prepare_routes) }
+      routes = descendants.flat_map { |s| s.send(:prepare_routes) }
       routes.uniq { |r| r.options.merge(path: r.path) }
     end
   end

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,28 @@ 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 || {}
+
+      # 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 = 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 +36,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.3.0'.freeze
+  VERSION = '1.6.2'.freeze
 end

data/spec/grape_path_helpers/all_routes_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 
+# rubocop:disable Metrics/BlockLength
 describe GrapePathHelpers::AllRoutes do
   Grape::API::Instance.extend described_class
 
@@ -32,6 +33,14 @@ describe GrapePathHelpers::AllRoutes do
         expect(all_routes.map(&:path)).to include(*expected_routes)
       end
     end
+
+    context 'when an API is created via an intermediate class' do
+      it 'includes those routes on both Grape::API::Instance and the base class' do
+        expect(Spec::Support::BaseAPI.all_routes.map(&:origin)).to include('/derived_ping')
+        expect(Grape::API::Instance.all_routes.map(&:origin)).to include('/derived_ping')
+      end
+    end
     # rubocop:enable Metrics/LineLength
   end
 end
+# rubocop:enable Metrics/BlockLength

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,7 +46,8 @@ 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
@@ -54,6 +55,14 @@ describe GrapePathHelpers::NamedRouteMatcher do
 
       helper_class.test_method_path
     end
+
+    context 'when segments is not a hash' do
+      it 'raises an ArgumentError' do
+        expect do
+          helper_class.test_method_path(1234)
+        end.to raise_error(ArgumentError)
+      end
+    end
   end
 
   describe '#route_match?' do
@@ -62,14 +71,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 +106,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 +115,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 +125,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)

data/spec/support/api.rb

@@ -81,5 +81,14 @@ module Spec
         end
       end
     end
+
+    class BaseAPI < Grape::API::Instance
+    end
+
+    class DerivedAPI < BaseAPI
+      get 'derived_ping' do
+        'pong'
+      end
+    end
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: grape-path-helpers
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.6.2
 platform: ruby
 authors:
 - Drew Blessing
 - Harper Henn
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-15 00:00:00.000000000 Z
+date: 2021-05-06 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: []