Class: RuboCop::Cop::Style::OrAssignment

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/style/or_assignment.rb

Overview

This cop checks for potential usage of the `||=` operator.

Examples:

# bad
name = name ? name : 'Bozhidar'

# bad
name = if name
         name
       else
         'Bozhidar'
       end

# bad
unless name
  name = 'Bozhidar'
end

# bad
name = 'Bozhidar' unless name

# good - set name to 'Bozhidar', only if it's nil or false
name ||= 'Bozhidar'

Constant Summary collapse

MSG =
'Use the double pipe equals operator `||=` instead.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_if(node) ⇒ Object


51
52
53
54
55
# File 'lib/rubocop/cop/style/or_assignment.rb', line 51

def on_if(node)
  return unless unless_assignment?(node)

  add_offense(node) { |corrector| autocorrect(corrector, node) }
end

#on_lvasgn(node) ⇒ Object Also known as: on_ivasgn, on_cvasgn, on_gvasgn


57
58
59
60
61
62
# File 'lib/rubocop/cop/style/or_assignment.rb', line 57

def on_lvasgn(node)
  return unless (else_branch = ternary_assignment?(node))
  return if else_branch.if_type?

  add_offense(node) { |corrector| autocorrect(corrector, node) }
end

#ternary_assignment?(node) ⇒ Object


35
36
37
38
39
40
41
# File 'lib/rubocop/cop/style/or_assignment.rb', line 35

def_node_matcher :ternary_assignment?, <<~PATTERN
  ({lvasgn ivasgn cvasgn gvasgn} _var
    (if
      ({lvar ivar cvar gvar} _var)
      ({lvar ivar cvar gvar} _var)
      $_))
PATTERN

#unless_assignment?(node) ⇒ Object


44
45
46
47
48
49
# File 'lib/rubocop/cop/style/or_assignment.rb', line 44

def_node_matcher :unless_assignment?, <<~PATTERN
  (if
    ({lvar ivar cvar gvar} _var) nil?
    ({lvasgn ivasgn cvasgn gvasgn} _var
      _))
PATTERN