Merge pull request #2776 from ruby-grape/endpoint_path_kwarg

Pass path to Grape::Endpoint as a keyword instead of via options

Author: dblock

CHANGELOG.md

@@ -5,6 +5,7 @@
 * [#2768](https://github.com/ruby-grape/grape/pull/2768): Remove Guard - [@ericproulx](https://github.com/ericproulx).
 * [#2774](https://github.com/ruby-grape/grape/pull/2774): Make `forward_match` an internal kwarg instead of a route option - [@ericproulx](https://github.com/ericproulx).
 * [#2775](https://github.com/ruby-grape/grape/pull/2775): Pass `http_methods` to `Grape::Endpoint` as a keyword instead of via options - [@ericproulx](https://github.com/ericproulx).
+* [#2776](https://github.com/ruby-grape/grape/pull/2776): Pass `path` to `Grape::Endpoint` as a keyword instead of via options - [@ericproulx](https://github.com/ericproulx).
 * Your contribution here.
 
 #### Fixes

UPGRADING.md

@@ -21,7 +21,7 @@ Grape::Endpoint.new(settings, method: :get, path: '/foo', for: self)
 Grape::Endpoint.new(settings, http_methods: :get, path: '/foo', for: self)
 ```
 
-Relatedly, an endpoint's public `options` Hash no longer carries `:method` (`endpoint.options[:method]`). Nothing in Grape read it, and downstream gems such as grape-swagger already read the verb from `route.request_method`, which is unchanged.
+Relatedly, an endpoint's public `options` Hash no longer carries `:method` or `:path`. Nothing in Grape read `:method`, and the only reader of `:path` was an internal test; both values are available from the route instead — `route.request_method` for the verb and `route.path` for the (compiled) path, which is what grape-swagger and other introspection already use. The raw definition-time path array is no longer exposed on the endpoint.
 
 ### Upgrading to >= 3.3
 

lib/grape/endpoint.rb

@@ -40,15 +40,15 @@ def block_to_unbound_method(block)
     #   validations, and other properties from.
     # @param http_methods [String or Array] which HTTP method(s) can be used to
     #   reach this endpoint.
+    # @param path [String or Array] the path to this endpoint, within the
+    #   current scope.
     # @param options [Hash] attributes of this endpoint, normalized into a
     #   +Grape::Endpoint::Options+ value object.
-    # @option options path [String or Array] the path to this endpoint, within
-    #   the current scope.
     # @option options route_options [Hash]
     # @note This happens at the time of API definition, so in this context the
     # endpoint does not know if it will be mounted under a different endpoint.
     # @yield a block defining what your API should do when this endpoint is hit
-    def initialize(new_settings, http_methods:, **options, &block)
+    def initialize(new_settings, http_methods:, path:, **options, &block)
       self.inheritable_setting = new_settings.point_in_time_copy
 
       # now +namespace_stackable(:declared_params)+ contains all params defined for
@@ -61,9 +61,7 @@ def initialize(new_settings, http_methods:, **options, &block)
       inheritable_setting.namespace_inheritable[:default_error_status] ||= 500
 
       @options = options
-      @options[:path] = Array(@options[:path])
-      @options[:path] << '/' if @options[:path].empty?
-      @config = Options.new(http_methods:, **options)
+      @config = Options.new(http_methods:, path:, **options)
 
       @status = nil
       @stream = nil

spec/grape/api_spec.rb

@@ -3982,7 +3982,7 @@ def my_method
       subject.format :json
       subject.get '/endpoint/options' do
         {
-          path: options[:path],
+          path: route.path,
           source_location: source.source_location
         }
       end
@@ -3991,7 +3991,7 @@ def my_method
     it 'path' do
       get '/endpoint/options'
       options = Grape::Json.parse(last_response.body)
-      expect(options['path']).to eq(['/endpoint/options'])
+      expect(options['path']).to eq('/endpoint/options(.json)')
       expect(options['source_location'][0]).to include 'api_spec.rb'
       expect(options['source_location'][1].to_i).to be > 0
     end