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.

Constant Summary collapse

MSG = 
'Use `%s` only for strings that contain both single quotes and ' \
'double quotes%s.'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, 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?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_dstr(node) ⇒ Object 



11
12
13
14
 
# File 'lib/rubocop/cop/style/unneeded_percent_q.rb', line 11

def on_dstr(node)
  # Using %Q to avoid escaping inner " is ok.
  check(node) unless node.loc.expression.source =~ /"/
end

#on_regexp(node) ⇒ Object

We process regexp nodes because the inner str nodes can cause confusion in on_str if they start with %( or %Q(.



22
23
24
25
 
# File 'lib/rubocop/cop/style/unneeded_percent_q.rb', line 22

def on_regexp(node)
  string_parts = node.children.select { |child| child.type == :str }
  string_parts.each { |s| ignore_node(s) }
end

#on_str(node) ⇒ Object 



16
17
18
 
# File 'lib/rubocop/cop/style/unneeded_percent_q.rb', line 16

def on_str(node)
  check(node)
end