Class: RuboCop::Cop::Style::StringConcatenation

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp, Util
Defined in:
lib/rubocop/cop/style/string_concatenation.rb

Overview

Checks for places where string concatenation can be replaced with string interpolation.

The cop can autocorrect simple cases but will skip autocorrecting more complex cases where the resulting code would be harder to read. In those cases, it might be useful to extract statements to local variables or methods which you can then interpolate in a string.

NOTE: When concatenation between two strings is broken over multiple lines, this cop does not register an offense; instead, ‘Style/LineEndConcatenation` will pick up the offense if enabled.

Two modes are supported:

  1. ‘aggressive` style checks and corrects all occurrences of `+` where

either the left or right side of ‘+` is a string literal.

  1. ‘conservative` style on the other hand, checks and corrects only if

left side (receiver of ‘+` method call) is a string literal. This is useful when the receiver is some expression that returns string like `Pathname` instead of a string literal.

Examples:

Mode: aggressive (default)

# bad
email_with_name = user.name + ' <' + user.email + '>'
Pathname.new('/') + 'test'

# good
email_with_name = "#{user.name} <#{user.email}>"
email_with_name = format('%s <%s>', user.name, user.email)
"#{Pathname.new('/')}test"

# accepted, line-end concatenation
name = 'First' +
  'Last'

Mode: conservative

# bad
'Hello' + user.name

# good
"Hello #{user.name}"
user.name + '!!'
Pathname.new('/') + 'test'

Constant Summary collapse

MSG = 
'Prefer string interpolation to string concatenation.'
RESTRICT_ON_SEND = 
%i[+].freeze

Constants included from Util

Util::LITERAL_REGEX

Constants included from PathUtil

PathUtil::HIDDEN_FILE_PATTERN

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from Util

add_parentheses, any_descendant?, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, indent, interpret_string_escapes, line, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interpolation_escape_character

Methods included from PathUtil

absolute?, glob?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_new_investigation ⇒ Object 



69
70
71
 
# File 'lib/rubocop/cop/style/string_concatenation.rb', line 69

def on_new_investigation
  @corrected_nodes = nil
end

#on_send(node) ⇒ Object 



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/rubocop/cop/style/string_concatenation.rb', line 73

def on_send(node)
  return unless string_concatenation?(node)
  return if line_end_concatenation?(node)

  topmost_plus_node = find_topmost_plus_node(node)
  parts = collect_parts(topmost_plus_node)
  return if mode == :conservative && !parts.first.str_type?

  register_offense(topmost_plus_node, parts)
end

#string_concatenation?(node) ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/rubocop/cop/style/string_concatenation.rb', line 62

def_node_matcher :string_concatenation?, <<~PATTERN
  {
    (send str_type? :+ _)
    (send _ :+ str_type?)
  }
PATTERN