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

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Lint::PercentStringArray

Includes:

PercentLiteral

Defined in:

lib/rubocop/cop/lint/percent_string_array.rb

Overview

This cop 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.

Constant Summary

MSG =

"Within `%w`/`%W`, quotes and ',' are unnecessary and may be " \
'unwanted in the resulting strings.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #on_array(node) ⇒ Object
• #on_percent_literal(node) ⇒ Object

Methods included from PercentLiteral

#begin_source, #contents_range, #percent_literal?, #process, #type

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #duplicate_location?, #excluded_file?, #extra_details?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

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 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?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_array(node) ⇒ Object

# File 'lib/rubocop/cop/lint/percent_string_array.rb', line 19

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

#on_percent_literal(node) ⇒ Object

# File 'lib/rubocop/cop/lint/percent_string_array.rb', line 23

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

  add_offense(node, :expression, MSG)
end