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

Inherits:
Cop
  • Object
show all
Includes:
ArrayMinSize, ArraySyntax, ConfigurableEnforcedStyle, PercentArray, PercentLiteral
Defined in:
lib/rubocop/cop/style/symbol_array.rb

Overview

This cop can check 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.

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]

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.'.freeze
ARRAY_MSG = 
'Use `[]` for an array of symbols.'.freeze

Constants included from PercentLiteral

PercentLiteral::PERCENT_LITERAL_TYPES

Constants included from Util

Util::ASGN_NODES, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Class Attribute Summary collapse

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Class Attribute Details

.largest_brackets ⇒ Object

Returns the value of attribute largest_brackets.



41
42
43
 
# File 'lib/rubocop/cop/style/symbol_array.rb', line 41

def largest_brackets
  @largest_brackets
end

Instance Method Details

#autocorrect(node) ⇒ Object 



54
55
56
57
58
59
60
 
# File 'lib/rubocop/cop/style/symbol_array.rb', line 54

def autocorrect(node)
  if style == :percent
    correct_percent(node, 'i')
  else
    correct_bracketed(node)
  end
end

#on_array(node) ⇒ Object 



44
45
46
47
48
49
50
51
52
 
# File 'lib/rubocop/cop/style/symbol_array.rb', line 44

def on_array(node)
  if bracketed_array_of?(:sym, node)
    return if symbols_contain_spaces?(node)

    check_bracketed_array(node)
  elsif node.percent_literal?(:symbol)
    check_percent_array(node)
  end
end