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::EndlessMethodBodyHelp`, `::RuboCop::Cop::EndlessMethodRewriter`, `::RuboCop::Cop::LineLengthHelp`, `::RuboCop::Cop::Alignment`, `::RuboCop::Cop::ConfigurableEnforcedStyle`, `::RuboCop::Cop::Base`, `::RuboCop::Cop::AutocorrectLogic`, `::RuboCop::Cop::IgnoredNode`, `::RuboCop::Util`, RuboCop::AST::Sexp
Inherits:	RuboCop::Cop::Base Object RuboCop::Cop::Base RuboCop::Cop::Style::EndlessMethod
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

CORRECTION_STYLES =
# File 'lib/rubocop/cop/style/endless_method.rb', line 142
```
%w[multiline single_line].freeze
```
MSG =
# File 'lib/rubocop/cop/style/endless_method.rb', line 143
```
'Avoid endless method definitions.'
```
MSG_MULTI_LINE =
# File 'lib/rubocop/cop/style/endless_method.rb', line 144
```
'Avoid endless method definitions with multiple lines.'
```
MSG_REQUIRE_ALWAYS =
# File 'lib/rubocop/cop/style/endless_method.rb', line 146
```
'Use endless method definitions.'
```
MSG_REQUIRE_SINGLE =
# File 'lib/rubocop/cop/style/endless_method.rb', line 145
```
'Use endless method definitions for single line methods.'
```

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

.autocorrect_incompatible_with

Style/MethodDefParentheses adds the same parentheses a parameter list needs in an endless definition, so letting both correct in the same pass would double them.

`::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	Reserved for Commissioner.

`::RuboCop::ExcludeLimit` - Extended

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

Instance Attribute Summary

#space_inside_parens? ⇒ Boolean readonly private

`::RuboCop::Cop::LineLengthHelp` - Included

#allow_cop_directives?, #allow_qualified_name?, #allow_rbs_inline_annotation?, #allow_uri?

`::RuboCop::Cop::Alignment` - Included

#column_delta, #using_tabs?

`::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?, #disabled_autocorrect?,
#preview?	Whether the user opted in to unstable behavior, with `--preview` or `AllCops: Preview`.
#processed_source, #project_index, #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?,
#skipped_unsafe_correction_with_disable_uncorrectable?	Whether a correction exists but is skipped because it is unsafe in a safe autocorrect run, while `--disable-uncorrectable` asks for a todo comment on everything this run cannot correct.
#contextual_autocorrect_held_back?	When LSP is enabled or the `--editor-mode` option is on, it is considered as editing source code, and autocorrection with `AutoCorrect: contextual` will not be performed.

Instance Method Summary

#on_def(node) (also: #on_defs)
#on_defs(node)

Alias for #on_def.
#arguments(node, missing = '') private
#body_to_end_range(node) private
#can_be_made_endless?(node) ⇒ Boolean private
#comment_in_discarded_range?(node) ⇒ Boolean private
#correct_to_endless(corrector, node) private
#endless_parent?(node) ⇒ Boolean private
#endless_replacement(node) private
#handle_allow_style(node) private
#handle_disallow_style(node) private
#handle_require_always_style(node) private
#handle_require_single_line_style(node) private
#line_when_made_endless(node) private
#name_to_arguments_range(node) private
#parenthesized_arguments(node) private
#receiver(node) private
#signature_to_body_range(node) private
#single_line_when_made_endless?(node) ⇒ Boolean private
#too_long_when_made_endless?(node) ⇒ Boolean private
#unparenthesized_arguments?(node) ⇒ Boolean private
#use_heredoc?(node) ⇒ Boolean private

`::RuboCop::Cop::EndlessMethodBodyHelp` - Included

#assigned_value, #command_call?, #command_disallowed_in_endless_body?, #endless_method_body?, #ends_with_anonymous_argument?, #ends_with_omitted_hash_value?,
#low_precedence_body?	`def foo = bar and baz` parses as `(def foo = bar) and baz`.
#multiple_values?	`foo = 1, 2` and `foo = *bar` assign an array without brackets.

`::RuboCop::Cop::EndlessMethodRewriter` - Included

#correct_to_multiline, #arguments, #configured_indentation_width, #receiver

`::RuboCop::Cop::LineLengthHelp` - Included

#allowed_position?, #directive_on_source_line?, #extend_end_position, #find_excessive_range, #indentation_difference, #line_length, #line_length_without_directive, #match_qualified_names, #match_uris, #qualified_name_regexp, #rbs_inline_annotation_on_source_line?, #tab_indentation_width, #uri_regexp, #valid_uri?

`::RuboCop::Cop::Alignment` - Included

#check_alignment, #configured_indentation_width, #display_column, #each_bad_alignment, #end_of_line_comment, #indentation, #offset, #register_offense, #within?

`::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	rubocop:disable-next Metrics.
#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	— grouped under the Commissioner heading above.
#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 the version of a gem in the target, by default its locked version (i.e. from Gemfile.lock or gems.locked).
#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, #covering_disabled_range, #current_corrector,
#current_offense_locations	Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?,
#enabled_lines?	A multi-line offense is suppressed by a directive on any line of its range, not only its first line, matching the intuition that the directive is attached to the offending code.
#file_name_matches_any?, #find_message, #find_severity, #matches_absolute_include_pattern?, #new_offense, #range_for_original, #range_from_node_or_range,
#reset_investigation	Actually private methods.
#suppression_reason	The `--` reason on the directive that suppresses offenses on this range, or `nil` when the directive carries none.
#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, #eol_comment, #eol_comment_would_be_inside_literal?, #heredoc_range, #line_with_eol_comment_too_long?, #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, #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

Class Method Details

.autocorrect_incompatible_with

Style/MethodDefParentheses adds the same parentheses a parameter list needs in an endless definition, so letting both correct in the same pass would double them.

[ GitHub ]

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


def self.autocorrect_incompatible_with
  [Style::MethodCallWithArgsParentheses, Style::MethodDefParentheses]
end

Instance Attribute Details

#space_inside_parens? ⇒ `Boolean` (readonly, private)

[ GitHub ]

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


def space_inside_parens?
  return false unless config.cop_enabled?('Layout/SpaceInsideParens')

  config.for_cop('Layout/SpaceInsideParens')['EnforcedStyle'] != 'no_space'
end

Instance Method Details

#arguments(node, missing = '') (private)

[ GitHub ]

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


def arguments(node, missing = '')
  return missing unless node.arguments.any?
  return parenthesized_arguments(node) if unparenthesized_arguments?(node)

  node.arguments.source
end

#body_to_end_range(node) (private)

[ GitHub ]

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


def body_to_end_range(node)
  node.body.source_range.end.join(node.loc.end.end)
end

#can_be_made_endless?(node) ⇒ `Boolean` (private)

[ GitHub ]

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


def can_be_made_endless?(node)
  return false unless node.body
  return false if comment_in_discarded_range?(node)

  endless_method_body?(node.body)
end

#comment_in_discarded_range?(node) ⇒ `Boolean` (private)

[ GitHub ]

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


def comment_in_discarded_range?(node)
  discarded_ranges = [signature_to_body_range(node), body_to_end_range(node)]

  processed_source.each_comment_in_lines(node.first_line..node.last_line).any? do |comment|
    discarded_ranges.any? { |range| range.contains?(comment.source_range) }
  end
end

#correct_to_endless(corrector, node) (private)

[ GitHub ]

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


def correct_to_endless(corrector, node)
  if unparenthesized_arguments?(node)
    corrector.replace(name_to_arguments_range(node), '(')
    corrector.replace(signature_to_body_range(node), ') = ')
  else
    corrector.replace(signature_to_body_range(node), ' = ')
  end

  corrector.remove(body_to_end_range(node))
end

#endless_parent?(node) ⇒ `Boolean` (private)

[ GitHub ]

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


def endless_parent?(node)
  node.parent&.any_def_type? && node.parent.endless?
end

#endless_replacement(node) (private)

[ GitHub ]

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


def endless_replacement(node)
  <<~RUBY.strip
    def #{receiver(node)}#{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 172


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|
    next if endless_parent?(node)

    correct_to_multiline(corrector, node)
  end
end

#handle_disallow_style(node) (private)

[ GitHub ]

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


def handle_disallow_style(node)
  return unless node.endless?

  add_offense(node) do |corrector|
    next if endless_parent?(node)

    correct_to_multiline(corrector, node)
  end
end

#handle_require_always_style(node) (private)

[ GitHub ]

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


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|
    correct_to_endless(corrector, node)
  end
end

#handle_require_single_line_style(node) (private)

[ GitHub ]

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


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

    add_offense(node, message: MSG_REQUIRE_SINGLE) do |corrector|
      correct_to_endless(corrector, node)
    end
  end
end

#line_when_made_endless(node) (private)

[ GitHub ]

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


def line_when_made_endless(node)
  keyword_element = node.loc.keyword
  code_before = keyword_element.source_line[0...keyword_element.column]
  end_element = node.loc.end
  code_after = end_element.source_line[end_element.last_column..]

  "#{code_before}#{endless_replacement(node)}#{code_after}"
end

#name_to_arguments_range(node) (private)

[ GitHub ]

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


def name_to_arguments_range(node)
  node.loc.name.end.join(node.arguments.source_range.begin)
end

#on_def(node) Also known as: #on_defs

[ GitHub ]

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


def on_def(node)
  return if node.assignment_method? || use_heredoc?(node)

  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

#on_defs(node)

Alias for #on_def.

[ GitHub ]

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


alias on_defs on_def

#parenthesized_arguments(node) (private)

[ GitHub ]

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


def parenthesized_arguments(node)
  padding = space_inside_parens? ? ' ' : ''

  "(#{padding}#{node.arguments.source}#{padding})"
end

#receiver(node) (private)

[ GitHub ]

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


def receiver(node)
  node.receiver ? "#{node.receiver.source}#{node.loc.operator.source}" : ''
end

#signature_to_body_range(node) (private)

[ GitHub ]

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


def signature_to_body_range(node)
  signature_end = node.arguments.any? ? node.arguments.source_range.end : node.loc.name.end

  signature_end.join(node.body.source_range.begin)
end

#single_line_when_made_endless?(node) ⇒ `Boolean` (private)

[ GitHub ]

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


def single_line_when_made_endless?(node)
  !endless_replacement(node).include?("\n")
end

#too_long_when_made_endless?(node) ⇒ `Boolean` (private)

[ GitHub ]

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


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

  line_length(line_when_made_endless(node)) > max_line_length
end

#unparenthesized_arguments?(node) ⇒ `Boolean` (private)

[ GitHub ]

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


def unparenthesized_arguments?(node)
  node.arguments.any? && !node.arguments.loc.begin
end

#use_heredoc?(node) ⇒ `Boolean` (private)

[ GitHub ]

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


def use_heredoc?(node)
  return false unless (body = node.body)
  return true if body.any_str_type? && body.heredoc?

  body.each_descendant(:any_str).any?(&:heredoc?)
end

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

Overview

Constant Summary

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::Alignment - Included

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

Class Method Summary

::RuboCop::Cop::TargetRubyVersion - Extended

::RuboCop::Cop::Base - Inherited

::RuboCop::ExcludeLimit - Extended

Instance Attribute Summary

::RuboCop::Cop::LineLengthHelp - Included

::RuboCop::Cop::Alignment - Included

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::AutocorrectLogic - Included

Instance Method Summary

::RuboCop::Cop::EndlessMethodBodyHelp - Included

::RuboCop::Cop::EndlessMethodRewriter - Included

::RuboCop::Cop::LineLengthHelp - Included

::RuboCop::Cop::Alignment - Included

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

Class Method Details

.autocorrect_incompatible_with

Instance Attribute Details

#space_inside_parens? ⇒ Boolean (readonly, private)

Instance Method Details

#arguments(node, missing = '') (private)

#body_to_end_range(node) (private)

#can_be_made_endless?(node) ⇒ Boolean (private)

#comment_in_discarded_range?(node) ⇒ Boolean (private)

#correct_to_endless(corrector, node) (private)

#endless_parent?(node) ⇒ Boolean (private)

#endless_replacement(node) (private)

#handle_allow_style(node) (private)

#handle_disallow_style(node) (private)

#handle_require_always_style(node) (private)

#handle_require_single_line_style(node) (private)

#line_when_made_endless(node) (private)

#name_to_arguments_range(node) (private)

#on_def(node) Also known as: #on_defs

#on_defs(node)

#parenthesized_arguments(node) (private)

#receiver(node) (private)

#signature_to_body_range(node) (private)

#single_line_when_made_endless?(node) ⇒ Boolean (private)

#too_long_when_made_endless?(node) ⇒ Boolean (private)

#unparenthesized_arguments?(node) ⇒ Boolean (private)

#use_heredoc?(node) ⇒ Boolean (private)

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::Alignment` - Included

`::RuboCop::Cop::AutoCorrector` - Extended

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::TargetRubyVersion` - Extended

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::ExcludeLimit` - Extended

`::RuboCop::Cop::LineLengthHelp` - Included

`::RuboCop::Cop::Alignment` - Included

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::AutocorrectLogic` - Included

`::RuboCop::Cop::EndlessMethodBodyHelp` - Included

`::RuboCop::Cop::EndlessMethodRewriter` - Included

`::RuboCop::Cop::LineLengthHelp` - Included

`::RuboCop::Cop::Alignment` - Included

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::AutocorrectLogic` - Included

`::RuboCop::Cop::IgnoredNode` - Included

#space_inside_parens? ⇒ `Boolean` (readonly, private)

#can_be_made_endless?(node) ⇒ `Boolean` (private)

#comment_in_discarded_range?(node) ⇒ `Boolean` (private)

#endless_parent?(node) ⇒ `Boolean` (private)

#single_line_when_made_endless?(node) ⇒ `Boolean` (private)

#too_long_when_made_endless?(node) ⇒ `Boolean` (private)

#unparenthesized_arguments?(node) ⇒ `Boolean` (private)

#use_heredoc?(node) ⇒ `Boolean` (private)