grape-path-helpers 1.2.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b434b7d1b56cd5b639816b364d237e3bd658b0cfe03c0d516c3135794a02bca6
-  data.tar.gz: 4d2958b9bb94e83fa61bb465ef564b100e1e1ff63dbb8748dbc821f4240b88e8
+  metadata.gz: 66a92790c192b884c021f5f6aa77544060f9386d036cfde63954b77b0930da2b
+  data.tar.gz: 9eb7630323cbd4adea877cf93c3c3061a14a4c14ec110a9ddf26dfe8e31b6387
 SHA512:
-  metadata.gz: dd5def728204b01e35b74e86d9c3b5115864b8e2ac1d1e912b0a7d6a623fda80a1ccbd855464f6cea73159280867eef46b33891aab34e883429dcb56051849be
-  data.tar.gz: d3c3dd5cace700e833448314055f7253ab93bf02af69ed70a4384f7e5176ac3914056cdf37000b3b1662fc9b0d23d5c1d8ab20d2bd147acb727edf7e41733958
+  metadata.gz: fc02941d380ee7316267feedd073e02c95f542a0dcbaad3ef55e97290e761f4bb29b7de80eb4156d34eefc36344f7f336a30abcfe82b6ede0d05cf05aa2bea4e
+  data.tar.gz: c157b188857534b828f19a7ad28eaeeff9c004f23946ef4e3aeab30352e02460b5d200d527a68dcd43fe477d187ea555d3e58e8e7bcef9e95dd90887b65f1ee6

data/.gitlab-ci.yml

@@ -1,8 +1,9 @@
-image: "ruby:2.4-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.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)
+
 ## 1.2.0
 
 * [Add wildcard segments support](https://gitlab.com/gitlab-org/grape-path-helpers/merge_requests/16)

data/Gemfile.lock

@@ -1,48 +1,62 @@
 PATH
   remote: .
   specs:
-    grape-path-helpers (1.0.6)
-      activesupport (>= 4, < 5.1)
-      grape (~> 1.0)
-      rake (~> 12)
+    grape-path-helpers (1.4.0)
+      activesupport
+      grape (~> 1.3)
+      rake (> 12)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.0.7)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
     ast (2.4.0)
-    axiom-types (0.1.1)
-      descendants_tracker (~> 0.0.4)
-      ice_nine (~> 0.11.0)
-      thread_safe (~> 0.3, >= 0.3.1)
-    builder (3.2.3)
+    builder (3.2.4)
     coderay (1.1.2)
-    coercible (1.0.0)
-      descendants_tracker (~> 0.0.1)
-    concurrent-ruby (1.0.5)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.3)
-    equalizer (0.0.11)
-    grape (1.0.3)
+    dry-configurable (0.11.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.0.8)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-types (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    grape (1.5.0)
       activesupport
       builder
+      dry-types (>= 1.1)
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-      virtus (>= 1.0.0)
-    i18n (1.0.1)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    ice_nine (0.11.2)
     method_source (0.9.0)
-    minitest (5.11.3)
-    mustermann (1.0.2)
-    mustermann-grape (1.0.0)
-      mustermann (~> 1.0.0)
+    minitest (5.14.2)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-grape (1.0.1)
+      mustermann (>= 1.0.0)
     parallel (1.12.1)
     parser (2.5.1.0)
       ast (~> 2.4.0)
@@ -50,11 +64,11 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (2.0.5)
+    rack (2.2.3)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rainbow (3.0.0)
-    rake (12.3.1)
+    rake (13.0.1)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -76,15 +90,12 @@ GEM
       ruby-progressbar (~> 1.7)
       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.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.3.3)
-    virtus (1.0.5)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
+    zeitwerk (2.4.1)
 
 PLATFORMS
   ruby
@@ -96,4 +107,4 @@ DEPENDENCIES
   rubocop (~> 0.56)
 
 BUNDLED WITH
-   1.16.2
+   2.1.4

data/LICENSE.txt

@@ -1,6 +1,7 @@
 MIT License (MIT)
 
-Copyright (c) 2015 Harper Henn
+Copyright (c) 2015,2016 Harper Henn
+Copyright (c) 2018-2020 GitLab B.V.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,10 +1,10 @@
 # grape-path-helpers
 
-[![Build status](https://gitlab.com/gitlab-org/grape-path-helpers/badges/master/build.svg)](https://gitlab.com/gitlab-org/grape-path-helpers/commits/master)
+[![Build status](https://gitlab.com/gitlab-org/grape-path-helpers/badges/master/pipeline.svg)](https://gitlab.com/gitlab-org/grape-path-helpers/commits/master)
 
 Provides named route helpers for Grape APIs, similar to [Rails' route helpers](http://edgeguides.rubyonrails.org/routing.html#path-and-url-helpers).
 
-**This is a fork and rename of [group-route-helpers](https://github.com/reprah/grape-route-helpers). It [includes some fixes](CHANGELOG.md) needed for GitLab.**
+**This is a fork and rename of [grape-route-helpers](https://github.com/reprah/grape-route-helpers). It [includes some fixes](CHANGELOG.md) needed for GitLab.**
 
 ### Installation
 
@@ -76,7 +76,7 @@ You can use helper methods in your REPL session by including a module:
 Use the methods inside your Grape API actions. Given this example API:
 
 ```ruby
-class ExampleAPI < Grape::API
+class ExampleAPI < Grape::API::Instance
   version 'v1'
   prefix 'api'
   format 'json'
@@ -127,7 +127,7 @@ api_v1_anything_path # => '/api/v1/*anything'
 If you want to assign a custom helper name to a route, pass the `:as` option when creating your route in your API:
 
 ```ruby
-class Base < Grape::API
+class Base < Grape::API::Instance
   get 'ping', as: 'is_the_server_running'
     'pong'
   end
@@ -169,6 +169,14 @@ end
 
 6.) Create a new pull request
 
+### Releasing
+
+1. Update the [CHANGELOG](CHANGELOG.md).
+2. Update the version in [lib/grape-path-helpers/version.rb](lib/grape-path-helpers/version.rb).
+3. [Tag](https://gitlab.com/gitlab-org/grape-path-helpers/-/tags) the commit with the version number prefixed by 'v'.
+4. Run `gem build grape-path-helpers` locally.
+5. Run `gem push $new_file.gem` locally, where `$new_file` is the file generated by the step above.
+
 ### License
 
 See LICENSE

data/Rakefile

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

data/grape-path-helpers.gemspec

@@ -12,8 +12,9 @@ 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.0'
-  gem.add_runtime_dependency 'rake', '~> 12'
+  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.rb

@@ -12,5 +12,5 @@ module GrapePathHelpers
   require 'grape-path-helpers/railtie' if defined?(Rails)
 end
 
-Grape::API.extend GrapePathHelpers::AllRoutes
+Grape::API::Instance.extend GrapePathHelpers::AllRoutes
 Grape::Endpoint.send(:include, GrapePathHelpers::NamedRouteMatcher)

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

@@ -3,26 +3,27 @@ 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 || {}
 
-      route = Grape::API.decorated_routes.detect do |r|
+      route = Grape::API::Instance.decorated_routes.detect do |r|
         route_match?(r, method_id, 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$/
 
-      Grape::API.decorated_routes.detect do |route|
+      Grape::API::Instance.decorated_routes.detect do |route|
         return true if route.respond_to?(method_name)
       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.decorated_routes.map do |route|
+      Grape::API::Instance.decorated_routes.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.2.0'.freeze
+  VERSION = '1.6.1'.freeze
 end

data/spec/grape_path_helpers/all_routes_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
+# rubocop:disable Metrics/BlockLength
 describe GrapePathHelpers::AllRoutes do
-  Grape::API.extend described_class
+  Grape::API::Instance.extend described_class
 
   describe '#all_routes' do
     context 'when API is mounted within another API' do
@@ -11,7 +12,7 @@ describe GrapePathHelpers::AllRoutes do
         mounting_api
 
         # A route is unique if no other route shares the same set of options
-        all_route_options = Grape::API.all_routes.map do |r|
+        all_route_options = Grape::API::Instance.all_routes.map do |r|
           r.instance_variable_get(:@options).merge(path: r.path)
         end
 
@@ -28,10 +29,18 @@ describe GrapePathHelpers::AllRoutes do
       it 'returns all POST routes' do
         expected_routes = Spec::Support::MultiplePostsAPI.routes.map(&:path)
 
-        all_routes = Grape::API.all_routes
+        all_routes = Grape::API::Instance.all_routes
         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

@@ -5,7 +5,7 @@ describe GrapePathHelpers::NamedRouteMatcher do
   include described_class
 
   let(:routes) do
-    Grape::API.decorated_routes
+    Grape::API::Instance.decorated_routes
   end
 
   let(:ping_route) do
@@ -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)
@@ -44,13 +44,14 @@ describe GrapePathHelpers::NamedRouteMatcher do
 
   describe '#method_missing' do
     it 'returns super method_missing if the method does not end with path' do
-      expect(Grape::API).not_to receive(:decorated_routes)
+      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
-      expect(Grape::API).to receive(:decorated_routes).and_call_original
+      expect(Grape::API::Instance).to receive(:decorated_routes).and_call_original # rubocop:disable Metrics/LineLength
 
       helper_class.test_method_path
     end
@@ -146,14 +147,14 @@ describe GrapePathHelpers::NamedRouteMatcher do
   end
 
   describe '#respond_to_missing?' do
-    it 'returns super if the method doesb not end with path' do
-      expect(Grape::API).not_to receive(:decorated_routes)
+    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).to receive(:decorated_routes).and_call_original
+      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

data/spec/support/api.rb

@@ -1,7 +1,7 @@
 module Spec
   module Support
     # Test API
-    class API < Grape::API
+    class API < Grape::API::Instance
       version 'v1'
       prefix 'api'
       format 'json'
@@ -48,7 +48,7 @@ module Spec
     end
 
     # API with more than one version
-    class APIWithMultipleVersions < Grape::API
+    class APIWithMultipleVersions < Grape::API::Instance
       version %w[beta alpha v1]
 
       get 'ping' do
@@ -57,13 +57,13 @@ module Spec
     end
 
     # API with another API mounted inside it
-    class MountedAPI < Grape::API
+    class MountedAPI < Grape::API::Instance
       mount Spec::Support::API
       mount Spec::Support::APIWithMultipleVersions
     end
 
     # API with a version that would be illegal as a method name
-    class APIWithIllegalVersion < Grape::API
+    class APIWithIllegalVersion < Grape::API::Instance
       version 'beta-1'
 
       get 'ping' do
@@ -72,7 +72,7 @@ module Spec
     end
 
     # API with multiple POST routes
-    class MultiplePostsAPI < Grape::API
+    class MultiplePostsAPI < Grape::API::Instance
       resource :hamlet do
         post 'to_be' do
         end
@@ -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.2.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Drew Blessing
 - Harper Henn
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-13 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,28 +31,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   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: []