Class: RuboCop::Cop::Lint::InterpolationCheck

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

Overview

This cop checks for interpolation in a single quoted string.

Examples:


# bad

foo = 'something with #{interpolation} inside'

# good

foo = "something with #{interpolation} inside"

Constant Summary collapse

MSG = 
'Interpolation in single quoted string detected. '\
'Use double quoted strings if you need interpolation.'

Constants included from Util

Util::LITERAL_REGEX

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, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

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 AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #safe_autocorrect?, #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?, 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?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#heredoc?(node) ⇒ Boolean

Returns:

  • (Boolean) 

33
34
35
36
 
# File 'lib/rubocop/cop/lint/interpolation_check.rb', line 33

def heredoc?(node)
  node.loc.is_a?(Parser::Source::Map::Heredoc) ||
    (node.parent && heredoc?(node.parent))
end

#on_str(node) ⇒ Object 


23
24
25
26
27
28
29
30
31
 
# File 'lib/rubocop/cop/lint/interpolation_check.rb', line 23

def on_str(node)
  return if heredoc?(node)

  parent = node.parent
  return if parent && (parent.dstr_type? || parent.regexp_type?)
  return unless node.source.scrub =~ /(?<!\\)#\{.*\}/

  add_offense(node)
end