123456789_123456789_123456789_123456789_123456789_

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

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/redundant_percent_q.rb

Overview

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

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

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

#acceptable_capital_q?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_percent_q.rb', line 99

def acceptable_capital_q?(node)
  src = node.source
  src.include?(QUOTE) &&
    (STRING_INTERPOLATION_REGEXP.match?(src) ||
    (node.str_type? && double_quotes_required?(src)))
end

#acceptable_q?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_percent_q.rb', line 91

def acceptable_q?(node)
  src = node.source

  return true if STRING_INTERPOLATION_REGEXP.match?(src)

  src.scan(/\\./).any?(ESCAPED_NON_BACKSLASH)
end

#allowed_percent_q?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_percent_q.rb', line 67

def allowed_percent_q?(node)
  (node.source.start_with?(PERCENT_Q) && acceptable_q?(node)) ||
    (node.source.start_with?(PERCENT_CAPITAL_Q) && acceptable_capital_q?(node))
end

#check(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_percent_q.rb', line 51

def check(node)
  return unless start_with_percent_q_variant?(node)
  return if interpolated_quotes?(node) || allowed_percent_q?(node)

  add_offense(node) do |corrector|
    delimiter = /\A%Q[^"]+\z|'/.match?(node.source) ? QUOTE : SINGLE_QUOTE

    corrector.replace(node.loc.begin, delimiter)
    corrector.replace(node.loc.end, delimiter)
  end
end

#interpolated_quotes?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_percent_q.rb', line 63

def interpolated_quotes?(node)
  node.source.include?(SINGLE_QUOTE) && node.source.include?(QUOTE)
end

#message(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_percent_q.rb', line 72

def message(node)
  src = node.source
  extra = if src.start_with?(PERCENT_CAPITAL_Q)
            DYNAMIC_MSG
          else
            EMPTY
          end
  format(MSG, q_type: src[0, 2], extra: extra)
end

#on_dstr(node)

[ GitHub ]

  
# 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)

[ GitHub ]

  
# 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

#start_with_percent_q_variant?(string) ⇒ Boolean (private)

[ GitHub ]

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

def start_with_percent_q_variant?(string)
  string.source.start_with?(PERCENT_Q, PERCENT_CAPITAL_Q)
end

#string_literal?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/redundant_percent_q.rb', line 82

def string_literal?(node)
  node.loc.respond_to?(:begin) && node.loc.respond_to?(:end) &&
    node.loc.begin && node.loc.end
end