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

Inherits:
Cop
  • Object
show all
Includes:
ArraySyntax, ConfigurableEnforcedStyle
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, perhaps because they support a version of Ruby lower than 2.0.

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 Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ArraySyntax

#bracketed_array_of?, #square_brackets?

Methods included from ConfigurableEnforcedStyle

#alternative_style, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#on_array(node) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/rubocop/cop/style/symbol_array.rb', line 20

def on_array(node)
  if bracketed_array_of?(:sym, node)
    return if comments_in_array?(node)
    return if symbols_contain_spaces?(node)
    style_detected(:brackets)
    add_offense(node, :expression, PERCENT_MSG) if style == :percent
  elsif node.loc.begin && node.loc.begin.source =~ /\A%[iI]/
    style_detected(:percent)
    add_offense(node, :expression, ARRAY_MSG) if style == :brackets
  end
end

#validate_config ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/rubocop/cop/style/symbol_array.rb', line 32

def validate_config
  if style == :percent && target_ruby_version < 2.0
    raise ValidationError, 'The default `percent` style for the ' \
                          '`Style/SymbolArray` cop is only compatible' \
                          ' with Ruby 2.0 and up, but the target Ruby' \
                          " version for your project is 1.9.\nPlease " \
                          'either disable this cop, configure it to ' \
                          'use `array` style, or adjust the ' \
                          '`TargetRubyVersion` parameter in your ' \
                          'configuration.'
  end
end