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

Inherits:
Cop
  • 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.'.freeze
ALTERNATIVE_PRIVATE = 
'`private_class_method` or `private` inside a ' \
'`class << self` block'.freeze
ALTERNATIVE_PROTECTED = 
'`protected` inside a `class << self` ' \
'block'.freeze

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?, #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?, 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

Methods included from PathUtil

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

#on_class(node) ⇒ Object 



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

def on_class(node)
  check_node(node.children[2]) # class body
end

#on_module(node) ⇒ Object 



64
65
66
 
# File 'lib/rubocop/cop/lint/ineffective_access_modifier.rb', line 64

def on_module(node)
  check_node(node.children[1]) # module body
end