Class: RuboCop::Cop::Lint::RedundantStringCoercion

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
Interpolation
Defined in:
lib/rubocop/cop/lint/redundant_string_coercion.rb

Overview

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

Examples:


# bad

"result is #{something.to_s}"

# good

"result is #{something}"

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 inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from Interpolation

#on_dstr, #on_node_with_interpolations

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, 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 ExcludeLimit

#exclude_limit

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

silence_warnings

Constructor Details

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

Instance Method Details

#on_interpolation(begin_node) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/rubocop/cop/lint/redundant_string_coercion.rb', line 31

def on_interpolation(begin_node)
  final_node = begin_node.children.last

  return unless to_s_without_args?(final_node)

  message = final_node.receiver ? MSG_DEFAULT : MSG_SELF

  add_offense(final_node.loc.selector, message: message) do |corrector|
    receiver = final_node.receiver
    corrector.replace(
      final_node,
      if receiver
        receiver.source
      else
        'self'
      end
    )
  end
end

#to_s_without_args?(node) ⇒ Object 



29
 
# File 'lib/rubocop/cop/lint/redundant_string_coercion.rb', line 29

def_node_matcher :to_s_without_args?, '(send _ :to_s)'