class RuboCop::Cop::Style::WordArray
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.
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.
@example EnforcedStyle: percent (default)
# good %w[foo bar baz] # bad ['foo', 'bar', 'baz']
@example EnforcedStyle: brackets
# good ['foo', 'bar', 'baz'] # bad %w[foo bar baz]
Constants
- ARRAY_MSG
- PERCENT_MSG
Attributes
largest_brackets[RW]
Public Instance Methods
autocorrect(node)
click to toggle source
# File lib/rubocop/cop/style/word_array.rb, line 53 def autocorrect(node) if style == :percent PercentLiteralCorrector .new(@config, @preferred_delimiters) .correct(node, 'w') else correct_bracketed(node) end end
on_array(node)
click to toggle source
# File lib/rubocop/cop/style/word_array.rb, line 43 def on_array(node) if bracketed_array_of?(:str, node) return if complex_content?(node.values) check_bracketed_array(node) elsif node.percent_literal?(:string) check_percent_array(node) end end
Private Instance Methods
check_bracketed_array(node)
click to toggle source
# File lib/rubocop/cop/style/word_array.rb, line 65 def check_bracketed_array(node) return if allowed_bracket_array?(node) array_style_detected(:brackets, node.values.size) add_offense(node) if style == :percent end
complex_content?(strings)
click to toggle source
# File lib/rubocop/cop/style/word_array.rb, line 72 def complex_content?(strings) strings.any? do |s| string = s.str_content.dup.force_encoding(::Encoding::UTF_8) !string.valid_encoding? || string !~ word_regex || string =~ / / end end
correct_bracketed(node)
click to toggle source
# File lib/rubocop/cop/style/word_array.rb, line 84 def correct_bracketed(node) words = node.children.map do |word| if word.dstr_type? string_literal = to_string_literal(word.source) trim_string_interporation_escape_character(string_literal) else to_string_literal(word.children[0]) end end lambda do |corrector| corrector.replace(node.source_range, "[#{words.join(', ')}]") end end
word_regex()
click to toggle source
# File lib/rubocop/cop/style/word_array.rb, line 80 def word_regex Regexp.new(cop_config['WordRegex']) end