class RuboCop::Cop::Style::QuotedSymbols

Checks if the quotes used for quoted symbols match the configured defaults. By default uses the same configuration as `Style/StringLiterals`; if that cop is not enabled, the default `EnforcedStyle` is `single_quotes`.

String interpolation is always kept in double quotes.

Note: `Lint/SymbolConversion` can be used in parallel to ensure that symbols are not quoted that don't need to be. This cop is for configuring the quoting style to use for symbols that require quotes.

@example EnforcedStyle: same_as_string_literals (default) / single_quotes

# bad
:"abc-def"

# good
:'abc-def'
:"#{str}"
:"a\'b"

@example EnforcedStyle: double_quotes

# bad
:'abc-def'

# good
:"abc-def"
:"#{str}"
:"a\'b"

Constants

MSG_DOUBLE
MSG_SINGLE

Public Instance Methods

on_sym(node) click to toggle source
# File lib/rubocop/cop/style/quoted_symbols.rb, line 44
def on_sym(node)
  return unless quoted?(node)

  message = style == :single_quotes ? MSG_SINGLE : MSG_DOUBLE

  if wrong_quotes?(node) || invalid_double_quotes?(node.source)
    add_offense(node, message: message) do |corrector|
      opposite_style_detected
      autocorrect(corrector, node)
    end
  else
    correct_style_detected
  end
end

Private Instance Methods

alternative_style() click to toggle source
# File lib/rubocop/cop/style/quoted_symbols.rb, line 108
def alternative_style
  (supported_styles - [style, :same_as_string_literals]).first
end
autocorrect(corrector, node) click to toggle source
# File lib/rubocop/cop/style/quoted_symbols.rb, line 71
def autocorrect(corrector, node)
  str = if hash_colon_key?(node)
          # strip quotes
          correct_quotes(node.source[1..-2])
        else
          # strip leading `:` and quotes
          ":#{correct_quotes(node.source[2..-2])}"
        end

  corrector.replace(node, str)
end
correct_quotes(str) click to toggle source
# File lib/rubocop/cop/style/quoted_symbols.rb, line 88
def correct_quotes(str)
  correction = if style == :single_quotes
                 to_string_literal(str)
               else
                 str.gsub("\\'", "'").inspect
               end

  # The conversion process doubles escaped slashes, so they have to be reverted
  correction.gsub('\\\\', '\\')
end
hash_colon_key?(node) click to toggle source
# File lib/rubocop/cop/style/quoted_symbols.rb, line 83
def hash_colon_key?(node)
  # Is the node a hash key with the colon style?
  hash_key?(node) && node.parent.colon?
end
invalid_double_quotes?(source) click to toggle source
# File lib/rubocop/cop/style/quoted_symbols.rb, line 61
def invalid_double_quotes?(source)
  return false unless style == :double_quotes

  # The string needs single quotes if:
  # 1. It contains a double quote
  # 2. It contains text that would become an escape sequence with double quotes
  # 3. It contains text that would become an interpolation with double quotes
  !/" | (?<!\\)\\[aAbcdefkMnprsStuUxzZ0-7] | \#[@{$]/x.match?(source)
end
quoted?(sym_node) click to toggle source
# File lib/rubocop/cop/style/quoted_symbols.rb, line 112
def quoted?(sym_node)
  sym_node.source.match?(/\A:?(['"]).*?\1\z/m)
end
style() click to toggle source
# File lib/rubocop/cop/style/quoted_symbols.rb, line 99
def style
  return super unless super == :same_as_string_literals

  string_literals_config = config.for_cop('Style/StringLiterals')
  return :single_quotes unless string_literals_config['Enabled']

  string_literals_config['EnforcedStyle'].to_sym
end
wrong_quotes?(node) click to toggle source
# File lib/rubocop/cop/style/quoted_symbols.rb, line 116
def wrong_quotes?(node)
  return super if hash_key?(node)

  super(node.source[1..])
end