123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Lint::LiteralInInterpolation

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/lint/literal_in_interpolation.rb

Overview

Checks for interpolated literals.

Examples:

# bad

"result is #{10}"
# good

"result is 10"

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.

.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.

.badge

Naming.

.callbacks_needed, .cop_name, .department,
.documentation_url

Returns an url to view this cops documentation online.

.exclude_from_registry

Call for abstract Cop classes.

.inherited,
.joining_forces

Override and return the Force class(es) you need to join.

.match?

Returns true if the cop name or the cop namespace matches any of the given names.

.new,
.requires_gem

Register a version requirement for the given gem name.

.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.

transform

Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::PercentLiteral - Included

::RuboCop::Cop::RangeHelp - Included

#add_range, #column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.

#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.

#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::RuboCop::Cop::Interpolation - Included

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.

#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.

#begin_investigation

Called before any investigation.

#callbacks_needed,
#cop_config

Configuration Helpers.

#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:

#inspect,
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#name

Alias for Base#cop_name.

#offenses,
#on_investigation_end

Called after all on_…​

#on_new_investigation

Called before all on_…​

#on_other_file

Called instead of all on_…​

#parse

There should be very limited reasons for a Cop to do it’s own parsing.

#parser_engine,
#ready

Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.

#complete_investigation

Called to complete an investigation.

#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#autocorrected_value(node) (private)

Metrics/CyclomaticComplexity

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/literal_in_interpolation.rb', line 62

def autocorrected_value(node)
  case node.type
  when :int
    node.children.last.to_i.to_s
  when :float
    node.children.last.to_f.to_s
  when :str
    autocorrected_value_for_string(node)
  when :sym
    autocorrected_value_for_symbol(node)
  when :array
    autocorrected_value_for_array(node)
  when :hash
    autocorrected_value_for_hash(node)
  when :nil
    ''
  else
    node.source.gsub('"', '\"')
  end
end

#autocorrected_value_for_array(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/literal_in_interpolation.rb', line 108

def autocorrected_value_for_array(node)
  return node.source.gsub('"', '\"') unless node.percent_literal?

  contents_range(node).source.split.to_s.gsub('"', '\"')
end

#autocorrected_value_for_hash(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/literal_in_interpolation.rb', line 114

def autocorrected_value_for_hash(node)
  hash_string = node.children.map do |child|
    key = autocorrected_value_in_hash(child.key)
    value = autocorrected_value_in_hash(child.value)
    "#{key}=>#{value}"
  end.join(', ')

  "{#{hash_string}}"
end

#autocorrected_value_for_string(node) (private)

Metrics/CyclomaticComplexity

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/literal_in_interpolation.rb', line 84

def autocorrected_value_for_string(node)
  if node.source.start_with?("'", '%q')
    node.children.last.inspect[1..-2]
  else
    node.children.last
  end
end

#autocorrected_value_for_symbol(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/literal_in_interpolation.rb', line 92

def autocorrected_value_for_symbol(node)
  end_pos =
    node.loc.end ? node.loc.end.begin_pos : node.source_range.end_pos

  range_between(node.loc.begin.end_pos, end_pos).source.gsub('"', '\"')
end

#autocorrected_value_in_hash(node) (private)

Metrics/AbcSize

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/literal_in_interpolation.rb', line 125

def autocorrected_value_in_hash(node)
  case node.type
  when :int
    node.children.last.to_i.to_s
  when :float
    node.children.last.to_f.to_s
  when :str
    "\\\"#{node.value.to_s.gsub('"') { '\\\\\"' }}\\\""
  when :sym
    autocorrected_value_in_hash_for_symbol(node)
  when :array
    autocorrected_value_for_array(node)
  when :hash
    autocorrected_value_for_hash(node)
  else
    node.source.gsub('"', '\"')
  end
end

#autocorrected_value_in_hash_for_symbol(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/literal_in_interpolation.rb', line 99

def autocorrected_value_in_hash_for_symbol(node)
  # TODO: We need to detect symbol unacceptable names more correctly
  if / |"|'/.match?(node.value.to_s)
    ":\\\"#{node.value.to_s.gsub('"') { '\\\\\"' }}\\\""
  else
    ":#{node.value}"
  end
end

#ends_heredoc_line?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/literal_in_interpolation.rb', line 155

def ends_heredoc_line?(node)
  grandparent = node.parent.parent
  return false unless grandparent&.dstr_type? && grandparent&.heredoc?

  line = processed_source.lines[node.last_line - 1]
  line.size == node.loc.last_column + 1
end

#in_array_percent_literal?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/literal_in_interpolation.rb', line 163

def in_array_percent_literal?(node)
  parent = node.parent
  return false unless parent.dstr_type? || parent.dsym_type?

  grandparent = parent.parent
  grandparent&.array_type? && grandparent&.percent_literal?
end

#offending?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/literal_in_interpolation.rb', line 48

def offending?(node)
  node &&
    !special_keyword?(node) &&
    prints_as_self?(node) &&
    # Special case for Layout/TrailingWhitespace
    !(space_literal?(node) && ends_heredoc_line?(node))
end

#on_interpolation(begin_node)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/literal_in_interpolation.rb', line 28

def on_interpolation(begin_node)
  final_node = begin_node.children.last
  return unless offending?(final_node)

  # %W and %I split the content into words before expansion
  # treating each interpolation as a word component, so
  # interpolation should not be removed if the expanded value
  # contains a space character.
  expanded_value = autocorrected_value(final_node)
  return if in_array_percent_literal?(begin_node) && /\s|\A\z/.match?(expanded_value)

  add_offense(final_node) do |corrector|
    return if final_node.dstr_type? # nested, fixed in next iteration

    corrector.replace(final_node.parent, expanded_value)
  end
end

#prints_as_self?(node) ⇒ Boolean (private)

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

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/literal_in_interpolation.rb', line 146

def prints_as_self?(node)
  node.basic_literal? ||
    (COMPOSITE.include?(node.type) && node.children.all? { |child| prints_as_self?(child) })
end

#space_literal?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/literal_in_interpolation.rb', line 151

def space_literal?(node)
  node.str_type? && node.value.blank?
end

#special_keyword?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/literal_in_interpolation.rb', line 56

def special_keyword?(node)
  # handle strings like __FILE__
  (node.str_type? && !node.loc.respond_to?(:begin)) || node.source_range.is?('__LINE__')
end