Class: RuboCop::Cop::Style::StringConcatenation
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:
self,
::RuboCop::Cop::RangeHelp ,
::RuboCop::Cop::Base ,
::RuboCop::Cop::AutocorrectLogic ,
::RuboCop::Cop::IgnoredNode ,
::RuboCop::Util ,
RuboCop::AST::Sexp
|
|
Inherits: |
RuboCop::Cop::Base
|
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.
2. 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.
Constant Summary
-
MSG =
# File 'lib/rubocop/cop/style/string_concatenation.rb', line 57'Prefer string interpolation to string concatenation.'
-
RESTRICT_ON_SEND =
# File 'lib/rubocop/cop/style/string_concatenation.rb', line 58%i[+].freeze
::RuboCop::Cop::Base
- Inherited
EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::RangeHelp
- Included
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 |
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 a 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
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
- #on_new_investigation
- #on_send(node)
- #string_concatenation?(node)
- #adjust_str(node) private
- #collect_parts(node, parts = []) private
- #corrected_ancestor?(node) ⇒ Boolean private
- #find_topmost_plus_node(node) private
- #handle_quotes(parts) private
- #heredoc?(node) ⇒ Boolean private
- #line_end_concatenation?(node) ⇒ Boolean private
- #mode private
- #plus_node?(node) ⇒ Boolean private
- #register_offense(topmost_plus_node, parts) private
- #replacement(parts) private
- #single_quoted?(str_node) ⇒ Boolean private
- #uncorrectable?(part) ⇒ Boolean private
::RuboCop::Cop::RangeHelp
- Included
#add_range, #column_offset_between, | |
#contents_range | A range containing only the contents of a literal with delimiters (e.g. |
#directions, | |
#effective_column | Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value. |
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range |
::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 |
#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
#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #max_line_length, | |
#range_by_lines | Expand the given range to include all of any lines it covers. |
#range_of_first_line, #range_overlaps_offense?, #string_continuation, #string_continuation?, #surrounding_heredoc, #surrounding_percent_array |
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#adjust_str(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/string_concatenation.rb', line 159
def adjust_str(node) single_quoted?(node) ? node.value.gsub(/(\\|")/, '\\\\\&') : node.value.inspect[1..-2] end
#collect_parts(node, parts = []) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/string_concatenation.rb', line 115
def collect_parts(node, parts = []) return unless node if plus_node?(node) collect_parts(node.receiver, parts) collect_parts(node.first_argument, parts) else parts << node end end
#corrected_ancestor?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/string_concatenation.rb', line 140
def corrected_ancestor?(node) node.each_ancestor(:send).any? { |ancestor| @corrected_nodes&.include?(ancestor) } end
#find_topmost_plus_node(node) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/string_concatenation.rb', line 107
def find_topmost_plus_node(node) current = node while (parent = current.parent) && plus_node?(parent) current = parent end current end
#handle_quotes(parts) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/string_concatenation.rb', line 163
def handle_quotes(parts) parts.map do |part| part == '"' ? '\"' : part end end
#heredoc?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/string_concatenation.rb', line 134
def heredoc?(node) return false unless node.str_type? || node.dstr_type? node.heredoc? end
#line_end_concatenation?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/string_concatenation.rb', line 97
def line_end_concatenation?(node) # If the concatenation happens at the end of the line, # and both the receiver and argument are strings, allow # `Style/LineEndConcatenation` to handle it instead. node.receiver.str_type? && node.first_argument.str_type? && node.multiline? && node.source =~ /\+\s*\n/ end
#mode (private)
[ GitHub ]# File 'lib/rubocop/cop/style/string_concatenation.rb', line 173
def mode cop_config['Mode'].to_sym end
#on_new_investigation
[ GitHub ]# File 'lib/rubocop/cop/style/string_concatenation.rb', line 68
def on_new_investigation @corrected_nodes = nil end
#on_send(node)
[ GitHub ]# File 'lib/rubocop/cop/style/string_concatenation.rb', line 72
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
#plus_node?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/string_concatenation.rb', line 126
def plus_node?(node) node.send_type? && node.method?(:+) end
#register_offense(topmost_plus_node, parts) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/string_concatenation.rb', line 85
def register_offense(topmost_plus_node, parts) add_offense(topmost_plus_node) do |corrector| correctable_parts = parts.none? { |part| uncorrectable?(part) } if correctable_parts && !corrected_ancestor?(topmost_plus_node) corrector.replace(topmost_plus_node, replacement(parts)) @corrected_nodes ||= Set.new.compare_by_identity @corrected_nodes.add(topmost_plus_node) end end end
#replacement(parts) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/string_concatenation.rb', line 144
def replacement(parts) interpolated_parts = parts.map do |part| case part.type when :str adjust_str(part) when :dstr part.children.all?(&:str_type?) ? adjust_str(part) : contents_range(part).source else "\#{#{part.source}}" end end "\"#{handle_quotes(interpolated_parts).join}\"" end
#single_quoted?(str_node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/string_concatenation.rb', line 169
def single_quoted?(str_node) str_node.source.start_with?("'") end
#string_concatenation?(node)
[ GitHub ]# File 'lib/rubocop/cop/style/string_concatenation.rb', line 61
def_node_matcher :string_concatenation?, <<~PATTERN { (send str_type? :+ _) (send _ :+ str_type?) } PATTERN
#uncorrectable?(part) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/string_concatenation.rb', line 130
def uncorrectable?(part) part.multiline? || heredoc?(part) || part.each_descendant(:block).any? end