123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Lint::LiteralAssignmentInCondition

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/lint/literal_assignment_in_condition.rb

Overview

Checks for literal assignments in the conditions of if, while, and until. It emulates the following Ruby warning:

$ ruby -we 'if x = true; end'
-e:1: warning: found `= literal' in conditional, should be ==

As a lint cop, it cannot be determined if == is appropriate as intended, therefore this cop does not provide autocorrection.

Examples:

# bad
if x = 42
  do_something
end

# good
if x == 42
  do_something
end

# good
if x = y
  do_something
end

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::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.
.builtin?

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

Cops (other than builtin) are encouraged to implement this.
.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::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #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

::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_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, #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, #max_line_length,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #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

#all_literals?(node) ⇒ Boolean (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/lint/literal_assignment_in_condition.rb', line 62



def all_literals?(node)
  case node.type
  when :dstr, :xstr
    false
  when :array
    node.values.all? { |value| all_literals?(value) }
  when :hash
    (node.values + node.keys).all? { |item| all_literals?(item) }
  else
    node.respond_to?(:literal?) && node.literal?
  end
end


  








  

    #offense_range(asgn_node, rhs)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/literal_assignment_in_condition.rb', line 79



def offense_range(asgn_node, rhs)
  asgn_node.loc.operator.join(rhs.source_range.end)
end


  








  

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

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/literal_assignment_in_condition.rb', line 39



def on_if(node)
  traverse_node(node.condition) do |asgn_node|
    next unless asgn_node.loc.operator

    rhs = asgn_node.to_a.last
    next if !all_literals?(rhs) || parallel_assignment_with_splat_operator?(rhs)

    range = offense_range(asgn_node, rhs)

    add_offense(range, message: format(MSG, literal: rhs.source))
  end
end


  








  

    #on_until(node)  
  



  

    


Alias for #on_if.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/literal_assignment_in_condition.rb', line 52



alias on_until on_if


  








  

    #on_while(node)  
  



  

    


Alias for #on_if.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/literal_assignment_in_condition.rb', line 51



alias on_while on_if


  








  

    #parallel_assignment_with_splat_operator?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/literal_assignment_in_condition.rb', line 75



def parallel_assignment_with_splat_operator?(node)
  node.array_type? && node.values.first&.splat_type?
end


  








  

    #traverse_node(node) {|node| ... }  (private)
  



  

    
  





  
Yields:


    
  
  • 
    (node)
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/literal_assignment_in_condition.rb', line 56



def traverse_node(node, &block)
  yield node if AST::Node::EQUALS_ASSIGNMENTS.include?(node.type)

  node.each_child_node { |child| traverse_node(child, &block) }
end