Class: RuboCop::Cop::Style::VariableInterpolation

Inherits:
Cop
  • Object
show all
Includes:
Interpolation
Defined in:
lib/rubocop/cop/style/variable_interpolation.rb

Overview

This cop checks for variable interpolation (like “#@ivar”).

Examples:

# bad
"His name is #$name"
/check #$pattern/
"Let's go to the #@store"

# good
"His name is #{$name}"
/check #{$pattern}/
"Let's go to the #{@store}"

Constant Summary collapse

MSG =
'Replace interpolated variable `%<variable>s` ' \
'with expression `#{%<variable>s}`.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from Interpolation

#on_dstr, #on_interpolation

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?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #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?, #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

#autocorrect(node) ⇒ Object


30
31
32
33
34
# File 'lib/rubocop/cop/style/variable_interpolation.rb', line 30

def autocorrect(node)
  lambda do |corrector|
    corrector.replace(node.source_range, "{#{node.source}}")
  end
end

#on_node_with_interpolations(node) ⇒ Object


24
25
26
27
28
# File 'lib/rubocop/cop/style/variable_interpolation.rb', line 24

def on_node_with_interpolations(node)
  var_nodes(node.children).each do |var_node|
    add_offense(var_node)
  end
end