Class: RuboCop::Cop::Layout::IndentationStyle

Inherits:
Cop
  • Object
show all
Includes:
Alignment, ConfigurableEnforcedStyle, RangeHelp
Defined in:
lib/rubocop/cop/layout/indentation_style.rb

Overview

This cop checks that the indentation method is consistent. Either tabs only or spaces only are used for indentation.

Examples:

EnforcedStyle: spaces (default)

# bad
# This example uses a tab to indent bar.
def foo
  bar
end

# good
# This example uses spaces to indent bar.
def foo
  bar
end

EnforcedStyle: tabs

# bad
# This example uses spaces to indent bar.
def foo
  bar
end

# good
# This example uses a tab to indent bar.
def foo
  bar
end

Constant Summary collapse

MSG =
'%<type>s detected in indentation.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Cop

#offenses

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, #corrections, #find_location, #highlights, joining_forces, #messages, #on_investigation_end, #on_new_investigation, #parse, qualified_cop_name, registry, support_autocorrect?, #support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object


57
58
59
60
61
62
63
# File 'lib/rubocop/cop/layout/indentation_style.rb', line 57

def autocorrect(range)
  if range.source.include?("\t")
    autocorrect_lambda_for_tabs(range)
  else
    autocorrect_lambda_for_spaces(range)
  end
end

#investigate(processed_source) ⇒ Object


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# File 'lib/rubocop/cop/layout/indentation_style.rb', line 41

def investigate(processed_source)
  str_ranges = string_literal_ranges(processed_source.ast)

  processed_source.lines.each.with_index(1) do |line, lineno|
    match = find_offence(line)
    next unless match

    range = source_range(processed_source.buffer,
                         lineno,
                         match.begin(0)...match.end(0))
    next if in_string_literal?(str_ranges, range)

    add_offense(range, location: range)
  end
end