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

Constants included from Util

Util::ASGN_NODES, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

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, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

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 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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, 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 



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

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
44
45
 
# 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]*)\t+/)
    next unless match
    prefix = match.captures[0]
    col = prefix.length
    next if in_string_literal?(str_ranges, lineno, col)

    range = source_range(processed_source.buffer,
                         lineno,
                         col...match.end(0))

    add_offense(range, location: range)
  end
end