Class: RuboCop::Cop::Lint::AssignmentInCondition

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Lint::AssignmentInCondition

Includes:

SafeAssignment

Defined in:

lib/rubocop/cop/lint/assignment_in_condition.rb

Overview

This cop checks for assignments in the conditions of if/while/until.

‘AllowSafeAssignment` option for safe assignment. By safe assignment we mean putting parentheses around an assignment to indicate “I know I’m using an assignment as a condition. It’s not a mistake.”

Examples:

# bad
if some_var = true
  do_something
end

# good
if some_var == true
  do_something
end

AllowSafeAssignment: true (default)

# good
if (some_var = true)
  do_something
end

AllowSafeAssignment: false

# bad
if (some_var = true)
  do_something
end

Constant Summary

MSG_WITH_SAFE_ASSIGNMENT_ALLOWED =

'Use `==` if you meant to do a comparison or wrap the expression ' \
'in parentheses to indicate you meant to assign in a ' \
'condition.'

MSG_WITHOUT_SAFE_ASSIGNMENT_ALLOWED =

'Use `==` if you meant to do a comparison or move the assignment ' \
'up out of the condition.'

ASGN_TYPES =

[:begin, *AST::Node::EQUALS_ASSIGNMENTS, :send].freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #on_if(node) ⇒ Object (also: #on_while, #on_until)

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

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, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #safe_autocorrect?, #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, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#on_if(node) ⇒ Object Also known as: on_while, on_until

# File 'lib/rubocop/cop/lint/assignment_in_condition.rb', line 49

def on_if(node)
  return if node.condition.block_type?

  traverse_node(node.condition, ASGN_TYPES) do |asgn_node|
    next :skip_children if skip_children?(asgn_node)
    next if allowed_construct?(asgn_node)

    add_offense(asgn_node, location: :operator)
  end
end