Class: RuboCop::Cop::Style::ClassMethodsDefinitions

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
CommentsHelp, ConfigurableEnforcedStyle, RangeHelp, VisibilityHelp
Defined in:
lib/rubocop/cop/style/class_methods_definitions.rb

Overview

This cop enforces using ‘def self.method_name` or `class << self` to define class methods.

Examples:

EnforcedStyle: def_self (default)

# bad
class SomeClass
  class << self
    attr_accessor :class_accessor

    def class_method
      # ...
    end
  end
end

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

  class << self
    attr_accessor :class_accessor
  end
end

# good - contains private method
class SomeClass
  class << self
    attr_accessor :class_accessor

    private

    def private_class_method
      # ...
    end
  end
end

EnforcedStyle: self_class

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

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

Constant Summary collapse

MSG = 
'Use `%<preferred>s` to define a class method.'
MSG_SCLASS = 
'Do not define public methods within class << self.'

Constants included from VisibilityHelp

VisibilityHelp::VISIBILITY_SCOPES

Constants inherited from Base

Base::RESTRICT_ON_SEND

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from CommentsHelp

#source_range_with_comment

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_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, indent, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#on_defs(node) ⇒ Object 



81
82
83
84
85
86
 
# File 'lib/rubocop/cop/style/class_methods_definitions.rb', line 81

def on_defs(node)
  return if def_self_style?

  message = format(MSG, preferred: 'class << self')
  add_offense(node, message: message)
end

#on_sclass(node) ⇒ Object 



71
72
73
74
75
76
77
78
79
 
# File 'lib/rubocop/cop/style/class_methods_definitions.rb', line 71

def on_sclass(node)
  return unless def_self_style?
  return unless node.identifier.source == 'self'
  return unless all_methods_public?(node)

  add_offense(node, message: MSG_SCLASS) do |corrector|
    autocorrect_sclass(node, corrector)
  end
end