parallel_coverage 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bca323f9f064ab1987f900f126efc03924b10c58344ee26450f1e500afba5347
-  data.tar.gz: f9976e4d96fd315332ea2302710db8453296212b90fcd3cd9ef7232904c2bc84
+  metadata.gz: fc5d1cd0fa84d14a150c10599dc01ab5756b7da9ed882a7d2605e244bf40aaf4
+  data.tar.gz: 8a5806d245400211adc8db05357d3b4f17d696ae38a4d786a1c8c9415fc67eeb
 SHA512:
-  metadata.gz: a255cf44d32dc47711d13d8849cf2723d1bb49830d74febb80190c1ff5099486a0e4350c38710e755162225bb717d5c8364cc0edeebf2491da1df20819758fce
-  data.tar.gz: fed394584759cb564be64eb19327298e1f20bfb38300a833b492bc7ade72a9c53c566fc5d120940d5f65f23eba03debe1f8af6624df8c8ead30526ab8fba4f8a
+  metadata.gz: f3b33c3dd152355c254b0d6065bc98b0944ea71b9e5fe5fb211cfcc54afe98cc905343bda7a8f5e70da291e44ec7f107a936784a6ed34e1ecbf1480b8088c56f
+  data.tar.gz: e142a278a4e47029f0337f18333079703f40e3d484ecfa730e020a48dc95a5603ac59e1fa52daa04413e86a4b260cef46521ed2a9bc5c81816f01e9df91e3e80

data/README.md

@@ -0,0 +1,68 @@
+# Parallel Coverage
+Rails engine that gets SimpleCov up and running for you in a parallelized test suite.
+
+This gem sets an initializer to run the coverage measurement instead of running it directly at the beginning of the tests themselves, so it is more suitable for a fully featured tests suite (i.e. with integration tests) rather than unit tests only.
+
+## Installation
+Add this lines to your application's Gemfile:
+```ruby
+group :test do
+  gem 'parallel_coverage'
+end
+```
+
+## Usage
+Run your tests through CLI with the `COVERAGE` environment variable set to true:
+```
+COVERAGE=true bin/rails test:system test
+```
+
+The default SimpleCov config passed to the `SimpleCov.start 'rails'` call is the following:
+```ruby
+  track_files 'app/**/*.rb'
+
+  add_filter '/bin/'
+  add_filter '/config/'
+  add_filter '/db/'
+  add_filter '/lib/'
+  add_filter '/test/'
+  add_filter 'vendor'
+  add_filter 'node_modules'
+  add_filter '/Rakefile'
+  add_filter '/app/controllers/admin/'
+
+  add_group 'Services', 'app/services'
+```
+We assume that admin controllers are not critical enought to be tracked in the coverage, but if you need to, you can override those settings by adding a `config/initializers/coverage.rb` with:
+```ruby
+ParallelCoverage.simple_cov_config = proc do
+  add_filter '/my/awesome/filter1'
+  add_filter '/my/awesome/filter2'
+  ...
+end
+```
+Keep in mind that by doing this you will totally disable the default config, so you'll have to put it back in your `config/initializers/coverage.rb` if you want to extend the config.
+
+## Release
+Before all, configure your credentials for RubyGems :
+
+ 1. Login to RubyGems
+ 2. Create a token which have rights to push gems (https://rubygems.org/profile/api_keys)
+ 3. Add it to your config:
+   ```
+   echo ":rubygems_api_key: YOUR_API_KEY" >> ~/.gem/credentials
+   ```
+
+You just have to run default command:
+```
+rake release
+```
+
+Else, to publish a new version of this gem, you'll need to build it with
+`gem build parallel_coverage.gemspec` and then push it manually:
+```
+gem push parallel_coverage-X.X.X.gem
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). Copyright 2021 Codeur SARL.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/parallel_coverage.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'parallel_coverage/version'
+require 'parallel_coverage/engine'
+
+class ParallelCoverage
+  cattr_accessor :simple_cov_config
+
+  def self.run_coverage
+    return unless ENV['COVERAGE']
+
+    require 'simplecov'
+
+    SimpleCov.start 'rails', &simple_cov_config
+  end
+
+  def self.parallelize_coverage
+    return unless ENV['COVERAGE']
+
+    ActiveSupport::TestCase.parallelize_setup do |worker|
+      SimpleCov.command_name "#{SimpleCov.command_name}-#{worker}"
+    end
+
+    ActiveSupport::TestCase.parallelize_teardown do
+      SimpleCov.result
+    end
+  end
+end
+
+ParallelCoverage.simple_cov_config = proc do
+  track_files 'app/**/*.rb'
+
+  add_filter '/bin/'
+  add_filter '/config/'
+  add_filter '/db/'
+  add_filter '/lib/'
+  add_filter '/test/'
+  add_filter 'vendor'
+  add_filter 'node_modules'
+  add_filter '/Rakefile'
+  add_filter '/app/controllers/admin/'
+  add_filter '/app/presenters/admin/'
+  add_filter '/app/decorators/admin/'
+  add_filter '/app/helpers/admin/'
+
+  add_group 'Services', 'app/services'
+end

data/lib/parallel_coverage/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class ParallelCoverage
+  class Engine < ::Rails::Engine
+    initializer 'parallel_coverage.run', after: :load_config_initializers do
+      ParallelCoverage.run_coverage
+    end
+
+    initializer 'parallel_coverage.report' do
+      ParallelCoverage.parallelize_coverage
+    end
+  end
+end

data/lib/parallel_coverage/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ParallelCoverage
+  VERSION = '0.1.5'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parallel_coverage
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Dev-team Codeur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-17 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,7 +59,12 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- README.md
+- Rakefile
+- lib/parallel_coverage.rb
+- lib/parallel_coverage/engine.rb
+- lib/parallel_coverage/version.rb
 homepage: https://github.com/codeur/parallel_coverage
 licenses:
 - MIT
@@ -80,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.7
 signing_key: 
 specification_version: 4
 summary: Setup code coverage for parallelized rails tests