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

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

Overview

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

Constant Summary collapse

MSG =
'Use `%w` or `%W` for array of words.'
QUESTION_MARK_SIZE =
'?'.size

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableMax

#max=

Methods included from ArraySyntax

#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, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_array(node) ⇒ Object


18
19
20
21
22
23
24
25
# File 'lib/rubocop/cop/style/word_array.rb', line 18

def on_array(node)
  array_elems = node.children
  return unless array_of?(:str, node) &&
                !complex_content?(array_elems) &&
                array_elems.size > min_size && !comments_in_array?(node)

  add_offense(node, :expression) { self.max = array_elems.size }
end