Class: RuboCop::Cop::Style::CaseEquality

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

Overview

If ‘AllowOnSelfClass` option is enabled, the cop will ignore violations when the receiver of the case equality operator is `self.class`. Note intermediate variables are not accepted.

Examples:

# bad
(1..100) === 7
/something/ === some_string

# good
something.is_a?(Array)
(1..100).include?(7)
/something/.match?(some_string)

AllowOnConstant: false (default)

# bad
Array === something

AllowOnConstant: true

# good
Array === something

AllowOnSelfClass: false (default)

# bad
self.class === something

AllowOnSelfClass: true

# good
self.class === something

Constant Summary collapse

MSG = 
'Avoid the use of the case equality operator `===`.'
RESTRICT_ON_SEND = 
%i[===].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, 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?, #autocorrect_with_disable_uncorrectable?, #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

#case_equality?(node) ⇒ Object 



47
 
# File 'lib/rubocop/cop/style/case_equality.rb', line 47

def_node_matcher :case_equality?, '(send $#offending_receiver? :=== $_)'

#on_send(node) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/rubocop/cop/style/case_equality.rb', line 52

def on_send(node)
  case_equality?(node) do |lhs, rhs|
    return if lhs.const_type? && !lhs.module_name?

    add_offense(node.loc.selector) do |corrector|
      replacement = replacement(lhs, rhs)
      corrector.replace(node, replacement) if replacement
    end
  end
end

#self_class?(node) ⇒ Object 



50
 
# File 'lib/rubocop/cop/style/case_equality.rb', line 50

def_node_matcher :self_class?, '(send (self) :class)'