123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::RedundantDoubleSplatHashBraces

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb

Overview

Checks for redundant uses of double splat hash braces.

Examples:

# bad
do_something(**{foo: bar, baz: qux})

# good
do_something(foo: bar, baz: qux)

# bad
do_something(**{foo: bar, baz: qux}.merge(options))

# good
do_something(foo: bar, baz: qux, **options)

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.

.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.

.badge

Naming.

.callbacks_needed, .cop_name, .department,
.documentation_url

Returns an url to view this cops documentation online.

.exclude_from_registry

Call for abstract Cop classes.

.inherited,
.joining_forces

Override and return the Force class(es) you need to join.

.match?

Returns true if the cop name or the cop namespace matches any of the given names.

.new,
.requires_gem

Register a version requirement for the given gem name.

.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.

transform

Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.

#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.

#begin_investigation

Called before any investigation.

#callbacks_needed,
#cop_config

Configuration Helpers.

#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:

#inspect
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#name

Alias for Base#cop_name.

#offenses,
#on_investigation_end

Called after all on_…​

#on_new_investigation

Called before all on_…​

#on_other_file

Called instead of all on_…​

#parse

There should be very limited reasons for a Cop to do it’s own parsing.

#parser_engine,
#ready

Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.

#complete_investigation

Called to complete an investigation.

#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#allowed_double_splat_receiver?(kwsplat) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb', line 45

def allowed_double_splat_receiver?(kwsplat)
  first_child = kwsplat.children.first
  return true if first_child.block_type? || first_child.numblock_type?
  return false unless first_child.call_type?

  root_receiver = root_receiver(first_child)

  !root_receiver&.hash_type?
end

#autocorrect(corrector, node, kwsplat) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb', line 55

def autocorrect(corrector, node, kwsplat)
  corrector.remove(kwsplat.loc.operator)
  corrector.remove(opening_brace(node))
  corrector.remove(closing_brace(node))

  merge_methods = select_merge_method_nodes(kwsplat)
  return if merge_methods.empty?

  autocorrect_merge_methods(corrector, merge_methods, kwsplat)
end

#autocorrect_merge_methods(corrector, merge_methods, kwsplat) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb', line 89

def autocorrect_merge_methods(corrector, merge_methods, kwsplat)
  range = range_of_merge_methods(merge_methods)

  new_kwsplat_arguments = extract_send_methods(kwsplat).map do |descendant|
    convert_to_new_arguments(descendant)
  end
  new_source = new_kwsplat_arguments.compact.reverse.unshift('').join(', ')

  corrector.replace(range, new_source)
end

#closing_brace(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb', line 85

def closing_brace(node)
  node.children.last.source_range.end.join(node.loc.end)
end

#convert_to_new_arguments(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb', line 111

def convert_to_new_arguments(node)
  return unless mergeable?(node)

  node.arguments.map do |arg|
    if arg.hash_type?
      arg.source
    else
      "**#{arg.source}"
    end
  end
end

#extract_send_methods(kwsplat) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb', line 107

def extract_send_methods(kwsplat)
  kwsplat.each_descendant(:send, :csend)
end

#mergeable?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb', line 123

def mergeable?(node)
  return true unless node.call_type?
  return false unless MERGE_METHODS.include?(node.method_name)
  return true unless (parent = node.parent)

  mergeable?(parent)
end

#on_hash(node)

Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb', line 29

def on_hash(node)
  return if node.pairs.empty? || node.pairs.any?(&:hash_rocket?)
  return unless (parent = node.parent)
  return unless parent.call_type? || parent.kwsplat_type?
  return unless mergeable?(parent)
  return unless (kwsplat = node.each_ancestor(:kwsplat).first)
  return if !node.braces? || allowed_double_splat_receiver?(kwsplat)

  add_offense(kwsplat) do |corrector|
    autocorrect(corrector, node, kwsplat)
  end
end

#opening_brace(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb', line 81

def opening_brace(node)
  node.loc.begin.join(node.children.first.source_range.begin)
end

#range_of_merge_methods(merge_methods) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb', line 100

def range_of_merge_methods(merge_methods)
  begin_merge_method = merge_methods.last
  end_merge_method = merge_methods.first

  begin_merge_method.loc.dot.begin.join(end_merge_method.source_range.end)
end

#root_receiver(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb', line 66

def root_receiver(node)
  receiver = node.receiver
  if receiver&.receiver
    root_receiver(receiver)
  else
    receiver
  end
end

#select_merge_method_nodes(kwsplat) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_double_splat_hash_braces.rb', line 75

def select_merge_method_nodes(kwsplat)
  extract_send_methods(kwsplat).select do |node|
    mergeable?(node)
  end
end