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

Inherits:
Cop
  • Object
show all
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.'
CONCAT_TOKEN_TYPES =
[:tPLUS, :tLSHFT].freeze
SIMPLE_STRING_TOKEN_TYPE =
:tSTRING
COMPLEX_STRING_EDGE_TOKEN_TYPES =
[:tSTRING_BEG, :tSTRING_END].freeze
HIGH_PRECEDENCE_OP_TOKEN_TYPES =
[:tSTAR2, :tPERCENT, :tDOT,
:tLBRACK2].freeze
QUOTE_DELIMITERS =
%w(' ").freeze

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(operator_range) ⇒ Object


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

def autocorrect(operator_range)
  # Include any trailing whitespace so we don't create a syntax error.
  operator_range = range_with_surrounding_space(operator_range,
                                                :right, nil,
                                                !:with_newline)
  ->(corrector) { corrector.replace(operator_range, '\\') }
end

#investigate(processed_source) ⇒ Object


31
32
33
34
35
# File 'lib/rubocop/cop/style/line_end_concatenation.rb', line 31

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