Class: RuboCop::Cop::Style::RedundantInterpolation

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
PercentLiteral
Defined in:
lib/rubocop/cop/style/redundant_interpolation.rb

Overview

This cop checks for strings that are just an interpolated expression.

Examples:


# bad
"#{@var}"

# good
@var.to_s

# good if @var is already a String
@var

Constant Summary collapse

MSG = 
'Prefer `to_s` over string interpolation.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Class Method Summary collapse

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, badge, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, 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_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interporation_escape_character

Methods included from PathUtil

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

Constructor Details

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

Class Method Details

.autocorrect_incompatible_with ⇒ Object 



24
25
26
 
# File 'lib/rubocop/cop/style/redundant_interpolation.rb', line 24

def self.autocorrect_incompatible_with
  [Style::LineEndConcatenation]
end

Instance Method Details

#on_dstr(node) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/rubocop/cop/style/redundant_interpolation.rb', line 28

def on_dstr(node)
  return unless single_interpolation?(node)

  add_offense(node) do |corrector|
    embedded_node = node.children.first

    if variable_interpolation?(embedded_node)
      autocorrect_variable_interpolation(corrector, embedded_node, node)
    elsif single_variable_interpolation?(embedded_node)
      autocorrect_single_variable_interpolation(corrector, embedded_node, node)
    else
      autocorrect_other(corrector, embedded_node, node)
    end
  end
end