parallel_coverage 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bca323f9f064ab1987f900f126efc03924b10c58344ee26450f1e500afba5347
-  data.tar.gz: f9976e4d96fd315332ea2302710db8453296212b90fcd3cd9ef7232904c2bc84
+  metadata.gz: 300ab57d8a943ab4515cd04cd1e24494139dd1af19f644520bccc3b112359429
+  data.tar.gz: f4687a0dc707a693a20856a758d9b5aeace26a918546e7f0e818842ef9248ed1
 SHA512:
-  metadata.gz: a255cf44d32dc47711d13d8849cf2723d1bb49830d74febb80190c1ff5099486a0e4350c38710e755162225bb717d5c8364cc0edeebf2491da1df20819758fce
-  data.tar.gz: fed394584759cb564be64eb19327298e1f20bfb38300a833b492bc7ade72a9c53c566fc5d120940d5f65f23eba03debe1f8af6624df8c8ead30526ab8fba4f8a
+  metadata.gz: 97f762bcbba8582dd43835bf0e8cb8f7f1a5430db752d7d5a77f1da509513045a3f93c5ff2ee8005c03e87a413dc7099ea57019b54cf0077eafe8a39c5c19e5b
+  data.tar.gz: 81a1af3e8aed3ec0b4546e7216672d1e4c8530dd421bbde57117fc79b3380970434bb6f00991c893ade57124c0bc49cec7d8ff589511d3c06a46ba689eaca0f4

data/README.md

@@ -0,0 +1,59 @@
+# 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 '**/*.rb'
+  add_filter '/bin/'
+  add_filter '/config/'
+  add_filter '/db/'
+  add_filter '/lib/'
+  add_filter '/test/'
+  add_filter '/Rakefile'
+  add_filter '/app/controllers/admin'
+```
+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
+```
+
+## Release (for Codeur dev team members)
+Before all, configure your credentials for `dev-codeur` RubyGems account:
+
+ 1. Login to RubyGems with the `dev-codeur` account
+ 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
+```

data/Rakefile

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

data/lib/parallel_coverage.rb

@@ -0,0 +1,40 @@
+# 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 '**/*.rb'
+  add_filter '/bin/'
+  add_filter '/config/'
+  add_filter '/db/'
+  add_filter '/lib/'
+  add_filter '/test/'
+  add_filter '/Rakefile'
+  # * Remove admin controllers from coverage
+  add_filter '/app/controllers/admin'
+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.1'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: parallel_coverage
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dev-team Codeur
@@ -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