Adopt rubocop-rspec plugin

Author: sferik

.rubocop.yml

@@ -2,6 +2,7 @@ plugins:
   - rubocop-capybara
   - rubocop-performance
   - rubocop-rake
+  - rubocop-rspec
 
 AllCops:
   Exclude:
@@ -106,6 +107,42 @@ Naming/FileName:
     - "spec/fixtures/utf-8.rb"
     - "lib/simplecov-html.rb"
 
+inherit_mode:
+  merge:
+    - Exclude
+
+# Spec fixtures are byte-stable test inputs (line numbers and `puts`
+# statements matter for coverage assertions), and spec/support/ holds
+# helper modules — neither directory is a real spec suite, so the
+# RSpec department shouldn't touch them. (The fixture rspec runners
+# under spec/fixtures/frameworks/ are intentionally minimal:
+# `expect(1).to eq(2)` is the point.)
+RSpec:
+  Exclude:
+    - "spec/fixtures/**/*"
+    - "spec/support/**/*"
+RSpec/ExpectActual:
+  Exclude:
+    - "spec/fixtures/**/*"
+RSpec/DescribeClass:
+  Exclude:
+    - "spec/fixtures/**/*"
+
+RSpec/ExampleLength:
+  Max: 20 # TODO: Lower to 5
+RSpec/MultipleExpectations:
+  Max: 6 # TODO: Lower to 1
+RSpec/SpecFilePathFormat:
+  # The project layout puts simplecov specs at spec/foo_spec.rb (mirroring
+  # lib/simplecov/foo.rb) rather than spec/simple_cov/foo_spec.rb. Map the
+  # SimpleCov module to an empty path segment so the cop accepts that.
+  CustomTransform:
+    SimpleCov: ''
+RSpec/NestedGroups:
+  Max: 5 # TODO: Lower to 3
+RSpec/MultipleMemoizedHelpers:
+  Max: 11 # TODO: Lower to 5
+
 Style/CollectionMethods:
   Description: Enforces the use of consistent method names from the Enumerable module.
   PreferredMethods:

Gemfile

@@ -16,6 +16,7 @@ group :development do
     gem "rubocop-capybara"
     gem "rubocop-performance"
     gem "rubocop-rake"
+    gem "rubocop-rspec"
   end
   gem "test-unit"
   # Explicitly add webrick because it has been removed from stdlib in Ruby 3.0

Gemfile.lock

@@ -165,6 +165,9 @@ GEM
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
+    rubocop-rspec (3.9.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
     ruby-progressbar (1.13.0)
     stringio (3.2.0)
     sys-uname (1.5.1)
@@ -208,6 +211,7 @@ DEPENDENCIES
   rubocop-capybara
   rubocop-performance
   rubocop-rake
+  rubocop-rspec
   simplecov!
   test-unit
   webrick

spec/combine/results_combiner_spec.rb

@@ -4,7 +4,7 @@
 
 describe SimpleCov::Combine::ResultsCombiner do
   describe "with two faked coverage resultsets" do
-    let(:resultset1) do
+    let(:first_resultset) do
       {
         source_fixture("sample.rb") => {
           "lines" => [nil, 1, 1, 1, nil, nil, 1, 1, nil, nil],
@@ -22,7 +22,7 @@
       }
     end
 
-    let(:resultset2) do
+    let(:second_resultset) do
       {
         source_fixture("sample.rb") => {"lines" => [1, nil, 1, 1, nil, nil, 1, 1, nil, nil]},
         source_fixture("app/models/user.rb") => {
@@ -37,7 +37,7 @@
       }
     end
 
-    let(:resultset3) do
+    let(:third_resultset) do
       {source_fixture("three.rb") => {"lines" => [nil, 1, 2]}}
     end
 
@@ -49,61 +49,61 @@
       SimpleCov.enable_coverage :branch
     end
 
-    context "a merge" do
-      subject do
-        SimpleCov::Combine::ResultsCombiner.combine(resultset1, resultset2, resultset3)
+    context "when a merge" do
+      subject(:combined) do
+        described_class.combine(first_resultset, second_resultset, third_resultset)
       end
 
       it "has proper results for sample.rb" do
-        expect(subject[source_fixture("sample.rb")]["lines"]).to eq([1, 1, 2, 2, nil, nil, 2, 2, nil, nil])
+        expect(combined[source_fixture("sample.rb")]["lines"]).to eq([1, 1, 2, 2, nil, nil, 2, 2, nil, nil])
 
         # gotta configure max line so it doesn't get ridiculous
         # rubocop:disable Style/IfUnlessModifier
         if SimpleCov.branch_coverage_supported?
-          expect(subject[source_fixture("sample.rb")]["branches"][[:if, 3, 8, 6, 8, 36]][[:then, 4, 8, 6, 8, 12]]).to eq(47)
+          expect(combined[source_fixture("sample.rb")]["branches"][[:if, 3, 8, 6, 8, 36]][[:then, 4, 8, 6, 8, 12]]).to eq(47)
         end
         # rubocop:enable Style/IfUnlessModifier
       end
 
       it "has proper results for user.rb" do
-        expect(subject[source_fixture("app/models/user.rb")]["lines"]).to eq([nil, 2, 6, 2, nil, nil, 2, 0, nil, nil])
+        expect(combined[source_fixture("app/models/user.rb")]["lines"]).to eq([nil, 2, 6, 2, nil, nil, 2, 0, nil, nil])
 
         if SimpleCov.branch_coverage_supported?
-          expect(subject[source_fixture("app/models/user.rb")]["branches"][[:if, 3, 8, 6, 8, 36]][[:then, 4, 8, 6, 8, 12]]).to eq(48)
-          expect(subject[source_fixture("app/models/user.rb")]["branches"][[:if, 3, 8, 6, 8, 36]][[:else, 5, 8, 6, 8, 36]]).to eq(26)
+          expect(combined[source_fixture("app/models/user.rb")]["branches"][[:if, 3, 8, 6, 8, 36]][[:then, 4, 8, 6, 8, 12]]).to eq(48)
+          expect(combined[source_fixture("app/models/user.rb")]["branches"][[:if, 3, 8, 6, 8, 36]][[:else, 5, 8, 6, 8, 36]]).to eq(26)
         end
       end
 
       it "has proper results for sample_controller.rb" do
-        expect(subject[source_fixture("app/controllers/sample_controller.rb")]["lines"]).to eq([nil, 4, 2, 1, nil, nil, 2, 0, nil, nil])
+        expect(combined[source_fixture("app/controllers/sample_controller.rb")]["lines"]).to eq([nil, 4, 2, 1, nil, nil, 2, 0, nil, nil])
       end
 
       it "has proper results for resultset1.rb" do
-        expect(subject[source_fixture("resultset1.rb")]["lines"]).to eq([1, 1, 1, 1])
+        expect(combined[source_fixture("resultset1.rb")]["lines"]).to eq([1, 1, 1, 1])
       end
 
       it "has proper results for resultset2.rb" do
-        expect(subject[source_fixture("resultset2.rb")]["lines"]).to eq([nil, 1, 1, nil])
+        expect(combined[source_fixture("resultset2.rb")]["lines"]).to eq([nil, 1, 1, nil])
       end
 
       it "has proper results for parallel_tests.rb" do
-        expect(subject[source_fixture("parallel_tests.rb")]["lines"]).to eq([nil, nil, nil, 0])
+        expect(combined[source_fixture("parallel_tests.rb")]["lines"]).to eq([nil, nil, nil, 0])
       end
 
       it "has proper results for conditionally_loaded_1.rb" do
-        expect(subject[source_fixture("conditionally_loaded_1.rb")]["lines"]).to eq([nil, 0, 1])
+        expect(combined[source_fixture("conditionally_loaded_1.rb")]["lines"]).to eq([nil, 0, 1])
       end
 
       it "has proper results for conditionally_loaded_2.rb" do
-        expect(subject[source_fixture("conditionally_loaded_2.rb")]["lines"]).to eq([nil, 0, 1])
+        expect(combined[source_fixture("conditionally_loaded_2.rb")]["lines"]).to eq([nil, 0, 1])
       end
 
       it "has proper results for three.rb" do
-        expect(subject[source_fixture("three.rb")]["lines"]).to eq([nil, 3, 7])
+        expect(combined[source_fixture("three.rb")]["lines"]).to eq([nil, 3, 7])
       end
 
       it "always returns a Hash object for branches", if: SimpleCov.branch_coverage_supported? do
-        expect(subject[source_fixture("three.rb")]["branches"]).to eq({})
+        expect(combined[source_fixture("three.rb")]["branches"]).to eq({})
       end
     end
   end
@@ -136,17 +136,17 @@
   end
 
   it "merges frozen resultsets" do
-    resultset1 = {
+    first_resultset = {
       source_fixture("sample.rb").freeze => {"lines" => [nil, 1, 1, 1, nil, nil, 1, 1, nil, nil]},
       source_fixture("app/models/user.rb").freeze => {"lines" => [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil]}
     }
 
-    resultset2 = {
+    second_resultset = {
       source_fixture("sample.rb").freeze => {"lines" => [1, nil, 1, 1, nil, nil, 1, 1, nil, nil]}
     }
 
-    merged_result = SimpleCov::Combine::ResultsCombiner.combine(resultset1, resultset2)
-    expect(merged_result.keys).to eq(resultset1.keys)
+    merged_result = described_class.combine(first_resultset, second_resultset)
+    expect(merged_result.keys).to eq(first_resultset.keys)
     expect(merged_result.values.map(&:frozen?)).to eq([false, false])
 
     expect(merged_result[source_fixture("sample.rb")]["lines"]).to eq([1, 1, 2, 2, nil, nil, 2, 2, nil, nil])

spec/command_guesser_spec.rb

@@ -3,58 +3,58 @@
 require "helper"
 
 describe SimpleCov::CommandGuesser do
-  subject { SimpleCov::CommandGuesser }
+  subject(:guesser) { described_class }
 
   it 'correctly guesses "Unit Tests" for unit tests' do
-    subject.original_run_command = "/some/path/test/units/foo_bar_test.rb"
-    expect(subject.guess).to eq("Unit Tests")
-    subject.original_run_command = "test/units/foo.rb"
-    expect(subject.guess).to eq("Unit Tests")
-    subject.original_run_command = "test/foo.rb"
-    expect(subject.guess).to eq("Unit Tests")
-    subject.original_run_command = "test/{models,helpers,unit}/**/*_test.rb"
-    expect(subject.guess).to eq("Unit Tests")
+    guesser.original_run_command = "/some/path/test/units/foo_bar_test.rb"
+    expect(guesser.guess).to eq("Unit Tests")
+    guesser.original_run_command = "test/units/foo.rb"
+    expect(guesser.guess).to eq("Unit Tests")
+    guesser.original_run_command = "test/foo.rb"
+    expect(guesser.guess).to eq("Unit Tests")
+    guesser.original_run_command = "test/{models,helpers,unit}/**/*_test.rb"
+    expect(guesser.guess).to eq("Unit Tests")
   end
 
   it 'correctly guesses "Functional Tests" for functional tests' do
-    subject.original_run_command = "/some/path/test/functional/foo_bar_controller_test.rb"
-    expect(subject.guess).to eq("Functional Tests")
-    subject.original_run_command = "test/{controllers,mailers,functional}/**/*_test.rb"
-    expect(subject.guess).to eq("Functional Tests")
+    guesser.original_run_command = "/some/path/test/functional/foo_bar_controller_test.rb"
+    expect(guesser.guess).to eq("Functional Tests")
+    guesser.original_run_command = "test/{controllers,mailers,functional}/**/*_test.rb"
+    expect(guesser.guess).to eq("Functional Tests")
   end
 
   it 'correctly guesses "Integration Tests" for integration tests' do
-    subject.original_run_command = "/some/path/test/integration/foo_bar_controller_test.rb"
-    expect(subject.guess).to eq("Integration Tests")
-    subject.original_run_command = "test/integration/**/*_test.rb"
-    expect(subject.guess).to eq("Integration Tests")
+    guesser.original_run_command = "/some/path/test/integration/foo_bar_controller_test.rb"
+    expect(guesser.guess).to eq("Integration Tests")
+    guesser.original_run_command = "test/integration/**/*_test.rb"
+    expect(guesser.guess).to eq("Integration Tests")
   end
 
   it 'correctly guesses "Cucumber Features" for cucumber features' do
-    subject.original_run_command = "features"
-    expect(subject.guess).to eq("Cucumber Features")
-    subject.original_run_command = "cucumber"
-    expect(subject.guess).to eq("Cucumber Features")
+    guesser.original_run_command = "features"
+    expect(guesser.guess).to eq("Cucumber Features")
+    guesser.original_run_command = "cucumber"
+    expect(guesser.guess).to eq("Cucumber Features")
   end
 
   it 'correctly guesses "RSpec" for RSpec' do
-    subject.original_run_command = "/some/path/spec/foo.rb"
-    expect(subject.guess).to eq("RSpec")
+    guesser.original_run_command = "/some/path/spec/foo.rb"
+    expect(guesser.guess).to eq("RSpec")
   end
 
   it "defaults to RSpec because RSpec constant is defined" do
-    subject.original_run_command = "some_arbitrary_command with arguments"
-    expect(subject.guess).to eq("RSpec")
+    guesser.original_run_command = "some_arbitrary_command with arguments"
+    expect(guesser.guess).to eq("RSpec")
   end
 
   it "appends parallel data" do
-    subject.original_run_command = "/some/path/spec/foo.rb"
+    guesser.original_run_command = "/some/path/spec/foo.rb"
     allow(ENV).to receive(:[]).and_call_original
     allow(ENV).to receive(:fetch).and_call_original
     allow(ENV).to receive(:[]).with("TEST_ENV_NUMBER").and_return("1")
     allow(ENV).to receive(:[]).with("PARALLEL_TEST_GROUPS").and_return("2")
     allow(ENV).to receive(:fetch).with("TEST_ENV_NUMBER", nil).and_return("1")
     allow(ENV).to receive(:fetch).with("PARALLEL_TEST_GROUPS", nil).and_return("2")
-    expect(subject.guess).to eq("RSpec (1/2)")
+    expect(guesser.guess).to eq("RSpec (1/2)")
   end
 end

spec/config_loader_spec.rb

@@ -2,7 +2,7 @@
 
 require "helper"
 
-describe "loading config" do
+describe "loading config" do # rubocop:disable RSpec/DescribeClass
   context "without ENV[HOME]" do
     it "does not raise any errors" do
       home = ENV.delete("HOME")

spec/configuration_spec.rb

@@ -42,9 +42,10 @@
 
     it "still returns the configured token (after the deprecation warning)" do
       capture_stderr { config.nocov_token("skippit") }
-      stderr = capture_stderr { @value = config.nocov_token }
+      value = nil
+      stderr = capture_stderr { value = config.nocov_token }
 
-      expect(@value).to eq "skippit"
+      expect(value).to eq "skippit"
       expect(stderr).to include("[DEPRECATION]") # the read still warns
     end
 
@@ -58,9 +59,10 @@
 
   describe "#current_nocov_token" do
     it "returns the configured token without emitting a deprecation warning" do
-      stderr = capture_stderr { @value = config.current_nocov_token }
+      value = nil
+      stderr = capture_stderr { value = config.current_nocov_token }
 
-      expect(@value).to eq "nocov"
+      expect(value).to eq "nocov"
       expect(stderr).to be_empty
     end
 
@@ -81,7 +83,7 @@
         expect(config.tracked_files).to eq glob
       end
 
-      context "and configured again with nil" do
+      context "when configured again with nil" do
         before { config.track_files(nil) }
 
         it "returns nil" do
@@ -102,13 +104,15 @@
       end
 
       it "does not warn you about your usage" do
-        expect(config).not_to receive(:warn)
+        allow(config).to receive(:warn)
         config.public_send(coverage_setting, 100.00)
+        expect(config).not_to have_received(:warn)
       end
 
       it "warns you about your usage" do
-        expect(config).to receive(:warn).with("The coverage you set for #{coverage_setting} is greater than 100%")
+        allow(config).to receive(:warn)
         config.public_send(coverage_setting, 100.01)
+        expect(config).to have_received(:warn).with("The coverage you set for #{coverage_setting} is greater than 100%")
       end
 
       it "sets the right coverage value when called with a number" do
@@ -177,13 +181,15 @@
       end
 
       it "does not warn you about your usage" do
-        expect(config).not_to receive(:warn)
+        allow(config).to receive(:warn)
         config.minimum_coverage_by_group({"Test Group 1" => 100.00})
+        expect(config).not_to have_received(:warn)
       end
 
       it "warns you about your usage" do
-        expect(config).to receive(:warn).with("The coverage you set for minimum_coverage_by_group is greater than 100%")
+        allow(config).to receive(:warn)
         config.minimum_coverage_by_group({"Test Group 1" => 100.01})
+        expect(config).to have_received(:warn).with("The coverage you set for minimum_coverage_by_group is greater than 100%")
       end
 
       it "sets the right coverage value when called with a number" do
@@ -377,20 +383,20 @@
 
     describe "#enable_for_subprocesses" do
       it "returns false by default" do
-        expect(config.enable_for_subprocesses).to eq false
+        expect(config.enable_for_subprocesses).to be false
       end
 
       it "can be set to true" do
         config.enable_for_subprocesses true
 
-        expect(config.enable_for_subprocesses).to eq true
+        expect(config.enable_for_subprocesses).to be true
       end
 
       it "can be enabled and then disabled again" do
         config.enable_for_subprocesses true
         config.enable_for_subprocesses false
 
-        expect(config.enable_for_subprocesses).to eq false
+        expect(config.enable_for_subprocesses).to be false
       end
     end