Merge pull request #13 from ydah/add-new3

feat: add Committee/DeprecatedOldAssertBehavior cop to warn against enabling deprecated old_assert_behavior

Author: ydah

changelog/new_deprecated_old_assert_behavior.md

@@ -0,0 +1 @@
+- [#13](https://github.com/ydah/rubocop-committee/pull/13) Add `Committee/DeprecatedOldAssertBehavior` cop to warn when `committee_options` enables `old_assert_behavior`. ([@ydah])

config/default.yml

@@ -11,6 +11,11 @@ Committee/AssertSchemaConformWithoutRequest:
   Enabled: pending
   VersionAdded: "<<next>>"
 
+Committee/DeprecatedOldAssertBehavior:
+  Description: Check if `committee_options` enables deprecated `old_assert_behavior`.
+  Enabled: pending
+  VersionAdded: "<<next>>"
+
 Committee/MultipleSchemaConform:
   Description: Check for multiple schema conformance assertions within the same request block.
   Enabled: pending

docs/modules/ROOT/pages/cops.adoc

@@ -3,6 +3,7 @@
 === Department xref:cops_committee.adoc[Committee]
 
 * xref:cops_committee.adoc#committeeassertschemaconformwithoutrequest[Committee/AssertSchemaConformWithoutRequest]
+* xref:cops_committee.adoc#committeedeprecatedoldassertbehavior[Committee/DeprecatedOldAssertBehavior]
 * xref:cops_committee.adoc#committeemultipleschemaconform[Committee/MultipleSchemaConform]
 * xref:cops_committee.adoc#committeeredundantresponsestatusassertions[Committee/RedundantResponseStatusAssertions]
 * xref:cops_committee.adoc#committeeunspecifiedexpectedstatus[Committee/UnspecifiedExpectedStatus]

docs/modules/ROOT/pages/cops_committee.adoc

@@ -38,6 +38,37 @@ it 'conforms to schema' do
 end
 ----
 
+[#committeedeprecatedoldassertbehavior]
+== Committee/DeprecatedOldAssertBehavior
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Enabled
+| Yes
+| No
+| -
+| -
+|===
+
+Check if `committee_options` enables deprecated `old_assert_behavior`.
+
+[#examples-committeedeprecatedoldassertbehavior]
+=== Examples
+
+[source,ruby]
+----
+# bad
+def committee_options
+  { schema_path: "schema.yaml", old_assert_behavior: true }
+end
+
+# good
+def committee_options
+  { schema_path: "schema.yaml", old_assert_behavior: false }
+end
+----
+
 [#committeemultipleschemaconform]
 == Committee/MultipleSchemaConform
 

lib/rubocop-committee.rb

@@ -6,6 +6,7 @@
 require_relative "rubocop/committee/plugin"
 
 require_relative "rubocop/cop/committee/assert_schema_conform_without_request"
+require_relative "rubocop/cop/committee/deprecated_old_assert_behavior"
 require_relative "rubocop/cop/committee/multiple_schema_conform"
 require_relative "rubocop/cop/committee/redundant_response_status_assertions"
 require_relative "rubocop/cop/committee/unspecified_expected_status"

lib/rubocop/cop/committee/deprecated_old_assert_behavior.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Committee
+      # Check if `committee_options` enables deprecated `old_assert_behavior`.
+      #
+      # @example
+      #   # bad
+      #   def committee_options
+      #     { schema_path: "schema.yaml", old_assert_behavior: true }
+      #   end
+      #
+      #   # good
+      #   def committee_options
+      #     { schema_path: "schema.yaml", old_assert_behavior: false }
+      #   end
+      #
+      class DeprecatedOldAssertBehavior < Base
+        MSG = "Do not enable deprecated `old_assert_behavior` in `committee_options`."
+
+        def on_def(node)
+          return unless node.method?(:committee_options)
+
+          node.each_descendant(:pair).each do |pair|
+            key, value = *pair
+            next unless old_assert_behavior_key?(key)
+            next unless value&.true_type?
+
+            add_offense(pair)
+          end
+        end
+
+        private
+
+        def old_assert_behavior_key?(node)
+          return node.value == :old_assert_behavior if node.sym_type?
+          return node.value == "old_assert_behavior" if node.str_type?
+
+          false
+        end
+      end
+    end
+  end
+end

spec/rubocop/cop/committee/deprecated_old_assert_behavior_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Committee::DeprecatedOldAssertBehavior, :config do
+  it "registers an offense when `old_assert_behavior: true` is set" do
+    expect_offense(<<~RUBY)
+      def committee_options
+        { schema_path: "schema.yaml", old_assert_behavior: true }
+                                      ^^^^^^^^^^^^^^^^^^^^^^^^^ Do not enable deprecated `old_assert_behavior` in `committee_options`.
+      end
+    RUBY
+  end
+
+  it "registers an offense when memoized options enable old behavior" do
+    expect_offense(<<~RUBY)
+      def committee_options
+        @committee_options ||= { schema_path: "schema.yaml", old_assert_behavior: true }
+                                                             ^^^^^^^^^^^^^^^^^^^^^^^^^ Do not enable deprecated `old_assert_behavior` in `committee_options`.
+      end
+    RUBY
+  end
+
+  it "does not register an offense when `old_assert_behavior` is false" do
+    expect_no_offenses(<<~RUBY)
+      def committee_options
+        { schema_path: "schema.yaml", old_assert_behavior: false }
+      end
+    RUBY
+  end
+
+  it "does not register an offense when `old_assert_behavior` is not present" do
+    expect_no_offenses(<<~RUBY)
+      def committee_options
+        { schema_path: "schema.yaml" }
+      end
+    RUBY
+  end
+end