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

Inherits:
Cop
  • Object
show all
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.'.freeze

Constants included from Util

Util::ASGN_NODES, 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

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, 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_rails_version, #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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/rubocop/cop/style/or_assignment.rb', line 61

def autocorrect(node)
  if ternary_assignment?(node)
    variable, default = take_variable_and_default_from_ternary(node)
  else
    variable, default = take_variable_and_default_from_unless(node)
  end

  lambda do |corrector|
    corrector.replace(node.source_range,
                      "#{variable} ||= #{default.source}")
  end
end

#on_if(node) ⇒ Object 



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

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

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



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

def on_lvasgn(node)
  return unless ternary_assignment?(node)
  add_offense(node)
end