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] # bad (contains spaces) %i[foo\ bar baz\ quux] # bad (contains [] with spaces) %i[foo \[ \]] # bad (contains () with spaces) %i(foo \( \))
@example EnforcedStyle: brackets
# good [:foo, :bar, :baz] # bad %i[foo bar baz]
Constants
- ARRAY_MSG
- DELIMITERS
- PERCENT_MSG
- REDEFINABLE_OPERATORS
- SPECIAL_GVARS
Attributes
Public Instance Methods
Source
# File lib/rubocop/cop/style/symbol_array.rb, line 66 def on_array(node) if bracketed_array_of?(:sym, node) return if complex_content?(node) check_bracketed_array(node, 'i') elsif node.percent_literal?(:symbol) check_percent_array(node) end end
Private Instance Methods
Source
# File lib/rubocop/cop/style/symbol_array.rb, line 96 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
Source
# File lib/rubocop/cop/style/symbol_array.rb, line 78 def complex_content?(node) node.children.any? do |sym| return false if DELIMITERS.include?(sym.source) content = *sym content = content.map { |c| c.is_a?(AST::Node) ? c.source : c }.join content_without_delimiter_pairs = content.gsub(/(\[[^\s\[\]]*\])|(\([^\s\(\)]*\))/, '') content.include?(' ') || DELIMITERS.any? do |delimiter| content_without_delimiter_pairs.include?(delimiter) end end end
Source
# File lib/rubocop/cop/style/symbol_array.rb, line 92 def invalid_percent_array_contents?(node) complex_content?(node) end
Source
# File lib/rubocop/cop/style/symbol_array.rb, line 119 def symbol_without_quote?(string) # 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
Source
# File lib/rubocop/cop/style/symbol_array.rb, line 111 def to_symbol_literal(string) if symbol_without_quote?(string) ":#{string}" else ":#{to_string_literal(string)}" end end