class RuboCop::Cop::Style::MultilineMethodSignature
Checks for method signatures that span multiple lines.
@example
# good def foo(bar, baz) end # bad def foo(bar, baz) end
Constants
- MSG
Public Instance Methods
on_def(node)
click to toggle source
# File lib/rubocop/cop/style/multiline_method_signature.rb, line 27 def on_def(node) return unless node.arguments? return if opening_line(node) == closing_line(node) return if correction_exceeds_max_line_length?(node) add_offense(node) { |corrector| autocorrect(corrector, node) } end
Also aliased as: on_defs
Private Instance Methods
arguments_range(node)
click to toggle source
# File lib/rubocop/cop/style/multiline_method_signature.rb, line 57 def arguments_range(node) range = range_between( node.first_argument.source_range.begin_pos, node.last_argument.source_range.end_pos ) range_with_surrounding_space(range, side: :left) end
autocorrect(corrector, node)
click to toggle source
# File lib/rubocop/cop/style/multiline_method_signature.rb, line 38 def autocorrect(corrector, node) arguments = node.arguments joined_arguments = arguments.map(&:source).join(', ') last_line_source_of_arguments = last_line_source_of_arguments(arguments) if last_line_source_of_arguments.start_with?(')') joined_arguments = "#{joined_arguments}#{last_line_source_of_arguments}" corrector.remove(range_by_whole_lines(arguments.loc.end, include_final_newline: true)) end corrector.remove(arguments_range(node)) corrector.insert_after(arguments.loc.begin, joined_arguments) end
closing_line(node)
click to toggle source
# File lib/rubocop/cop/style/multiline_method_signature.rb, line 69 def closing_line(node) node.arguments.last_line end
correction_exceeds_max_line_length?(node)
click to toggle source
# File lib/rubocop/cop/style/multiline_method_signature.rb, line 73 def correction_exceeds_max_line_length?(node) indentation_width(node) + definition_width(node) > max_line_length end
definition_width(node)
click to toggle source
# File lib/rubocop/cop/style/multiline_method_signature.rb, line 81 def definition_width(node) node.source_range.begin.join(node.arguments.source_range.end).length end
indentation_width(node)
click to toggle source
# File lib/rubocop/cop/style/multiline_method_signature.rb, line 77 def indentation_width(node) processed_source.line_indentation(node.loc.expression.line) end
last_line_source_of_arguments(arguments)
click to toggle source
# File lib/rubocop/cop/style/multiline_method_signature.rb, line 53 def last_line_source_of_arguments(arguments) processed_source[arguments.last_line - 1].strip end
max_line_length()
click to toggle source
# File lib/rubocop/cop/style/multiline_method_signature.rb, line 85 def max_line_length config.for_cop('Layout/LineLength')['Max'] || 120 end
opening_line(node)
click to toggle source
# File lib/rubocop/cop/style/multiline_method_signature.rb, line 65 def opening_line(node) node.first_line end