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 %<string1>s and %<string2>s into a single string ' \
'literal, rather than using implicit string concatenation.'
FOR_ARRAY =
' Or, if they were intended to be separate array ' \
'elements, separate them with a comma.'
FOR_METHOD =
' Or, if they were intended to be separate method ' \
'arguments, separate them with a comma.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, 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 NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

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, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#on_dstr(node) ⇒ Object



33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/rubocop/cop/lint/implicit_string_concatenation.rb', line 33

def on_dstr(node)
  each_bad_cons(node) do |child_node1, child_node2|
    range   = child_node1.source_range.join(child_node2.source_range)
    message = format(MSG,
                     string1: display_str(child_node1),
                     string2: display_str(child_node2))
    if node.parent&.array_type?
      message << FOR_ARRAY
    elsif node.parent&.send_type?
      message << FOR_METHOD
    end
    add_offense(node, location: range, message: message)
  end
end