Class: RuboCop::Cop::Style::AndOr

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: self, `::RuboCop::Cop::RangeHelp`, `::RuboCop::Cop::ConfigurableEnforcedStyle`, `::RuboCop::Cop::Base`, `::RuboCop::Cop::AutocorrectLogic`, `::RuboCop::Cop::IgnoredNode`, `::RuboCop::Util`, RuboCop::AST::Sexp
Inherits:	RuboCop::Cop::Base Object RuboCop::Cop::Base RuboCop::Cop::Style::AndOr
Defined in:	lib/rubocop/cop/style/and_or.rb

Overview

Checks for uses of and and or, and suggests using && and {||} instead. It can be configured to check only in conditions or in all contexts.

Examples:

EnforcedStyle: conditionals (default)

# bad
if foo and bar
end

# good
foo.save && return

# good
foo.save and return

# good
if foo && bar
end

EnforcedStyle: always

# bad
foo.save and return

# bad
if foo and bar
end

# good
foo.save && return

# good
if foo && bar
end

Cop Safety Information:

Autocorrection is unsafe because there is a different operator precedence between logical operators (&& and {||}) and semantic operators (and and or), and that might change the behavior.

Constant Summary

MSG =
# File 'lib/rubocop/cop/style/and_or.rb', line 49
```
'Use `%<prefer>s` instead of `%<current>s`.'
```

Class Attribute Summary

`::RuboCop::Cop::AutoCorrector` - Extended

support_autocorrect?

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

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

#detected_style, #detected_style=, #no_acceptable_style?, #style_configured?

`::RuboCop::Cop::Base` - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

`::RuboCop::Cop::AutocorrectLogic` - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Instance Method Summary

#on_and(node) (also: #on_or)
#on_if(node) (also: #on_while, #on_while_post, #on_until, #on_until_post)
#on_or(node)

Alias for #on_and.
#on_until(node)

Alias for #on_if.
#on_until_post(node)

Alias for #on_if.
#on_while(node)

Alias for #on_if.
#on_while_post(node)

Alias for #on_if.
#correct_not(node, receiver, corrector) private

! is a special case: 'x and !obj.method arg' can be autocorrected if we recurse down a level and add parens to 'obj.method arg' however, 'not x' also parses as (send x :!).
#correct_other(node, corrector) private
#correct_send(node, corrector) private
#correct_setter(node, corrector) private
#correctable_send?(node) ⇒ Boolean private
#keep_operator_precedence(corrector, node) private
#message(node) private
#on_conditionals(node) private
#process_logical_operator(node) private
#whitespace_before_arg(node) private

`::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::ConfigurableEnforcedStyle` - Included

#alternative_style, #alternative_styles, #ambiguous_style_detected,
#conflicting_styles_detected	Alias for ConfigurableEnforcedStyle#no_acceptable_style!.
#correct_style_detected, #no_acceptable_style!, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected,
#unrecognized_style_detected	Alias for ConfigurableEnforcedStyle#no_acceptable_style!.

`::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_gem_version	Returns a gems locked versions (i.e.
#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

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #heredoc_range, #max_line_length, #multiline_ranges, #multiline_string?,
#range_by_lines	Expand the given range to include all of any lines it covers.
#range_of_first_line, #range_overlaps_offense?, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

`::RuboCop::Cop::IgnoredNode` - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Instance Method Details

#correct_not(node, receiver, corrector) (private)

! is a special case: 'x and !obj.method arg' can be autocorrected if we recurse down a level and add parens to 'obj.method arg' however, 'not x' also parses as (send x :!)

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 117


def correct_not(node, receiver, corrector)
  if node.prefix_bang?
    return unless receiver.send_type?

    correct_send(receiver, corrector)
  elsif node.prefix_not?
    correct_other(node, corrector)
  else
    raise 'unrecognized unary negation operator'
  end
end

#correct_other(node, corrector) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 129


def correct_other(node, corrector)
  return if node.source_range.begin.is?('(')

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

#correct_send(node, corrector) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 95


def correct_send(node, corrector)
  return correct_not(node, node.receiver, corrector) if node.method?(:!)
  return correct_setter(node, corrector) if node.setter_method?
  return correct_other(node, corrector) if node.comparison_method?

  return unless correctable_send?(node)

  whitespace_before_arg_range = whitespace_before_arg(node)
  corrector.remove(whitespace_before_arg_range)
  corrector.insert_before(whitespace_before_arg_range, '(')
  corrector.insert_after(node.last_argument, ')')
end

#correct_setter(node, corrector) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 108


def correct_setter(node, corrector)
  corrector.insert_before(node.receiver, '(')
  corrector.insert_after(node.last_argument, ')')
end

#correctable_send?(node) ⇒ `Boolean` (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 143


def correctable_send?(node)
  !node.parenthesized? && node.arguments? && !node.method?(:[])
end

#keep_operator_precedence(corrector, node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 135


def keep_operator_precedence(corrector, node)
  if node.or_type? && node.parent&.and_type?
    corrector.wrap(node, '(', ')')
  elsif node.and_type? && node.rhs.or_type?
    corrector.wrap(node.rhs, '(', ')')
  end
end

#message(node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 91


def message(node)
  format(MSG, prefer: node.alternate_operator, current: node.operator)
end

#on_and(node) Also known as: #on_or

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 51


def on_and(node)
  process_logical_operator(node) if style == :always
end

#on_conditionals(node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 85


def on_conditionals(node)
  node.condition.each_node(*AST::Node::OPERATOR_KEYWORDS) do |operator|
    process_logical_operator(operator)
  end
end

#on_if(node) Also known as: #on_while, #on_while_post, #on_until, #on_until_post

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 56


def on_if(node)
  on_conditionals(node) if style == :conditionals
end

#on_or(node)

Alias for #on_and.

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 54


alias on_or on_and

#on_until(node)

Alias for #on_if.

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 61


alias on_until      on_if

#on_until_post(node)

Alias for #on_if.

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 62


alias on_until_post on_if

#on_while(node)

Alias for #on_if.

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 59


alias on_while      on_if

#on_while_post(node)

Alias for #on_if.

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 60


alias on_while_post on_if

#process_logical_operator(node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 66


def process_logical_operator(node)
  return if node.logical_operator?

  message = message(node)
  add_offense(node.loc.operator, message: message) do |corrector|
    node.each_child_node do |expr|
      if expr.send_type?
        correct_send(expr, corrector)
      elsif expr.return_type? || expr.assignment?
        correct_other(expr, corrector)
      end
    end

    corrector.replace(node.loc.operator, node.alternate_operator)

    keep_operator_precedence(corrector, node)
  end
end

#whitespace_before_arg(node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/and_or.rb', line 147


def whitespace_before_arg(node)
  begin_paren = node.loc.selector.end_pos
  end_paren = begin_paren
  # Increment position of parenthesis, unless message is a predicate
  # method followed by a non-whitespace char (e.g. is_a?String).
  end_paren += 1 unless /\?\S/.match?(node.source)
  range_between(begin_paren, end_paren)
end

Class: RuboCop::Cop::Style::AndOr

Overview

Constant Summary

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::RangeHelp - Included

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

Class Method Summary

::RuboCop::Cop::Base - Inherited

::RuboCop::ExcludeLimit - Extended

Instance Attribute Summary

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::AutocorrectLogic - Included

Instance Method Summary

::RuboCop::Cop::RangeHelp - Included

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

Instance Method Details

#correct_not(node, receiver, corrector) (private)

#correct_other(node, corrector) (private)

#correct_send(node, corrector) (private)

#correct_setter(node, corrector) (private)

#correctable_send?(node) ⇒ Boolean (private)

#keep_operator_precedence(corrector, node) (private)

#message(node) (private)

#on_and(node) Also known as: #on_or

#on_conditionals(node) (private)

#on_if(node) Also known as: #on_while, #on_while_post, #on_until, #on_until_post

#on_or(node)

#on_until(node)

#on_until_post(node)

#on_while(node)

#on_while_post(node)

#process_logical_operator(node) (private)

#whitespace_before_arg(node) (private)

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::RangeHelp` - Included

`::RuboCop::Cop::AutoCorrector` - Extended

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::ExcludeLimit` - Extended

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::AutocorrectLogic` - Included

`::RuboCop::Cop::RangeHelp` - Included

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::AutocorrectLogic` - Included

`::RuboCop::Cop::IgnoredNode` - Included

#correctable_send?(node) ⇒ `Boolean` (private)