Merge pull request #15 from ydah/add-new5

feat: add Committee/SchemaConformConsistency cop to enforce preferred schema conformance assertion style

Author: ydah

changelog/new_schema_conform_consistency.md

@@ -0,0 +1 @@
+- [#15](https://github.com/ydah/rubocop-committee/pull/15) Add `Committee/SchemaConformConsistency` cop to enforce preferred schema conformance assertion style. ([@ydah])

config/default.yml

@@ -26,6 +26,15 @@ Committee/RedundantResponseStatusAssertions:
   Enabled: pending
   VersionAdded: "0.1"
 
+Committee/SchemaConformConsistency:
+  Description: Prefer `assert_schema_conform` or separate request/response confirmations based on EnforcedStyle.
+  Enabled: pending
+  SupportedStyles:
+    - combined
+    - separate
+  EnforcedStyle: combined
+  VersionAdded: "<<next>>"
+
 Committee/UnspecifiedExpectedStatus:
   Description: |
     Check if the status code is specified as an argument to the method of the Committee

docs/modules/ROOT/pages/cops.adoc

@@ -6,6 +6,7 @@
 * 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#committeeschemaconformconsistency[Committee/SchemaConformConsistency]
 * xref:cops_committee.adoc#committeeunspecifiedexpectedstatus[Committee/UnspecifiedExpectedStatus]
 * xref:cops_committee.adoc#committeeunusedschemacoverage[Committee/UnusedSchemaCoverage]
 

docs/modules/ROOT/pages/cops_committee.adoc

@@ -137,6 +137,63 @@ it 'does something' do
 end
 ----
 
+[#committeeschemaconformconsistency]
+== Committee/SchemaConformConsistency
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Enabled
+| Yes
+| No
+| -
+| -
+|===
+
+Prefer `assert_schema_conform` when request and response schema confirmations
+are both asserted in the same example.
+
+[#examples-committeeschemaconformconsistency]
+=== Examples
+
+[#enforcedstyle_-combined-_default_-committeeschemaconformconsistency]
+==== EnforcedStyle: combined (default)
+
+[source,ruby]
+----
+# bad
+it 'returns users' do
+  get '/users'
+  assert_request_schema_confirm
+  assert_response_schema_confirm(200)
+end
+
+# good
+it 'returns users' do
+  get '/users'
+  assert_schema_conform(200)
+end
+----
+
+[#enforcedstyle_-separate-committeeschemaconformconsistency]
+==== EnforcedStyle: separate
+
+[source,ruby]
+----
+# bad
+it 'returns users' do
+  get '/users'
+  assert_schema_conform(200)
+end
+
+# good
+it 'returns users' do
+  get '/users'
+  assert_request_schema_confirm
+  assert_response_schema_confirm(200)
+end
+----
+
 [#committeeunspecifiedexpectedstatus]
 == Committee/UnspecifiedExpectedStatus
 

lib/rubocop-committee.rb

@@ -9,6 +9,7 @@
 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/schema_conform_consistency"
 require_relative "rubocop/cop/committee/redundant_response_status_assertions"
 require_relative "rubocop/cop/committee/unused_schema_coverage"
 require_relative "rubocop/cop/committee/unspecified_expected_status"

lib/rubocop/cop/committee/schema_conform_consistency.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Committee
+      # Prefer `assert_schema_conform` when request and response schema confirmations
+      # are both asserted in the same example.
+      #
+      # @example EnforcedStyle: combined (default)
+      #   # bad
+      #   it 'returns users' do
+      #     get '/users'
+      #     assert_request_schema_confirm
+      #     assert_response_schema_confirm(200)
+      #   end
+      #
+      #   # good
+      #   it 'returns users' do
+      #     get '/users'
+      #     assert_schema_conform(200)
+      #   end
+      #
+      # @example EnforcedStyle: separate
+      #   # bad
+      #   it 'returns users' do
+      #     get '/users'
+      #     assert_schema_conform(200)
+      #   end
+      #
+      #   # good
+      #   it 'returns users' do
+      #     get '/users'
+      #     assert_request_schema_confirm
+      #     assert_response_schema_confirm(200)
+      #   end
+      #
+      class SchemaConformConsistency < Base
+        include ConfigurableEnforcedStyle
+
+        MSG_COMBINED = "Use `assert_schema_conform` instead of separate request/response confirmations."
+        MSG_SEPARATE = "Use separate `assert_*_schema_confirm` calls instead of `assert_schema_conform`."
+
+        REQUEST_METHOD = :assert_request_schema_confirm
+        RESPONSE_METHOD = :assert_response_schema_confirm
+        SCHEMA_METHOD = :assert_schema_conform
+
+        EXAMPLE_METHODS = %i[it specify example scenario].freeze
+        RESTRICT_ON_SEND = [REQUEST_METHOD, RESPONSE_METHOD, SCHEMA_METHOD].freeze
+
+        def on_send(node) # rubocop:disable InternalAffairs/OnSendWithoutOnCSend
+          example_block = example_block_for(node)
+          return unless example_block
+
+          return unless offense?(node, example_block)
+
+          add_offense(node, message: offense_message(node))
+        end
+
+        private
+
+        def offense?(node, example_block)
+          return request_or_response?(node) && request_and_response_in?(example_block) if style == :combined
+          return schema_conform?(node) if style == :separate
+
+          false
+        end
+
+        def offense_message(_node)
+          if style == :combined
+            MSG_COMBINED
+          elsif style == :separate
+            MSG_SEPARATE
+          else
+            # :nocov:
+            :noop
+            # :nocov:
+          end
+        end
+
+        def example_block_for(node)
+          node.each_ancestor(:block).find { |ancestor| example_block?(ancestor) }
+        end
+
+        def example_block?(node)
+          return false unless node.block_type?
+
+          send_node = node.send_node
+          return false unless send_node&.send_type?
+
+          EXAMPLE_METHODS.include?(send_node.method_name)
+        end
+
+        def request_and_response_in?(example_block)
+          has_request = false
+          has_response = false
+
+          example_block.each_descendant(:send).each do |send_node|
+            next unless send_node.receiver.nil?
+
+            has_request ||= send_node.method?(REQUEST_METHOD)
+            has_response ||= send_node.method?(RESPONSE_METHOD)
+            return true if has_request && has_response
+          end
+
+          false
+        end
+
+        def request_or_response?(node)
+          node.receiver.nil? && [REQUEST_METHOD, RESPONSE_METHOD].include?(node.method_name)
+        end
+
+        def schema_conform?(node)
+          node.receiver.nil? && node.method?(SCHEMA_METHOD)
+        end
+      end
+    end
+  end
+end

spec/rubocop/cop/committee/schema_conform_consistency_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Committee::SchemaConformConsistency, :config do
+  context "when EnforcedStyle is combined" do
+    let(:cop_config) { { "EnforcedStyle" => "combined" } }
+
+    it "registers offenses when request and response confirmations are both present" do
+      expect_offense(<<~RUBY)
+        it 'returns users' do
+          get '/users'
+          assert_request_schema_confirm
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `assert_schema_conform` instead of separate request/response confirmations.
+          assert_response_schema_confirm(200)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `assert_schema_conform` instead of separate request/response confirmations.
+        end
+      RUBY
+    end
+
+    it "does not register an offense when using assert_schema_conform" do
+      expect_no_offenses(<<~RUBY)
+        it 'returns users' do
+          get '/users'
+          assert_schema_conform(200)
+        end
+      RUBY
+    end
+
+    it "does not register an offense when only one confirmation is present" do
+      expect_no_offenses(<<~RUBY)
+        it 'returns users' do
+          get '/users'
+          assert_request_schema_confirm
+        end
+      RUBY
+    end
+  end
+
+  context "when EnforcedStyle is separate" do
+    let(:cop_config) { { "EnforcedStyle" => "separate" } }
+
+    it "registers an offense for assert_schema_conform" do
+      expect_offense(<<~RUBY)
+        it 'returns users' do
+          get '/users'
+          assert_schema_conform(200)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^ Use separate `assert_*_schema_confirm` calls instead of `assert_schema_conform`.
+        end
+      RUBY
+    end
+
+    it "does not register an offense when using request and response confirmations" do
+      expect_no_offenses(<<~RUBY)
+        it 'returns users' do
+          get '/users'
+          assert_request_schema_confirm
+          assert_response_schema_confirm(200)
+        end
+      RUBY
+    end
+  end
+end