Class: RuboCop::Cop::Layout::IndentationWidth
- Includes:
- Alignment, CheckAssignment, EndKeywordAlignment, IgnoredPattern, RangeHelp
- Defined in:
- lib/rubocop/cop/layout/indentation_width.rb
Overview
This cop checks for indentation that doesn’t use the specified number of spaces.
See also the IndentationConsistency cop which is the companion to this one.
Constant Summary collapse
- MSG =
'Use %<configured_indentation_width>d (not %<indentation>d) ' \ 'spaces for%<name>s indentation.'
- SPECIAL_MODIFIERS =
%w[private protected].freeze
Constants included from Util
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
- #autocorrect(node) ⇒ Object
- #on_block(node) ⇒ Object
- #on_case(case_node) ⇒ Object
- #on_class(node) ⇒ Object (also: #on_sclass, #on_module)
- #on_def(node) ⇒ Object (also: #on_defs)
- #on_ensure(node) ⇒ Object (also: #on_resbody, #on_for)
- #on_if(node, base = node) ⇒ Object
- #on_kwbegin(node) ⇒ Object
- #on_rescue(node) ⇒ Object
- #on_send(node) ⇒ Object (also: #on_csend)
- #on_while(node, base = node) ⇒ Object (also: #on_until)
Methods included from CheckAssignment
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?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version
Methods included from AST::Sexp
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, 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(node) ⇒ Object
149 150 151 |
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 149 def autocorrect(node) AlignmentCorrector.correct(processed_source, node, @column_delta) end |
#on_block(node) ⇒ Object
81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 81 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
133 134 135 136 137 138 139 140 |
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 133 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 Also known as: on_sclass, on_module
93 94 95 |
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 93 def on_class(node) check_members(node.loc.keyword, [node.body]) end |
#on_def(node) ⇒ Object Also known as: on_defs
116 117 118 119 120 |
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 116 def on_def(node) return if ignored_node?(node) check_indentation(node.loc.keyword, node.body) end |
#on_ensure(node) ⇒ Object Also known as: on_resbody, on_for
66 67 68 |
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 66 def on_ensure(node) check_indentation(node.loc.keyword, node.body) end |
#on_if(node, base = node) ⇒ Object
142 143 144 145 146 147 |
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 142 def on_if(node, base = node) return if ignored_node?(node) return if node.ternary? || node.modifier_form? check_if(node, node.body, node.else_branch, base.loc) end |
#on_kwbegin(node) ⇒ Object
73 74 75 76 77 78 79 |
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 73 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_rescue(node) ⇒ Object
61 62 63 64 |
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 61 def on_rescue(node) _begin_node, *_rescue_nodes, else_node = *node check_indentation(node.loc.else, else_node) end |
#on_send(node) ⇒ Object Also known as: on_csend
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 99 def on_send(node) super return unless node.adjacent_def_modifier? def_end_config = config.for_cop('Layout/DefEndAlignment') style = def_end_config['EnforcedStyleAlignWith'] || 'start_of_line' base = if style == 'def' node.first_argument else leftmost_modifier_of(node) || node end check_indentation(base.source_range, node.first_argument.body) ignore_node(node.first_argument) end |
#on_while(node, base = node) ⇒ Object Also known as: on_until
123 124 125 126 127 128 129 |
# File 'lib/rubocop/cop/layout/indentation_width.rb', line 123 def on_while(node, base = node) return if ignored_node?(node) return unless node.single_line_condition? check_indentation(base.loc, node.body) end |