Merge pull request #2601 from ruby-grape/refactor_route_setting_internal_usage

Refactor route_setting internal usage to use inheritable_setting.route

Author: dblock

CHANGELOG.md

@@ -14,6 +14,7 @@
 * [#2598](https://github.com/ruby-grape/grape/pull/2598): Refactor settings DSL to use explicit methods instead of dynamic generation - [@ericproulx](https://github.com/ericproulx).
 * [#2599](https://github.com/ruby-grape/grape/pull/2599): Simplify settings DSL get_or_set method and optimize logger implementation - [@ericproulx](https://github.com/ericproulx).
 * [#2600](https://github.com/ruby-grape/grape/pull/2600): Refactor versioner middleware: simplify base class and improve consistency - [@ericproulx](https://github.com/ericproulx).
+* [#2601](https://github.com/ruby-grape/grape/pull/2601): Refactor route_setting internal usage to use inheritable_setting.route for improved consistency and performance - [@ericproulx](https://github.com/ericproulx).
 * Your contribution here.
 
 #### Fixes

lib/grape/dsl/desc.rb

@@ -58,7 +58,7 @@ def desc(description, options = {}, &config_block)
             options.merge(description: description)
           end
         namespace_setting :description, settings
-        route_setting :description, settings
+        inheritable_setting.route[:description] = settings
       end
     end
   end

lib/grape/dsl/inside_route.rb

@@ -55,7 +55,7 @@ def declared_hash(passed_params, options, declared_params, params_nested_path)
         end
 
         def declared_hash_attr(passed_params, options, declared_param, params_nested_path, memo)
-          renamed_params = route_setting(:renamed_params) || {}
+          renamed_params = inheritable_setting.route[:renamed_params] || {}
           if declared_param.is_a?(Hash)
             declared_param.each_pair do |declared_parent_param, declared_children_params|
               params_nested_path_dup = params_nested_path.dup
@@ -119,7 +119,7 @@ def optioned_param_key(declared_param, options)
         def optioned_declared_params(include_parent_namespaces)
           declared_params = if include_parent_namespaces
                               # Declared params including parent namespaces
-                              route_setting(:declared_params)
+                              inheritable_setting.route[:declared_params]
                             else
                               # Declared params at current namespace
                               namespace_stackable(:declared_params).last || []

lib/grape/dsl/routing.rb

@@ -141,14 +141,15 @@ def mount(mounts, *opts)
       #     end
       #   end
       def route(methods, paths = ['/'], route_options = {}, &block)
-        methods = '*' if methods == :any
+        method = methods == :any ? '*' : methods
+        description = inheritable_setting.route[:description] || {}
         endpoint_options = {
-          method: methods,
+          method: method,
           path: paths,
           for: self,
           route_options: {
             params: namespace_stackable_with_hash(:params) || {}
-          }.deep_merge(route_setting(:description) || {}).deep_merge(route_options || {})
+          }.deep_merge(description).deep_merge(route_options || {})
         }
 
         new_endpoint = Grape::Endpoint.new(inheritable_setting, endpoint_options, &block)

lib/grape/endpoint.rb

@@ -55,8 +55,8 @@ def initialize(new_settings, options = {}, &block)
       # now +namespace_stackable(:declared_params)+ contains all params defined for
       # this endpoint and its parents, but later it will be cleaned up,
       # see +reset_validations!+ in lib/grape/dsl/validations.rb
-      route_setting(:declared_params, namespace_stackable(:declared_params).flatten)
-      route_setting(:saved_validations, namespace_stackable(:validations))
+      inheritable_setting.route[:declared_params] = namespace_stackable(:declared_params).flatten
+      inheritable_setting.route[:saved_validations] = namespace_stackable(:validations)
 
       namespace_stackable(:representations, []) unless namespace_stackable(:representations)
       namespace_inheritable(:default_error_status, 500) unless namespace_inheritable(:default_error_status)
@@ -302,9 +302,11 @@ def run_filters(filters, type = :other)
     end
 
     def validations
+      saved_validations = inheritable_setting.route[:saved_validations]
+      return if saved_validations.nil?
       return enum_for(:validations) unless block_given?
 
-      route_setting(:saved_validations)&.each do |saved_validation|
+      saved_validations.each do |saved_validation|
         yield Grape::Validations::ValidatorFactory.create_validator(saved_validation)
       end
     end

lib/grape/validations/params_scope.rb

@@ -211,9 +211,10 @@ def full_path
       # @param new_name [String, Symbol] the new name of the parameter (the
       #   renamed name, with the +as: ...+ semantic)
       def push_renamed_param(path, new_name)
-        base = @api.route_setting(:renamed_params) || {}
+        api_route_setting = @api.inheritable_setting.route
+        base = api_route_setting[:renamed_params] || {}
         base[Array(path).map(&:to_s)] = new_name.to_s
-        @api.route_setting(:renamed_params, base)
+        api_route_setting[:renamed_params] = base
       end
 
       def require_required_and_optional_fields(context, opts)

spec/grape/dsl/desc_spec.rb

@@ -6,30 +6,7 @@
   let(:dummy_class) do
     Class.new do
       extend Grape::DSL::Desc
-
-      def self.namespace_setting(key, value = nil)
-        if value
-          namespace_setting_hash[key] = value
-        else
-          namespace_setting_hash[key]
-        end
-      end
-
-      def self.route_setting(key, value = nil)
-        if value
-          route_setting_hash[key] = value
-        else
-          route_setting_hash[key]
-        end
-      end
-
-      def self.namespace_setting_hash
-        @namespace_setting_hash ||= {}
-      end
-
-      def self.route_setting_hash
-        @route_setting_hash ||= {}
-      end
+      extend Grape::DSL::Settings
     end
   end
 

spec/grape/dsl/routing_spec.rb

@@ -123,8 +123,8 @@
     end
 
     it 'generates correct endpoint options' do
-      allow(subject).to receive(:route_setting).with(:description).and_return(fiz: 'baz')
-      allow(subject).to receive(:namespace_stackable_with_hash).and_return(nuz: 'naz')
+      subject.inheritable_setting.route[:description] = { fiz: 'baz' }
+      subject.inheritable_setting.namespace_stackable[:params] = { nuz: 'naz' }
 
       expect(Grape::Endpoint).to receive(:new) do |_inheritable_setting, endpoint_options|
         expect(endpoint_options[:method]).to eq :get