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`.'.freeze

Constants included from AccessModifierNode

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

Constants included from AutocorrectAlignment

AutocorrectAlignment::SPACE

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from AccessModifierNode

#class_or_module_parent?, #modifier_node?, #modifier_structure?

Methods included from Sexp

#s

Methods included from ConfigurableEnforcedStyle

#alternative_style, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #supported_styles, #unexpected_style_detected

Methods included from AutocorrectAlignment

#autocorrect, #check_alignment, #configured_indentation_width, #display_column, #indentation, #offset

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?, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_block(node) ⇒ Object 



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

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

#on_class(node) ⇒ Object 



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

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

#on_module(node) ⇒ Object 



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

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

#on_sclass(node) ⇒ Object 



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

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