Class: RuboCop::Cop::Lint::PercentStringArray

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
PercentLiteral
Defined in:
lib/rubocop/cop/lint/percent_string_array.rb

Overview

Checks for quotes and commas in %w, e.g. %w('foo', "bar")

It is more likely that the additional characters are unintended (for example, mistranslating an array of literals to percent string notation) rather than meant to be part of the resulting strings.

Examples:


# bad

%w('foo', "bar")

# good

%w(foo bar)

Cop Safety Information:

  • The cop is unsafe because the correction changes the values in the array and that might have been done purposely.

    %w('foo', "bar") #=> ["'foo',", '"bar"']
%w(foo bar)      #=> ['foo', 'bar']

Constant Summary collapse

QUOTES_AND_COMMAS = 
[/,$/, /^'.*'$/, /^".*"$/].freeze
LEADING_QUOTE = 
/^['"]/.freeze
TRAILING_QUOTE = 
/['"]?,?$/.freeze
MSG = 
"Within `%w`/`%W`, quotes and ',' are unnecessary and may be " \
'unwanted in the resulting strings.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_array(node) ⇒ Object 



44
45
46
 
# File 'lib/rubocop/cop/lint/percent_string_array.rb', line 44

def on_array(node)
  process(node, '%w', '%W')
end

#on_percent_literal(node) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/rubocop/cop/lint/percent_string_array.rb', line 48

def on_percent_literal(node)
  return unless contains_quotes_or_commas?(node)

  add_offense(node) do |corrector|
    node.each_value do |value|
      range = value.source_range

      match = range.source.match(TRAILING_QUOTE)
      corrector.remove_trailing(range, match[0].length) if match

      corrector.remove_leading(range, 1) if LEADING_QUOTE.match?(range.source)
    end
  end
end