Class: RuboCop::Cop::Style::SymbolArray
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::RuboCop::Cop::TargetRubyVersion ,
::RuboCop::Cop::AutoCorrector ,
::RuboCop::Cop::Base ,
::RuboCop::ExcludeLimit ,
NodePattern::Macros,
RuboCop::AST::Sexp
|
|
Instance Chain:
|
|
Inherits: |
RuboCop::Cop::Base
|
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.
Constant Summary
-
ARRAY_MSG =
# File 'lib/rubocop/cop/style/symbol_array.rb', line 51'Use %<prefer>s for an array of symbols.'
-
DELIMITERS =
# File 'lib/rubocop/cop/style/symbol_array.rb', line 52['[', ']', '(', ')'].freeze
-
PERCENT_MSG =
# File 'lib/rubocop/cop/style/symbol_array.rb', line 50'Use `%i` or `%I` for an array of symbols.'
-
REDEFINABLE_OPERATORS =
# File 'lib/rubocop/cop/style/symbol_array.rb', line 57%w( | ^ & <=> == === =~ > >= < <= << >> + - * / % ** ~ +@ -@ [] []= ` ! != !~ ).freeze
-
SPECIAL_GVARS =
# File 'lib/rubocop/cop/style/symbol_array.rb', line 53%w[ $! $" $$ $& $' $* $+ $, $/ $; $: $. $< $= $> $? $@ $\\ $_ $` $~ $0 $-0 $-F $-I $-K $-W $-a $-d $-i $-l $-p $-v $-w ].freeze
::RuboCop::Cop::Base
- Inherited
EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::ConfigurableEnforcedStyle
- Included
Class Attribute Summary
::RuboCop::Cop::AutoCorrector
- Extended
::RuboCop::Cop::Base
- Inherited
.gem_requirements, .lint?, | |
.support_autocorrect? | Returns if class supports autocorrect. |
.support_multiple_source? | Override if your cop should be called repeatedly for multiple investigations Between calls to |
Class Method Summary
::RuboCop::Cop::TargetRubyVersion
- Extended
maximum_target_ruby_version, minimum_target_ruby_version, required_maximum_ruby_version, required_minimum_ruby_version, support_target_ruby_version? |
::RuboCop::Cop::Base
- Inherited
.autocorrect_incompatible_with | List of cops that should not try to autocorrect at the same time as this cop. |
.badge | Naming. |
.callbacks_needed, .cop_name, .department, | |
.documentation_url | Returns a url to view this cops documentation online. |
.exclude_from_registry | Call for abstract Cop classes. |
.inherited, | |
.joining_forces | Override and return the Force class(es) you need to join. |
.match? | Returns true if the cop name or the cop namespace matches any of the given names. |
.new, | |
.requires_gem | Register a version requirement for the given gem name. |
.restrict_on_send |
::RuboCop::ExcludeLimit
- Extended
exclude_limit | Sets up a configuration option to have an exclude limit tracked. |
transform |
Instance Attribute Summary
::RuboCop::Cop::ConfigurableEnforcedStyle
- Included
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
- #on_array(node)
- #build_bracketed_array(node) private
- #complex_content?(node) ⇒ Boolean private
- #invalid_percent_array_contents?(node) ⇒ Boolean private
- #symbol_without_quote?(string) ⇒ Boolean private
- #to_symbol_literal(string) private
::RuboCop::Cop::PercentArray
- Included
#allowed_bracket_array?, #build_bracketed_array_with_appropriate_whitespace, #build_message_for_bracketed_array, #check_bracketed_array, #check_percent_array, #comments_in_array?, | |
#invalid_percent_array_contents? | Override to determine values that are invalid in a percent array. |
#invalid_percent_array_context? | Ruby does not allow percent arrays in an ambiguous block context. |
#whitespace_between | Provides whitespace between elements for building a bracketed array. |
#whitespace_leading | Provides leading whitespace for building a bracketed array. |
#whitespace_trailing | Provides trailing whitespace for building a bracketed array. |
::RuboCop::Cop::ConfigurableEnforcedStyle
- Included
::RuboCop::Cop::ArraySyntax
- Included
::RuboCop::Cop::ArrayMinSize
- Included
#array_style_detected | rubocop:todo Metrics/AbcSize. |
#below_array_length?, #largest_brackets_size, #min_size_config, #smallest_percent_size |
::RuboCop::Cop::Base
- Inherited
#add_global_offense | Adds an offense that has no particular location. |
#add_offense | Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense. |
#begin_investigation | Called before any investigation. |
#callbacks_needed, | |
#cop_config | Configuration Helpers. |
#cop_name, #excluded_file?, | |
#external_dependency_checksum | This method should be overridden when a cop’s behavior depends on state that lives outside of these locations: |
#inspect, | |
#message | Gets called if no message is specified when calling |
#name | Alias for Base#cop_name. |
#offenses, | |
#on_investigation_end | Called after all on_… |
#on_new_investigation | Called before all on_… |
#on_other_file | Called instead of all on_… |
#parse | There should be very limited reasons for a Cop to do it’s own parsing. |
#parser_engine, | |
#ready | Called between investigations. |
#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction, | |
#callback_argument | Reserved for Cop::Cop. |
#complete_investigation | Called to complete an investigation. |
#correct, #current_corrector, | |
#current_offense_locations | Reserved for Commissioner: |
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range, | |
#reset_investigation | Actually private methods. |
#use_corrector |
::RuboCop::Cop::AutocorrectLogic
- Included
#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #max_line_length, | |
#range_by_lines | Expand the given range to include all of any lines it covers. |
#range_of_first_line, #range_overlaps_offense?, #string_continuation, #string_continuation?, #surrounding_heredoc, #surrounding_percent_array |
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Class Attribute Details
.largest_brackets (rw)
[ GitHub ]# File 'lib/rubocop/cop/style/symbol_array.rb', line 63
attr_accessor :largest_brackets
Instance Method Details
#build_bracketed_array(node) (private)
[ GitHub ]# 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
#complex_content?(node) ⇒ Boolean
(private)
# 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
#invalid_percent_array_contents?(node) ⇒ Boolean
(private)
# File 'lib/rubocop/cop/style/symbol_array.rb', line 92
def invalid_percent_array_contents?(node) complex_content?(node) end
#on_array(node)
[ GitHub ]# 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
#symbol_without_quote?(string) ⇒ Boolean
(private)
# 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
#to_symbol_literal(string) (private)
[ GitHub ]# 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