Class: RuboCop::Cop::Layout::MultilineAssignmentLayout

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
CheckAssignment, ConfigurableEnforcedStyle, RangeHelp
Defined in:
lib/rubocop/cop/layout/multiline_assignment_layout.rb

Overview

This cop checks whether the multiline assignments have a newline after the assignment operator.

Examples:

EnforcedStyle: new_line (default)

# bad
foo = if expression
  'bar'
end

# good
foo =
  if expression
    'bar'
  end

# good
foo =
  begin
    compute
  rescue => e
    nil
  end

EnforcedStyle: same_line

# good
foo = if expression
  'bar'
end

SupportedTypes: ['block', 'case', 'class', 'if', 'kwbegin', 'module'] (default)

# good
foo =
  if expression
    'bar'
  end

# good
foo =
  [1].map do |i|
    i + 1
  end

SupportedTypes: ['block']

# good
foo = if expression
  'bar'
end

# good
foo =
  [1].map do |i|
    'bar' * i
  end

Constant Summary collapse

NEW_LINE_OFFENSE =
'Right hand side of multi-line assignment is on ' \
'the same line as the assignment operator `=`.'
SAME_LINE_OFFENSE =
'Right hand side of multi-line assignment is not ' \
'on the same line as the assignment operator `=`.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods included from CheckAssignment

extract_rhs, #on_lvasgn, #on_send

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, 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, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

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

silence_warnings

Constructor Details

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

Instance Method Details

#check_assignment(node, rhs) ⇒ Object


72
73
74
75
76
77
78
79
# File 'lib/rubocop/cop/layout/multiline_assignment_layout.rb', line 72

def check_assignment(node, rhs)
  return if node.send_type? && node.loc.operator&.source != '='
  return unless rhs
  return unless supported_types.include?(rhs.type)
  return if rhs.first_line == rhs.last_line

  check_by_enforced_style(node, rhs)
end

#check_by_enforced_style(node, rhs) ⇒ Object


81
82
83
84
85
86
87
88
# File 'lib/rubocop/cop/layout/multiline_assignment_layout.rb', line 81

def check_by_enforced_style(node, rhs)
  case style
  when :new_line
    check_new_line_offense(node, rhs)
  when :same_line
    check_same_line_offense(node, rhs)
  end
end

#check_new_line_offense(node, rhs) ⇒ Object


90
91
92
93
94
95
96
# File 'lib/rubocop/cop/layout/multiline_assignment_layout.rb', line 90

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

  add_offense(node, message: NEW_LINE_OFFENSE) do |corrector|
    corrector.insert_after(node.loc.operator, "\n")
  end
end

#check_same_line_offense(node, rhs) ⇒ Object


98
99
100
101
102
103
104
105
106
107
# File 'lib/rubocop/cop/layout/multiline_assignment_layout.rb', line 98

def check_same_line_offense(node, rhs)
  return unless node.loc.operator.line != rhs.first_line

  add_offense(node, message: SAME_LINE_OFFENSE) do |corrector|
    range = range_between(
      node.loc.operator.end_pos, extract_rhs(node).source_range.begin_pos
    )
    corrector.replace(range, ' ')
  end
end