Class: RuboCop::Cop::Layout::IndentationStyle
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::RuboCop::Cop::AutoCorrector ,
::RuboCop::Cop::Base ,
::RuboCop::ExcludeLimit ,
NodePattern::Macros,
RuboCop::AST::Sexp
|
|
Instance Chain:
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/layout/indentation_style.rb |
Overview
Checks that the indentation method is consistent. Either tabs only or spaces only are used for indentation.
Constant Summary
-
MSG =
# File 'lib/rubocop/cop/layout/indentation_style.rb', line 40'%<type>s detected in indentation.'
::RuboCop::Cop::Base
- Inherited
EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::Alignment
- Included
::RuboCop::Cop::ConfigurableEnforcedStyle
- Included
::RuboCop::Cop::RangeHelp
- Included
Class Attribute Summary
::RuboCop::Cop::AutoCorrector
- Extended
::RuboCop::Cop::Base
- Inherited
.gem_requirements, .lint?, | |
.support_autocorrect? | Returns if class supports autocorrect. |
.support_multiple_source? | Override if your cop should be called repeatedly for multiple investigations Between calls to #on_new_investigation and |
Class Method Summary
::RuboCop::Cop::Base
- Inherited
.autocorrect_incompatible_with | List of cops that should not try to autocorrect at the same time as this cop. |
.badge | Naming. |
.callbacks_needed, .cop_name, .department, | |
.documentation_url | Returns a url to view this cops documentation online. |
.exclude_from_registry | Call for abstract Cop classes. |
.inherited, | |
.joining_forces | Override and return the Force class(es) you need to join. |
.match? | Returns true if the cop name or the cop namespace matches any of the given names. |
.new, | |
.requires_gem | Register a version requirement for the given gem name. |
.restrict_on_send |
::RuboCop::ExcludeLimit
- Extended
exclude_limit | Sets up a configuration option to have an exclude limit tracked. |
transform |
Instance Attribute Summary
::RuboCop::Cop::ConfigurableEnforcedStyle
- Included
::RuboCop::Cop::Alignment
- Included
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
- #on_new_investigation
- #autocorrect(corrector, range) private
- #autocorrect_lambda_for_spaces(corrector, range) private
- #autocorrect_lambda_for_tabs(corrector, range) private
- #find_offense(line, lineno) private
- #in_string_literal?(ranges, tabs_range) ⇒ Boolean private
- #message(_node) private
- #string_literal_ranges(ast) private
::RuboCop::Cop::RangeHelp
- Included
#add_range, #column_offset_between, | |
#contents_range | A range containing only the contents of a literal with delimiters (e.g. |
#directions, | |
#effective_column | Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value. |
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range |
::RuboCop::Cop::ConfigurableEnforcedStyle
- Included
::RuboCop::Cop::Alignment
- Included
#check_alignment, #configured_indentation_width, #display_column, #each_bad_alignment, #end_of_line_comment, #indentation, #offset, #register_offense, #within? |
::RuboCop::Cop::Base
- Inherited
#add_global_offense | Adds an offense that has no particular location. |
#add_offense | Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense. |
#begin_investigation | Called before any investigation. |
#callbacks_needed, | |
#cop_config | Configuration Helpers. |
#cop_name, #excluded_file?, | |
#external_dependency_checksum | This method should be overridden when a cop’s behavior depends on state that lives outside of these locations: |
#inspect, | |
#message | Gets called if no message is specified when calling |
#name | Alias for Base#cop_name. |
#offenses, | |
#on_investigation_end | Called after all on_… |
#on_new_investigation | Called before all on_… |
#on_other_file | Called instead of all on_… |
#parse | There should be very limited reasons for a Cop to do it’s own parsing. |
#parser_engine, | |
#ready | Called between investigations. |
#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction, | |
#callback_argument | Reserved for Cop::Cop. |
#complete_investigation | Called to complete an investigation. |
#correct, #current_corrector, | |
#current_offense_locations | Reserved for Commissioner: |
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range, | |
#reset_investigation | Actually private methods. |
#use_corrector |
::RuboCop::Cop::AutocorrectLogic
- Included
#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #heredoc_range, #max_line_length, #multiline_ranges, #multiline_string?, | |
#range_by_lines | Expand the given range to include all of any lines it covers. |
#range_of_first_line, #range_overlaps_offense?, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array? |
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#autocorrect(corrector, range) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/indentation_style.rb', line 58
def autocorrect(corrector, range) if range.source.include?("\t") autocorrect_lambda_for_tabs(corrector, range) else autocorrect_lambda_for_spaces(corrector, range) end end
#autocorrect_lambda_for_spaces(corrector, range) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/indentation_style.rb', line 82
def autocorrect_lambda_for_spaces(corrector, range) corrector.replace(range, range.source.gsub(/\A\s+/) do |match| "\t" * (match.size / configured_indentation_width) end) end
#autocorrect_lambda_for_tabs(corrector, range) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/indentation_style.rb', line 77
def autocorrect_lambda_for_tabs(corrector, range) spaces = ' ' * configured_indentation_width corrector.replace(range, range.source.gsub("\t", spaces)) end
#find_offense(line, lineno) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/indentation_style.rb', line 66
def find_offense(line, lineno) match = if style == :spaces line.match(/\A\s*\t+/) else line.match(/\A\s* +/) end return unless match source_range(processed_source.buffer, lineno, match.begin(0)...match.end(0)) end
#in_string_literal?(ranges, tabs_range) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/layout/indentation_style.rb', line 88
def in_string_literal?(ranges, tabs_range) ranges.any? { |range| range.contains?(tabs_range) } end
#message(_node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/indentation_style.rb', line 109
def (_node) format(MSG, type: style == :spaces ? 'Tab' : 'Space') end
#on_new_investigation
[ GitHub ]# File 'lib/rubocop/cop/layout/indentation_style.rb', line 42
def on_new_investigation str_ranges = nil processed_source.lines.each.with_index(1) do |line, lineno| next unless (range = find_offense(line, lineno)) # Perform costly calculation only when needed. str_ranges ||= string_literal_ranges(processed_source.ast) next if in_string_literal?(str_ranges, range) add_offense(range) { |corrector| autocorrect(corrector, range) } end end
#string_literal_ranges(ast) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/indentation_style.rb', line 92
def string_literal_ranges(ast) # which lines start inside a string literal? return [] if ast.nil? ranges = Set.new ast.each_node(:str, :dstr) do |str| loc = str.location if str.heredoc? ranges << loc.heredoc_body elsif loc.respond_to?(:begin) && loc.begin ranges << loc.expression end end ranges end