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

Inherits:
Cop
  • Object
show all
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 included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#offenses

Attributes inherited from Base

#config, #processed_source

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #corrections, #find_location, #highlights, joining_forces, #messages, #on_investigation_end, #on_new_investigation, #parse, qualified_cop_name, registry, support_autocorrect?, #support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, 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, 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?, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, relative_path, smart_path

Constructor Details

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

Class Method Details

.autocorrect_incompatible_withObject


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

def self.autocorrect_incompatible_with
  [Style::LineEndConcatenation]
end

Instance Method Details

#autocorrect(node) ⇒ Object


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

def autocorrect(node)
  embedded_node = node.children.first

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

#on_dstr(node) ⇒ Object


27
28
29
# File 'lib/rubocop/cop/style/redundant_interpolation.rb', line 27

def on_dstr(node)
  add_offense(node) if single_interpolation?(node)
end