Class: RuboCop::Cop::Style::TrailingBodyOnMethodDefinition

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

Overview

Checks for trailing code after the method definition.

NOTE: It always accepts endless method definitions that are basically on the same line.

Examples:

# bad
def some_method; do_stuff
end

def f(x); b = foo
  b[c: x]
end

# good
def some_method
  do_stuff
end

def f(x)
  b = foo
  b[c: x]
end

def endless_method = do_stuff

Constant Summary collapse

MSG = 
"Place the first line of a multi-line method definition's body on its own line."

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 included from TrailingBody

#body_on_first_line?, #first_part_of, #trailing_body?

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 



38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/rubocop/cop/style/trailing_body_on_method_definition.rb', line 38

def on_def(node)
  return unless trailing_body?(node)
  return if node.endless?

  add_offense(first_part_of(node.body)) do |corrector|
    LineBreakCorrector.correct_trailing_body(
      configured_width: configured_indentation_width,
      corrector: corrector,
      node: node,
      processed_source: processed_source
    )
  end
end