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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
ArrayMinSize, ArraySyntax, ConfigurableEnforcedStyle, PercentArray
Defined in:
lib/rubocop/cop/style/word_array.rb

Overview

Checks 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.

NOTE: When using the ‘percent` style, %w() arrays containing a space will be registered as offenses.

Configuration option: MinSize If set, arrays with fewer elements than this value will not trigger the cop. For example, a ‘MinSize` of `3` will not enforce a style on an array of 2 or fewer elements.

Examples:

EnforcedStyle: percent (default)

# good
%w[foo bar baz]

# bad
['foo', 'bar', 'baz']

# bad (contains spaces)
%w[foo\ bar baz\ quux]

# bad
[
  ['one', 'One'],
  ['two', 'Two']
]

# good
[
  %w[one One],
  %w[two Two]
]

# good (2d array containing spaces)
[
  ['one', 'One'],
  ['two', 'Two'],
  ['forty two', 'Forty Two']
]

EnforcedStyle: brackets

# good
['foo', 'bar', 'baz']

# bad
%w[foo bar baz]

# good (contains spaces)
['foo bar', 'baz quux']

# good
[
  ['one', 'One'],
  ['two', 'Two']
]

# bad
[
  %w[one One],
  %w[two Two]
]

Constant Summary collapse

PERCENT_MSG = 
'Use `%w` or `%W` for an array of words.'
ARRAY_MSG = 
'Use %<prefer>s for an array of words.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Class Attribute Summary collapse

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #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_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, 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

Class Attribute Details

.largest_brackets ⇒ Object

Returns the value of attribute largest_brackets.



82
83
84
 
# File 'lib/rubocop/cop/style/word_array.rb', line 82

def largest_brackets
  @largest_brackets
end

Instance Method Details

#on_array(node) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
 
# File 'lib/rubocop/cop/style/word_array.rb', line 94

def on_array(node)
  if bracketed_array_of?(:str, node)
    return if complex_content?(node.values)
    return if within_matrix_of_complex_content?(node)

    check_bracketed_array(node, 'w')
  elsif node.percent_literal?(:string)
    check_percent_array(node)
  end
end

#on_new_investigation ⇒ Object 



85
86
87
88
89
90
91
92
 
# File 'lib/rubocop/cop/style/word_array.rb', line 85

def on_new_investigation
  super

  # Prevent O(n2) checks (checking the entire matrix once for each child array) by caching
  @matrix_of_complex_content_cache = Hash.new do |cache, node|
    cache[node] = matrix_of_complex_content?(node)
  end
end