Class: RuboCop::Cop::Style::WordArray

Inherits:
Cop
  • Object
show all
Includes:
ArraySyntax
Defined in:
lib/rubocop/cop/style/word_array.rb

Overview

This cop can check for array literals made up of word-like strings, that are not using the %w() syntax.

Alternatively, it can check for uses of the %w() syntax, in projects which do not want to include that syntax.

Constant Summary collapse

PERCENT_MSG = 
'Use `%w` or `%W` for an array of words.'.freeze
ARRAY_MSG = 
'Use `[]` for an array of words.'.freeze
QUESTION_MARK_SIZE = 
'?'.size

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, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ArraySyntax

#bracketed_array_of?, #square_brackets?

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?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, 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_body

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?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, ternary_op?, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/rubocop/cop/style/word_array.rb', line 36

def autocorrect(node)
  words = node.children
  if style == :percent
    escape = words.any? { |w| double_quotes_required?(w.children[0]) }
    char = escape ? 'W' : 'w'
    contents = autocorrect_words(words, escape, node.loc.line)
    lambda do |corrector|
      corrector.replace(node.source_range, "%#{char}(#{contents})")
    end
  else
    words = words.map { |w| to_string_literal(w.children[0]) }
    lambda do |corrector|
      corrector.replace(node.source_range, "[#{words.join(', ')}]")
    end
  end
end

#on_array(node) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/rubocop/cop/style/word_array.rb', line 19

def on_array(node)
  array_elems = node.children

  if bracketed_array_of?(:str, node)
    return if complex_content?(array_elems) ||
              comments_in_array?(node)
    style_detected(:brackets, array_elems.size)

    if style == :percent && array_elems.size >= min_size
      add_offense(node, :expression, PERCENT_MSG)
    end
  elsif node.loc.begin && node.loc.begin.source =~ /\A%[wW]/
    style_detected(:percent, array_elems.size)
    add_offense(node, :expression, ARRAY_MSG) if style == :brackets
  end
end