Merge pull request #14 from ydah/add-new4

feat: add Committee/UnusedSchemaCoverage cop to warn when schema coverage is set up without a report call

Author: ydah

changelog/new_unused_schema_coverage.md

@@ -0,0 +1 @@
+- [#14](https://github.com/ydah/rubocop-committee/pull/14) Add `Committee/UnusedSchemaCoverage` cop to warn when schema coverage is set up without any report call. ([@ydah])

config/default.yml

@@ -32,3 +32,8 @@ Committee/UnspecifiedExpectedStatus:
     where the expected response status code is required.
   Enabled: pending
   VersionAdded: "0.1"
+
+Committee/UnusedSchemaCoverage:
+  Description: Check for schema coverage setup without any report call.
+  Enabled: pending
+  VersionAdded: "<<next>>"

docs/modules/ROOT/pages/cops.adoc

@@ -7,5 +7,6 @@
 * xref:cops_committee.adoc#committeemultipleschemaconform[Committee/MultipleSchemaConform]
 * xref:cops_committee.adoc#committeeredundantresponsestatusassertions[Committee/RedundantResponseStatusAssertions]
 * xref:cops_committee.adoc#committeeunspecifiedexpectedstatus[Committee/UnspecifiedExpectedStatus]
+* xref:cops_committee.adoc#committeeunusedschemacoverage[Committee/UnusedSchemaCoverage]
 
 // END_COP_LIST

docs/modules/ROOT/pages/cops_committee.adoc

@@ -170,3 +170,40 @@ it 'does something' do
   assert_schema_conform(200)
 end
 ----
+
+[#committeeunusedschemacoverage]
+== Committee/UnusedSchemaCoverage
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Enabled
+| Yes
+| No
+| -
+| -
+|===
+
+Check for unused schema coverage setup without any report call.
+
+[#examples-committeeunusedschemacoverage]
+=== Examples
+
+[source,ruby]
+----
+# bad
+before do
+  @schema_coverage = Committee::Test::SchemaCoverage.new(schema)
+  @committee_options[:schema_coverage] = @schema_coverage
+end
+
+# good
+before do
+  @schema_coverage = Committee::Test::SchemaCoverage.new(schema)
+  @committee_options[:schema_coverage] = @schema_coverage
+end
+
+after(:all) do
+  @schema_coverage.report
+end
+----

lib/rubocop-committee.rb

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

lib/rubocop/cop/committee/unused_schema_coverage.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Committee
+      # Check for unused schema coverage setup without any report call.
+      #
+      # @example
+      #   # bad
+      #   before do
+      #     @schema_coverage = Committee::Test::SchemaCoverage.new(schema)
+      #     @committee_options[:schema_coverage] = @schema_coverage
+      #   end
+      #
+      #   # good
+      #   before do
+      #     @schema_coverage = Committee::Test::SchemaCoverage.new(schema)
+      #     @committee_options[:schema_coverage] = @schema_coverage
+      #   end
+      #
+      #   after(:all) do
+      #     @schema_coverage.report
+      #   end
+      #
+      class UnusedSchemaCoverage < Base
+        MSG = "Call `report` or `report_flatten` when schema coverage is set up."
+
+        EXAMPLE_GROUP_METHODS = %i[describe context feature].freeze
+
+        # @!method schema_coverage_assignment(node)
+        def_node_search :schema_coverage_assignment, <<~PATTERN
+          (ivasgn :@schema_coverage (send (const (const (const nil? :Committee) :Test) :SchemaCoverage) :new ...))
+        PATTERN
+
+        # @!method schema_coverage_report?(node)
+        def_node_search :schema_coverage_report?, <<~PATTERN
+          (send (ivar :@schema_coverage) {:report :report_flatten})
+        PATTERN
+
+        def on_block(node)
+          return unless example_group?(node)
+
+          assignment = schema_coverage_assignment(node).first
+          return unless assignment
+          return if schema_coverage_report?(node)
+
+          add_offense(assignment)
+        end
+        alias on_numblock on_block
+
+        private
+
+        def example_group?(node)
+          send_node = node.send_node
+          return false unless send_node&.send_type?
+
+          EXAMPLE_GROUP_METHODS.include?(send_node.method_name)
+        end
+      end
+    end
+  end
+end

spec/rubocop/cop/committee/unused_schema_coverage_spec.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Committee::UnusedSchemaCoverage, :config do
+  it "registers an offense when schema coverage is set up but not reported" do
+    expect_offense(<<~RUBY)
+      RSpec.describe 'Users API' do
+        before do
+          @schema_coverage = Committee::Test::SchemaCoverage.new(schema)
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Call `report` or `report_flatten` when schema coverage is set up.
+          @committee_options[:schema_coverage] = @schema_coverage
+        end
+
+        it 'does something' do
+          get '/users'
+          assert_schema_conform(200)
+        end
+      end
+    RUBY
+  end
+
+  it "does not register an offense when report is called" do
+    expect_no_offenses(<<~RUBY)
+      RSpec.describe 'Users API' do
+        before do
+          @schema_coverage = Committee::Test::SchemaCoverage.new(schema)
+          @committee_options[:schema_coverage] = @schema_coverage
+        end
+
+        after(:all) do
+          @schema_coverage.report
+        end
+      end
+    RUBY
+  end
+
+  it "does not register an offense when report_flatten is called" do
+    expect_no_offenses(<<~RUBY)
+      RSpec.describe 'Users API' do
+        before do
+          @schema_coverage = Committee::Test::SchemaCoverage.new(schema)
+          @committee_options[:schema_coverage] = @schema_coverage
+        end
+
+        after(:all) do
+          @schema_coverage.report_flatten
+        end
+      end
+    RUBY
+  end
+
+  it "does not register an offense when schema coverage is not used" do
+    expect_no_offenses(<<~RUBY)
+      RSpec.describe 'Users API' do
+        before do
+          @committee_options[:schema_path] = 'schema.yaml'
+        end
+      end
+    RUBY
+  end
+end