Use Ruby 3.1 shorthand kwargs syntax across the codebase

ericproulx · claude · ericproulx · commit 97bbc0f07e3e · 2026-04-05T23:47:00.000+02:00
Replace redundant `key: key` kwargs with the shorthand `key:` form
where the local variable name matches the keyword argument name.

Co-Authored-By: Claude Sonnet 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@
 * [#2657](https://github.com/ruby-grape/grape/pull/2657): Instantiate validators at definition time - [@ericproulx](https://github.com/ericproulx).
 * [#2667](https://github.com/ruby-grape/grape/pull/2667): Skip instrumentation in run_validators when no validators present - [@ericproulx](https://github.com/ericproulx).
 * [#2670](https://github.com/ruby-grape/grape/pull/2670): Added support for Rack 3.2.6 and better handling to rack exceptions - [@ericproulx](https://github.com/ericproulx).
+* [#2671](https://github.com/ruby-grape/grape/pull/2671): Use ruby 3.1 shorthand kwargs syntax - [@ericproulx](https://github.com/ericproulx).
 * Your contribution here.
 
 #### Fixes
diff --git a/lib/grape/api.rb b/lib/grape/api.rb
@@ -44,7 +44,7 @@ def initial_setup(base_instance_parent)
       def override_all_methods!
         (base_instance.methods - Class.methods - NON_OVERRIDABLE).each do |method_override|
           define_singleton_method(method_override) do |*args, **kwargs, &block|
-            add_setup(method: method_override, args: args, kwargs: kwargs, block: block)
+            add_setup(method: method_override, args:, kwargs:, block:)
           end
         end
       end
diff --git a/lib/grape/api/instance.rb b/lib/grape/api/instance.rb
@@ -170,7 +170,7 @@ def collect_route_config_per_pattern(all_routes)
           allow_header = namespace_inheritable[:do_not_route_options] ? allowed_methods : [Rack::OPTIONS] | allowed_methods
           last_route.app.options[:options_route_enabled] = true unless namespace_inheritable[:do_not_route_options] || allowed_methods.include?(Rack::OPTIONS)
 
-          greedy_route = Grape::Router::GreedyRoute.new(last_route.pattern, endpoint: last_route.app, allow_header: allow_header)
+          greedy_route = Grape::Router::GreedyRoute.new(last_route.pattern, endpoint: last_route.app, allow_header:)
           @router.associate_routes(greedy_route)
         end
       end
diff --git a/lib/grape/declared_params_handler.rb b/lib/grape/declared_params_handler.rb
@@ -12,9 +12,9 @@ def initialize(include_missing: true, evaluate_given: false, stringify: false, c
     def call(passed_params, declared_params, route_params, renamed_params)
       recursive_declared(
         passed_params,
-        declared_params: declared_params,
-        route_params: route_params,
-        renamed_params: renamed_params
+        declared_params:,
+        route_params:,
+        renamed_params:
       )
     end
 
diff --git a/lib/grape/dsl/inside_route.rb b/lib/grape/dsl/inside_route.rb
@@ -29,11 +29,11 @@ def error!(message, status = nil, additional_headers = nil, backtrace = nil, ori
         status = self.status(status || inheritable_setting.namespace_inheritable[:default_error_status])
         headers = additional_headers.present? ? header.merge(additional_headers) : header
         throw :error,
-              message: message,
-              status: status,
-              headers: headers,
-              backtrace: backtrace,
-              original_exception: original_exception
+              message:,
+              status:,
+              headers:,
+              backtrace:,
+              original_exception:
       end
 
       # Redirect to a new url.
diff --git a/lib/grape/dsl/routing.rb b/lib/grape/dsl/routing.rb
@@ -136,8 +136,8 @@ def mount(mounts, *opts)
           endpoints << Grape::Endpoint.new(
             in_setting,
             method: :any,
-            path: path,
-            app: app,
+            path:,
+            app:,
             route_options: { anchor: false },
             forward_match: !app.respond_to?(:inheritable_setting),
             for: self
@@ -167,7 +167,7 @@ def route(methods, paths = ['/'], route_options = {}, &)
 
         new_endpoint = Grape::Endpoint.new(
           inheritable_setting,
-          method: method,
+          method:,
           path: paths,
           for: self,
           route_options: all_route_options,
diff --git a/lib/grape/endpoint.rb b/lib/grape/endpoint.rb
@@ -158,7 +158,7 @@ def inspect
     protected
 
     def run
-      ActiveSupport::Notifications.instrument('endpoint_run.grape', endpoint: self, env: env) do
+      ActiveSupport::Notifications.instrument('endpoint_run.grape', endpoint: self, env:) do
         @request = Grape::Request.new(env, build_params_with: inheritable_setting.namespace_inheritable[:build_params_with])
         begin
           self.class.run_before_each(self)
@@ -229,7 +229,7 @@ def run_validators(request:)
     def run_filters(filters, type = :other)
       return unless filters
 
-      ActiveSupport::Notifications.instrument('endpoint_run_filters.grape', endpoint: self, filters: filters, type: type) do
+      ActiveSupport::Notifications.instrument('endpoint_run_filters.grape', endpoint: self, filters:, type:) do
         filters.each { |filter| instance_eval(&filter) }
       end
     end
@@ -316,15 +316,15 @@ def build_stack
       stack.use Rack::Head
       stack.use Rack::Lint if lint?
       stack.use Grape::Middleware::Error,
-                format: format,
-                content_types: content_types,
+                format:,
+                content_types:,
                 default_status: inheritable_setting.namespace_inheritable[:default_error_status],
                 rescue_all: inheritable_setting.namespace_inheritable[:rescue_all],
                 rescue_grape_exceptions: inheritable_setting.namespace_inheritable[:rescue_grape_exceptions],
                 default_error_formatter: inheritable_setting.namespace_inheritable[:default_error_formatter],
                 error_formatters: inheritable_setting.namespace_stackable_with_hash(:error_formatters),
                 rescue_options: inheritable_setting.namespace_stackable_with_hash(:rescue_options),
-                rescue_handlers: rescue_handlers,
+                rescue_handlers:,
                 base_only_rescue_handlers: inheritable_setting.namespace_stackable_with_hash(:base_only_rescue_handlers),
                 all_rescue_handler: inheritable_setting.namespace_inheritable[:all_rescue_handler],
                 grape_exceptions_rescue_handler: inheritable_setting.namespace_inheritable[:grape_exceptions_rescue_handler]
@@ -340,9 +340,9 @@ def build_stack
       end
 
       stack.use Grape::Middleware::Formatter,
-                format: format,
+                format:,
                 default_format: inheritable_setting.namespace_inheritable[:default_format] || :txt,
-                content_types: content_types,
+                content_types:,
                 formatters: inheritable_setting.namespace_stackable_with_hash(:formatters),
                 parsers: inheritable_setting.namespace_stackable_with_hash(:parsers)
 
diff --git a/lib/grape/exceptions/invalid_accept_header.rb b/lib/grape/exceptions/invalid_accept_header.rb
@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class InvalidAcceptHeader < Base
       def initialize(message, headers)
-        super(message: compose_message(:invalid_accept_header, message: message), status: 406, headers: headers)
+        super(message: compose_message(:invalid_accept_header, message: message), status: 406, headers:)
       end
     end
   end
diff --git a/lib/grape/exceptions/invalid_formatter.rb b/lib/grape/exceptions/invalid_formatter.rb
@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class InvalidFormatter < Base
       def initialize(klass, to_format)
-        super(message: compose_message(:invalid_formatter, klass: klass, to_format: to_format))
+        super(message: compose_message(:invalid_formatter, klass:, to_format:))
       end
     end
   end
diff --git a/lib/grape/exceptions/invalid_version_header.rb b/lib/grape/exceptions/invalid_version_header.rb
@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class InvalidVersionHeader < Base
       def initialize(message, headers)
-        super(message: compose_message(:invalid_version_header, message: message), status: 406, headers: headers)
+        super(message: compose_message(:invalid_version_header, message: message), status: 406, headers:)
       end
     end
   end
diff --git a/lib/grape/exceptions/invalid_versioner_option.rb b/lib/grape/exceptions/invalid_versioner_option.rb
@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class InvalidVersionerOption < Base
       def initialize(strategy)
-        super(message: compose_message(:invalid_versioner_option, strategy: strategy))
+        super(message: compose_message(:invalid_versioner_option, strategy:))
       end
     end
   end
diff --git a/lib/grape/exceptions/method_not_allowed.rb b/lib/grape/exceptions/method_not_allowed.rb
@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class MethodNotAllowed < Base
       def initialize(headers)
-        super(message: '405 Not Allowed', status: 405, headers: headers)
+        super(message: '405 Not Allowed', status: 405, headers:)
       end
     end
   end
diff --git a/lib/grape/exceptions/missing_mime_type.rb b/lib/grape/exceptions/missing_mime_type.rb
@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class MissingMimeType < Base
       def initialize(new_format)
-        super(message: compose_message(:missing_mime_type, new_format: new_format))
+        super(message: compose_message(:missing_mime_type, new_format:))
       end
     end
   end
diff --git a/lib/grape/exceptions/unknown_auth_strategy.rb b/lib/grape/exceptions/unknown_auth_strategy.rb
@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class UnknownAuthStrategy < Base
       def initialize(strategy:)
-        super(message: compose_message(:unknown_auth_strategy, strategy: strategy))
+        super(message: compose_message(:unknown_auth_strategy, strategy:))
       end
     end
   end
diff --git a/lib/grape/exceptions/unknown_parameter.rb b/lib/grape/exceptions/unknown_parameter.rb
@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class UnknownParameter < Base
       def initialize(param)
-        super(message: compose_message(:unknown_parameter, param: param))
+        super(message: compose_message(:unknown_parameter, param:))
       end
     end
   end
diff --git a/lib/grape/exceptions/unknown_params_builder.rb b/lib/grape/exceptions/unknown_params_builder.rb
@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class UnknownParamsBuilder < Base
       def initialize(params_builder_type)
-        super(message: compose_message(:unknown_params_builder, params_builder_type: params_builder_type))
+        super(message: compose_message(:unknown_params_builder, params_builder_type:))
       end
     end
   end
diff --git a/lib/grape/exceptions/unknown_validator.rb b/lib/grape/exceptions/unknown_validator.rb
@@ -4,7 +4,7 @@ module Grape
   module Exceptions
     class UnknownValidator < Base
       def initialize(validator_type)
-        super(message: compose_message(:unknown_validator, validator_type: validator_type))
+        super(message: compose_message(:unknown_validator, validator_type:))
       end
     end
   end
diff --git a/lib/grape/exceptions/validation.rb b/lib/grape/exceptions/validation.rb
@@ -15,7 +15,7 @@ def initialize(params:, message: nil, status: nil, headers: nil)
           message = translate_message(message)
         end
 
-        super(status: status, message: message, headers: headers)
+        super(status:, message:, headers:)
       end
 
       # Remove all the unnecessary stuff from Grape::Exceptions::Base like status
diff --git a/lib/grape/middleware/error.rb b/lib/grape/middleware/error.rb
@@ -38,8 +38,8 @@ def format_message(message, backtrace, original_exception = nil)
         throw :error,
               status: 406,
               message: "The requested format '#{format}' is not supported.",
-              backtrace: backtrace,
-              original_exception: original_exception
+              backtrace:,
+              original_exception:
       end
 
       def find_handler(klass)
diff --git a/lib/grape/middleware/formatter.rb b/lib/grape/middleware/formatter.rb
@@ -38,7 +38,7 @@ def build_formatted_response(status, headers, bodies)
         else
           # Allow content-type to be explicitly overwritten
           formatter = fetch_formatter(headers, options)
-          bodymap = ActiveSupport::Notifications.instrument('format_response.grape', formatter: formatter, env: env) do
+          bodymap = ActiveSupport::Notifications.instrument('format_response.grape', formatter:, env:) do
             bodies.collect { |body| formatter.call(body, env) }
           end
           Rack::Response.new(bodymap, status, headers)
diff --git a/lib/grape/router/pattern.rb b/lib/grape/router/pattern.rb
@@ -16,7 +16,7 @@ class Pattern
       def initialize(origin:, suffix:, anchor:, params:, format:, version:, requirements:)
         @origin = origin
         @path = PatternCache[[build_path_from_pattern(@origin, anchor), suffix]]
-        @pattern = Mustermann::Grape.new(@path, uri_decode: true, params: params, capture: extract_capture(format, version, requirements))
+        @pattern = Mustermann::Grape.new(@path, uri_decode: true, params:, capture: extract_capture(format, version, requirements))
         @to_regexp = @pattern.to_regexp
       end
 
diff --git a/lib/grape/util/media_type.rb b/lib/grape/util/media_type.rb
@@ -47,7 +47,7 @@ def parse(media_type)
           type, subtype = media_type.split('/', 2)
           return if type.blank? || subtype.blank?
 
-          new(type: type, subtype: subtype)
+          new(type:, subtype:)
         end
 
         def match?(media_type)
diff --git a/lib/grape/validations/params_scope.rb b/lib/grape/validations/params_scope.rb
@@ -275,10 +275,10 @@ def new_scope(element, type:, as:, optional: false, &)
 
         self.class.new(
           api: @api,
-          element: element,
+          element:,
           element_renamed: as,
           parent: self,
-          optional: optional,
+          optional:,
           type: type || Array,
           group: @group,
           &
diff --git a/lib/grape/validations/validators/base.rb b/lib/grape/validations/validators/base.rb
@@ -117,7 +117,7 @@ def validate_param!(attr_name, params)
 
         def validation_error!(attr_name_or_params, message = @exception_message)
           params = attr_name_or_params.is_a?(Array) ? attr_name_or_params : @scope.full_name(attr_name_or_params)
-          raise Grape::Exceptions::Validation.new(params: params, message: message)
+          raise Grape::Exceptions::Validation.new(params:, message:)
         end
 
         def hash_like?(obj)
