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:


# bad

"result is #{something.to_s}"

# good

"result is #{something}"

Constant Summary collapse

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

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, 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_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, find_file_upwards, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/lint/string_conversion_in_interpolation.rb', line 36

def autocorrect(node)
  lambda do |corrector|
    receiver, _method_name, *_args = *node
    corrector.replace(
      node.source_range,
      if receiver
        receiver.source
      else
        'self'
      end
    )
  end
end

#on_dstr(node) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/rubocop/cop/lint/string_conversion_in_interpolation.rb', line 25

def on_dstr(node)
  node.each_child_node(:begin) do |begin_node|
    final_node = begin_node.children.last

    next unless final_node && final_node.send_type? &&
                final_node.method?(:to_s) && !final_node.arguments?

    add_offense(final_node, location: :selector)
  end
end