123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Lint::ParenthesesAsGroupedExpression

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/lint/parentheses_as_grouped_expression.rb

Overview

Checks for space between the name of a called method and a left parenthesis.

Examples:

# bad
do_something (foo)

# good
do_something(foo)
do_something (2 + 3) * 4
do_something (foo * bar).baz

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

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

#chained_calls?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb', line 61

def chained_calls?(node)
  first_argument = node.first_argument
  first_argument.call_type? && (node.children.last&.children&.count || 0) > 1
end

#first_argument_block_type?(first_arg) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb', line 49

def first_argument_block_type?(first_arg)
  first_arg.block_type? || first_arg.numblock_type?
end

#first_argument_starts_with_left_parenthesis?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb', line 57

def first_argument_starts_with_left_parenthesis?(node)
  node.first_argument.source.start_with?('(')
end

#on_csend(node)

Alias for #on_send.

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb', line 35

alias on_csend on_send

#on_send(node) Also known as: #on_csend

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb', line 24

def on_send(node)
  return if valid_context?(node)

  space_length = spaces_before_left_parenthesis(node)
  return unless space_length.positive?

  range = space_range(node.first_argument.source_range, space_length)
  message = format(MSG, argument: node.first_argument.source)

  add_offense(range, message: message) { |corrector| corrector.remove(range) }
end

#space_range(expr, space_length) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb', line 86

def space_range(expr, space_length)
  range_between(expr.begin_pos - space_length, expr.begin_pos)
end

#spaces_before_left_parenthesis(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb', line 70

def spaces_before_left_parenthesis(node)
  receiver = node.receiver
  receiver_length = if receiver
                      receiver.source.length
                    else
                      0
                    end
  without_receiver = node.source[receiver_length..]

  # Escape question mark if any.
  method_regexp = Regexp.escape(node.method_name)

  match = without_receiver.match(/^\s*&?\.?\s*#{method_regexp}(\s+)\(/)
  match ? match.captures[0].length : 0
end

#ternary_expression?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb', line 66

def ternary_expression?(node)
  node.if_type? && node.ternary?
end

#valid_context?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb', line 39

def valid_context?(node)
  unless node.arguments.one? && first_argument_starts_with_left_parenthesis?(node)
    return true
  end
  return true if first_argument_block_type?(node.first_argument)

  node.operator_method? || node.setter_method? || chained_calls?(node) ||
    valid_first_argument?(node.first_argument)
end

#valid_first_argument?(first_arg) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/parentheses_as_grouped_expression.rb', line 53

def valid_first_argument?(first_arg)
  first_arg.operator_keyword? || first_arg.hash_type? || ternary_expression?(first_arg)
end