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 no_op; end
def self.resource_class=(klass); end
def @table.columns; end

Constant Summary collapse

MSG = 
'Avoid single-line method definitions.'.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 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, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #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?, #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?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, find_file_upwards, 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 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/rubocop/cop/style/single_line_methods.rb', line 33

def autocorrect(node)
  body = node.body

  lambda do |corrector|
    each_part(body) do |part|
      break_line_before(part, node, corrector, 1)
    end

    break_line_before(node.loc.end, node, corrector, 0)

    eol_comment = end_of_line_comment(node.source_range.line)
    move_comment(eol_comment, node, corrector) if eol_comment
  end
end

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



25
26
27
28
29
30
 
# File 'lib/rubocop/cop/style/single_line_methods.rb', line 25

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

  add_offense(node)
end