class RuboCop::Cop::Layout::HashAlignment

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

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

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

@example EnforcedHashRocketStyle: key (default)

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

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

@example EnforcedHashRocketStyle: separator

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

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

@example EnforcedHashRocketStyle: table

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

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

@example EnforcedColonStyle: key (default)

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

# good
{
  foo: bar,
  ba: baz
}

@example EnforcedColonStyle: separator

# bad
{
  foo: bar,
  ba: baz
}

# good
{
  foo: bar,
   ba: baz
}

@example EnforcedColonStyle: table

# bad
{
  foo: bar,
  ba: baz
}

# good
{
  foo: bar,
  ba:  baz
}

@example 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
})

@example EnforcedLastArgumentHashStyle: always_ignore

# Ignore both implicit and explicit hashes.

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

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

@example EnforcedLastArgumentHashStyle: ignore_implicit

# Ignore only implicit hashes.

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

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

@example EnforcedLastArgumentHashStyle: ignore_explicit

# Ignore only explicit hashes.

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

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

Constants

MESSAGES
SEPARATOR_ALIGNMENT_STYLES

Attributes

column_deltas[RW]
offenses_by[RW]

Public Instance Methods

on_hash(node) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 208
def on_hash(node)
  return if autocorrect_incompatible_with_other_cops?(node) || ignored_node?(node) ||
            node.pairs.empty? || node.single_line?

  proc = ->(a) { a.checkable_layout?(node) }
  return unless alignment_for_hash_rockets.any?(proc) && alignment_for_colons.any?(proc)

  check_pairs(node)
end
on_send(node) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 195
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
Also aliased as: on_super, on_yield
on_super(node)
Alias for: on_send
on_yield(node)
Alias for: on_send

Private Instance Methods

add_offenses() click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 265
def add_offenses
  kwsplat_offenses = offenses_by.delete(KeywordSplatAlignment)
  register_offenses_with_format(kwsplat_offenses, KeywordSplatAlignment)

  format, offenses = offenses_by.min_by { |_, v| v.length }
  register_offenses_with_format(offenses, format)
end
adjust(corrector, delta, range) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 371
def adjust(corrector, delta, range)
  if delta.positive?
    corrector.insert_before(range, ' ' * delta)
  elsif delta.negative?
    range = range_between(range.begin_pos - delta.abs, range.begin_pos)
    corrector.remove(range)
  end
end
alignment_for(pair) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 300
def alignment_for(pair)
  if pair.kwsplat_type?
    [KeywordSplatAlignment.new]
  elsif pair.hash_rocket?
    alignment_for_hash_rockets
  else
    alignment_for_colons
  end
end
alignment_for_colons() click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 314
def alignment_for_colons
  @alignment_for_colons ||= new_alignment('EnforcedColonStyle')
end
alignment_for_hash_rockets() click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 310
def alignment_for_hash_rockets
  @alignment_for_hash_rockets ||= new_alignment('EnforcedHashRocketStyle')
end
argument_alignment_config() click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 390
def argument_alignment_config
  config.for_cop('Layout/ArgumentAlignment')
end
argument_before_hash(hash_node) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 233
def argument_before_hash(hash_node)
  hash_node.left_sibling.respond_to?(:loc) ? hash_node.left_sibling : nil
end
autocorrect_incompatible_with_other_cops?(node) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 222
def autocorrect_incompatible_with_other_cops?(node)
  return false unless enforce_first_argument_with_fixed_indentation? &&
                      node.pairs.any? &&
                      node.parent&.call_type?

  left_sibling = argument_before_hash(node)
  parent_loc = node.parent.loc
  selector = left_sibling || parent_loc.selector || parent_loc.expression
  same_line?(selector, node.pairs.first)
end
check_delta(delta, node:, alignment:) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 283
def check_delta(delta, node:, alignment:)
  offenses_by[alignment.class] ||= []
  return if good_alignment? delta

  column_deltas[alignment.class][node] = delta
  offenses_by[alignment.class].push(node)
end
check_pairs(node) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 246
def check_pairs(node)
  first_pair = node.pairs.first
  reset!

  alignment_for(first_pair).each do |alignment|
    delta = alignment.deltas_for_first_pair(first_pair, node)
    check_delta delta, node: first_pair, alignment: alignment
  end

  node.children.each do |current|
    alignment_for(current).each do |alignment|
      delta = alignment.deltas(first_pair, current)
      check_delta delta, node: current, alignment: alignment
    end
  end

  add_offenses
end
correct_key_value(corrector, delta, key, value, separator) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 337
def correct_key_value(corrector, delta, key, value, separator)
  # We can't use the instance variable inside the lambda. That would
  # just give each lambda the same reference and they would all get the
  # last value of each. Some local variables fix the problem.
  separator_delta = delta[:separator] || 0
  value_delta     = delta[:value]     || 0
  key_delta       = delta[:key]       || 0

  key_column = key.column
  key_delta = -key_column if key_delta < -key_column

  adjust(corrector, key_delta, key)
  adjust(corrector, separator_delta, separator)
  adjust(corrector, value_delta, value)
end
correct_no_value(corrector, key_delta, key) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 333
def correct_no_value(corrector, key_delta, key)
  adjust(corrector, key_delta, key)
end
correct_node(corrector, node, delta) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 318
def correct_node(corrector, node, delta)
  # We can't use the instance variable inside the lambda. That would
  # just give each lambda the same reference and they would all get the
  # last value of each. A local variable fixes the problem.

  if node.value && node.respond_to?(:value_omission?) && !node.value_omission?
    correct_key_value(corrector, delta, node.key.source_range,
                      node.value.source_range,
                      node.loc.operator)
  else
    delta_value = delta[:key] || 0
    correct_no_value(corrector, delta_value, node.source_range)
  end
end
double_splat?(node) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 242
def double_splat?(node)
  node.children.last.is_a?(Symbol)
end
enforce_first_argument_with_fixed_indentation?() click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 384
def enforce_first_argument_with_fixed_indentation?
  return false unless argument_alignment_config['Enabled']

  argument_alignment_config['EnforcedStyle'] == 'with_fixed_indentation'
end
good_alignment?(column_deltas) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 380
def good_alignment?(column_deltas)
  column_deltas.values.all?(&:zero?)
end
ignore_hash_argument?(node) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 291
def ignore_hash_argument?(node)
  case cop_config['EnforcedLastArgumentHashStyle']
  when 'always_inspect'  then false
  when 'always_ignore'   then true
  when 'ignore_explicit' then node.braces?
  when 'ignore_implicit' then !node.braces?
  end
end
new_alignment(key) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 353
def new_alignment(key)
  formats = cop_config[key]
  formats = [formats] if formats.is_a? String

  formats.uniq.map do |format|
    case format
    when 'key'
      KeyAlignment.new
    when 'table'
      TableAlignment.new
    when 'separator'
      SeparatorAlignment.new
    else
      raise "Unknown #{key}: #{formats}"
    end
  end
end
register_offenses_with_format(offenses, format) click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 273
def register_offenses_with_format(offenses, format)
  (offenses || []).each do |offense|
    add_offense(offense, message: MESSAGES[format]) do |corrector|
      delta = column_deltas[alignment_for(offense).first.class][offense]

      correct_node(corrector, offense, delta) unless delta.nil?
    end
  end
end
reset!() click to toggle source
# File lib/rubocop/cop/layout/hash_alignment.rb, line 237
def reset!
  self.offenses_by = {}
  self.column_deltas = Hash.new { |hash, key| hash[key] = {} }
end