Class: RuboCop::Cop::Layout::MultilineHashKeyLineBreaks

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
MultilineElementLineBreaks
Defined in:
lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb

Overview

Ensures that each key in a multi-line hash starts on a separate line.

Examples:


# bad
{
  a: 1, b: 2,
  c: 3
}

# good
{
  a: 1,
  b: 2,
  c: 3
}

# good
{
  a: 1,
  b: {
    c: 3,
  }
}

AllowMultilineFinalElement: false (default)


# bad
{ a: 1, b: {
  c: 3,
}}

AllowMultilineFinalElement: true


# good
{ a: 1, b: {
  c: 3,
}}

Constant Summary collapse

MSG = 
'Each key in a multi-line hash must start on a separate line.'

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

#on_hash(node) ⇒ Object 



52
53
54
55
56
57
58
59
60
 
# File 'lib/rubocop/cop/layout/multiline_hash_key_line_breaks.rb', line 52

def on_hash(node)
  # This cop only deals with hashes wrapped by a set of curly
  # braces like {foo: 1}. That is, not a kwargs hashes.
  # Style/MultilineMethodArgumentLineBreaks handles those.
  return unless starts_with_curly_brace?(node)
  return unless node.loc.begin

  check_line_breaks(node, node.children, ignore_last: ignore_last_element?)
end