123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::StringLiterals

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/style/string_literals.rb

Overview

Checks if uses of quotes match the configured preference.

Examples:

EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"

# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'

# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

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::StringHelp - Included

::RuboCop::Cop::StringLiteralsHelp - Included

::RuboCop::Cop::ConfigurableEnforcedStyle - 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 Attribute Details

#consistent_multiline?Boolean (readonly, private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/string_literals.rb', line 101

def consistent_multiline?
  cop_config['ConsistentQuotesInMultiline']
end

Instance Method Details

#accept_child_double_quotes?(nodes) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/string_literals.rb', line 123

def accept_child_double_quotes?(nodes)
  nodes.any? { |n| n.dstr_type? || double_quotes_required?(n.source) }
end

#all_string_literals?(nodes) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/string_literals.rb', line 71

def all_string_literals?(nodes)
  nodes.all? { |n| n.str_type? || n.dstr_type? }
end

#autocorrect(corrector, node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/string_literals.rb', line 61

def autocorrect(corrector, node)
  StringLiteralCorrector.correct(corrector, node, style)
end

#check_multiline_quote_style(node, quote) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/string_literals.rb', line 105

def check_multiline_quote_style(node, quote)
  children = node.children
  if unexpected_single_quotes?(quote)
    all_children_with_quotes = children.all? { |c| wrong_quotes?(c) }
    register_offense(node) if all_children_with_quotes
  elsif unexpected_double_quotes?(quote) && !accept_child_double_quotes?(children)
    register_offense(node)
  end
end

#detect_quote_styles(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/string_literals.rb', line 75

def detect_quote_styles(node)
  styles = node.children.map { |c| c.loc.begin }

  # For multi-line strings that only have quote marks
  # at the beginning of the first line and the end of
  # the last, the begin and end region of each child
  # is nil. The quote marks are in the parent node.
  return [node.loc.begin.source] if styles.all?(&:nil?)

  styles.map(&:source).uniq
end

#message(_node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/string_literals.rb', line 87

def message(_node)
  if style == :single_quotes
    "Prefer single-quoted strings when you don't need string " \
      'interpolation or special symbols.'
  else
    'Prefer double-quoted strings unless you need single quotes to ' \
      'avoid extra backslashes for escaping.'
  end
end

#offense?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/string_literals.rb', line 97

def offense?(node)
  wrong_quotes?(node) && !inside_interpolation?(node)
end

#on_dstr(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/string_literals.rb', line 37

def on_dstr(node)
  # Strings which are continued across multiple lines using \
  # are parsed as a `dstr` node with `str` children
  # If one part of that continued string contains interpolations,
  # then it will be parsed as a nested `dstr` node
  return unless consistent_multiline?
  return if node.heredoc?

  children = node.children
  return unless all_string_literals?(children)

  quote_styles = detect_quote_styles(node)

  if quote_styles.size > 1
    register_offense(node, message: MSG_INCONSISTENT)
  else
    check_multiline_quote_style(node, quote_styles[0])
  end

  ignore_node(node)
end

#register_offense(node, message: nil) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/string_literals.rb', line 65

def register_offense(node, message: nil)
  add_offense(node, message: message || message(node)) do |corrector|
    autocorrect(corrector, node)
  end
end

#unexpected_double_quotes?(quote) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/string_literals.rb', line 119

def unexpected_double_quotes?(quote)
  quote == '"' && style == :single_quotes
end

#unexpected_single_quotes?(quote) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/string_literals.rb', line 115

def unexpected_single_quotes?(quote)
  quote == "'" && style == :double_quotes
end