Class: RuboCop::Cop::Style::AccessModifierIndentation

Inherits:
Cop
  • Object
show all
Includes:
AccessModifierNode, AutocorrectAlignment, ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/style/access_modifier_indentation.rb

Overview

Modifiers should be indented as deep as method definitions, or as deep as the class/module keyword, depending on configuration.

Constant Summary collapse

MSG =
'%s access modifiers like `%s`.'

Constants included from AccessModifierNode

AccessModifierNode::MODUDULE_FUNCTION_NODE, AccessModifierNode::PRIVATE_NODE, AccessModifierNode::PROTECTED_NODE, AccessModifierNode::PUBLIC_NODE

Constants included from Util

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

Methods included from AccessModifierNode

#modifier_node?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #both_styles_detected, #correct_style_detected, #opposite_style_detected, #parameter_name, #style, #unrecognized_style_detected

Methods included from AutocorrectAlignment

#autocorrect, #check_alignment, #configured_indentation_width, #start_of_line?

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, non_rails, qualified_cop_name, rails?, #relevant_file?, #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, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_block(node) ⇒ Object



30
31
32
33
# File 'lib/rubocop/cop/style/access_modifier_indentation.rb', line 30

def on_block(node)
  _method, _args, body = *node
  check_body(body, node) if class_constructor?(node)
end

#on_class(node) ⇒ Object



15
16
17
18
# File 'lib/rubocop/cop/style/access_modifier_indentation.rb', line 15

def on_class(node)
  _name, _base_class, body = *node
  check_body(body, node)
end

#on_module(node) ⇒ Object



25
26
27
28
# File 'lib/rubocop/cop/style/access_modifier_indentation.rb', line 25

def on_module(node)
  _name, body = *node
  check_body(body, node)
end

#on_sclass(node) ⇒ Object



20
21
22
23
# File 'lib/rubocop/cop/style/access_modifier_indentation.rb', line 20

def on_sclass(node)
  _name, body = *node
  check_body(body, node)
end