123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::WordArray

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
self, ::RuboCop::Cop::PercentArray, ::RuboCop::Cop::ConfigurableEnforcedStyle, ::RuboCop::Cop::ArraySyntax, ::RuboCop::Cop::ArrayMinSize, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/word_array.rb

Overview

Checks for array literals made up of word-like strings, that are not using the %w() syntax.

Alternatively, it can check for uses of the %w() syntax, in projects which do not want to include that syntax.

Note
 When using the percent style, %w() arrays containing a space will be registered as offenses.

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
%w[foo bar baz]

# bad
['foo', 'bar', 'baz']

# bad (contains spaces)
%w[foo\ bar baz\ quux]

# bad
[
  ['one', 'One'],
  ['two', 'Two']
]

# good
[
  %w[one One],
  %w[two Two]
]

# good (2d array containing spaces)
[
  ['one', 'One'],
  ['two', 'Two'],
  ['forty two', 'Forty Two']
]

EnforcedStyle: brackets

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

# bad
%w[foo bar baz]

# good (contains spaces)
['foo bar', 'baz quux']

# good
[
  ['one', 'One'],
  ['two', 'Two']
]

# bad
[
  %w[one One],
  %w[two Two]
]

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

SYMBOL_TO_STRING_CACHE

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

support_autocorrect?

::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 #on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::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

#detected_style, #detected_style=, #no_acceptable_style?, #style_configured?

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Instance Method Summary

::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

#alternative_style, #alternative_styles, #ambiguous_style_detected,
#conflicting_styles_detected

Alias for ConfigurableEnforcedStyle#no_acceptable_style!.
#correct_style_detected, #no_acceptable_style!, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected,
#unrecognized_style_detected

Alias for ConfigurableEnforcedStyle#no_acceptable_style!.

::RuboCop::Cop::ArraySyntax - Included

#bracketed_array_of?

::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 add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.
#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

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Class Attribute Details

.largest_brackets (rw)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/word_array.rb', line 82



attr_accessor :largest_brackets


  







Instance Method Details



  

    #build_bracketed_array(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/word_array.rb', line 138



def build_bracketed_array(node)
  return '[]' if node.children.empty?

  words = node.children.map do |word|
    if word.dstr_type?
      string_literal = to_string_literal(word.source)

      trim_string_interpolation_escape_character(string_literal)
    else
      to_string_literal(word.children[0])
    end
  end
  build_bracketed_array_with_appropriate_whitespace(elements: words, node: node)
end


  








  

    #complex_content?(strings, complex_regex: word_regex)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/word_array.rb', line 118



def complex_content?(strings, complex_regex: word_regex)
  strings.any? do |s|
    next unless s.str_content

    string = s.str_content.dup.force_encoding(::Encoding::UTF_8)
    !string.valid_encoding? ||
      (complex_regex && !complex_regex.match?(string)) ||
      string.include?(' ')
  end
end


  








  

    #invalid_percent_array_contents?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/word_array.rb', line 129



def invalid_percent_array_contents?(node)
  # Disallow %w() arrays that contain invalid encoding or spaces
  complex_content?(node.values, complex_regex: false)
end


  








  

    #matrix_of_complex_content?(array)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/word_array.rb', line 113



def matrix_of_complex_content?(array)
  array.values.all?(&:array_type?) &&
    array.values.any? { |subarray| complex_content?(subarray.values) }
end


  








  

    #on_array(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/word_array.rb', line 94



def on_array(node)
  if bracketed_array_of?(:str, node)
    return if complex_content?(node.values)
    return if within_matrix_of_complex_content?(node)

    check_bracketed_array(node, 'w')
  elsif node.percent_literal?(:string)
    check_percent_array(node)
  end
end


  








  

    #on_new_investigation  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/word_array.rb', line 85



def on_new_investigation
  super

  # Prevent O(n2) checks (checking the entire matrix once for each child array) by caching
  @matrix_of_complex_content_cache = Hash.new do |cache, node|
    cache[node] = matrix_of_complex_content?(node)
  end
end


  








  

    #within_matrix_of_complex_content?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/word_array.rb', line 107



def within_matrix_of_complex_content?(node)
  return false unless (parent = node.parent)

  parent.array_type? && @matrix_of_complex_content_cache[parent]
end


  








  

    #word_regex   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/word_array.rb', line 134



def word_regex
  Regexp.new(cop_config['WordRegex'])
end