Class: RuboCop::Cop::Style::MultilineAssignmentLayout

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

Overview

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

Examples:

# bad (with EnforcedStyle set to new_line)
foo = if expression
  'bar'
end

# good (with EnforcedStyle set to same_line)
foo = if expression
  'bar'
end

# good (with EnforcedStyle set to new_line)
foo =
  if expression
    'bar'
  end

# good (with EnforcedStyle set to new_line)
foo =
  begin
    compute
  rescue => e
    nil
  end

Constant Summary collapse

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

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

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, #supported_styles, #unexpected_style_detected

Methods included from CheckAssignment

extract_rhs, #on_send

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?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, ternary_op?, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/rubocop/cop/style/multiline_assignment_layout.rb', line 69

def autocorrect(node)
  case style
  when :new_line
    ->(corrector) { corrector.insert_after(node.loc.operator, "\n") }
  when :same_line
    range = Parser::Source::Range.new(
      node.source_range.source_buffer,
      node.loc.operator.end_pos,
      extract_rhs(node).source_range.begin_pos)

    ->(corrector) { corrector.replace(range, ' ') }
  end
end

#check_assignment(node, rhs) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/rubocop/cop/style/multiline_assignment_layout.rb', line 44

def check_assignment(node, rhs)
  return unless rhs
  return unless supported_types.include?(rhs.type)
  return if rhs.loc.first_line == rhs.loc.last_line

  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 



57
58
59
60
61
 
# File 'lib/rubocop/cop/style/multiline_assignment_layout.rb', line 57

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

  add_offense(node, :expression, NEW_LINE_OFFENSE)
end

#check_same_line_offense(node, rhs) ⇒ Object 



63
64
65
66
67
 
# File 'lib/rubocop/cop/style/multiline_assignment_layout.rb', line 63

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

  add_offense(node, :expression, SAME_LINE_OFFENSE)
end