123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Layout::AccessModifierIndentation

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/layout/access_modifier_indentation.rb

Overview

Bare access modifiers (those not applying to specific methods) should be indented as deep as method definitions, or as deep as the class/module keyword, depending on configuration.

Examples:

EnforcedStyle: indent (default)

# bad
class Plumbus
private
  def smooth; end
end

# good
class Plumbus
  private
  def smooth; end
end

EnforcedStyle: outdent

# bad
class Plumbus
  private
  def smooth; end
end

# good
class Plumbus
private
  def smooth; end
end

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::Alignment - Included

SPACE

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.

.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.

.badge

Naming.

.callbacks_needed, .cop_name, .department,
.documentation_url

Returns an url to view this cops documentation online.

.exclude_from_registry

Call for abstract Cop classes.

.inherited,
.joining_forces

Override and return the Force class(es) you need to join.

.match?

Returns true if the cop name or the cop namespace matches any of the given names.

.new,
.requires_gem

Register a version requirement for the given gem name.

.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.

transform

Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::RangeHelp - Included

#add_range, #column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.

#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.

#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::Alignment - Included

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.

#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.

#begin_investigation

Called before any investigation.

#callbacks_needed,
#cop_config

Configuration Helpers.

#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:

#inspect
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#name

Alias for Base#cop_name.

#offenses,
#on_investigation_end

Called after all on_…​

#on_new_investigation

Called before all on_…​

#on_other_file

Called instead of all on_…​

#parse

There should be very limited reasons for a Cop to do it’s own parsing.

#parser_engine,
#ready

Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.

#complete_investigation

Called to complete an investigation.

#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#autocorrect(corrector, node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/access_modifier_indentation.rb', line 54

def autocorrect(corrector, node)
  AlignmentCorrector.correct(corrector, processed_source, node, @column_delta)
end

#check_body(body, node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/access_modifier_indentation.rb', line 58

def check_body(body, node)
  modifiers = body.each_child_node(:send).select(&:bare_access_modifier?)
  end_range = node.loc.end

  modifiers.each { |modifier| check_modifier(modifier, end_range) }
end

#check_modifier(send_node, end_range) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/access_modifier_indentation.rb', line 65

def check_modifier(send_node, end_range)
  offset = column_offset_between(send_node.source_range, end_range)

  @column_delta = expected_indent_offset - offset
  if @column_delta.zero?
    correct_style_detected
  else
    add_offense(send_node) do |corrector|
      if offset == unexpected_indent_offset
        opposite_style_detected
      else
        unrecognized_style_detected
      end

      autocorrect(corrector, send_node)
    end
  end
end

#expected_indent_offset (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/access_modifier_indentation.rb', line 88

def expected_indent_offset
  style == :outdent ? 0 : configured_indentation_width
end

#message(range) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/access_modifier_indentation.rb', line 84

def message(range)
  format(MSG, style: style.capitalize, node: range.source)
end

#on_block(node)

Alias for #on_class.

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/access_modifier_indentation.rb', line 50

alias on_block  on_class

#on_class(node) Also known as: #on_sclass, #on_module, #on_block

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/access_modifier_indentation.rb', line 43

def on_class(node)
  return unless node.body&.begin_type?

  check_body(node.body, node)
end

#on_module(node)

Alias for #on_class.

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/access_modifier_indentation.rb', line 49

alias on_module on_class

#on_sclass(node)

Alias for #on_class.

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/access_modifier_indentation.rb', line 48

alias on_sclass on_class

#unexpected_indent_offset (private)

An offset that is not expected, but correct if the configuration is changed.

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/access_modifier_indentation.rb', line 94

def unexpected_indent_offset
  configured_indentation_width - expected_indent_offset
end