Class: RuboCop::Cop::Style::IndentHash

Inherits:
Cop
  • Object
show all
Includes:
AutocorrectAlignment, ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/style/indent_hash.rb

Overview

This cops checks the indentation of the first key in a hash literal where the opening brace and the first key are on separate lines. The other keys' indentations are handled by the AlignHash cop.

By default, Hash literals that are arguments in a method call with parentheses, and where the opening curly brace of the hash is on the same line as the opening parenthesis of the method call, shall have their first key indented one step (two spaces) more than the position inside the opening parenthesis.

Other hash literals shall have their first key indented one step more than the start of the line where the opening curly brace is.

This default style is called 'special_inside_parentheses'. Alternative styles are 'consistent' and 'align_braces'. Here are examples:

# special_inside_parentheses
hash = {
  key: :value
}
but_in_a_method_call({
                       its_like: :this
                     })
# consistent
hash = {
  key: :value
}
and_in_a_method_call({
  no: :difference
})
# align_braces
and_now_for_something = {
                          completely: :different
                        }

Constant Summary

Constants included from AutocorrectAlignment

AutocorrectAlignment::SPACE

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, 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 ConfigurableEnforcedStyle

#alternative_style, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #unexpected_style_detected

Methods included from AutocorrectAlignment

#autocorrect, #check_alignment, #configured_indentation_width, #indentation, #offset, #start_of_line?

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_hash(node) ⇒ Object


45
46
47
48
# File 'lib/rubocop/cop/style/indent_hash.rb', line 45

def on_hash(node)
  left_brace = node.loc.begin
  check(node, left_brace, nil) if left_brace
end

#on_send(node) ⇒ Object


50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/rubocop/cop/style/indent_hash.rb', line 50

def on_send(node)
  _receiver, _method_name, *args = *node
  left_parenthesis = node.loc.begin
  return unless left_parenthesis

  args.each do |arg|
    on_node(:hash, arg, :send) do |hash_node|
      left_brace = hash_node.loc.begin
      if left_brace && left_brace.line == left_parenthesis.line
        check(hash_node, left_brace, left_parenthesis)
        ignore_node(hash_node)
      end
    end
  end
end