Module: SimpleCov::Parallel

Defined in:
lib/simplecov/parallel.rb,
lib/simplecov/parallel/version.rb,
lib/simplecov/parallel/adapter/base.rb,
lib/simplecov/parallel/adapter/circleci.rb

Overview

Provides parallelism support for SimpleCov.

Defined Under Namespace

Modules: Adapter, Version

Constant Summary collapse

NoAdapterAvailableError = 
Class.new(StandardError)

Class Method Summary collapse

Class Method Details

.activate ⇒ Object

Activates SimpleCov parallelism support for the current environment. This modifies some SimpleCov configuration options so you should configure SimpleCov before invoking this method. When no adapter is available in the current environment, it does nothing.

Examples:

require 'simplecov/parallel'
SimpleCov::Parallel.activate
SimpleCov.start

See Also:



21
22
23
24
 
# File 'lib/simplecov/parallel.rb', line 21

def activate
  activate!
rescue NoAdapterAvailableError # rubocop:disable Lint/HandleExceptions
end

.activate! ⇒ Object

Activates SimpleCov parallelism support for the current environment. This modifies some SimpleCov configuration options so you should configure SimpleCov before invoking this method.

Examples:

require 'simplecov/parallel'
SimpleCov::Parallel.activate! if ENV['CIRCLECI']
SimpleCov.start

Raises:

  • NoAdapterAvailableError when no adapter is available in the current environment

See Also:



38
39
40
41
42
43
44
45
 
# File 'lib/simplecov/parallel.rb', line 38

def activate!
  if available_adapter_classes.empty?
    raise NoAdapterAvailableError,
          'No SimpleCov::Parallel adapter is available in the current environment.'
  end

  available_adapter_classes.first.new.activate
end