123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Layout::SpaceInsideParens

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:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/layout/space_inside_parens.rb

Overview

Checks for spaces inside ordinary round parentheses.

Examples:

EnforcedStyle: no_space (default)

# The `no_space` style enforces that parentheses do not have spaces.

# bad
f( 3)
g = (a + 3 )
f( )

# good
f(3)
g = (a + 3)
f()

EnforcedStyle: space

# The `space` style enforces that parentheses have a space at the
# beginning and end.
# Note: Empty parentheses should not have spaces.

# bad
f(3)
g = (a + 3)
y( )

# good
f( 3 )
g = ( a + 3 )
y()

EnforcedStyle: compact

# The `compact` style enforces that parentheses have a space at the
# beginning with the exception that successive parentheses are allowed.
# Note: Empty parentheses should not have spaces.

# bad
f(3)
g = (a + 3)
y( )
g( f( x ) )
g( f( x( 3 ) ), 5 )
g( ( ( 3 + 5 ) * f) ** x, 5 )

# good
f( 3 )
g = ( a + 3 )
y()
g( f( x ))
g( f( x( 3 )), 5 )
g((( 3 + 5 ) * f ) ** x, 5 )

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

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

Instance Method Summary

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::SurroundingSpace - Included

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

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#can_be_ignored?(token1, token2) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/space_inside_parens.rb', line 161

def can_be_ignored?(token1, token2)
  return true unless parens?(token1, token2)

  # Ignore empty parentheses.
  return true if range_between(token1.begin_pos, token2.end_pos).source == '()'

  # If the second token is a comment, that means that a line break
  # follows, and that the rules for space inside don't apply.
  return true if token2.comment?

  !same_line?(token1, token2) || token1.space_after?
end

#correct_extraneous_space(tokens) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/space_inside_parens.rb', line 99

def correct_extraneous_space(tokens)
  tokens.each_cons(2) do |token1, token2|
    next unless parens?(token1, token2)

    # If the second token is a comment, that means that a line break
    # follows, and that the rules for space inside don't apply.
    next if token2.comment?
    next unless same_line?(token1, token2) && token1.space_after?

    range = range_between(token1.end_pos, token2.begin_pos)
    add_offense(range) do |corrector|
      corrector.remove(range)
    end
  end
end

#correct_extraneous_space_between_consecutive_parens(token1, token2) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/space_inside_parens.rb', line 115

def correct_extraneous_space_between_consecutive_parens(token1, token2)
  return if range_between(token1.end_pos, token2.begin_pos).source != ' '

  range = range_between(token1.end_pos, token2.begin_pos)
  add_offense(range) do |corrector|
    corrector.remove(range)
  end
end

#correct_extraneous_space_in_empty_parens(token1, token2) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/space_inside_parens.rb', line 124

def correct_extraneous_space_in_empty_parens(token1, token2)
  return unless token1.left_parens? && token2.right_parens?

  return if range_between(token1.begin_pos, token2.end_pos).source == '()'

  range = range_between(token1.end_pos, token2.begin_pos)
  add_offense(range) do |corrector|
    corrector.remove(range)
  end
end

#correct_missing_space(token1, token2) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/space_inside_parens.rb', line 135

def correct_missing_space(token1, token2)
  return if can_be_ignored?(token1, token2)

  range = if token1.left_parens?
            range_between(token2.begin_pos, token2.begin_pos + 1)
          elsif token2.right_parens?
            range_between(token2.begin_pos, token2.end_pos)
          end

  add_offense(range, message: MSG_SPACE) do |corrector|
    corrector.insert_before(range, ' ')
  end
end

#left_parens?(token1, token2) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/space_inside_parens.rb', line 153

def left_parens?(token1, token2)
  token1.left_parens? && token2.left_parens?
end

#on_new_investigation

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/space_inside_parens.rb', line 66

def on_new_investigation
  tokens = processed_source.sorted_tokens

  case style
  when :space
    process_with_space_style(tokens)
  when :compact
    process_with_compact_style(tokens)
  else
    correct_extraneous_space(tokens)
  end
end

#parens?(token1, token2) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/space_inside_parens.rb', line 149

def parens?(token1, token2)
  token1.left_parens? || token2.right_parens?
end

#process_with_compact_style(tokens) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/space_inside_parens.rb', line 88

def process_with_compact_style(tokens)
  tokens.each_cons(2) do |token1, token2|
    correct_extraneous_space_in_empty_parens(token1, token2)
    if !left_parens?(token1, token2) && !right_parens?(token1, token2)
      correct_missing_space(token1, token2)
    else
      correct_extraneous_space_between_consecutive_parens(token1, token2)
    end
  end
end

#process_with_space_style(tokens) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/space_inside_parens.rb', line 81

def process_with_space_style(tokens)
  tokens.each_cons(2) do |token1, token2|
    correct_extraneous_space_in_empty_parens(token1, token2)
    correct_missing_space(token1, token2)
  end
end

#right_parens?(token1, token2) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/layout/space_inside_parens.rb', line 157

def right_parens?(token1, token2)
  token1.right_parens? && token2.right_parens?
end