class RuboCop::Cop::Style::WordArray
]
%w[two Two]
%w[one One],
[
# bad
]
[‘two’, ‘Two’]
[‘one’, ‘One’],
[
# good
[‘foo bar’, ‘baz quux’]
# good (contains spaces)
%w[foo bar baz]
# bad
[‘foo’, ‘bar’, ‘baz’]
# good
@example EnforcedStyle: brackets
]
[‘forty two’, ‘Forty Two’]
[‘two’, ‘Two’],
[‘one’, ‘One’],
[
# good (2d array containing spaces)
]
%w[two Two]
%w[one One],
[
# good
]
[‘two’, ‘Two’]
[‘one’, ‘One’],
[
# bad
%w[foo\ bar baz\ quux]
# bad (contains spaces)
[‘foo’, ‘bar’, ‘baz’]
# bad
%w[foo bar baz]
# good
@example EnforcedStyle: percent (default)
array of 2 or fewer elements.
cop. For example, a ‘MinSize` of `3` will not enforce a style on an
If set, arrays with fewer elements than this value will not trigger the
Configuration option: MinSize
will be registered as offenses.
NOTE: When using the `percent` style, %w() arrays containing a space
which do not want to include that syntax.
Alternatively, it can check for uses of the %w() syntax, in projects
strings, that are not using the %w() syntax.
Checks for array literals made up of word-like
def build_bracketed_array(node)
def build_bracketed_array(node) return '[]' if node.children.empty? words = node.children.map do |word| if word.dstr_type? string_literal = to_string_literal(word.source) trim_string_interpolation_escape_character(string_literal) else to_string_literal(word.children[0]) end end build_bracketed_array_with_appropriate_whitespace(elements: words, node: node) end
def complex_content?(strings, complex_regex: word_regex)
def complex_content?(strings, complex_regex: word_regex) strings.any? do |s| next unless s.str_content string = s.str_content.dup.force_encoding(::Encoding::UTF_8) !string.valid_encoding? || (complex_regex && !complex_regex.match?(string)) || string.include?(' ') end end
def invalid_percent_array_contents?(node)
def invalid_percent_array_contents?(node) # Disallow %w() arrays that contain invalid encoding or spaces complex_content?(node.values, complex_regex: false) end
def matrix_of_complex_content?(array)
def matrix_of_complex_content?(array) array.values.all?(&:array_type?) && array.values.any? { |subarray| complex_content?(subarray.values) } end
def on_array(node)
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
def on_new_investigation
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
def within_matrix_of_complex_content?(node)
def within_matrix_of_complex_content?(node) return false unless (parent = node.parent) parent.array_type? && @matrix_of_complex_content_cache[parent] end
def word_regex
def word_regex Regexp.new(cop_config['WordRegex']) end