Class: 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 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 included from Util
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
Methods inherited from Cop
#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version
Methods included from AST::Sexp
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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character
Methods included from PathUtil
absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#autocorrect(node) ⇒ Object
43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/rubocop/cop/lint/percent_string_array.rb', line 43 def autocorrect(node) lambda do |corrector| node.values.each do |value| range = value.loc.expression match = range.source.match(TRAILING_QUOTE) corrector.remove_trailing(range, match[0].length) if match if range.source =~ LEADING_QUOTE corrector.remove_leading(range, 1) end end end end |
#on_array(node) ⇒ Object
33 34 35 |
# File 'lib/rubocop/cop/lint/percent_string_array.rb', line 33 def on_array(node) process(node, '%w', '%W') end |
#on_percent_literal(node) ⇒ Object
37 38 39 40 41 |
# File 'lib/rubocop/cop/lint/percent_string_array.rb', line 37 def on_percent_literal(node) return unless contains_quotes_or_commas?(node) add_offense(node) end |