123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Lint::AmbiguousOperatorPrecedence

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/ambiguous_operator_precedence.rb

Overview

Looks for expressions containing multiple binary operators where precedence is ambiguous due to lack of parentheses. For example, in 1 + 2 * 3, the multiplication will happen before the addition, but lexically it appears that the addition will happen first.

The cop does not consider unary operators (ie. !a or -b) or comparison operators (ie. a =~ b) because those are not ambiguous.

Note
Ranges are handled by Lint/AmbiguousRange.

Examples:

# bad
a + b * c
a || b && c
a ** b + c

# good (different precedence)
a + (b * c)
a || (b && c)
(a ** b) + c

# good (same precedence)
a + b + c
a * b / c % d

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

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

#autocorrect(corrector, node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/ambiguous_operator_precedence.rb', line 105

def autocorrect(corrector, node)
  corrector.wrap(node, '(', ')')
end

#greater_precedence?(node1, node2) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/ambiguous_operator_precedence.rb', line 89

def greater_precedence?(node1, node2)
  node1_precedence = precedence(node1)
  node2_precedence = precedence(node2)
  return false unless node1_precedence && node2_precedence

  node2_precedence > node1_precedence
end

#on_and(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/ambiguous_operator_precedence.rb', line 54

def on_and(node)
  return unless (parent = node.parent)

  return if parent.begin_type? # if the `and` is in a `begin`, it's parenthesized already
  return unless parent.or_type?

  add_offense(node) do |corrector|
    autocorrect(corrector, node)
  end
end

#on_new_investigation

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/ambiguous_operator_precedence.rb', line 47

def on_new_investigation
  # Cache the precedence of each node being investigated
  # so that we only need to calculate it once
  @node_precedences = {}
  super
end

#on_send(node)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/ambiguous_operator_precedence.rb', line 65

def on_send(node)
  return if node.parenthesized?

  return unless (parent = node.parent)
  return unless operator?(parent)
  return unless greater_precedence?(node, parent)

  add_offense(node) do |corrector|
    autocorrect(corrector, node)
  end
end

#operator?(node) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/ambiguous_operator_precedence.rb', line 85

def operator?(node)
  (node.send_type? && RESTRICT_ON_SEND.include?(node.method_name)) || node.operator_keyword?
end

#operator_name(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/ambiguous_operator_precedence.rb', line 97

def operator_name(node)
  if node.send_type?
    node.method_name
  else
    node.operator.to_sym
  end
end

#precedence(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/lint/ambiguous_operator_precedence.rb', line 79

def precedence(node)
  @node_precedences.fetch(node) do
    PRECEDENCE.index { |operators| operators.include?(operator_name(node)) }
  end
end