Class: RuboCop::Cop::Style::SymbolArray

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

Overview

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.

Examples:

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 \( \))

EnforcedStyle: brackets

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

# bad
%i[foo bar baz]

Constant Summary collapse

PERCENT_MSG = 
'Use `%i` or `%I` for an array of symbols.'
ARRAY_MSG = 
'Use %<prefer>s for an array of symbols.'
DELIMITERS = 
['[', ']', '(', ')'].freeze
SPECIAL_GVARS = 
%w[
  $! $" $$ $& $' $* $+ $, $/ $; $: $. $< $= $> $? $@ $\\ $_ $` $~ $0
  $-0 $-F $-I $-K $-W $-a $-d $-i $-l $-p $-v $-w
].freeze
REDEFINABLE_OPERATORS = 
%w(
  | ^ & <=> == === =~ > >= < <= << >>
  + - * / % ** ~ +@ -@ [] []= ` ! != !~
).freeze

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 TargetRubyVersion

maximum_target_ruby_version, minimum_target_ruby_version, required_maximum_ruby_version, required_minimum_ruby_version, support_target_ruby_version?

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_new_investigation, #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.



63
64
65
 
# File 'lib/rubocop/cop/style/symbol_array.rb', line 63

def largest_brackets
  @largest_brackets
end

Instance Method Details

#on_array(node) ⇒ Object 



66
67
68
69
70
71
72
73
74
 
# 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