class RuboCop::Cop::Lint::LiteralInInterpolation

This cop checks for interpolated literals.

@example

# bad

"result is #{10}"

@example

# good

"result is 10"

Constants

COMPOSITE
MSG

Public Instance Methods

autocorrect(node) click to toggle source
# File lib/rubocop/cop/lint/literal_in_interpolation.rb, line 34
def autocorrect(node)
  return if node.dstr_type? # nested, fixed in next iteration

  value = autocorrected_value(node)
  ->(corrector) { corrector.replace(node.parent.source_range, value) }
end
on_dstr(node) click to toggle source
# File lib/rubocop/cop/lint/literal_in_interpolation.rb, line 23
def on_dstr(node)
  node.each_child_node(:begin) do |begin_node|
    final_node = begin_node.children.last
    next unless final_node
    next if special_keyword?(final_node)
    next unless prints_as_self?(final_node)

    add_offense(final_node)
  end
end

Private Instance Methods

autocorrected_value(node) click to toggle source
# File lib/rubocop/cop/lint/literal_in_interpolation.rb, line 49
def autocorrected_value(node)
  case node.type
  when :str
    node.children.last
  when :sym
    autocorrected_value_for_symbol(node)
  else
    node.source.gsub('"', '\"')
  end
end
autocorrected_value_for_symbol(node) click to toggle source
# File lib/rubocop/cop/lint/literal_in_interpolation.rb, line 60
def autocorrected_value_for_symbol(node)
  end_pos =
    node.loc.end ? node.loc.end.begin_pos : node.loc.expression.end_pos

  range_between(node.loc.begin.end_pos, end_pos).source
end
prints_as_self?(node) click to toggle source

Does node print its own source when converted to a string?

# File lib/rubocop/cop/lint/literal_in_interpolation.rb, line 68
def prints_as_self?(node)
  node.basic_literal? ||
    (COMPOSITE.include?(node.type) &&
      node.children.all? { |child| prints_as_self?(child) })
end
special_keyword?(node) click to toggle source
# File lib/rubocop/cop/lint/literal_in_interpolation.rb, line 43
def special_keyword?(node)
  # handle strings like __FILE__
  (node.str_type? && !node.loc.respond_to?(:begin)) ||
    node.source_range.is?('__LINE__')
end