Class: RuboCop::Cop::Lint::UselessAccessModifier

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Lint::UselessAccessModifier

Includes:

AccessModifierNode

Defined in:

lib/rubocop/cop/lint/useless_access_modifier.rb

Overview

This cop checks for access modifiers without any code.

Examples:

class Foo
  private # This is useless

  def self.some_method
  end
end

Constant Summary

MSG =

'Useless `%s` access modifier.'

Constants included from AccessModifierNode

AccessModifierNode::MODULE_FUNCTION_NODE, AccessModifierNode::PRIVATE_NODE, AccessModifierNode::PROTECTED_NODE, AccessModifierNode::PUBLIC_NODE

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, 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

• #on_class(node) ⇒ Object

Methods included from AccessModifierNode

#class_constructor?, #class_or_module_parent?, #modifier_node?, #modifier_structure?

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, 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

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

# File 'lib/rubocop/cop/lint/useless_access_modifier.rb', line 19

def on_class(node)
  _name, _base_class, body = *node
  return unless body

  body_nodes = body.type == :begin ? body.children : [body]

  body_nodes.each do |child_node|
    check_for_access_modifier(child_node) ||
      check_for_instance_method(child_node)
  end

  add_offense_for_access_modifier
end