class RuboCop::Cop::Style::BarePercentLiterals

This cop checks if usage of %() or %Q() matches configuration.

@example EnforcedStyle: bare_percent (default)

# bad
%Q(He said: "#{greeting}")
%q{She said: 'Hi'}

# good
%(He said: "#{greeting}")
%{She said: 'Hi'}

@example EnforcedStyle: percent_q

# bad
%|He said: "#{greeting}"|
%/She said: 'Hi'/

# good
%Q|He said: "#{greeting}"|
%q/She said: 'Hi'/

Constants

MSG

Public Instance Methods

autocorrect(node) click to toggle source
# File lib/rubocop/cop/style/bare_percent_literals.rb, line 39
def autocorrect(node)
  src = node.loc.begin.source
  replacement = src.start_with?('%Q') ? '%' : '%Q'
  lambda do |corrector|
    corrector.replace(node.loc.begin, src.sub(/%Q?/, replacement))
  end
end
on_dstr(node) click to toggle source
# File lib/rubocop/cop/style/bare_percent_literals.rb, line 31
def on_dstr(node)
  check(node)
end
on_str(node) click to toggle source
# File lib/rubocop/cop/style/bare_percent_literals.rb, line 35
def on_str(node)
  check(node)
end

Private Instance Methods

add_offense_for_wrong_style(node, good, bad) click to toggle source
# File lib/rubocop/cop/style/bare_percent_literals.rb, line 70
def add_offense_for_wrong_style(node, good, bad)
  add_offense(node, location: :begin, message: format(MSG,
                                                      good: good,
                                                      bad: bad))
end
check(node) click to toggle source
# File lib/rubocop/cop/style/bare_percent_literals.rb, line 49
def check(node)
  return if node.heredoc?
  return unless node.loc.respond_to?(:begin)
  return unless node.loc.begin

  source = node.loc.begin.source
  if requires_percent_q?(source)
    add_offense_for_wrong_style(node, 'Q', '')
  elsif requires_bare_percent?(source)
    add_offense_for_wrong_style(node, '', 'Q')
  end
end
requires_bare_percent?(source) click to toggle source
# File lib/rubocop/cop/style/bare_percent_literals.rb, line 66
def requires_bare_percent?(source)
  style == :bare_percent && source =~ /^%Q/
end
requires_percent_q?(source) click to toggle source
# File lib/rubocop/cop/style/bare_percent_literals.rb, line 62
def requires_percent_q?(source)
  style == :percent_q && source =~ /^%[^\w]/
end