123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::HashAsLastArrayItem

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/hash_as_last_array_item.rb

Overview

Checks for presence or absence of braces around hash literal as a last array item depending on configuration.

Note
This cop will ignore arrays where all items are hashes, regardless of EnforcedStyle.

Examples:

EnforcedStyle: braces (default)

# bad
[1, 2, one: 1, two: 2]

# good
[1, 2, { one: 1, two: 2 }]

# good
[{ one: 1 }, { two: 2 }]

EnforcedStyle: no_braces

# bad
[1, 2, { one: 1, two: 2 }]

# good
[1, 2, one: 1, two: 2]

# good
[{ one: 1 }, { two: 2 }]

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

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::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::RangeHelp - Included

#add_range, #column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.

#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.

#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::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 Attribute Details

#braces_style?Boolean (readonly, private)

[ GitHub ]

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

def braces_style?
  style == :braces
end

Instance Method Details

#check_braces(node) (private)

[ GitHub ]

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

def check_braces(node)
  return if node.braces?

  add_offense(node, message: 'Wrap hash in `{` and `}`.') do |corrector|
    corrector.wrap(node, '{', '}')
  end
end

#check_no_braces(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/hash_as_last_array_item.rb', line 74

def check_no_braces(node)
  return unless node.braces?
  return if node.children.empty? # Empty hash cannot be "unbraced"

  add_offense(node, message: 'Omit the braces around the hash.') do |corrector|
    remove_last_element_trailing_comma(corrector, node.parent)
    corrector.remove(node.loc.begin)
    corrector.remove(node.loc.end)
  end
end

#containing_array(hash_node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/hash_as_last_array_item.rb', line 50

def containing_array(hash_node)
  parent = hash_node.parent
  parent if parent&.array_type?
end

#explicit_array?(array) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/hash_as_last_array_item.rb', line 61

def explicit_array?(array)
  # an implicit array cannot have an "unbraced" hash
  array.square_brackets?
end

#last_array_item?(array, node) ⇒ Boolean (private)

[ GitHub ]

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

def last_array_item?(array, node)
  return false if array.child_nodes.all?(&:hash_type?)

  array.children.last.equal?(node)
end

#on_hash(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/hash_as_last_array_item.rb', line 36

def on_hash(node)
  return if node.children.first&.kwsplat_type?
  return unless (array = containing_array(node))
  return unless last_array_item?(array, node) && explicit_array?(array)

  if braces_style?
    check_braces(node)
  else
    check_no_braces(node)
  end
end

#remove_last_element_trailing_comma(corrector, node) (private)

[ GitHub ]

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

def remove_last_element_trailing_comma(corrector, node)
  range = range_with_surrounding_space(
    node.children.last.source_range,
    side: :right
  ).end.resize(1)

  corrector.remove(range) if range.source == ','
end