Class: RuboCop::Cop::Style::UnneededPercentQ

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/unneeded_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.'.freeze
DYNAMIC_MSG =
', or for dynamic strings that contain ' \
'double quotes'.freeze
SINGLE_QUOTE =
"'".freeze
QUOTE =
'"'.freeze
EMPTY =
''.freeze
PERCENT_Q =
'%q'.freeze
PERCENT_CAPITAL_Q =
'%Q'.freeze
STRING_INTERPOLATION_REGEXP =
/#\{.+}/
ESCAPED_NON_BACKSLASH =
/\\[^\\]/

Constants included from Util

Util::ASGN_NODES, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object



46
47
48
49
50
51
52
53
# File 'lib/rubocop/cop/style/unneeded_percent_q.rb', line 46

def autocorrect(node)
  delimiter =
    node.source =~ /^%Q[^"]+$|'/ ? QUOTE : SINGLE_QUOTE
  lambda do |corrector|
    corrector.replace(node.loc.begin, delimiter)
    corrector.replace(node.loc.end, delimiter)
  end
end

#on_dstr(node) ⇒ Object



33
34
35
36
# File 'lib/rubocop/cop/style/unneeded_percent_q.rb', line 33

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

#on_str(node) ⇒ Object



38
39
40
41
42
43
44
# File 'lib/rubocop/cop/style/unneeded_percent_q.rb', line 38

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