grape-path-helpers 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40792c146fc9c26dd609bc8dd99adce92b010820e3c2ca9644144f3493dd06ec
-  data.tar.gz: aed680f63272f1e61467787e0d374bb8a8145b61979c18b5c61e332763472cd5
+  metadata.gz: 4a9b0351af6ba5b42ba8b521c7bc83a832d4a20a445c30c4c346874f161ddfba
+  data.tar.gz: abe212bb7ab94afa5d12f738a68b2c7c84b93ec807825d5622022ccacb99c5bd
 SHA512:
-  metadata.gz: ff06e53d14f8d46a398cc14754fbc61e7e1a1e28179aa83a27bbca47698c117daaf064f62d3e03e1a385112fea2c0dd076b102e64e4c2f1ffa3c4d4fae7d3279
-  data.tar.gz: 82fde6483c7ad996189c59ab9c79969495e642fb0274d9e209228b6633e6c6c731066a4bf24effa6e00e990f3fc82b94eca8084b469f64aad15e8f9a5f486728
+  metadata.gz: 1c4341eed5f6e6cbbc0f3fa7c35bca36e0f10129948556f6549a4f384e699aa6e6981f61e4c8657e660a7db6d2acfd4adb0b42558bfa58c9e7f8b337014f4f96
+  data.tar.gz: c996a522cfcfb00b275ab276a9ee3e24280a624fa859e4c434937903de0ad3dc004c50231cf37c5abca9ad467b30d29ec0aff131e6e33a58d88b5d1bed5d3499

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 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)
+
+## 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)

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,15 +1,16 @@
 PATH
   remote: .
   specs:
-    grape-path-helpers (1.6.0)
+    grape-path-helpers (1.7.0)
       activesupport
       grape (~> 1.3)
       rake (> 12)
+      ruby2_keywords (~> 0.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.1)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -18,9 +19,9 @@ GEM
     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.12.0)
+    dry-configurable (0.12.1)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5.0)
     dry-container (0.7.2)
@@ -28,29 +29,27 @@ GEM
       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-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.5.3)
       activesupport
       builder
       dry-types (>= 1.1)
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-    i18n (1.8.7)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     method_source (0.9.0)
-    minitest (5.14.3)
+    minitest (5.14.4)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     mustermann-grape (1.0.1)
@@ -88,7 +87,7 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
-    ruby2_keywords (0.0.2)
+    ruby2_keywords (0.0.4)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.3.3)

data/grape-path-helpers.gemspec

@@ -14,6 +14,7 @@ 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 '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

@@ -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/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,47 +3,31 @@ module GrapePathHelpers
   # to unknown methods will look for a route with a matching
   # helper function name
   module NamedRouteMatcher
-    def method_missing(method_id, *args, **kwargs)
-      return super unless method_id.to_s =~ /_path$/
+    def method_missing(method_name, *args)
+      possible_routes = Grape::API::Instance
+                        .decorated_routes_by_helper_name[method_name]
+      return super unless possible_routes
 
-      success, result = call_path_method(method_id, *args, **kwargs)
+      segments = args.first || {}
+      return super unless segments.is_a?(Hash)
 
-      if success
-        result
-      else
-        super
-      end
-    end
-
-    def call_path_method(method_id, *arguments)
-      segments = arguments.first || {}
+      requested_segments = segments.keys.map(&:to_s)
 
-      route = Grape::API::Instance.decorated_routes.detect do |r|
-        route_match?(r, method_id, segments)
+      route = possible_routes.detect do |r|
+        r.uses_segments_in_path_helper?(requested_segments)
       end
 
-      return false unless route
-
-      [true, route.send(method_id, *arguments)]
-    end
-
-    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)
+      if route
+        route.send(method_name, *args)
+      else
+        super
       end
-
-      super
     end
+    ruby2_keywords(:method_missing)
 
-    def route_match?(route, method_name, 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)
+    def respond_to_missing?(method_name, _include_private = false)
+      !Grape::API::Instance.decorated_routes_by_helper_name[method_name].nil? ||
+        super
     end
   end
 end

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

@@ -3,7 +3,7 @@ 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.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.0'.freeze
+  VERSION = '1.7.0'.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,46 @@ 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
-  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) { {} }
-
-      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)
+    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
-
-      expect(helper_class.send(:respond_to_missing?, :test)).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
-
-      expect(helper_class.send(:respond_to_missing?, :test_path)).to eq(false)
-    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 +68,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 +76,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 +85,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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-path-helpers
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Drew Blessing
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,6 +53,20 @@ dependencies:
     - - ">"
       - !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
@@ -106,6 +120,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt