123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::MultilineMethodSignature

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
self, ::RuboCop::Cop::RangeHelp, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/multiline_method_signature.rb

Overview

Checks for method signatures that span multiple lines.

Examples:

# good

def foo(bar, baz)
end

# bad

def foo(bar,
        baz)
end

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

support_autocorrect?

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.
.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.
.badge

Naming.
.callbacks_needed, .cop_name, .department,
.documentation_url

Returns a url to view this cops documentation online.
.exclude_from_registry

Call for abstract Cop classes.
.inherited,
.joining_forces

Override and return the Force class(es) you need to join.
.match?

Returns true if the cop name or the cop namespace matches any of the given names.
.new,
.requires_gem

Register a version requirement for the given gem name.
.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.
transform

Instance Attribute Summary

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

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

Instance Method Summary

::RuboCop::Cop::RangeHelp - Included

#add_range, #column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.
#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.
#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.
#begin_investigation

Called before any investigation.
#callbacks_needed,
#cop_config

Configuration Helpers.
#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:
#inspect,
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.
#name

Alias for Base#cop_name.
#offenses,
#on_investigation_end

Called after all on_…​
#on_new_investigation

Called before all on_…​
#on_other_file

Called instead of all on_…​
#parse

There should be very limited reasons for a Cop to do it’s own parsing.
#parser_engine,
#ready

Called between investigations.
#relevant_file?,
#target_gem_version

Returns a gems locked versions (i.e.
#target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.
#complete_investigation

Called to complete an investigation.
#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.
#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #heredoc_range, #max_line_length, #multiline_ranges, #multiline_string?,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #range_overlaps_offense?, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Instance Method Details

#arguments_range(node) (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/multiline_method_signature.rb', line 69



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, begin_of_arguments)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_method_signature.rb', line 42



def autocorrect(corrector, node, begin_of_arguments)
  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

  arguments_range = arguments_range(node)
  # If the method name isn't on the same line as def, move it directly after def
  if arguments_range.first_line != opening_line(node)
    corrector.remove(node.loc.name)
    corrector.insert_after(node.loc.keyword, " #{node.loc.name.source}")
  end

  corrector.remove(arguments_range)
  corrector.insert_after(begin_of_arguments, joined_arguments)
end


  








  

    #closing_line(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_method_signature.rb', line 81



def closing_line(node)
  node.arguments.last_line
end


  








  

    #correction_exceeds_max_line_length?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_method_signature.rb', line 85



def correction_exceeds_max_line_length?(node)
  indentation_width(node) + definition_width(node) > max_line_length
end


  








  

    #definition_width(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_method_signature.rb', line 93



def definition_width(node)
  node.source_range.begin.join(node.arguments.source_range.end).length
end


  








  

    #indentation_width(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_method_signature.rb', line 89



def indentation_width(node)
  processed_source.line_indentation(node.source_range.line)
end


  








  

    #last_line_source_of_arguments(arguments)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_method_signature.rb', line 65



def last_line_source_of_arguments(arguments)
  processed_source[arguments.last_line - 1].strip
end


  








  

    #max_line_length   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_method_signature.rb', line 97



def max_line_length
  config.for_cop('Layout/LineLength')['Max'] || 120
end


  








  

    #on_def(node)  
    Also known as: #on_defs
  

  [ GitHub ]


  

  


# 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)
  return unless (begin_of_arguments = node.arguments.loc.begin)

  add_offense(node) do |corrector|
    autocorrect(corrector, node, begin_of_arguments)
  end
end


  








  

    #on_defs(node)  
  



  

    


Alias for #on_def.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_method_signature.rb', line 37



alias on_defs on_def


  








  

    #opening_line(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/multiline_method_signature.rb', line 77



def opening_line(node)
  node.first_line
end