Class: RuboCop::Cop::Style::SingleLineMethods

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
Alignment
Defined in:
lib/rubocop/cop/style/single_line_methods.rb

Overview

Checks for single-line method definitions that contain a body. It will accept single-line methods with no body.

Endless methods added in Ruby 3.0 are also accepted by this cop.

If ‘Style/EndlessMethod` is enabled with `EnforcedStyle: allow_single_line` or `allow_always`, single-line methods will be autocorrected to endless methods if there is only one statement in the body.

Examples:

# bad
def some_method; body end
def link_to(url); {:name => url}; end
def @table.columns; super; end

# good
def self.resource_class=(klass); end
def @table.columns; end
def some_method() = body

AllowIfMethodIsEmpty: true (default)

# good
def no_op; end

AllowIfMethodIsEmpty: false

# bad
def no_op; end

Constant Summary collapse

MSG = 
'Avoid single-line method definitions.'
NOT_SUPPORTED_ENDLESS_METHOD_BODY_TYPES = 
%i[return break next].freeze

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_def(node) ⇒ Object Also known as: on_defs 



41
42
43
44
45
46
47
 
# File 'lib/rubocop/cop/style/single_line_methods.rb', line 41

def on_def(node)
  return unless node.single_line?
  return if node.endless?
  return if allow_empty? && !node.body

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