Class: RuboCop::Cop::Lint::IneffectiveAccessModifier

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/lint/ineffective_access_modifier.rb

Overview

This cop checks for `private` or `protected` access modifiers which are applied to a singleton method. These access modifiers do not make singleton methods private/protected. `private_class_method` can be used for that.

Examples:


# bad

class C
  private

  def self.method
    puts 'hi'
  end
end

# good

class C
  def self.method
    puts 'hi'
  end

  private_class_method :method
end

# good

class C
  class << self
    private

    def method
      puts 'hi'
    end
  end
end

Constant Summary collapse

MSG = 
'`%<modifier>s` (on line %<line>d) does not make singleton ' \
'methods %<modifier>s. Use %<alternative>s instead.'
ALTERNATIVE_PRIVATE = 
'`private_class_method` or `private` inside a `class << self` block'
ALTERNATIVE_PROTECTED = 
'`protected` inside a `class << self` block'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

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, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

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

silence_warnings

Constructor Details

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

Instance Method Details

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


59
60
61
 
# File 'lib/rubocop/cop/lint/ineffective_access_modifier.rb', line 59

def on_class(node)
  check_node(node.body)
end

#private_class_methods(node) ⇒ Object 


55
56
57
 
# File 'lib/rubocop/cop/lint/ineffective_access_modifier.rb', line 55

def_node_search :private_class_methods, <<~PATTERN
  (send nil? :private_class_method $...)
PATTERN