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.%<method>s` instead of `%<class>s.%<method>s`.'

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, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #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?, 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 



39
40
41
 
# File 'lib/rubocop/cop/style/class_methods.rb', line 39

def autocorrect(node)
  ->(corrector) { corrector.replace(node.loc.name, 'self') }
end

#on_class(node) ⇒ Object Also known as: on_module 



26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/rubocop/cop/style/class_methods.rb', line 26

def on_class(node)
  return unless node.body

  if node.body.defs_type?
    check_defs(node.identifier, node.body)
  elsif node.body.begin_type?
    node.body.each_child_node(:defs) do |def_node|
      check_defs(node.identifier, def_node)
    end
  end
end