Module: RuboCop::Cop::MultilineExpressionIndentation

Included in:
Layout::MultilineMethodCallIndentation, Layout::MultilineOperationIndentation
Defined in:
lib/rubocop/cop/mixin/multiline_expression_indentation.rb

Overview

Common functionality for checking multiline method calls and binary operations.

Instance Method Summary collapse

Instance Method Details

#argument_in_method_call(node, kind) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 108

def argument_in_method_call(node, kind)
  node.each_ancestor(:send, :block).find do |a|
    # If the node is inside a block, it makes no difference if that block
    # is an argument in a method call. It doesn't count.
    break false if a.block_type?

    next if a.setter_method?

    a.arguments.any? do |arg|
      within_node?(node, arg) && (kind == :with_or_without_parentheses ||
                                  kind == :with_parentheses &&
                                  parentheses?(node.parent))
    end
  end
end

#assignment_rhs(node) ⇒ Object 



154
155
156
157
158
159
160
161
162
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 154

def assignment_rhs(node)
  case node.type
  when :casgn   then _scope, _lhs, rhs = *node
  when :op_asgn then _lhs, _op, rhs = *node
  when :send    then rhs = node.last_argument
  else               _lhs, rhs = *node
  end
  rhs
end

#check(range, node, lhs, rhs) ⇒ Object 



58
59
60
61
62
63
64
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 58

def check(range, node, lhs, rhs)
  if range
    incorrect_style_detected(range, node, lhs, rhs)
  else
    correct_style_detected
  end
end

#correct_indentation(node) ⇒ Object 



48
49
50
51
52
53
54
55
56
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 48

def correct_indentation(node)
  if kw_node_with_special_indentation(node)
    # This cop could have its own IndentationWidth configuration
    configured_indentation_width +
      @config.for_cop('Layout/IndentationWidth')['Width']
  else
    configured_indentation_width
  end
end

#grouped_expression?(node) ⇒ Boolean

Returns:

  • (Boolean) 


171
172
173
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 171

def grouped_expression?(node)
  node.begin_type? && node.loc.respond_to?(:begin) && node.loc.begin
end

#incorrect_style_detected(range, node, lhs, rhs) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 66

def incorrect_style_detected(range, node, lhs, rhs)
  add_offense(range, range, message(node, lhs, rhs)) do
    if supported_styles.size > 2 ||
       offending_range(node, lhs, rhs, alternative_style)
      unrecognized_style_detected
    else
      opposite_style_detected
    end
  end
end

#indentation(node) ⇒ Object 



77
78
79
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 77

def indentation(node)
  node.source_range.source_line =~ /\S/
end

#inside_arg_list_parentheses?(node, ancestor) ⇒ Boolean

Returns:

  • (Boolean) 


175
176
177
178
179
180
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 175

def inside_arg_list_parentheses?(node, ancestor)
  return false unless ancestor.send_type? && ancestor.parenthesized?

  node.source_range.begin_pos > ancestor.loc.begin.begin_pos &&
    node.source_range.end_pos < ancestor.loc.end.end_pos
end

#kw_node_with_special_indentation(node) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 94

def kw_node_with_special_indentation(node)
  node.each_ancestor.find do |a|
    next unless a.loc.respond_to?(:keyword)

    case a.type
    when :for                  then _, expression, = *a
    when :return               then expression, = *a
    when *Util::MODIFIER_NODES then expression, = *a
    end

    within_node?(node, expression) if expression
  end
end

#left_hand_side(lhs) ⇒ Object

In a chain of method calls, we regard the top send node as the base for indentation of all lines following the first. For example: a.

b c { block }.            <-- b is indented relative to a
d                         <-- d is indented relative to a



23
24
25
26
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 23

def left_hand_side(lhs)
  lhs = lhs.parent while lhs.parent && lhs.parent.send_type?
  lhs
end

#not_for_this_cop?(node) ⇒ Boolean

Returns:

  • (Boolean) 


164
165
166
167
168
169
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 164

def not_for_this_cop?(node)
  node.ancestors.any? do |ancestor|
    grouped_expression?(ancestor) ||
      inside_arg_list_parentheses?(node, ancestor)
  end
end

#on_send(node) ⇒ Object 



8
9
10
11
12
13
14
15
16
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 8

def on_send(node)
  return if !node.receiver || node.method?(:[])
  return unless relevant_node?(node)

  lhs = left_hand_side(node.receiver)
  rhs = right_hand_side(node)
  range = offending_range(node, lhs, rhs, style)
  check(range, node, lhs, rhs)
end

#operation_description(node, rhs) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 81

def operation_description(node, rhs)
  ancestor = kw_node_with_special_indentation(node)
  if ancestor
    kw = ancestor.loc.keyword.source
    kind = kw == 'for' ? 'collection' : 'condition'
    article = kw =~ /^[iu]/ ? 'an' : 'a'
    "a #{kind} in #{article} `#{kw}` statement"
  else
    'an expression' +
      (part_of_assignment_rhs(node, rhs) ? ' in an assignment' : '')
  end
end

#part_of_assignment_rhs(node, candidate) ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 124

def part_of_assignment_rhs(node, candidate)
  node.each_ancestor.find do |a|
    case a.type
    when :if, :while, :until, :for, :return, :array, :kwbegin
      break # other kinds of alignment
    when :block
      break if part_of_block_body?(candidate, a)
    when :send
      valid_method_rhs_candidate?(candidate, a)
    when *Util::ASGN_NODES
      valid_rhs_candidate?(candidate, assignment_rhs(a))
    end
  end
end

#part_of_block_body?(candidate, node) ⇒ Boolean

Returns:

  • (Boolean) 


149
150
151
152
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 149

def part_of_block_body?(candidate, node)
  _method, _args, body = *node
  body && within_node?(candidate, body)
end

#regular_method_right_hand_side(send_node) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 36

def regular_method_right_hand_side(send_node)
  dot = send_node.loc.dot
  selector = send_node.loc.selector
  if send_node.dot? && selector && dot.line == selector.line
    dot.join(selector)
  elsif selector
    selector
  elsif send_node.implicit_call?
    dot.join(send_node.loc.begin)
  end
end

#right_hand_side(send_node) ⇒ Object 



28
29
30
31
32
33
34
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 28

def right_hand_side(send_node)
  if send_node.operator_method? && send_node.arguments?
    send_node.first_argument.source_range # not used for method calls
  else
    regular_method_right_hand_side(send_node)
  end
end

#valid_method_rhs_candidate?(candidate, node) ⇒ Boolean

The []= operator and setters (a.b = c) are parsed as :send nodes.

Returns:

  • (Boolean) 


140
141
142
143
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 140

def valid_method_rhs_candidate?(candidate, node)
  node.setter_method? &&
    valid_rhs_candidate?(candidate, node.last_argument)
end

#valid_rhs_candidate?(candidate, node) ⇒ Boolean

Returns:

  • (Boolean) 


145
146
147
 
# File 'lib/rubocop/cop/mixin/multiline_expression_indentation.rb', line 145

def valid_rhs_candidate?(candidate, node)
  !candidate || within_node?(candidate, node)
end