grape-path-helpers 1.6.2 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8734d9daeae94b2a878f9fc18e9c178546e3228132df7ed03a0b3e1ab4de9a2c
-  data.tar.gz: 7151c3498b0957a40be8fdf9751aea18a62628c01379a5861116c5f855910c60
+  metadata.gz: 8df03144931341081ba2a02ba59cc45d6a74cc55a5d465d40cf8a333c5032ac1
+  data.tar.gz: 1a173198fadb720a0aa3a23632f2657ba24425fae84720dcf3703d3e8281fd71
 SHA512:
-  metadata.gz: 0fecfaaab23602b4cc8f50a4a9356e228d69909b36f799000bce239798e443f35cb3aa0d2367d9980a0e58c41dd4f5671c501dab08a6fb94bfffb5148652d200
-  data.tar.gz: a6c4dd8fb3cd7bb33a96687a94ac0e96733af8ecfe5096f781b32139c3518b96295763405086d05389f54adf66bf96bd4940352cf322c5135158f274f0420c11
+  metadata.gz: 855800980e102dc069cac30f31f85d77e0e8681fdd312b1a0d574151b9331ebd34fbb1b7756c06cd0ca4602f865b6d585841eef0da1b38cacf9e3b117b964b4d
+  data.tar.gz: ddeb1c0471150615131ed8d2af3c7dfc2b5ad9254c9f6046d0dd43d2e589511935a13107bf59502df3d6f8f7d378bedfee8bc04025f2aaec17537e9c29ac798a

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.7.1
+
+* Fix undefined method error (https://gitlab.com/gitlab-org/grape-path-helpers/-/merge_requests/42)
+
+## 1.7.0
+
+* [Further improve performance of route matching](https://gitlab.com/gitlab-org/grape-path-helpers/-/merge_requests/38)
+
+## 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)

data/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+## Developer Certificate of Origin and License
+
+By contributing to GitLab B.V., you accept and agree to the following terms and
+conditions for your present and future contributions submitted to GitLab B.V.
+Except for the license granted herein to GitLab B.V. and recipients of software
+distributed by GitLab B.V., you reserve all right, title, and interest in and to
+your Contributions.
+
+All contributions are subject to the Developer Certificate of Origin and license set out at [docs.gitlab.com/ce/legal/developer_certificate_of_origin](https://docs.gitlab.com/ce/legal/developer_certificate_of_origin).
+
+_This notice should stay as the first item in the CONTRIBUTING.md file._
+
+## Code of conduct
+
+As contributors and maintainers of this project, we pledge to respect all people
+who contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual
+language or imagery, derogatory comments or personal attacks, trolling, public
+or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct. Project maintainers who do not follow the
+Code of Conduct may be removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior can be
+reported by emailing contact@gitlab.com.
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org), version 1.1.0,
+available at [https://contributor-covenant.org/version/1/1/0/](https://contributor-covenant.org/version/1/1/0/).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape-path-helpers (1.6.2)
+    grape-path-helpers (1.7.1)
       activesupport
       grape (~> 1.3)
       rake (> 12)
@@ -10,51 +10,44 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.1)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.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.10)
     diff-lcs (1.3)
-    dry-configurable (0.12.0)
+    dry-container (0.10.1)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5.0)
-    dry-container (0.7.2)
+    dry-core (0.8.1)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.5.0)
-      concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
-    dry-inflector (0.2.0)
-    dry-logic (1.1.0)
+    dry-inflector (0.3.0)
+    dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
-    dry-types (1.4.0)
+    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.1)
+    grape (1.6.2)
       activesupport
       builder
       dry-types (>= 1.1)
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-    i18n (1.8.7)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     method_source (0.9.0)
-    minitest (5.14.3)
-    mustermann (1.1.1)
+    minitest (5.16.2)
+    mustermann (3.0.0)
       ruby2_keywords (~> 0.0.1)
-    mustermann-grape (1.0.1)
+    mustermann-grape (1.0.2)
       mustermann (>= 1.0.0)
     parallel (1.12.1)
     parser (2.5.1.0)
@@ -63,11 +56,11 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (2.2.3)
+    rack (2.2.4)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -89,11 +82,10 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
-    ruby2_keywords (0.0.2)
-    tzinfo (2.0.4)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.3.3)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -8,10 +8,6 @@ Provides named route helpers for Grape APIs, similar to [Rails' route helpers](h
 
 ### Installation
 
-#### Compatibility with Grape
-
-If you're using grape 0.16.0 or higher, you'll need version 2.0.0 or higher of grape-path-helpers.
-
 #### Rails
 
 p 1.) Add the gem to your Gemfile.

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

@@ -3,11 +3,24 @@ module GrapePathHelpers
   # list of routes from all APIs and decorate them with
   # the DecoratedRoute class
   module AllRoutes
-    def decorated_routes
-      # memoize so that construction of decorated routes happens once
-      @decorated_routes ||= all_routes
-                            .map { |r| DecoratedRoute.new(r) }
-                            .sort_by { |r| -r.dynamic_path_segments.count }
+    def decorated_routes_by_helper_name
+      return @decorated_routes_by_helper_name if @decorated_routes_by_helper_name # rubocop:disable Metrics/LineLength
+
+      routes = {}
+
+      all_routes
+        .map { |r| DecoratedRoute.new(r) }
+        .sort_by { |r| -r.dynamic_path_segments.count }
+        .each do |route|
+          route.helper_names.each do |helper_name|
+            key = helper_name.to_sym
+
+            routes[key] ||= []
+            routes[key] << route
+          end
+        end
+
+      @decorated_routes_by_helper_name = routes
     end
 
     def all_routes

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

@@ -3,23 +3,24 @@ module GrapePathHelpers
   # to unknown methods will look for a route with a matching
   # helper function name
   module NamedRouteMatcher
-    def method_missing(method_id, *args)
-      return super unless method_id.to_s =~ /_path$/
+    def method_missing(method_name, *args)
+      return super unless method_name.end_with?('_path')
 
-      segments = args.first || {}
+      possible_routes = Grape::API::Instance
+                        .decorated_routes_by_helper_name[method_name]
+      return super unless possible_routes
 
-      # rubocop:disable Metrics/LineLength
-      raise ArgumentError, 'Helper options must be a hash' unless segments.is_a?(Hash)
-      # rubocop:enable Metrics/LineLength
+      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, requested_segments)
+      route = possible_routes.detect do |r|
+        r.uses_segments_in_path_helper?(requested_segments)
       end
 
       if route
-        route.send(method_id, *args)
+        route.send(method_name, *args)
       else
         super
       end
@@ -27,19 +28,13 @@ module GrapePathHelpers
     ruby2_keywords(:method_missing)
 
     def respond_to_missing?(method_name, _include_private = false)
-      return super unless method_name =~ /_path$/
-
-      Grape::API::Instance.decorated_routes.detect do |route|
-        return true if route.respond_to?(method_name)
-      end
-
-      super
+      grape_route_path?(method_name) || super
     end
 
-    def route_match?(route, method_name, requested_segments)
-      return false unless route.respond_to?(method_name)
-
-      route.uses_segments_in_path_helper?(requested_segments)
+    def grape_route_path?(method_name)
+      method_name.end_with?('_path') &&
+        !Grape::API::Instance
+          .decorated_routes_by_helper_name[method_name].nil?
     end
   end
 end

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

@@ -3,7 +3,12 @@ module GrapePathHelpers
   # and required arguments for every Grape::Route.
   class RouteDisplayer
     def route_attributes
-      Grape::API::Instance.decorated_routes.map do |route|
+      Grape::API::Instance
+        .decorated_routes_by_helper_name
+        .values
+        .flatten
+        .uniq
+        .map do |route|
         {
           route_path: route.route_path,
           route_method: route.route_method,

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

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

data/spec/grape_path_helpers/named_route_matcher_spec.rb

@@ -4,28 +4,6 @@ require 'spec_helper'
 describe GrapePathHelpers::NamedRouteMatcher do
   include described_class
 
-  let(:routes) do
-    Grape::API::Instance.decorated_routes
-  end
-
-  let(:ping_route) do
-    routes.detect do |route|
-      route.route_path =~ /ping/ && route.route_version == 'v1'
-    end
-  end
-
-  let(:index_route) do
-    routes.detect do |route|
-      route.route_namespace =~ /cats$/
-    end
-  end
-
-  let(:show_route) do
-    routes.detect do |route|
-      route.route_namespace =~ %r{cats/:id}
-    end
-  end
-
   let(:helper_class) do
     fake_class = Class.new do
       prepend GrapePathHelpers::NamedRouteMatcher
@@ -43,123 +21,61 @@ describe GrapePathHelpers::NamedRouteMatcher do
   end
 
   describe '#method_missing' do
-    it 'returns super method_missing if the method does not end with path' do
-      expect(Grape::API::Instance).not_to receive(:decorated_routes)
-
-      expect(helper_class.test_method(:arg1, kwarg1: :kwarg1))
-        .to eq([:test_method, [:arg1], { kwarg1: :kwarg1 }])
+    it 'returns super method_missing if the route does not exist' do
+      expect(helper_class.test_method(id: 1))
+        .to eq([:test_method, [], { id: 1 }])
     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
-
-      helper_class.test_method_path
+    it 'returns super method_missing if first arg is not a hash' do
+      expect(helper_class.api_v1_cats_path(:arg1, kwarg1: :kwarg1))
+        .to eq([:api_v1_cats_path, [:arg1], { kwarg1: :kwarg1 }])
     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
-    context 'when route responds to a method name' do
-      let(:route) { ping_route }
-      let(:method_name) { :api_v1_ping_path }
-      let(:segments) { {} }
-
-      it 'returns true' do
-        is_match = route_match?(route, method_name, segments)
-        expect(is_match).to eq(true)
+    context 'when method name matches a Grape::Route path helper name' do
+      it 'returns the path for that route object' do
+        expect(helper_class.api_v1_ping_path).to eq('/api/v1/ping.json')
       end
 
-      context 'when requested segments contains expected options' do
-        let(:segments) { { 'format' => 'xml' } }
-
-        it 'returns true' do
-          is_match = route_match?(route, method_name, segments)
-          expect(is_match).to eq(true)
-        end
-
-        context 'when no dynamic segments are requested' do
-          context 'when the route requires dynamic segments' do
-            let(:route) { show_route }
-            let(:method_name) { :ap1_v1_cats_path }
-
-            it 'returns false' do
-              is_match = route_match?(route, method_name, segments)
-              expect(is_match).to eq(false)
-            end
-          end
-
-          context 'when the route does not require dynamic segments' do
-            it 'returns true' do
-              is_match = route_match?(route, method_name, segments)
-              expect(is_match).to eq(true)
-            end
-          end
-        end
-
-        context 'when route requires the requested segments' do
-          let(:route) { show_route }
-          let(:method_name) { :api_v1_cats_path }
-          let(:segments) { { 'id' => 1 } }
-
-          it 'returns true' do
-            is_match = route_match?(route, method_name, segments)
-            expect(is_match).to eq(true)
-          end
-        end
-
-        context 'when route does not require the requested segments' do
-          let(:segments) { { 'some_option' => 'some value' } }
-
-          it 'returns false' do
-            is_match = route_match?(route, method_name, segments)
-            expect(is_match).to eq(false)
-          end
+      context 'when route contains dynamic segments' do
+        it 'returns the path for that route object' do
+          expect(helper_class.api_v1_cats_path(id: 5))
+            .to eq('/api/v1/cats/5.json')
         end
       end
 
-      context 'when segments contains unexpected options' do
-        let(:segments) { { 'some_option' => 'some value' } }
-
-        it 'returns false' do
-          is_match = route_match?(route, method_name, segments)
-          expect(is_match).to eq(false)
+      context 'when route requires dynamic segments but none are passed in' do
+        it 'returns super method_missing' do
+          expect(helper_class.api_v1_cats_owners_path)
+            .to eq([:api_v1_cats_owners_path, [], {}])
         end
       end
-    end
 
-    context 'when route does not respond to a method name' do
-      let(:method_name) { :some_other_path }
-      let(:route) { ping_route }
-      let(:segments) { {} }
-
-      it 'returns false' do
-        is_match = route_match?(route, method_name, segments)
-        expect(is_match).to eq(false)
+      context 'when route has no dynamic segments but some are passed in' do
+        it 'returns super method_missing' do
+          expect(helper_class.api_v1_ping_path(invalid: 'test'))
+            .to eq([:api_v1_ping_path, [], { invalid: 'test' }])
+        end
       end
     end
   end
 
   describe '#respond_to_missing?' do
-    it 'returns super if the method does not end with path' do
-      expect(Grape::API::Instance).not_to receive(:decorated_routes) # rubocop:disable Metrics/LineLength
+    context 'when method name doesnt end with _path suffix' do
+      let(:method_name) { :api_v1_cats }
 
-      expect(helper_class.send(:respond_to_missing?, :test)).to eq(false)
-    end
+      it 'returns false' do
+        expect(respond_to_missing?(method_name)).to eq(false)
+      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
+      it 'doesnt execute decorated_routes_by_helper_name method' do
+        expect(Grape::API::Instance)
+          .not_to receive(:decorated_routes_by_helper_name)
 
-      expect(helper_class.send(:respond_to_missing?, :test_path)).to eq(false)
+        respond_to_missing?(method_name)
+      end
     end
 
-    context 'when method name with segments matches a Grape::Route path' do
+    context 'when method name matches a Grape::Route path with segments' do
       let(:method_name) { :api_v1_cats_path }
 
       it 'returns true' do
@@ -167,7 +83,7 @@ describe GrapePathHelpers::NamedRouteMatcher do
       end
     end
 
-    context 'when method name matches a Grape::Route path helper name' do
+    context 'when method name matches a Grape::Route path' do
       let(:method_name) { :api_v1_ping_path }
 
       it 'returns true' do
@@ -175,7 +91,7 @@ describe GrapePathHelpers::NamedRouteMatcher do
       end
     end
 
-    context 'when method name does not match a Grape::Route path helper name' do
+    context 'when method name does not match a Grape::Route path' do
       let(:method_name) { :some_other_path }
 
       it 'returns false' do
@@ -184,56 +100,44 @@ describe GrapePathHelpers::NamedRouteMatcher do
     end
   end
 
-  describe '#method_missing' do
-    context 'when method name matches a Grape::Route path helper name' do
-      it 'returns the path for that route object' 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
-      it 'raises a NameError' do
-        expect do
-          some_method_name
-        end.to raise_error(NameError)
-      end
-    end
-  end
-
   context 'when Grape::Route objects share the same helper name' do
     context 'when helpers require different segments to generate their path' do
       it 'uses arguments to infer which route to use' do
-        show_path = api_v1_cats_path('id' => 1)
+        show_path = helper_class.api_v1_cats_path(
+          'id' => 1
+        )
         expect(show_path).to eq('/api/v1/cats/1.json')
 
-        index_path = api_v1_cats_path
+        index_path = helper_class.api_v1_cats_path
         expect(index_path).to eq('/api/v1/cats.json')
       end
 
       it 'does not get shadowed by another route with less segments' do
-        show_path = api_v1_cats_owners_path('id' => 1)
+        show_path = helper_class.api_v1_cats_owners_path(
+          'id' => 1
+        )
         expect(show_path).to eq('/api/v1/cats/1/owners.json')
 
-        show_path = api_v1_cats_owners_path('id' => 1, 'owner_id' => 1)
+        show_path = helper_class.api_v1_cats_owners_path(
+          'id' => 1,
+          'owner_id' => 1
+        )
         expect(show_path).to eq('/api/v1/cats/1/owners/1.json')
       end
     end
 
     context 'when query params are passed in' do
       it 'uses arguments to infer which route to use' do
-        show_path = api_v1_cats_path('id' => 1, params: { 'foo' => 'bar' })
+        show_path = helper_class.api_v1_cats_path(
+          'id' => 1,
+          params: { 'foo' => 'bar' }
+        )
+
         expect(show_path).to eq('/api/v1/cats/1.json?foo=bar')
 
-        index_path = api_v1_cats_path(params: { 'foo' => 'bar' })
+        index_path = helper_class.api_v1_cats_path(
+          params: { 'foo' => 'bar' }
+        )
         expect(index_path).to eq('/api/v1/cats.json?foo=bar')
       end
     end

data/spec/grape_path_helpers/route_displayer_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe GrapePathHelpers::RouteDisplayer do
+  subject(:route_displayer) { described_class.new }
+
+  describe '#route_attributes' do
+    subject { route_displayer.route_attributes }
+
+    it 'returns the list of attributes' do
+      is_expected.to include(a_hash_including(
+                               route_path: '/:version/ping(.:format)',
+                               route_method: 'GET',
+                               helper_names: ['beta_1_ping_path'],
+                               helper_arguments: []
+                             ))
+    end
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: grape-path-helpers
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.1
 platform: ruby
 authors:
 - Drew Blessing
 - Harper Henn
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-06 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -120,6 +120,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -139,13 +140,14 @@ files:
 - spec/grape_path_helpers/all_routes_spec.rb
 - spec/grape_path_helpers/decorated_route_spec.rb
 - spec/grape_path_helpers/named_route_matcher_spec.rb
+- spec/grape_path_helpers/route_displayer_spec.rb
 - spec/spec_helper.rb
 - spec/support/api.rb
 homepage: https://gitlab.com/gitlab-org/grape-path-helpers
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -160,8 +162,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.3.19
+signing_key: 
 specification_version: 4
 summary: Route path helpers for Grape
 test_files: []