123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Layout::LineContinuationSpacing

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/line_continuation_spacing.rb

Overview

Checks that the backslash of a line continuation is separated from preceding text by exactly one space (default) or zero spaces.

Examples:

EnforcedStyle: space (default)

# bad
'a'\
'b'  \
'c'

# good
'a' \
'b' \
'c'

EnforcedStyle: no_space

# bad
'a' \
'b'  \
'c'

# good
'a'\
'b'\
'c'

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

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 on_investigation_end, the result of processed_source will remain constant.

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 an 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

Instance Method Summary

::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 add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#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

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Attribute Details

#no_space_style?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/line_continuation_spacing.rb', line 130

def no_space_style?
  cop_config['EnforcedStyle'] == 'no_space'
end

#space_style?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/line_continuation_spacing.rb', line 134

def space_style?
  cop_config['EnforcedStyle'] == 'space'
end

Instance Method Details

#autocorrect(corrector, range) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/line_continuation_spacing.rb', line 81

def autocorrect(corrector, range)
  correction = if no_space_style?
                 '\\'
               elsif space_style?
                 ' \\'
               end
  corrector.replace(range, correction)
end

#comment_ranges(comments) (private)

Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/line_continuation_spacing.rb', line 111

def comment_ranges(comments)
  comments.map(&:source_range)
end

#find_offensive_spacing(line) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/line_continuation_spacing.rb', line 65

def find_offensive_spacing(line)
  if no_space_style?
    line[/\s+\\$/, 0]
  elsif space_style?
    line[/((?<!\s)|\s{2,})\\$/, 0]
  end
end

#ignore_range?(backtick_range) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/line_continuation_spacing.rb', line 121

def ignore_range?(backtick_range)
  ignored_ranges.any? { |range| range.contains?(backtick_range) }
end

#ignored_literal_ranges(ast) (private)

Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/line_continuation_spacing.rb', line 91

def ignored_literal_ranges(ast)
  # which lines start inside a string literal?
  return [] if ast.nil?

  ast.each_node(:str, :dstr, :array).with_object(Set.new) do |literal, ranges|
    loc = literal.location

    if literal.array_type?
      next unless literal.percent_literal?

      ranges << loc.expression
    elsif literal.heredoc?
      ranges << loc.heredoc_body
    elsif loc.respond_to?(:begin) && loc.begin
      ranges << loc.expression
    end
  end
end

#ignored_ranges (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/line_continuation_spacing.rb', line 125

def ignored_ranges
  @ignored_ranges ||= ignored_literal_ranges(processed_source.ast) +
                      comment_ranges(processed_source.comments)
end

#investigate(line, line_number) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/line_continuation_spacing.rb', line 49

def investigate(line, line_number)
  offensive_spacing = find_offensive_spacing(line)
  return unless offensive_spacing

  range = source_range(
    processed_source.buffer,
    line_number,
    line.length - offensive_spacing.length - 1,
    offensive_spacing.length
  )

  return if ignore_range?(range)

  add_offense(range) { |corrector| autocorrect(corrector, range) }
end

#last_line(processed_source) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/line_continuation_spacing.rb', line 115

def last_line(processed_source)
  last_token = processed_source.tokens.last

  last_token ? last_token.line : processed_source.lines.length
end

#message(_range) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/line_continuation_spacing.rb', line 73

def message(_range)
  if no_space_style?
    'Use zero spaces in front of backslash.'
  elsif space_style?
    'Use one space in front of backslash.'
  end
end

#on_new_investigation

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/line_continuation_spacing.rb', line 34

def on_new_investigation
  return unless processed_source.raw_source.include?('\\')

  last_line = last_line(processed_source)

  processed_source.raw_source.lines.each_with_index do |line, index|
    break if index >= last_line

    line_number = index + 1
    investigate(line, line_number)
  end
end