class RuboCop::Cop::Style::SymbolArray
Checks for array literals made up of symbols that are not using the %i() syntax.
Alternatively, it checks for symbol arrays using the %i() syntax on projects which do not want to use that syntax, perhaps because they support a version of Ruby lower than 2.0.
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 %i[foo bar baz] # bad [:foo, :bar, :baz]
@example EnforcedStyle: brackets
# good [:foo, :bar, :baz] # bad %i[foo bar baz]
Constants
- ARRAY_MSG
- PERCENT_MSG
Attributes
largest_brackets[RW]
Public Instance Methods
on_array(node)
click to toggle source
# File lib/rubocop/cop/style/symbol_array.rb, line 48 def on_array(node) if bracketed_array_of?(:sym, node) return if symbols_contain_spaces?(node) check_bracketed_array(node, 'i') elsif node.percent_literal?(:symbol) check_percent_array(node) end end
Private Instance Methods
build_bracketed_array(node)
click to toggle source
# File lib/rubocop/cop/style/symbol_array.rb, line 67 def build_bracketed_array(node) return '[]' if node.children.empty? syms = node.children.map do |c| if c.dsym_type? string_literal = to_string_literal(c.source) ":#{trim_string_interpolation_escape_character(string_literal)}" else to_symbol_literal(c.value.to_s) end end build_bracketed_array_with_appropriate_whitespace(elements: syms, node: node) end
symbol_without_quote?(string)
click to toggle source
# File lib/rubocop/cop/style/symbol_array.rb, line 90 def symbol_without_quote?(string) special_gvars = %w[ $! $" $$ $& $' $* $+ $, $/ $; $: $. $< $= $> $? $@ $\\ $_ $` $~ $0 $-0 $-F $-I $-K $-W $-a $-d $-i $-l $-p $-v $-w ] redefinable_operators = %w( | ^ & <=> == === =~ > >= < <= << >> + - * / % ** ~ +@ -@ [] []= ` ! != !~ ) # method name /\A[a-zA-Z_]\w*[!?]?\z/.match?(string) || # instance / class variable /\A@@?[a-zA-Z_]\w*\z/.match?(string) || # global variable /\A\$[1-9]\d*\z/.match?(string) || /\A\$[a-zA-Z_]\w*\z/.match?(string) || special_gvars.include?(string) || redefinable_operators.include?(string) end
symbols_contain_spaces?(node)
click to toggle source
# File lib/rubocop/cop/style/symbol_array.rb, line 60 def symbols_contain_spaces?(node) node.children.any? do |sym| content, = *sym / /.match?(content) end end
to_symbol_literal(string)
click to toggle source
# File lib/rubocop/cop/style/symbol_array.rb, line 82 def to_symbol_literal(string) if symbol_without_quote?(string) ":#{string}" else ":#{to_string_literal(string)}" end end