Class: RuboCop::Cop::Style::IndentationWidth

Inherits:
Cop
  • Object
show all
Includes:
AccessModifierNode, AutocorrectAlignment, CheckAssignment, EndKeywordAlignment, OnMethodDef
Defined in:
lib/rubocop/cop/style/indentation_width.rb

Overview

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

Examples:


class A
 def test
  puts 'hello'
 end
end

Constant Summary collapse

SPECIAL_MODIFIERS =
%w(private protected).freeze

Constants included from AutocorrectAlignment

AutocorrectAlignment::SPACE

Constants included from EndKeywordAlignment

EndKeywordAlignment::MSG

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, 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 included from AccessModifierNode

#class_or_module_parent?, #modifier_node?, #modifier_structure?

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 CheckAssignment

extract_rhs

Methods included from OnMethodDef

#method_def_node_parts, #on_def, #on_defs

Methods included from AutocorrectAlignment

#autocorrect, #check_alignment, #display_column, #indentation, #offset

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_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, 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_ruby_version

Methods included from AST::Sexp

#s

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?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_block(node) ⇒ Object



45
46
47
48
49
50
51
52
53
54
55
56
57
# File 'lib/rubocop/cop/style/indentation_width.rb', line 45

def on_block(node)
  _method, _args, body = *node
  # Check body against end/} indentation. Checking against variable
  # assignments, etc, would be more difficult. The end/} must be at the
  # beginning of its line.
  loc = node.loc
  return unless begins_its_line?(loc.end)

  check_indentation(loc.end, body)
  return unless indentation_consistency_style == 'rails'

  check_members(loc.end, [body])
end

#on_case(case_node) ⇒ Object



102
103
104
105
106
107
108
109
# File 'lib/rubocop/cop/style/indentation_width.rb', line 102

def on_case(case_node)
  case_node.each_when do |when_node|
    check_indentation(when_node.loc.keyword, when_node.body)
  end

  check_indentation(case_node.when_branches.last.loc.keyword,
                    case_node.else_branch)
end

#on_class(node) ⇒ Object



64
65
66
67
# File 'lib/rubocop/cop/style/indentation_width.rb', line 64

def on_class(node)
  _class_name, _base_class, *members = *node
  check_members(node.loc.keyword, members)
end

#on_ensure(node) ⇒ Object



33
34
35
36
# File 'lib/rubocop/cop/style/indentation_width.rb', line 33

def on_ensure(node)
  _body, ensure_body = *node
  check_indentation(node.loc.keyword, ensure_body)
end

#on_for(node) ⇒ Object



88
89
90
# File 'lib/rubocop/cop/style/indentation_width.rb', line 88

def on_for(node)
  check_indentation(node.loc.keyword, node.body)
end

#on_if(node, base = node) ⇒ Object



111
112
113
114
115
116
# File 'lib/rubocop/cop/style/indentation_width.rb', line 111

def on_if(node, base = node)
  return if ignored_node?(node) || !node.body
  return if node.ternary? || node.modifier_form?

  check_if(node, node.body, node.else_branch, base.loc)
end

#on_kwbegin(node) ⇒ Object



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

def on_kwbegin(node)
  # Check indentation against end keyword but only if it's first on its
  # line.
  return unless begins_its_line?(node.loc.end)
  check_indentation(node.loc.end, node.children.first)
end

#on_method_def(node, _method_name, _args, body) ⇒ Object



84
85
86
# File 'lib/rubocop/cop/style/indentation_width.rb', line 84

def on_method_def(node, _method_name, _args, body)
  check_indentation(node.loc.keyword, body) unless ignored_node?(node)
end

#on_module(node) ⇒ Object



59
60
61
62
# File 'lib/rubocop/cop/style/indentation_width.rb', line 59

def on_module(node)
  _module_name, *members = *node
  check_members(node.loc.keyword, members)
end

#on_rescue(node) ⇒ Object



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

def on_rescue(node)
  _begin_node, *rescue_nodes, else_node = *node
  rescue_nodes.each do |rescue_node|
    _, _, body = *rescue_node
    check_indentation(rescue_node.loc.keyword, body)
  end
  check_indentation(node.loc.else, else_node)
end

#on_send(node) ⇒ Object



69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/rubocop/cop/style/indentation_width.rb', line 69

def on_send(node)
  super
  return unless modifier_and_def_on_same_line?(node)
  _, _, *args = *node

  *_, body = *args.first

  def_end_config = config.for_cop('Lint/DefEndAlignment')
  style = def_end_config['EnforcedStyleAlignWith'] || 'start_of_line'
  base = style == 'def' ? args.first : node

  check_indentation(base.source_range, body)
  ignore_node(args.first)
end

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



92
93
94
95
96
97
98
# File 'lib/rubocop/cop/style/indentation_width.rb', line 92

def on_while(node, base = node)
  return if ignored_node?(node)

  return unless node.single_line_condition?

  check_indentation(base.loc, node.body)
end