Class: RuboCop::Cop::Layout::AlignHash

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Layout::AlignHash

Includes:

HashAlignment, RangeHelp

Defined in:

lib/rubocop/cop/layout/align_hash.rb

Overview

Check that the keys, separators, and values of a multi-line hash literal are aligned according to configuration. The configuration options are:

- key (left align keys, one space before hash rockets and values)
- separator (align hash rockets and colons, right align keys)
- table (left align keys, hash rockets, and values)

The treatment of hashes passed as the last argument to a method call can also be configured. The options are:

- always_inspect
- always_ignore
- ignore_implicit (without curly braces)

Alternatively you can specify multiple allowed styles. That’s done by passing a list of styles to EnforcedStyles.

Examples:

EnforcedHashRocketStyle: key (default)

# bad
{
  :foo => bar,
   :ba => baz
}
{
  :foo => bar,
  :ba  => baz
}

# good
{
  :foo => bar,
  :ba => baz
}

EnforcedHashRocketStyle: separator

# bad
{
  :foo => bar,
  :ba => baz
}
{
  :foo => bar,
  :ba  => baz
}

# good
{
  :foo => bar,
   :ba => baz
}

EnforcedHashRocketStyle: table

# bad
{
  :foo => bar,
   :ba => baz
}

# good
{
  :foo => bar,
  :ba  => baz
}

EnforcedColonStyle: key (default)

# bad
{
  foo: bar,
   ba: baz
}
{
  foo: bar,
  ba:  baz
}

# good
{
  foo: bar,
  ba: baz
}

EnforcedColonStyle: separator

# bad
{
  foo: bar,
  ba: baz
}

# good
{
  foo: bar,
   ba: baz
}

EnforcedColonStyle: table

# bad
{
  foo: bar,
  ba: baz
}

# good
{
  foo: bar,
  ba:  baz
}

EnforcedLastArgumentHashStyle: always_inspect (default)

# Inspect both implicit and explicit hashes.

# bad
do_something(foo: 1,
  bar: 2)

# bad
do_something({foo: 1,
  bar: 2})

# good
do_something(foo: 1,
             bar: 2)

# good
do_something(
  foo: 1,
  bar: 2
)

# good
do_something({foo: 1,
              bar: 2})

# good
do_something({
  foo: 1,
  bar: 2
})

EnforcedLastArgumentHashStyle: always_ignore

# Ignore both implicit and explicit hashes.

# good
do_something(foo: 1,
  bar: 2)

# good
do_something({foo: 1,
  bar: 2})

EnforcedLastArgumentHashStyle: ignore_implicit

# Ignore only implicit hashes.

# bad
do_something({foo: 1,
  bar: 2})

# good
do_something(foo: 1,
  bar: 2)

EnforcedLastArgumentHashStyle: ignore_explicit

# Ignore only explicit hashes.

# bad
do_something(foo: 1,
  bar: 2)

# good
do_something({foo: 1,
  bar: 2})

Constant Summary

MSG =

'Align the elements of a hash literal if they span more than ' \
'one line.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

• #column_deltas ⇒ Object

  Returns the value of attribute column_deltas.

• #offences_by ⇒ Object

  Returns the value of attribute offences_by.

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #autocorrect(node) ⇒ Object
• #on_hash(node) ⇒ Object
• #on_send(node) ⇒ Object (also: #on_super, #on_yield)

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Attribute Details

#column_deltas ⇒ Object

Returns the value of attribute column_deltas.

# File 'lib/rubocop/cop/layout/align_hash.rb', line 219

def column_deltas
  @column_deltas
end

#offences_by ⇒ Object

Returns the value of attribute offences_by.

# File 'lib/rubocop/cop/layout/align_hash.rb', line 218

def offences_by
  @offences_by
end

Instance Method Details

#autocorrect(node) ⇒ Object

# File 'lib/rubocop/cop/layout/align_hash.rb', line 211

def autocorrect(node)
  delta = column_deltas[alignment_for(node).first.class][node]
  return if delta.nil?

  correct_node(node, delta)
end

#on_hash(node) ⇒ Object

# File 'lib/rubocop/cop/layout/align_hash.rb', line 199

def on_hash(node)
  return if ignored_node?(node)
  return if node.pairs.empty? || node.single_line?

  return unless alignment_for_hash_rockets
                .any? { |a| a.checkable_layout?(node) } &&
                alignment_for_colons
                .any? { |a| a.checkable_layout?(node) }

  check_pairs(node)
end

#on_send(node) ⇒ Object Also known as: on_super, on_yield

# File 'lib/rubocop/cop/layout/align_hash.rb', line 185

def on_send(node)
  return if double_splat?(node)
  return unless node.arguments?

  last_argument = node.last_argument

  return unless last_argument.hash_type? &&
                ignore_hash_argument?(last_argument)

  ignore_node(last_argument)
end