Class: RuboCop::Cop::Style::RedundantPercentQ

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/style/redundant_percent_q.rb

Overview

This cop checks for usage of the %q/%Q syntax when '' or “” would do.

Examples:


# bad
name = %q(Bruce Wayne)
time = %q(8 o'clock)
question = %q("What did you say?")

# good
name = 'Bruce Wayne'
time = "8 o'clock"
question = '"What did you say?"'

Constant Summary collapse

MSG =
'Use `%<q_type>s` only for strings that contain both ' \
'single quotes and double quotes%<extra>s.'
DYNAMIC_MSG =
', or for dynamic strings that contain double quotes'
SINGLE_QUOTE =
"'"
QUOTE =
'"'
EMPTY =
''
PERCENT_Q =
'%q'
PERCENT_CAPITAL_Q =
'%Q'
STRING_INTERPOLATION_REGEXP =
/#\{.+\}/.freeze
ESCAPED_NON_BACKSLASH =
/\\[^\\]/.freeze

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_dstr(node) ⇒ Object


34
35
36
37
38
# File 'lib/rubocop/cop/style/redundant_percent_q.rb', line 34

def on_dstr(node)
  return unless string_literal?(node)

  check(node)
end

#on_str(node) ⇒ Object


40
41
42
43
44
45
46
47
# File 'lib/rubocop/cop/style/redundant_percent_q.rb', line 40

def on_str(node)
  # Interpolated strings that contain more than just interpolation
  # will call `on_dstr` for the entire string and `on_str` for the
  # non interpolated portion of the string
  return unless string_literal?(node)

  check(node)
end