Class: RuboCop::Cop::Style::KeywordArgumentsMerging

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/style/keyword_arguments_merging.rb

Overview

When passing an existing hash as keyword arguments, provide additional arguments directly rather than using ‘merge`.

Providing arguments directly is more performant than using ‘merge`, and also leads to shorter and simpler code.

Examples:

# bad
some_method(**opts.merge(foo: true))
some_method(**opts.merge(other_opts))

# good
some_method(**opts, foo: true)
some_method(**opts, **other_opts)

Constant Summary collapse

MSG = 
'Provide additional arguments directly rather than using `merge`.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#merge_kwargs?(node) ⇒ Object 



27
28
29
30
31
32
33
34
 
# File 'lib/rubocop/cop/style/keyword_arguments_merging.rb', line 27

def_node_matcher :merge_kwargs?, <<~PATTERN
  (send _ _
    ...
    (hash
      (kwsplat
        $(send $_ :merge $...))
      ...))
PATTERN

#on_kwsplat(node) ⇒ Object 



36
37
38
39
40
41
42
43
44
 
# File 'lib/rubocop/cop/style/keyword_arguments_merging.rb', line 36

def on_kwsplat(node)
  return unless (ancestor = node.parent&.parent)

  merge_kwargs?(ancestor) do |merge_node, hash_node, other_hash_node|
    add_offense(merge_node) do |corrector|
      autocorrect(corrector, node, hash_node, other_hash_node)
    end
  end
end