Class: Rubocop::Cop::Style::IndentationWidth

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/indentation_width.rb

Overview

This cops checks for indentation that doesn't use two spaces.

class A def test puts 'hello' end end

Constant Summary collapse

CORRECT_INDENTATION = 
2
MSG = 
"Use #{CORRECT_INDENTATION} (not %d) spaces for indentation."

Constants inherited from Cop

Cop::OPERATOR_METHODS

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offences, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offence, all, #autocorrect?, #convention, #cop_config, cop_name, #cop_name, cop_type, #debug?, #ignore_node, inherited, #initialize, lint?, #message, non_rails, rails?, style?, #support_autocorrect?, #warning

Constructor Details

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

Instance Method Details

#on_block(node) ⇒ Object 



23
24
25
26
27
28
 
# File 'lib/rubocop/cop/style/indentation_width.rb', line 23

def on_block(node)
  _method, _args, body = *node
  # Check body against end/} indentation. Checking against variable
  # assignments, etc, would be more difficult.
  check_indentation(node.loc.end, body)
end

#on_case(node) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/rubocop/cop/style/indentation_width.rb', line 62

def on_case(node)
  _condition, *branches = *node
  latest_when = nil
  branches.compact.each do |b|
    if b.type == :when
      _condition, body = *b
      # Check "when" body against "when" keyword indentation.
      check_indentation(b.loc.keyword, body)
      latest_when = b
    else
      # Since it's not easy to get the position of the "else" keyword,
      # we check "else" body against latest "when" keyword indentation.
      check_indentation(latest_when.loc.keyword, b)
    end
  end
end

#on_class(node) ⇒ Object 



35
36
37
38
 
# File 'lib/rubocop/cop/style/indentation_width.rb', line 35

def on_class(node)
  _class_name, _base_class, *members = *node
  members.each { |m| check_indentation(node.loc.keyword, m) }
end

#on_def(node) ⇒ Object 



40
41
42
43
 
# File 'lib/rubocop/cop/style/indentation_width.rb', line 40

def on_def(node)
  _method_name, _args, body = *node
  check_indentation(node.loc.keyword, body)
end

#on_defs(node) ⇒ Object 



45
46
47
48
 
# File 'lib/rubocop/cop/style/indentation_width.rb', line 45

def on_defs(node)
  _scope, _method_name, _args, body = *node
  check_indentation(node.loc.keyword, body)
end

#on_for(node) ⇒ Object 



50
51
52
53
 
# File 'lib/rubocop/cop/style/indentation_width.rb', line 50

def on_for(node)
  _variable, _collection, body = *node
  check_indentation(node.loc.keyword, body)
end

#on_if(node) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/rubocop/cop/style/indentation_width.rb', line 79

def on_if(node)
  return if ternary_op?(node)
  return if modifier_if?(node)

  case node.loc.keyword.source
  when 'if'     then _condition, body, else_clause = *node
  when 'unless' then _condition, else_clause, body = *node
  else               _condition, body = *node
  end

  check_if(node, body, else_clause) if body
end

#on_kwbegin(node) ⇒ Object 



19
20
21
 
# File 'lib/rubocop/cop/style/indentation_width.rb', line 19

def on_kwbegin(node)
  node.children.each { |c| check_indentation(node.loc.end, c) }
end

#on_module(node) ⇒ Object 



30
31
32
33
 
# File 'lib/rubocop/cop/style/indentation_width.rb', line 30

def on_module(node)
  _module_name, *members = *node
  members.each { |m| check_indentation(node.loc.keyword, m) }
end

#on_while(node) ⇒ Object Also known as: on_until 



55
56
57
58
 
# File 'lib/rubocop/cop/style/indentation_width.rb', line 55

def on_while(node)
  _condition, body = *node
  check_indentation(node.loc.keyword, body)
end