Add new Style/ClassEqualityComparison cop

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### New features
 
 * [#8796](https://github.com/rubocop-hq/rubocop/pull/8796): Add new `Lint/HashCompareByIdentity` cop. ([@fatkodima][])
+* [#8833](https://github.com/rubocop-hq/rubocop/pull/8833): Add new `Style/ClassEqualityComparison` cop. ([@fatkodima][])
 * [#8668](https://github.com/rubocop-hq/rubocop/pull/8668): Add new `Lint/RedundantSafeNavigation` cop. ([@fatkodima][])
 * [#8842](https://github.com/rubocop-hq/rubocop/issues/8842): Add notification about cache being used to debug mode. ([@hatkyinc2][])
 * [#8822](https://github.com/rubocop-hq/rubocop/pull/8822): Make `Style/RedundantBegin` aware of `begin` without `rescue` or `ensure`. ([@koic][])

config/default.yml

@@ -2724,6 +2724,16 @@ Style/ClassCheck:
     - is_a?
     - kind_of?
 
+Style/ClassEqualityComparison:
+  Description: 'Enforces the use of `Object#instance_of?` instead of class comparison for equality.'
+  StyleGuide: '#instance-of-vs-class-comparison'
+  Enabled: pending
+  VersionAdded: '0.93'
+  IgnoredMethods:
+    - ==
+    - equal?
+    - eql?
+
 Style/ClassMethods:
   Description: 'Use self when defining module/class methods.'
   StyleGuide: '#def-self-class-methods'

docs/modules/ROOT/pages/cops.adoc

@@ -351,6 +351,7 @@ In the following section you find all available cops:
 * xref:cops_style.adoc#stylecharacterliteral[Style/CharacterLiteral]
 * xref:cops_style.adoc#styleclassandmodulechildren[Style/ClassAndModuleChildren]
 * xref:cops_style.adoc#styleclasscheck[Style/ClassCheck]
+* xref:cops_style.adoc#styleclassequalitycomparison[Style/ClassEqualityComparison]
 * xref:cops_style.adoc#styleclassmethods[Style/ClassMethods]
 * xref:cops_style.adoc#styleclassmethodsdefinitions[Style/ClassMethodsDefinitions]
 * xref:cops_style.adoc#styleclassvars[Style/ClassVars]

docs/modules/ROOT/pages/cops_style.adoc

@@ -1052,6 +1052,49 @@ var.kind_of?(String)
 
 * https://rubystyle.guide#is-a-vs-kind-of
 
+== Style/ClassEqualityComparison
+
+|===
+| Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChanged
+
+| Pending
+| Yes
+| Yes
+| 0.93
+| -
+|===
+
+This cop enforces the use of `Object#instance_of?` instead of class comparison
+for equality.
+
+=== Examples
+
+[source,ruby]
+----
+# bad
+var.class == Date
+var.class.equal?(Date)
+var.class.eql?(Date)
+var.class.name == 'Date'
+
+# good
+var.instance_of?(Date)
+----
+
+=== Configurable attributes
+
+|===
+| Name | Default value | Configurable values
+
+| IgnoredMethods
+| `==`, `equal?`, `eql?`
+| Array
+|===
+
+=== References
+
+* https://rubystyle.guide#instance-of-vs-class-comparison
+
 == Style/ClassMethods
 
 |===

lib/rubocop.rb

@@ -399,6 +399,7 @@
 require_relative 'rubocop/cop/style/character_literal'
 require_relative 'rubocop/cop/style/class_and_module_children'
 require_relative 'rubocop/cop/style/class_check'
+require_relative 'rubocop/cop/style/class_equality_comparison'
 require_relative 'rubocop/cop/style/class_methods'
 require_relative 'rubocop/cop/style/class_methods_definitions'
 require_relative 'rubocop/cop/style/class_vars'

lib/rubocop/cop/style/class_equality_comparison.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Style
+      # This cop enforces the use of `Object#instance_of?` instead of class comparison
+      # for equality.
+      #
+      # @example
+      #   # bad
+      #   var.class == Date
+      #   var.class.equal?(Date)
+      #   var.class.eql?(Date)
+      #   var.class.name == 'Date'
+      #
+      #   # good
+      #   var.instance_of?(Date)
+      #
+      class ClassEqualityComparison < Base
+        include RangeHelp
+        include IgnoredMethods
+        extend AutoCorrector
+
+        MSG = 'Use `Object.instance_of?` instead of comparing classes.'
+
+        RESTRICT_ON_SEND = %i[== equal? eql?].freeze
+
+        def_node_matcher :class_comparison_candidate?, <<~PATTERN
+          (send
+            {$(send _ :class) (send $(send _ :class) :name)}
+            {:== :equal? :eql?} $_)
+        PATTERN
+
+        def on_send(node)
+          def_node = node.each_ancestor(:def, :defs).first
+          return if def_node && ignored_method?(def_node.method_name)
+
+          class_comparison_candidate?(node) do |receiver_node, class_node|
+            range = range_between(receiver_node.loc.selector.begin_pos, node.source_range.end_pos)
+
+            add_offense(range) do |corrector|
+              corrector.replace(range, "instance_of?(#{class_node.source})")
+            end
+          end
+        end
+      end
+    end
+  end
+end

spec/rubocop/cop/style/class_equality_comparison_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Style::ClassEqualityComparison, :config do
+  let(:cop_config) do
+    { 'IgnoredMethods' => [] }
+  end
+
+  it 'registers an offense and corrects when comparing class for equality' do
+    expect_offense(<<~RUBY)
+      var.class == Date
+          ^^^^^^^^^^^^^ Use `Object.instance_of?` instead of comparing classes.
+      var.class.equal?(Date)
+          ^^^^^^^^^^^^^^^^^^ Use `Object.instance_of?` instead of comparing classes.
+      var.class.eql?(Date)
+          ^^^^^^^^^^^^^^^^ Use `Object.instance_of?` instead of comparing classes.
+    RUBY
+  end
+
+  it 'registers an offense and corrects when comparing class name for equality' do
+    expect_offense(<<~RUBY)
+      var.class.name == "Date"
+          ^^^^^^^^^^^^^^^^^^^^ Use `Object.instance_of?` instead of comparing classes.
+    RUBY
+  end
+
+  it 'does not register an offense when using `instance_of?`' do
+    expect_no_offenses(<<~RUBY)
+      var.instance_of?(Date)
+    RUBY
+  end
+
+  context 'when IgnoredMethods is specified' do
+    let(:cop_config) do
+      { 'IgnoredMethods' => ['=='] }
+    end
+
+    it 'does not register an offense when comparing class for equality' do
+      expect_no_offenses(<<~RUBY)
+        def ==(other)
+          self.class == other.class &&
+            name == other.name
+        end
+      RUBY
+    end
+  end
+end