Class: RuboCop::Cop::Style::ClassMethods

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

Overview

This cop checks for uses of the class/module name instead of self, when defining class/module methods.

Examples:

# bad
class SomeClass
  def SomeClass.class_method
    ...
  end
end

# good
class SomeClass
  def self.class_method
    ...
  end
end

Constant Summary collapse

MSG =
'Use `self.%s` instead of `%s.%s`.'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, 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?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_class(node) ⇒ Object



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

def on_class(node)
  name, _superclass, body = *node
  check(name, body)
end

#on_module(node) ⇒ Object



31
32
33
34
# File 'lib/rubocop/cop/style/class_methods.rb', line 31

def on_module(node)
  name, body = *node
  check(name, body)
end