Class: RuboCop::Cop::Style::AlignHash

Inherits:
Cop
  • Object
show all
Includes:
IgnoredNode
Defined in:
lib/rubocop/cop/style/align_hash.rb

Overview

Here we check if the keys, separators, and values of a multi-line hash literal are aligned.

Defined Under Namespace

Classes: AlignmentOfValues, KeyAlignment, SeparatorAlignment, TableAlignment

Constant Summary collapse

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

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #display_cop_names?, #exclude_file?, #include_file?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from Util

block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes

Methods included from PathUtil

match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_hash(node) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/rubocop/cop/style/align_hash.rb', line 156

def on_hash(node)
  return if ignored_node?(node)
  return if node.children.empty?
  return unless multiline?(node)

  @alignment_for_hash_rockets ||=
    new_alignment('EnforcedHashRocketStyle')
  @alignment_for_colons ||= new_alignment('EnforcedColonStyle')

  first_pair = node.children.first

  unless @alignment_for_hash_rockets.checkable_layout(node) &&
      @alignment_for_colons.checkable_layout(node)
    return
  end

  @column_deltas = alignment_for(first_pair)
    .deltas_for_first_pair(first_pair, node)
  add_offense(first_pair, :expression) unless good_alignment?

  node.children.each_cons(2) do |prev, current|
    @column_deltas = alignment_for(current).deltas(first_pair, prev,
                                                   current)
    add_offense(current, :expression) unless good_alignment?
  end
end

#on_send(node) ⇒ Object 



149
150
151
152
153
154
 
# File 'lib/rubocop/cop/style/align_hash.rb', line 149

def on_send(node)
  return unless (last_child = node.children.last) &&
    hash?(last_child) && ignore_last_argument_hash?(last_child)

  ignore_node(last_child)
end