Class: Rubocop::Cop::Lint::StringConversionInInterpolation

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/lint/string_conversion_in_interpolation.rb

Overview

This cop checks for string conversion in string interpolation, which is redundant.

Examples:


"result is #{something.to_s}"

Constant Summary collapse

MSG_DEFAULT = 
'Redundant use of `Object#to_s` in interpolation.'
MSG_SELF = 
'Use `self` instead of `Object#to_s` in interpolation.'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #display_cop_names?, #exclude_file?, #include_file?, inherited, #initialize, lint?, #message, non_rails, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes

Methods included from PathUtil

match_path?, relative_path

Constructor Details

This class inherits a constructor from Rubocop::Cop::Cop

Instance Method Details

#on_dstr(node) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/rubocop/cop/lint/string_conversion_in_interpolation.rb', line 16

def on_dstr(node)
  node.children.select { |n| n.type == :begin }.each do |begin_node|
    final_node = begin_node.children.last
    next unless final_node && final_node.type == :send

    receiver, method_name, *args = *final_node

    if method_name == :to_s && args.empty?
      add_offense(
        final_node,
        :selector,
        receiver ? MSG_DEFAULT : MSG_SELF
      )
    end
  end
end