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:


# bad

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

# good

# With parentheses, there's no ambiguity.
do_something(*some_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}.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, 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, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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