Class: RuboCop::Cop::Style::EmptyMethod

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle, OnMethodDef
Defined in:
lib/rubocop/cop/style/empty_method.rb

Overview

This cop checks for the formatting of empty method definitions. By default it enforces empty method definitions to go on a single line (compact style), but it can be configured to enforce the ‘end` to go on its own line (expanded style.)

Note: A method definition is not considered empty if it contains

comments.

Examples:


EnforcedStyle: compact (default)

@bad
def foo(bar)
end
def self.foo(bar)
end

@good
def foo(bar); end
def foo(bar)
  # baz
end
def self.foo(bar); end

EnforcedStyle: expanded

@bad
def foo(bar); end
def self.foo(bar); end

@good
def foo(bar)
end
def self.foo(bar)
end

Constant Summary collapse

MSG_COMPACT = 
'Put empty method definitions on a single line.'.freeze
MSG_EXPANDED = 
'Put the `end` of empty method definitions on the ' \
'next line.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods included from OnMethodDef

#method_def_node_parts, #on_def, #on_defs

Methods inherited from Cop

#add_offense, all, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_method_def(node, _method_name, _args, body) ⇒ Object 



50
51
52
53
54
55
56
 
# File 'lib/rubocop/cop/style/empty_method.rb', line 50

def on_method_def(node, _method_name, _args, body)
  return if body || comment_lines?(node)
  return if compact_style? && compact?(node)
  return if expanded_style? && expanded?(node)

  add_offense(node, node.source_range, message)
end