Class: RuboCop::Cop::Lint::ImplicitStringConcatenation

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/lint/implicit_string_concatenation.rb

Overview

This cop checks for implicit string concatenation of string literals which are on the same line.

Examples:

@bad
array = ['Item 1' 'Item 2']

@good
array = ['Item 1Item 2']
array = ['Item 1' + 'Item 2']
array = [
  'Item 1' \
  'Item 2'
]

Constant Summary collapse

MSG = 
'Combine %s and %s into a single string literal, rather than ' \
'using implicit string concatenation.'.freeze
FOR_ARRAY = 
' Or, if they were intended to be separate array ' \
'elements, separate them with a comma.'.freeze
FOR_METHOD = 
' Or, if they were intended to be separate method ' \
'arguments, separate them with a comma.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

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, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_dstr(node) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/rubocop/cop/lint/implicit_string_concatenation.rb', line 29

def on_dstr(node)
  node.children.each_cons(2) do |child1, child2|
    # `'abc' 'def'` -> (dstr (str "abc") (str "def"))
    next unless string_literal?(child1) && string_literal?(child2)
    next unless child1.loc.last_line == child2.loc.line

    # Make sure we don't flag a string literal which simply has
    # embedded newlines
    # `"abc\ndef"` also -> (dstr (str "abc") (str "def"))
    next unless child1.source[-1] == ending_delimiter(child1)

    range   = child1.source_range.join(child2.source_range)
    message = format(MSG, display_str(child1), display_str(child2))
    if node.parent && node.parent.array_type?
      message << FOR_ARRAY
    elsif node.parent && node.parent.send_type?
      message << FOR_METHOD
    end
    add_offense(node, range, message)
  end
end