Class: RuboCop::Cop::Lint::AmbiguousOperator

Inherits:
Cop
  • Object
show all
Includes:
ParserDiagnostic
Defined in:
lib/rubocop/cop/lint/ambiguous_operator.rb

Overview

This cop checks for ambiguous operators in the first argument of a method invocation without parentheses.

Examples:

array = [1, 2, 3]

# The `*` is interpreted as a splat operator but it could possibly be
# a `*` method invocation (i.e. `do_something.*(array)`).
do_something *array

# With parentheses, there's no ambiguity.
do_something(*array)

Constant Summary collapse

AMBIGUITIES =
{
  '+'  => { actual: 'positive number', possible: 'addition' },
  '-'  => { actual: 'negative number', possible: 'subtraction' },
  '*'  => { actual: 'splat',           possible: 'multiplication' },
  '&'  => { actual: 'block',           possible: 'binary AND' },
  '**' => { actual: 'keyword splat',   possible: 'exponent' }
}.each do |key, hash|
  hash[:operator] = key
end
MSG_FORMAT =
'Ambiguous %{actual} operator. Parenthesize the method ' \
"arguments if it's surely a %{actual} operator, or add " \
'a whitespace to the right of the `%{operator}` if it ' \
'should be a %{possible}.'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Method Summary

Methods included from ParserDiagnostic

#investigate

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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