123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::BarePercentLiterals

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

Overview

Checks if usage of %() or %Q() matches configuration.

Examples:

EnforcedStyle: bare_percent (default)

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

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

EnforcedStyle: percent_q

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

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

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

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

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

#add_offense_for_wrong_style(node, good, bad) (private)

[ GitHub ]

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

def add_offense_for_wrong_style(node, good, bad)
  location = node.loc.begin

  add_offense(location, message: format(MSG, good: good, bad: bad)) do |corrector|
    source = location.source
    replacement = source.start_with?('%Q') ? '%' : '%Q'

    corrector.replace(location, source.sub(/%Q?/, replacement))
  end
end

#check(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/bare_percent_literals.rb', line 42

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

#on_dstr(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/bare_percent_literals.rb', line 32

def on_dstr(node)
  check(node)
end

#on_str(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/bare_percent_literals.rb', line 36

def on_str(node)
  check(node)
end

#requires_bare_percent?(source) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/bare_percent_literals.rb', line 59

def requires_bare_percent?(source)
  style == :bare_percent && source.start_with?('%Q')
end

#requires_percent_q?(source) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/bare_percent_literals.rb', line 55

def requires_percent_q?(source)
  style == :percent_q && /^%[^\w]/.match?(source)
end