parallel_rspec_simplecov 0.3.0 → 1.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a942644939bc97f3b7a8567c0d0ee07cd78095366503aa10400dda8d707f0fc
-  data.tar.gz: 77581e6f6239a62a28989581d5528ad0253b1333c0547d9efedc61111a05f97c
+  metadata.gz: 9bdcdacea3afc1313b6a67c49dc222909b877e2270a5e450f5da29f6bba7aba3
+  data.tar.gz: 4413ab01734c4395b3aab98500015706e62c67cd1598a15489f869417dec52df
 SHA512:
-  metadata.gz: 9bbfaba6a75af9d81dbba64d6eefe40a94d0561b4efc83ba981d63b4dae41c8b421e923b8642b871213706c1a8d7fca524bb86082ddfea3548dd3be4d550b361
-  data.tar.gz: e6ca0cb5329fe63100ba78a29e6bd2ce751e02859f708afef0aa9b95d0e46e019bf5483b310bdab2dca1332cc88c05b23e4c30ffe48636d25a38a39ed8767947
+  metadata.gz: f0825595a26b144bda243ea0699c740de6c03914ce5d234786d268598f69469cee31cda3af357226d9176d065a0096705dbb9bfd380eb8039e8a2ec92b569b49
+  data.tar.gz: d526f3501070e33f50789c319e4715706fd0739fd5b6e74ee453d582cf4291de4dcf6a74ce3bc94184fcf8583e05d262f185bef8c371e68ebb86a27a943855f0

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/README.md

@@ -1,39 +1,33 @@
-# ParallelRSpec::Simplecov
+# ParallelRSpec::SimpleCov
 
-TODO: Delete this and the text below, and describe your gem
+A very small library for collecting SimpleCov coverage from RSpec suites run in parallel via [parallel_rspec](https://github.com/willbryant/parallel_rspec).
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/parallel_rspec_simplecov`. To experiment with that code, run `bin/console` for an interactive prompt.
+SimpleCov doesn't merge coverage across `parallel_rspec`'s forked workers by default; this gem registers an `after_fork` hook so each worker writes its own resultset, then collates them in `after(:suite)`.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add parallel_rspec_simplecov
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/parallel_rspec_simplecov.
+Replace your call (in `spec_helper.rb`, for example) to `SimpleCov.start` with a call to `ParallelRSpec::SimpleCov.start`. It accepts the same positional `profile` argument and configuration block as `SimpleCov.start`, plus a `formatters:` keyword listing the formatters to apply to the *merged* result.
+
+```ruby
+ParallelRSpec::SimpleCov.start(
+  'rails',
+  formatters: [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::CoberturaFormatter,
+  ]
+) do
+  enable_coverage :branch
+  add_filter '/spec/'
+  add_filter '/config/'
+end
+```
 
-## License
+## Output
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Per-worker resultsets land in `coverage/rspec_N/`; the merged result and any formatter output (HTML, Cobertura, …) end up at the top level of `coverage/`.

data/Rakefile

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/parallel_rspec_simplecov/simplecov.rb

@@ -5,14 +5,32 @@ require "parallel_rspec/config"
 module ParallelRSpec::SimpleCov
   @simplecov_enabled = false
   @simplecov_base_dir = nil
-  @simplecov_formatters = nil
+  @simplecov_formatters = []
 
+  # Returns true once {.start} has been called in this process.
+  #
+  # @return [Boolean]
   def self.simplecov_enabled?
     @simplecov_enabled
   end
 
+  # Configure SimpleCov to merge coverage across `parallel_rspec` workers.
+  #
+  # Call this in place of `SimpleCov.start` from your `spec_helper.rb`. It
+  # starts SimpleCov on the server process, registers an `after_fork` hook
+  # so each worker writes its own resultset under `coverage/rspec_N/`, and
+  # registers an `after(:suite)` hook to collate everything into a merged
+  # report at the end of the run.
+  #
+  # Idempotent: subsequent calls are no-ops.
+  #
+  # @param profile [String, nil] SimpleCov profile name, passed through to `SimpleCov.start`.
+  # @param formatters [Array<SimpleCov::Formatter>, nil] formatters to apply to the merged result. Accepts formatter classes or instances. When more than one is given they are wrapped in a `MultiFormatter`. When omitted, SimpleCov's default formatter is used.
+  # @yield SimpleCov configuration block (e.g. `add_filter`, `enable_coverage :branch`), passed through to `SimpleCov.start`.
+  # @return [void]
   def self.start(profile = nil, formatters: nil, &block)
-    puts "SimpleCov.start"
+    return if @simplecov_enabled
+
     ::SimpleCov.enable_for_subprocesses true
 
     base_dir = ::SimpleCov.coverage_dir
@@ -48,10 +66,16 @@ module ParallelRSpec::SimpleCov
     start_simplecov.call("RSpec Server", File.join(base_dir, "rspec_server"))
 
     @simplecov_base_dir = base_dir
-    @simplecov_formatters = formatters
+    @simplecov_formatters = Array(formatters)
     @simplecov_enabled = true
   end
 
+  # Merge per-worker resultsets into a single report. Called automatically
+  # from the `after(:suite)` hook installed by {.start} — not intended to
+  # be called directly.
+  #
+  # @api private
+  # @return [void]
   def self.collate!
     base_dir = @simplecov_base_dir || ::SimpleCov.coverage_dir
 
@@ -68,19 +92,18 @@ module ParallelRSpec::SimpleCov
     end
 
     collate_formatter =
-      case (@simplecov_formatters || []).length
+      case @simplecov_formatters.length
       when 0 then nil
       when 1 then @simplecov_formatters.first
       else ::SimpleCov::Formatter::MultiFormatter.new(@simplecov_formatters)
       end
 
-    puts "Collating #{resultsets.size} SimpleCov resultset(s)..."
-
     ::SimpleCov.collate(resultsets) do
       coverage_dir base_dir
       formatter collate_formatter if collate_formatter
     end
   rescue => e
     warn "[parallel_rspec] simplecov collation failed: #{e.class}: #{e.message}"
+    warn e.backtrace.first(5).join("\n") if e.backtrace
   end
 end

data/lib/parallel_rspec_simplecov/version.rb

@@ -2,6 +2,6 @@
 
 module ParallelRSpec
   module SimpleCov
-    VERSION = "0.3.0"
+    VERSION = "1.0.0.rc1"
   end
 end

data/sig/parallel_rspec_simplecov.rbs

@@ -1,3 +1,9 @@
-module ParallelRSpec::Simplecov
-  VERSION: String
+module ParallelRSpec
+  module SimpleCov
+    VERSION: String
+
+    def self.simplecov_enabled?: () -> bool
+    def self.start: (?String? profile, ?formatters: Array[untyped]?) ?{ () -> void } -> void
+    def self.collate!: () -> void
+  end
 end

data/spec/parallel_rspec_simplecov_spec.rb

@@ -0,0 +1,119 @@
+RSpec.describe ParallelRSpec::SimpleCov do
+  before do
+    described_class.instance_variable_set(:@simplecov_enabled, false)
+    described_class.instance_variable_set(:@simplecov_base_dir, nil)
+    described_class.instance_variable_set(:@simplecov_formatters, [])
+  end
+
+  describe ".simplecov_enabled?" do
+    it "is false before start is called" do
+      expect(described_class.simplecov_enabled?).to be false
+    end
+  end
+
+  describe ".start" do
+    let(:after_fork_callbacks) { [] }
+    let(:after_suite_hooks) { [] }
+
+    before do
+      allow(::SimpleCov).to receive(:enable_for_subprocesses)
+      allow(::SimpleCov).to receive(:coverage_dir).and_return("coverage")
+      allow(::SimpleCov).to receive(:command_name)
+      allow(::SimpleCov).to receive(:start)
+      allow(::SimpleCov).to receive(:print_error_status=)
+      allow(::SimpleCov).to receive(:formatter)
+      allow(::SimpleCov).to receive(:minimum_coverage)
+
+      allow(ParallelRSpec::Config).to receive(:after_fork) do |&block|
+        after_fork_callbacks << block
+      end
+      allow(RSpec.configuration).to receive(:after).with(:suite) do |&block|
+        after_suite_hooks << block
+      end
+    end
+
+    it "marks simplecov as enabled" do
+      described_class.start
+      expect(described_class).to be_simplecov_enabled
+    end
+
+    it "registers exactly one after_fork callback" do
+      described_class.start
+      expect(after_fork_callbacks.size).to eq(1)
+    end
+
+    it "registers exactly one after(:suite) hook" do
+      described_class.start
+      expect(after_suite_hooks.size).to eq(1)
+    end
+
+    it "is idempotent — repeated calls do not re-register hooks" do
+      described_class.start
+      described_class.start
+      described_class.start
+      expect(after_fork_callbacks.size).to eq(1)
+      expect(after_suite_hooks.size).to eq(1)
+    end
+
+    describe "formatter normalization" do
+      it "treats nil as an empty array" do
+        described_class.start
+        expect(described_class.instance_variable_get(:@simplecov_formatters)).to eq([])
+      end
+
+      it "wraps a single formatter in an array" do
+        formatter = double("formatter")
+        described_class.start(formatters: formatter)
+        expect(described_class.instance_variable_get(:@simplecov_formatters)).to eq([formatter])
+      end
+
+      it "preserves an array of formatters" do
+        formatters = [double("a"), double("b")]
+        described_class.start(formatters: formatters)
+        expect(described_class.instance_variable_get(:@simplecov_formatters)).to eq(formatters)
+      end
+    end
+  end
+
+  describe ".collate!" do
+    let(:base_dir) { Dir.mktmpdir("parallel_rspec_simplecov_spec") }
+
+    before do
+      described_class.instance_variable_set(:@simplecov_base_dir, base_dir)
+      allow(::SimpleCov).to receive(:result).and_return(instance_double(::SimpleCov::Result, format!: nil))
+    end
+
+    after do
+      FileUtils.remove_entry(base_dir)
+    end
+
+    context "when no worker resultsets exist" do
+      it "warns and skips collation" do
+        allow(::SimpleCov).to receive(:collate)
+        expect { described_class.collate! }.to output(/no SimpleCov resultsets found/).to_stderr
+        expect(::SimpleCov).not_to have_received(:collate)
+      end
+    end
+
+    context "when worker resultsets exist" do
+      before do
+        ["rspec_1", "rspec_2"].each do |dir|
+          FileUtils.mkdir_p(File.join(base_dir, dir))
+          File.write(File.join(base_dir, dir, ".resultset.json"), "{}")
+        end
+      end
+
+      it "calls SimpleCov.collate with the discovered resultsets" do
+        captured_paths = nil
+        allow(::SimpleCov).to receive(:collate) { |paths, &_block| captured_paths = paths }
+
+        described_class.collate!
+
+        expect(captured_paths).to match_array([
+          File.join(base_dir, "rspec_1", ".resultset.json"),
+          File.join(base_dir, "rspec_2", ".resultset.json"),
+        ])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "parallel_rspec_simplecov"
+require "fileutils"
+require "tmpdir"
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.expect_with(:rspec) { |c| c.syntax = :expect }
+end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: parallel_rspec_simplecov
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Ben Anderson
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -57,6 +57,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
@@ -65,6 +66,8 @@ files:
 - lib/parallel_rspec_simplecov/simplecov.rb
 - lib/parallel_rspec_simplecov/version.rb
 - sig/parallel_rspec_simplecov.rbs
+- spec/parallel_rspec_simplecov_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/bagedevimo/parallel_rspec_simplecov
 licenses:
 - MIT
@@ -80,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.4.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="