Class: RuboCop::Cop::Layout::LineContinuationLeadingSpace
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:
self,
::RuboCop::Cop::RangeHelp ,
::RuboCop::Cop::Base ,
::RuboCop::Cop::AutocorrectLogic ,
::RuboCop::Cop::IgnoredNode ,
::RuboCop::Util ,
RuboCop::AST::Sexp
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/layout/line_continuation_leading_space.rb |
Overview
Checks that strings broken over multiple lines (by a backslash) contain trailing spaces instead of leading spaces (default) or leading spaces instead of trailing spaces.
Constant Summary
-
LEADING_STYLE_OFFENSE =
private
# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 49/(?<trailing_spaces>\s+)(?<ending>#{LINE_1_ENDING})/.freeze
-
LINE_1_ENDING =
private
# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 47/['"]\s*\\\n/.freeze
-
LINE_2_BEGINNING =
private
# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 48/\A\s*['"]/.freeze
-
TRAILING_STYLE_OFFENSE =
private
# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 50/(?<beginning>#{LINE_2_BEGINNING})(?<leading_spaces>\s+)/.freeze
::RuboCop::Cop::Base
- Inherited
EMPTY_OFFENSES, RESTRICT_ON_SEND
::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 |
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
- #enforced_style_leading? ⇒ Boolean readonly private
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
- #on_dstr(node)
- #autocorrect(corrector, offense_range, insert_pos, spaces) private
- #continuation?(line, line_num, node) ⇒ Boolean private
- #investigate(first_line, second_line, end_of_first_line) private
- #investigate_leading_style(first_line, second_line, end_of_first_line) private
- #investigate_trailing_style(first_line, second_line, end_of_first_line) private
- #leading_offense_range(end_of_first_line, matches) private
- #message(_range) private
- #raw_lines(node) private
- #trailing_offense_range(end_of_first_line, matches) 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::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, #max_line_length, | |
#range_by_lines | Expand the given range to include all of any lines it covers. |
#range_of_first_line, #range_overlaps_offense?, #string_continuation, #string_continuation?, #surrounding_heredoc, #surrounding_percent_array |
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Attribute Details
#enforced_style_leading? ⇒ Boolean
(readonly, private)
[ GitHub ]
# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 138
def enforced_style_leading? cop_config['EnforcedStyle'] == 'leading' end
Instance Method Details
#autocorrect(corrector, offense_range, insert_pos, spaces) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 113
def autocorrect(corrector, offense_range, insert_pos, spaces) corrector.remove(offense_range) corrector.replace(range_between(insert_pos, insert_pos), spaces) end
#continuation?(line, line_num, node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 106
def continuation?(line, line_num, node) return false unless line.end_with?("\\\n") # Ensure backslash isn't part of a token spanning to the next line. node.children.none? { |c| (c.first_line...c.last_line).cover?(line_num) && c.multiline? } end
#investigate(first_line, second_line, end_of_first_line) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 76
def investigate(first_line, second_line, end_of_first_line) if enforced_style_leading? investigate_leading_style(first_line, second_line, end_of_first_line) else investigate_trailing_style(first_line, second_line, end_of_first_line) end end
#investigate_leading_style(first_line, second_line, end_of_first_line) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 84
def investigate_leading_style(first_line, second_line, end_of_first_line) matches = first_line.match(LEADING_STYLE_OFFENSE) return if matches.nil? offense_range = leading_offense_range(end_of_first_line, matches) add_offense(offense_range) do |corrector| insert_pos = end_of_first_line + second_line[LINE_2_BEGINNING].length autocorrect(corrector, offense_range, insert_pos, matches[:trailing_spaces]) end end
#investigate_trailing_style(first_line, second_line, end_of_first_line) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 95
def investigate_trailing_style(first_line, second_line, end_of_first_line) matches = second_line.match(TRAILING_STYLE_OFFENSE) return if matches.nil? offense_range = trailing_offense_range(end_of_first_line, matches) add_offense(offense_range) do |corrector| insert_pos = end_of_first_line - first_line[LINE_1_ENDING].length autocorrect(corrector, offense_range, insert_pos, matches[:leading_spaces]) end end
#leading_offense_range(end_of_first_line, matches) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 118
def leading_offense_range(end_of_first_line, matches) end_pos = end_of_first_line - matches[:ending].length begin_pos = end_pos - matches[:trailing_spaces].length range_between(begin_pos, end_pos) end
#message(_range) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 130
def (_range) if enforced_style_leading? 'Move trailing spaces to the start of the next line.' else 'Move leading spaces to the end of the previous line.' end end
#on_dstr(node)
[ GitHub ]# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 54
def on_dstr(node) # Quick check if we possibly have line continuations. return unless node.source.include?('\\') end_of_first_line = node.source_range.begin_pos - node.source_range.column lines = raw_lines(node) lines.each_cons(2).with_index(node.first_line) do |(raw_line_one, raw_line_two), line_num| end_of_first_line += raw_line_one.length next unless continuation?(raw_line_one, line_num, node) investigate(raw_line_one, raw_line_two, end_of_first_line) end end
#raw_lines(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 72
def raw_lines(node) processed_source.raw_source.lines[node.first_line - 1, line_range(node).size] end
#trailing_offense_range(end_of_first_line, matches) (private)
[ GitHub ]# File 'lib/rubocop/cop/layout/line_continuation_leading_space.rb', line 124
def trailing_offense_range(end_of_first_line, matches) begin_pos = end_of_first_line + matches[:beginning].length end_pos = begin_pos + matches[:leading_spaces].length range_between(begin_pos, end_pos) end