Class: RuboCop::Cop::Layout::Tab

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

Overview

This cop checks for tabs inside the source code.

Examples:

# 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

Constant Summary collapse

MSG =
'Tab detected.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object


45
46
47
48
49
50
# File 'lib/rubocop/cop/layout/tab.rb', line 45

def autocorrect(range)
  lambda do |corrector|
    spaces = ' ' * configured_indentation_width
    corrector.replace(range, range.source.gsub(/\t/, spaces))
  end
end

#investigate(processed_source) ⇒ Object


29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/rubocop/cop/layout/tab.rb', line 29

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

  processed_source.lines.each.with_index(1) do |line, lineno|
    match = line.match(/\t+/)
    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