Replace grape-route-helpers with our own grape-path-helpers

This gem (https://gitlab.com/gitlab-org/grape-path-helpers) makes a number of changes: 1. Brings in @mdelaossa's changes in reprah/grape-route-helpers#21 2. Fixes some broken specs and code for Grape 1.0+ 3. Optimizes the generation of paths by bringing in @dblessing's HashWithIndifferentAccess changes in https://gitlab.com/gitlab-org/gitlab-ce/issues/45718#note_70123793 Closes #45718
gitlabhq · May 30, 2018 · 990af4f · 990af4f
1 parent 5b1416a
commit 990af4f
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 73 deletions.
diff --git a/Gemfile b/Gemfile
@@ -28,7 +28,7 @@ gem 'mysql2', '~> 0.4.10', group: :mysql
 gem 'pg', '~> 0.18.2', group: :postgres
 
 gem 'rugged', '~> 0.27'
-gem 'grape-route-helpers', '~> 2.1.0'
+gem 'grape-path-helpers', '~> 1.0'
 
 gem 'faraday', '~> 0.12'
 

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -348,7 +348,7 @@ GEM
       signet (~> 0.7)
     gpgme (2.0.13)
       mini_portile2 (~> 2.1)
-    grape (1.0.2)
+    grape (1.0.3)
       activesupport
       builder
       mustermann-grape (~> 1.0.0)
@@ -358,10 +358,10 @@ GEM
     grape-entity (0.7.1)
       activesupport (>= 4.0)
       multi_json (>= 1.3.2)
-    grape-route-helpers (2.1.0)
-      activesupport
-      grape (>= 0.16.0)
-      rake
+    grape-path-helpers (1.0.1)
+      activesupport (~> 4)
+      grape (~> 1.0)
+      rake (~> 12)
     grape_logging (1.7.0)
       grape
     grpc (1.11.0)
@@ -1049,7 +1049,7 @@ DEPENDENCIES
   gpgme
   grape (~> 1.0)
   grape-entity (~> 0.7.1)
-  grape-route-helpers (~> 2.1.0)
+  grape-path-helpers (~> 1.0)
   grape_logging (~> 1.7)
   grpc (~> 1.11.0)
   haml_lint (~> 0.26.0)

diff --git a/changelogs/unreleased/sh-use-grape-path-helpers.yml b/changelogs/unreleased/sh-use-grape-path-helpers.yml
@@ -0,0 +1,5 @@
+---
+title: Replace grape-route-helpers with our own grape-path-helpers
+merge_request:
+author:
+type: performance
diff --git a/config/initializers/grape_route_helpers_fix.rb b/config/initializers/grape_route_helpers_fix.rb
diff --git a/lib/api/helpers/related_resources_helpers.rb b/lib/api/helpers/related_resources_helpers.rb
@@ -1,7 +1,7 @@
 module API
   module Helpers
     module RelatedResourcesHelpers
-      include GrapeRouteHelpers::NamedRouteMatcher
+      include GrapePathHelpers::NamedRouteMatcher
 
       def issues_available?(project, options)
         available?(:issues, project, options[:current_user])

diff --git a/spec/initializers/grape_route_helpers_fix_spec.rb b/spec/initializers/grape_route_helpers_fix_spec.rb
diff --git a/spec/requests/api/merge_requests_spec.rb b/spec/requests/api/merge_requests_spec.rb
@@ -29,6 +29,18 @@
     project.add_reporter(user)
   end
 
+  describe 'route shadowing' do
+    include GrapePathHelpers::NamedRouteMatcher
+
+    it 'does not occur' do
+      path = api_v4_projects_merge_requests_path(id: 1)
+      expect(path).to eq('/api/v4/projects/1/merge_requests')
+
+      path = api_v4_projects_merge_requests_path(id: 1, merge_request_iid: 3)
+      expect(path).to eq('/api/v4/projects/1/merge_requests/3')
+    end
+  end
+
   describe 'GET /merge_requests' do
     context 'when unauthenticated' do
       it 'returns an array of all merge requests' do