Add RSpec/StubProducts cop

CHANGELOG.md

@@ -4,7 +4,8 @@
 
 # v0.3.1
 
-Correct cop name `Migration/SchemaStatementsMethods` in config ([#17](https://github.com/petalmd/rubocop-petal/pull/17))
+* Correct cop name `Migration/SchemaStatementsMethods` in config ([#17](https://github.com/petalmd/rubocop-petal/pull/17))
+* Added cop `RSpec/StubProducts` ([#18](https://github.com/petalmd/rubocop-petal/pull/18))
 
 # v0.3.0
 

config/default.yml

@@ -30,6 +30,12 @@ RSpec/CreateListMax:
   Include:
     - spec/**/*
 
+RSpec/StubProducts:
+  Description: 'Suggest to use stub_products instead of veil/unveil_product.'
+  Enabled: true
+  Include:
+    - spec/**/*
+
 Grape/HelpersIncludeModule:
   Description: 'Prevent using helpers with block to include module'
   Enabled: true

lib/rubocop/cop/rspec/stub_products.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Suggest to use stub_products instead of veil/unveil_product
+      # which queries the database and can cause flaky tests.
+      #
+      #   # bad
+      #   unveil_product('MY_PRODUCT')
+      #   veil_product('MY_PRODUCT')
+      #
+      #   # good
+      #   stub_products('MY_PRODUCT' => true)
+      #   stub_products('MY_PRODUCT' => false)
+      #   stub_products('MY_PRODUCT' => group)
+      #   stub_products('MY_PRODUCT' => [group1, group2])
+      #   stub_products(MY_PRODUCT: true)
+      #
+      class StubProducts < Base
+        MSG = 'Use `stub_products` instead of veil/unveil_product.'
+
+        def_node_search :veil_product?, <<~PATTERN
+          (send nil? :veil_product _)
+        PATTERN
+
+        def_node_search :unveil_product?, <<~PATTERN
+          (send nil? :unveil_product _)
+        PATTERN
+
+        def on_send(node)
+          return unless veil_product?(node) || unveil_product?(node)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

spec/rubocop/cop/rspec/stub_products_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::RSpec::StubProducts, :config do
+  context 'when using veil_product' do
+    it 'registers an offense' do
+      expect_offense(<<~RUBY)
+        veil_product('MY_PRODUCT')
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `stub_products` instead of veil/unveil_product.
+      RUBY
+    end
+  end
+
+  context 'when using unveil_product' do
+    it 'registers an offense' do
+      expect_offense(<<~RUBY)
+        unveil_product('MY_PRODUCT')
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `stub_products` instead of veil/unveil_product.
+      RUBY
+    end
+  end
+
+  context 'when not using veil nor unveil_product' do
+    it 'doesnt register an offense' do
+      expect_no_offenses(<<~RUBY)
+        stub_products('MY_PRODUCT' => group)
+      RUBY
+    end
+  end
+end