class RuboCop::Cop::Style::AndOr

This cop 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.

@example EnforcedStyle: always (default)

# bad
foo.save and return

# bad
if foo and bar
end

# good
foo.save && return

# good
if foo && bar
end

@example EnforcedStyle: conditionals

# bad
if foo and bar
end

# good
foo.save && return

# good
foo.save and return

# good
if foo && bar
end

Constants

MSG

Public Instance Methods

autocorrect(node) click to toggle source
# File lib/rubocop/cop/style/and_or.rb, line 58
def autocorrect(node)
  lambda do |corrector|
    node.each_child_node do |expr|
      if expr.send_type?
        correct_send(expr, corrector)
      elsif expr.return_type?
        correct_other(expr, corrector)
      elsif expr.assignment?
        correct_other(expr, corrector)
      end
    end

    corrector.replace(node.loc.operator, node.alternate_operator)
  end
end
on_and(node) click to toggle source
# File lib/rubocop/cop/style/and_or.rb, line 45
def on_and(node)
  process_logical_operator(node) if style == :always
end
Also aliased as: on_or
on_if(node) click to toggle source
# File lib/rubocop/cop/style/and_or.rb, line 50
def on_if(node)
  on_conditionals(node) if style == :conditionals
end
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

Private Instance Methods

correct_not(node, receiver, corrector) click to toggle source

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

# File lib/rubocop/cop/style/and_or.rb, line 112
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) click to toggle source
# File lib/rubocop/cop/style/and_or.rb, line 124
def correct_other(node, corrector)
  return if node.source_range.begin.is?('(')

  corrector.insert_before(node.source_range, '(')
  corrector.insert_after(node.source_range, ')')
end
correct_send(node, corrector) click to toggle source
# File lib/rubocop/cop/style/and_or.rb, line 92
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)

  corrector.replace(whitespace_before_arg(node), '(')
  corrector.insert_after(node.last_argument.source_range, ')')
end
correct_setter(node, corrector) click to toggle source
# File lib/rubocop/cop/style/and_or.rb, line 103
def correct_setter(node, corrector)
  corrector.insert_before(node.receiver.source_range, '(')
  corrector.insert_after(node.last_argument.source_range, ')')
end
correctable_send?(node) click to toggle source
# File lib/rubocop/cop/style/and_or.rb, line 131
def correctable_send?(node)
  !node.parenthesized? && node.arguments? && !node.method?(:[])
end
message(node) click to toggle source
# File lib/rubocop/cop/style/and_or.rb, line 88
def message(node)
  format(MSG, prefer: node.alternate_operator, current: node.operator)
end
on_conditionals(node) click to toggle source
# File lib/rubocop/cop/style/and_or.rb, line 76
def on_conditionals(node)
  node.condition.each_node(*AST::Node::OPERATOR_KEYWORDS) do |operator|
    process_logical_operator(operator)
  end
end
process_logical_operator(node) click to toggle source
# File lib/rubocop/cop/style/and_or.rb, line 82
def process_logical_operator(node)
  return if node.logical_operator?

  add_offense(node, location: :operator)
end
whitespace_before_arg(node) click to toggle source
# File lib/rubocop/cop/style/and_or.rb, line 135
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 node.source =~ /\?\S/
  range_between(begin_paren, end_paren)
end