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

Inherits:
Cop
  • Object
show all
Includes:
Alignment
Defined in:
lib/rubocop/cop/style/single_line_methods.rb

Overview

This cop checks for single-line method definitions that contain a body. It will accept single-line methods with no 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

AllowIfMethodIsEmpty: true (default)

# good
def no_op; end

AllowIfMethodIsEmpty: false

# bad
def no_op; end

Constant Summary collapse

MSG = 
'Avoid single-line method definitions.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #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?, #correctable?, #disable_offense, #disable_uncorrectable?, #safe_autocorrect?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/rubocop/cop/style/single_line_methods.rb', line 40

def autocorrect(node)
  lambda do |corrector|
    each_part(node.body) do |part|
      LineBreakCorrector.break_line_before(
        range: part, node: node, corrector: corrector,
        configured_width: configured_indentation_width
      )
    end

    LineBreakCorrector.break_line_before(
      range: node.loc.end, node: node, corrector: corrector,
      indent_steps: 0, configured_width: configured_indentation_width
    )

    move_comment(node, corrector)
  end
end

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



32
33
34
35
36
37
 
# File 'lib/rubocop/cop/style/single_line_methods.rb', line 32

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

  add_offense(node)
end