123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::EndlessMethod

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

Overview

Checks for endless methods.

It can enforce endless method definitions whenever possible or with single line methods. It can also disallow multiline endless method definitions or all endless definitions.

require_single_line style enforces endless method definitions for single line methods. require_always style enforces endless method definitions for single statement methods.

Other method definition types are not considered by this cop.

The supported styles are:

  • allow_single_line (default) - only single line endless method definitions are allowed.

  • allow_always - all endless method definitions are allowed.

  • disallow - all endless method definitions are disallowed.

  • require_single_line - endless method definitions are required for single line methods.

  • require_always - all endless method definitions are required.

Note
 Incorrect endless method definitions will always be corrected to a multi-line definition.

Examples:

EnforcedStyle: allow_single_line (default)

# bad, multi-line endless method
def my_method = x.foo
                 .bar
                 .baz

# good
def my_method
  x
end

# good
def my_method = x

# good
def my_method
  x.foo
   .bar
   .baz
end

EnforcedStyle: allow_always

# good
def my_method
  x
end

# good
def my_method = x

# good
def my_method = x.foo
                 .bar
                 .baz

# good
def my_method
  x.foo
   .bar
   .baz
end

EnforcedStyle: disallow

# bad
def my_method = x

# bad
def my_method = x.foo
                 .bar
                 .baz

# good
def my_method
  x
end

# good
def my_method
  x.foo
   .bar
   .baz
end

EnforcedStyle: require_single_line

# bad
def my_method
  x
end

# bad
def my_method = x.foo
                 .bar
                 .baz

# good
def my_method = x

# good
def my_method
  x.foo
   .bar
   .baz
end

EnforcedStyle: require_always

# bad
def my_method
  x
end

# bad
def my_method
  x.foo
   .bar
   .baz
end

# good
def my_method = x

# good
def my_method = x.foo
                 .bar
                 .baz

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

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::TargetRubyVersion - Extended

maximum_target_ruby_version, minimum_target_ruby_version, required_maximum_ruby_version, required_minimum_ruby_version, support_target_ruby_version?

::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::ConfigurableEnforcedStyle - Included

#detected_style, #detected_style=, #no_acceptable_style?, #style_configured?

::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::EndlessMethodRewriter - Included

#correct_to_multiline, #arguments

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

#alternative_style, #alternative_styles, #ambiguous_style_detected,
#conflicting_styles_detected

Alias for ConfigurableEnforcedStyle#no_acceptable_style!.
#correct_style_detected, #no_acceptable_style!, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected,
#unrecognized_style_detected

Alias for ConfigurableEnforcedStyle#no_acceptable_style!.

::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(node, missing = '') (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/endless_method.rb', line 217



def arguments(node, missing = '')
  node.arguments.any? ? node.arguments.source : missing
end


  








  

    #can_be_made_endless?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/endless_method.rb', line 221



def can_be_made_endless?(node)
  node.body && !node.body.begin_type? && !node.body.kwbegin_type?
end


  








  

    #correct_to_multiline(corrector, node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/endless_method.rb', line 201



def correct_to_multiline(corrector, node)
  replacement = <<~RUBY.strip
    def #{node.method_name}#{arguments(node)}
      #{node.body.source}
    end
  RUBY

  corrector.replace(node, replacement)
end


  








  

    #endless_replacement(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/endless_method.rb', line 211



def endless_replacement(node)
  <<~RUBY.strip
    def #{node.method_name}#{arguments(node)} = #{node.body.source}
  RUBY
end


  








  

    #handle_allow_style(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/endless_method.rb', line 163



def handle_allow_style(node)
  return unless node.endless?
  return if node.single_line? || style == :allow_always

  add_offense(node, message: MSG_MULTI_LINE) do |corrector|
    correct_to_multiline(corrector, node)
  end
end


  








  

    #handle_disallow_style(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/endless_method.rb', line 195



def handle_disallow_style(node)
  return unless node.endless?

  add_offense(node) { |corrector| correct_to_multiline(corrector, node) }
end


  








  

    #handle_require_always_style(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/endless_method.rb', line 186



def handle_require_always_style(node)
  return if node.endless? || !can_be_made_endless?(node)
  return if too_long_when_made_endless?(node)

  add_offense(node, message: MSG_REQUIRE_ALWAYS) do |corrector|
    corrector.replace(node, endless_replacement(node))
  end
end


  








  

    #handle_require_single_line_style(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/endless_method.rb', line 172



def handle_require_single_line_style(node)
  if node.endless? && !node.single_line?
    add_offense(node, message: MSG_MULTI_LINE) do |corrector|
      correct_to_multiline(corrector, node)
    end
  elsif !node.endless? && can_be_made_endless?(node) && node.body.single_line?
    return if too_long_when_made_endless?(node)

    add_offense(node, message: MSG_REQUIRE_SINGLE) do |corrector|
      corrector.replace(node, endless_replacement(node))
    end
  end
end


  








  

    #on_def(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/endless_method.rb', line 146



def on_def(node)
  return if node.assignment_method?

  case style
  when :allow_single_line, :allow_always
    handle_allow_style(node)
  when :disallow
    handle_disallow_style(node)
  when :require_single_line
    handle_require_single_line_style(node)
  when :require_always
    handle_require_always_style(node)
  end
end


  








  

    #too_long_when_made_endless?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/endless_method.rb', line 225



def too_long_when_made_endless?(node)
  return false unless config.cop_enabled?('Layout/LineLength')

  endless_replacement(node).length > config.for_cop('Layout/LineLength')['Max']
end