grape-path-helpers 1.7.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a9b0351af6ba5b42ba8b521c7bc83a832d4a20a445c30c4c346874f161ddfba
-  data.tar.gz: abe212bb7ab94afa5d12f738a68b2c7c84b93ec807825d5622022ccacb99c5bd
+  metadata.gz: 48d0b31d4510edbe385479f81ca2e91a51cf09454037339d7c71510ea892321e
+  data.tar.gz: a8856400f31326e0c13b1ca55397c9d46b7f0e800848ba8f4cbb9df65794cf78
 SHA512:
-  metadata.gz: 1c4341eed5f6e6cbbc0f3fa7c35bca36e0f10129948556f6549a4f384e699aa6e6981f61e4c8657e660a7db6d2acfd4adb0b42558bfa58c9e7f8b337014f4f96
-  data.tar.gz: c996a522cfcfb00b275ab276a9ee3e24280a624fa859e4c434937903de0ad3dc004c50231cf37c5abca9ad467b30d29ec0aff131e6e33a58d88b5d1bed5d3499
+  metadata.gz: '0097583d83eb6f56e6063fb4527809411d0970a9aa36622e0e96ae039d3556cb737d7624807a3ef2f0862329babf62474b4b6423bb6ebae6c506c2f5c35f8245'
+  data.tar.gz: 945c6f84ebb3ee473f94aadba7780b04c1f813d4e8405c5f634218904f8b54af78a5fc49e12b171de294f6a50b50d2d871c75083779d9d1ed446d0c164db4420

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2.0.0
+
+* [Adds support for Rack 3](https://gitlab.com/gitlab-org/ruby/gems/grape-path-helpers/-/merge_requests/45)
+
+## 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)

data/Gemfile.lock

@@ -1,58 +1,53 @@
 PATH
   remote: .
   specs:
-    grape-path-helpers (1.7.0)
+    grape-path-helpers (2.0.0)
       activesupport
-      grape (~> 1.3)
+      grape (~> 2.0)
       rake (> 12)
       ruby2_keywords (~> 0.0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.3.2)
+    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.8)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.3)
-    dry-configurable (0.12.1)
+    dry-core (1.0.1)
       concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5.0)
-    dry-container (0.7.2)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-logic (1.5.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.5.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.1)
       concurrent-ruby (~> 1.0)
-    dry-inflector (0.2.0)
-    dry-logic (1.2.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.5, >= 0.5)
-    dry-types (1.5.1)
-      concurrent-ruby (~> 1.0)
-      dry-container (~> 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.3)
-      activesupport
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    grape (2.0.0)
+      activesupport (>= 5)
       builder
       dry-types (>= 1.1)
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-    i18n (1.8.10)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     method_source (0.9.0)
-    minitest (5.14.4)
-    mustermann (1.1.1)
+    minitest (5.20.0)
+    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)
@@ -61,11 +56,11 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (2.2.3)
+    rack (3.0.8)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.1.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -87,11 +82,11 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
-    ruby2_keywords (0.0.4)
-    tzinfo (2.0.4)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.3.3)
-    zeitwerk (2.4.2)
+    zeitwerk (2.6.12)
 
 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/grape-path-helpers.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.homepage    = 'https://gitlab.com/gitlab-org/grape-path-helpers'
 
   gem.add_runtime_dependency 'activesupport'
-  gem.add_runtime_dependency 'grape', '~> 1.3'
+  gem.add_runtime_dependency 'grape', '~> 2.0'
   gem.add_runtime_dependency 'rake', '> 12'
   gem.add_runtime_dependency 'ruby2_keywords', '~> 0.0.2'
 

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

@@ -4,6 +4,8 @@ module GrapePathHelpers
   # helper function name
   module NamedRouteMatcher
     def method_missing(method_name, *args)
+      return super unless method_name.end_with?('_path')
+
       possible_routes = Grape::API::Instance
                         .decorated_routes_by_helper_name[method_name]
       return super unless possible_routes
@@ -26,8 +28,13 @@ module GrapePathHelpers
     ruby2_keywords(:method_missing)
 
     def respond_to_missing?(method_name, _include_private = false)
-      !Grape::API::Instance.decorated_routes_by_helper_name[method_name].nil? ||
-        super
+      grape_route_path?(method_name) || super
+    end
+
+    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.values.flatten.uniq.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.7.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/spec/grape_path_helpers/named_route_matcher_spec.rb

@@ -60,6 +60,21 @@ describe GrapePathHelpers::NamedRouteMatcher do
   end
 
   describe '#respond_to_missing?' do
+    context 'when method name doesnt end with _path suffix' do
+      let(:method_name) { :api_v1_cats }
+
+      it 'returns false' do
+        expect(respond_to_missing?(method_name)).to eq(false)
+      end
+
+      it 'doesnt execute decorated_routes_by_helper_name method' do
+        expect(Grape::API::Instance)
+          .not_to receive(:decorated_routes_by_helper_name)
+
+        respond_to_missing?(method_name)
+      end
+    end
+
     context 'when method name matches a Grape::Route path with segments' do
       let(:method_name) { :api_v1_cats_path }
 

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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-path-helpers
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Drew Blessing
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2023-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +140,7 @@ 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
@@ -161,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.5.2
 signing_key:
 specification_version: 4
 summary: Route path helpers for Grape