Class: Mutant::Config Private

Inherits:
Object
  • Object
show all
Includes:
Adamantium::Flat
Defined in:
lib/mutant.rb,
lib/mutant/config.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Standalone configuration of a mutant execution.

Does not reference any “external” volatile state. The configuration applied to current environment is being represented by the Mutant::Env object.

Defined Under Namespace

Classes: CoverageCriteria

Constant Summary collapse

DEFAULT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

new(
  coverage_criteria: Config::CoverageCriteria::EMPTY,
  expression_parser: Expression::Parser.new([
    Expression::Method,
    Expression::Methods,
    Expression::Namespace::Exact,
    Expression::Namespace::Recursive
  ]),
  fail_fast:         false,
  includes:          EMPTY_ARRAY,
  integration:       nil,
  isolation:         Mutant::Isolation::Fork.new(WORLD),
  jobs:              nil,
  matcher:           Matcher::Config::DEFAULT,
  mutation_timeout:  nil,
  reporter:          Reporter::CLI.build(WORLD.stdout),
  requires:          EMPTY_ARRAY,
  zombie:            false
)
MORE_THAN_ONE_CONFIG_FILE =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

<<~'MESSAGE'
  Found more than one candidate for use as implicit config file: %s
MESSAGE
CANDIDATES =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

%w[
  .mutant.yml
  config/mutant.yml
  mutant.yml
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.env ⇒ Config

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The configuration from the environment

Returns:



152
153
154
 
# File 'lib/mutant/config.rb', line 152

def self.env
  DEFAULT.with(jobs: Etc.nprocessors)
end

.load_config_file(world) ⇒ Either<String,Config>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Load config file

Parameters:

Returns:



118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/mutant/config.rb', line 118

def self.load_config_file(world)
  config = DEFAULT
  files = CANDIDATES.map(&world.pathname.public_method(:new)).select(&:readable?)

  if files.one?
    load_contents(files.first).fmap(&config.public_method(:with))
  elsif files.empty?
    Either::Right.new(config)
  else
    Either::Left.new(MORE_THAN_ONE_CONFIG_FILE % files.join(', '))
  end
end

Instance Method Details

#expand_defaults ⇒ Config

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Expand config with defaults

Returns:



134
135
136
137
138
139
 
# File 'lib/mutant/config.rb', line 134

def expand_defaults
  with(
    coverage_criteria: CoverageCriteria::DEFAULT.merge(coverage_criteria),
    jobs:              jobs || 1
  )
end

#merge(other) ⇒ Config

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Merge with other config

rubocop:disable Metrics/AbcSize rubocop:disable Metrics/MethodLength

Parameters:

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/mutant/config.rb', line 96

def merge(other)
  other.with(
    coverage_criteria: coverage_criteria.merge(other.coverage_criteria),
    fail_fast:         fail_fast || other.fail_fast,
    includes:          includes + other.includes,
    jobs:              other.jobs || jobs,
    integration:       other.integration || integration,
    mutation_timeout:  other.mutation_timeout || mutation_timeout,
    matcher:           matcher.merge(other.matcher),
    requires:          requires + other.requires,
    zombie:            zombie || other.zombie
  )
end