Class: RuboCop::Cop::Layout::IndentationWidth

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

Overview

This cops checks for indentation that doesn’t use the specified number of spaces.

See also the IndentationConsistency cop which is the companion to this one.

Examples:

# bad, Width: 2
class A
 def test
  puts 'hello'
 end
end

# bad, Width: 2,
       IgnoredPatterns:
         - '^\s*module'
module A
class B
  def test
  puts 'hello'
  end
end
end

# good, Width: 2
class A
  def test
    puts 'hello'
  end
end

# good, Width: 2,
        IgnoredPatterns:
          - '^\s*module'
module A
class B
  def test
    puts 'hello'
  end
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 IgnoredPattern

#ignored_line?, #ignored_patterns, #matches_ignored_pattern?

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, 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 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_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#on_block(node) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 77

def on_block(node)
  end_loc = node.loc.end

  return unless begins_its_line?(end_loc)

  check_indentation(end_loc, node.body)

  return unless indentation_consistency_style == 'rails'

  check_members(end_loc, [node.body])
end

#on_case(case_node) ⇒ Object 



127
128
129
130
131
132
133
134
 
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 127

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 



94
95
96
97
 
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 94

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

#on_ensure(node) ⇒ Object Also known as: on_resbody, on_for 



63
64
65
 
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 63

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

#on_if(node, base = node) ⇒ Object 



136
137
138
139
140
141
 
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 136

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 



70
71
72
73
74
75
 
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 70

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 



113
114
115
 
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 113

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

#on_module(node) ⇒ Object 



89
90
91
92
 
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 89

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

#on_rescue(node) ⇒ Object 



58
59
60
61
 
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 58

def on_rescue(node)
  _begin_node, *_rescue_nodes, else_node = *node
  check_indentation(node.loc.else, else_node)
end

#on_send(node) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 99

def on_send(node)
  super
  return unless modifier_and_def_on_same_line?(node)

  *_, body = *node.first_argument

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

  check_indentation(base.source_range, body)
  ignore_node(node.first_argument)
end

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



117
118
119
120
121
122
123
 
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 117

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

  return unless node.single_line_condition?

  check_indentation(base.loc, node.body)
end