123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Layout::SpaceInsideReferenceBrackets

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::ConfigurableEnforcedStyle, ::RuboCop::Cop::SurroundingSpace, ::RuboCop::Cop::RangeHelp, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/layout/space_inside_reference_brackets.rb

Overview

Checks that reference brackets have or don’t have surrounding space depending on configuration.

Examples:

EnforcedStyle: no_space (default)

# The `no_space` style enforces that reference brackets have
# no surrounding space.

# bad
hash[ :key ]
array[ index ]

# good
hash[:key]
array[index]

EnforcedStyle: space

# The `space` style enforces that reference brackets have
# surrounding space.

# bad
hash[:key]
array[index]

# good
hash[ :key ]
array[ index ]

EnforcedStyleForEmptyBrackets: no_space (default)

# The `no_space` EnforcedStyleForEmptyBrackets style enforces that
# empty reference brackets do not contain spaces.

# bad
foo[ ]
foo[     ]
foo[
]

# good
foo[]

EnforcedStyleForEmptyBrackets: space

# The `space` EnforcedStyleForEmptyBrackets style enforces that
# empty reference brackets contain exactly one space.

# bad
foo[]
foo[    ]
foo[
]

# good
foo[ ]

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

::RuboCop::Cop::SurroundingSpace - Included

NO_SPACE_COMMAND, SINGLE_SPACE_REGEXP, SPACE_COMMAND

::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.
.builtin?

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

Cops (other than builtin) are encouraged to implement this.
.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, #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::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::SurroundingSpace - Included

#empty_brackets?, #empty_offense, #empty_offenses, #extra_space?, #no_character_between?, #no_space_offenses, #offending_empty_no_space?, #offending_empty_space?, #on_new_investigation, #reposition, #side_space_range, #space_between?, #space_offense, #space_offenses

::RuboCop::Cop::RangeHelp - Included

#add_range, #column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.
#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

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

Instance Method Details

#autocorrect(corrector, node) (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/layout/space_inside_reference_brackets.rb', line 92



def autocorrect(corrector, node)
  tokens, left, right = reference_brackets(node)

  if empty_brackets?(left, right, tokens: tokens)
    SpaceCorrector.empty_corrections(processed_source, corrector, empty_config, left, right)
  elsif style == :no_space
    SpaceCorrector.remove_space(processed_source, corrector, left, right)
  else
    SpaceCorrector.add_space(processed_source, corrector, left, right)
  end
end


  








  

    #closing_bracket(tokens, opening_bracket)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/space_inside_reference_brackets.rb', line 121



def closing_bracket(tokens, opening_bracket)
  i = tokens.index(opening_bracket)
  inner_left_brackets_needing_closure = 0

  tokens[i..].each do |token|
    inner_left_brackets_needing_closure += 1 if token.left_bracket?
    inner_left_brackets_needing_closure -= 1 if token.right_bracket?
    return token if inner_left_brackets_needing_closure.zero? && token.right_bracket?
  end
end


  








  

    #empty_config   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/space_inside_reference_brackets.rb', line 137



def empty_config
  cop_config['EnforcedStyleForEmptyBrackets']
end


  








  

    #left_ref_bracket(node, tokens)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/space_inside_reference_brackets.rb', line 110



def left_ref_bracket(node, tokens)
  current_token = tokens.reverse.find(&:left_ref_bracket?)
  previous_token = previous_token(current_token)

  if node.method?(:[]=) || (previous_token && !previous_token.right_bracket?)
    tokens.find(&:left_ref_bracket?)
  else
    current_token
  end
end


  








  

    #on_send(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/space_inside_reference_brackets.rb', line 70



def on_send(node)
  tokens = processed_source.tokens_within(node)
  left_token = left_ref_bracket(node, tokens)
  return unless left_token

  right_token = closing_bracket(tokens, left_token)

  if empty_brackets?(left_token, right_token, tokens: tokens)
    return empty_offenses(node, left_token, right_token, EMPTY_MSG)
  end

  return if node.multiline?

  if style == :no_space
    no_space_offenses(node, left_token, right_token, MSG)
  else
    space_offenses(node, left_token, right_token, MSG)
  end
end


  








  

    #previous_token(current_token)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/space_inside_reference_brackets.rb', line 132



def previous_token(current_token)
  index = processed_source.tokens.index(current_token)
  index.nil? || index.zero? ? nil : processed_source.tokens[index - 1]
end


  








  

    #reference_brackets(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/layout/space_inside_reference_brackets.rb', line 104



def reference_brackets(node)
  tokens = processed_source.tokens_within(node)
  left = left_ref_bracket(node, tokens)
  [tokens, left, closing_bracket(tokens, left)]
end