Class: RuboCop::Cop::Style::LineEndConcatenation

Inherits:
Cop
  • Object
show all
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/line_end_concatenation.rb

Overview

This cop checks for string literal concatenation at the end of a line.

Examples:


# bad
some_str = 'ala' +
           'bala'

some_str = 'ala' <<
           'bala'

# good
some_str = 'ala' \
           'bala'

Constant Summary collapse

MSG = 
'Use `\\` instead of `+` or `<<` to concatenate ' \
'those strings.'.freeze
CONCAT_TOKEN_TYPES = 
%i[tPLUS tLSHFT].freeze
SIMPLE_STRING_TOKEN_TYPE = 
:tSTRING
COMPLEX_STRING_EDGE_TOKEN_TYPES = 
%i[tSTRING_BEG tSTRING_END].freeze
HIGH_PRECEDENCE_OP_TOKEN_TYPES = 
%i[tSTAR2 tPERCENT tDOT
tLBRACK2].freeze
QUOTE_DELIMITERS = 
%w[' "].freeze

Constants included from Util

Util::ASGN_NODES, 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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, 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 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, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Class Method Details

.autocorrect_incompatible_with ⇒ Object 



34
35
36
 
# File 'lib/rubocop/cop/style/line_end_concatenation.rb', line 34

def self.autocorrect_incompatible_with
  [Style::UnneededInterpolation]
end

Instance Method Details

#autocorrect(operator_range) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/rubocop/cop/style/line_end_concatenation.rb', line 44

def autocorrect(operator_range)
  # Include any trailing whitespace so we don't create a syntax error.
  operator_range = range_with_surrounding_space(range: operator_range,
                                                side: :right,
                                                newlines: false)
  one_more_char = operator_range.resize(operator_range.size + 1)
  # Don't create a double backslash at the end of the line, in case
  # there already was a backslash after the concatenation operator.
  operator_range = one_more_char if one_more_char.source.end_with?('\\')

  ->(corrector) { corrector.replace(operator_range, '\\') }
end

#investigate(processed_source) ⇒ Object 



38
39
40
41
42
 
# File 'lib/rubocop/cop/style/line_end_concatenation.rb', line 38

def investigate(processed_source)
  processed_source.tokens.each_index do |index|
    check_token_set(index)
  end
end