123456789_123456789_123456789_123456789_123456789_

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

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/lint/implicit_string_concatenation.rb

Overview

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

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

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::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 Method Details

#display_str(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/implicit_string_concatenation.rb', line 90

def display_str(node)
  if node.source.include?("\n")
    str_content(node).inspect
  else
    node.source
  end
end

#each_bad_cons(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/implicit_string_concatenation.rb', line 57

def each_bad_cons(node)
  node.children.each_cons(2) do |child_node1, child_node2|
    # `'abc' 'def'` -> (dstr (str "abc") (str "def"))
    next unless string_literals?(child_node1, child_node2)
    next unless child_node1.last_line == child_node2.first_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 child_node1.source[-1] == ending_delimiter(child_node1)

    yield child_node1, child_node2
  end
end

#ending_delimiter(str) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/implicit_string_concatenation.rb', line 72

def ending_delimiter(str)
  # implicit string concatenation does not work with %{}, etc.
  case str.source[0]
  when "'"
    "'"
  when '"'
    '"'
  end
end

#on_dstr(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/implicit_string_concatenation.rb', line 36

def on_dstr(node)
  each_bad_cons(node) do |lhs_node, rhs_node|
    range = lhs_node.source_range.join(rhs_node.source_range)
    message = format(MSG, lhs: display_str(lhs_node), rhs: display_str(rhs_node))
    if node.parent&.array_type?
      message << FOR_ARRAY
    elsif node.parent&.send_type?
      message << FOR_METHOD
    end

    add_offense(range, message: message) do |corrector|
      preferred  = "#{lhs_node.source} + #{rhs_node.source}"

      corrector.replace(range, preferred)
    end
  end
end

#str_content(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/implicit_string_concatenation.rb', line 98

def str_content(node)
  if node.str_type?
    node.children[0]
  else
    node.children.map { |c| str_content(c) }.join
  end
end

#string_literal?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/implicit_string_concatenation.rb', line 82

def string_literal?(node)
  node.str_type? || node.dstr_type?
end

#string_literals?(node1, node2) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/implicit_string_concatenation.rb', line 86

def string_literals?(node1, node2)
  string_literal?(node1) && string_literal?(node2)
end