Class: RuboCop::Cop::Layout::AssignmentIndentation

Inherits:
Cop
  • Object
show all
Includes:
Alignment, CheckAssignment
Defined in:
lib/rubocop/cop/layout/assignment_indentation.rb

Overview

This cop checks the indentation of the first line of the right-hand-side of a multi-line assignment.

The indentation of the remaining lines can be corrected with other cops such as `IndentationConsistency` and `EndAlignment`.

Examples:

# bad
value =
if foo
  'bar'
end

# good
value =
  if foo
    'bar'
  end

Constant Summary collapse

MSG = 
'Indent the first line of the right-hand-side of a ' \
'multi-line assignment.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#offenses

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from CheckAssignment

extract_rhs, #on_lvasgn, #on_send

Methods inherited from Cop

#add_offense, all, #corrections, #find_location, #highlights, joining_forces, #messages, #on_investigation_end, #on_new_investigation, #parse, qualified_cop_name, registry, support_autocorrect?, #support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, 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?, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 


40
41
42
 
# File 'lib/rubocop/cop/layout/assignment_indentation.rb', line 40

def autocorrect(node)
  AlignmentCorrector.correct(processed_source, node, column_delta)
end

#check_assignment(node, rhs) ⇒ Object 


31
32
33
34
35
36
37
38
 
# File 'lib/rubocop/cop/layout/assignment_indentation.rb', line 31

def check_assignment(node, rhs)
  return unless rhs
  return unless node.loc.operator
  return if node.loc.operator.line == rhs.first_line

  base = display_column(leftmost_multiple_assignment(node).source_range)
  check_alignment([rhs], base + configured_indentation_width)
end

#leftmost_multiple_assignment(node) ⇒ Object 


44
45
46
47
48
49
50
51
 
# File 'lib/rubocop/cop/layout/assignment_indentation.rb', line 44

def leftmost_multiple_assignment(node)
  return node unless same_line?(node, node.parent) &&
                     node.parent.assignment?

  leftmost_multiple_assignment(node.parent)

  node.parent
end