Class: Evilution::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/evilution/config.rb

Defined Under Namespace

Modules: Builders, EnvLoader, FileLoader, Sources, Validators

Constant Summary collapse

CONFIG_FILES = 
%w[.evilution.yml config/evilution.yml].freeze
DEFAULTS = 
{
  timeout: 30, format: :text, target: nil, min_score: 0.0, integration: :rspec,
  verbose: false, quiet: false, jobs: 1, fail_fast: nil, baseline: true,
  isolation: :auto, incremental: false, suggest_tests: false, progress: true,
  save_session: false, line_ranges: {}, spec_files: [], ignore_patterns: [],
  show_disabled: false, baseline_session: nil, skip_heredoc_literals: false,
  related_specs_heuristic: false, fallback_to_full_suite: false, preload: nil,
  spec_mappings: {}, spec_pattern: nil, example_targeting: true,
  example_targeting_fallback: :full_file,
  example_targeting_cache: { max_files: 50, max_blocks: 10_000 },
  quiet_children: false, quiet_children_dir: "tmp/evilution_children",
  profile: :default
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**options) ⇒ Config

Returns a new instance of Config.



34
35
36
37
38
39
 
# File 'lib/evilution/config.rb', line 34

def initialize(**options)
  skip_file = options.delete(:skip_config_file) ? true : false
  merged = Sources.merge(explicit: options, skip_file: skip_file)
  assign_attributes(merged)
  freeze
end

Instance Attribute Details

#baseline ⇒ Object (readonly)

Returns the value of attribute baseline.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def baseline
  @baseline
end

#baseline_session ⇒ Object (readonly)

Returns the value of attribute baseline_session.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def baseline_session
  @baseline_session
end

#example_targeting ⇒ Object (readonly)

Returns the value of attribute example_targeting.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def example_targeting
  @example_targeting
end

#example_targeting_cache ⇒ Object (readonly)

Returns the value of attribute example_targeting_cache.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def example_targeting_cache
  @example_targeting_cache
end

#example_targeting_fallback ⇒ Object (readonly)

Returns the value of attribute example_targeting_fallback.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def example_targeting_fallback
  @example_targeting_fallback
end

#fail_fast ⇒ Object (readonly)

Returns the value of attribute fail_fast.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def fail_fast
  @fail_fast
end

#fallback_to_full_suite ⇒ Object (readonly)

Returns the value of attribute fallback_to_full_suite.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def fallback_to_full_suite
  @fallback_to_full_suite
end

#format ⇒ Object (readonly)

Returns the value of attribute format.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def format
  @format
end

#hooks ⇒ Object (readonly)

Returns the value of attribute hooks.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def hooks
  @hooks
end

#ignore_patterns ⇒ Object (readonly)

Returns the value of attribute ignore_patterns.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def ignore_patterns
  @ignore_patterns
end

#incremental ⇒ Object (readonly)

Returns the value of attribute incremental.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def incremental
  @incremental
end

#integration ⇒ Object (readonly)

Returns the value of attribute integration.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def integration
  @integration
end

#isolation ⇒ Object (readonly)

Returns the value of attribute isolation.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def isolation
  @isolation
end

#jobs ⇒ Object (readonly)

Returns the value of attribute jobs.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def jobs
  @jobs
end

#line_ranges ⇒ Object (readonly)

Returns the value of attribute line_ranges.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def line_ranges
  @line_ranges
end

#min_score ⇒ Object (readonly)

Returns the value of attribute min_score.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def min_score
  @min_score
end

#preload ⇒ Object (readonly)

Returns the value of attribute preload.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def preload
  @preload
end

#profile ⇒ Object (readonly)

Returns the value of attribute profile.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def profile
  @profile
end

#progress ⇒ Object (readonly)

Returns the value of attribute progress.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def progress
  @progress
end

#quiet ⇒ Object (readonly)

Returns the value of attribute quiet.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def quiet
  @quiet
end

#quiet_children ⇒ Object (readonly)

Returns the value of attribute quiet_children.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def quiet_children
  @quiet_children
end

#quiet_children_dir ⇒ Object (readonly)

Returns the value of attribute quiet_children_dir.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def quiet_children_dir
  @quiet_children_dir
end

#related_specs_heuristic ⇒ Object (readonly)

Returns the value of attribute related_specs_heuristic.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def related_specs_heuristic
  @related_specs_heuristic
end

#save_session ⇒ Object (readonly)

Returns the value of attribute save_session.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def save_session
  @save_session
end

#show_disabled ⇒ Object (readonly)

Returns the value of attribute show_disabled.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def show_disabled
  @show_disabled
end

#skip_heredoc_literals ⇒ Object (readonly)

Returns the value of attribute skip_heredoc_literals.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def skip_heredoc_literals
  @skip_heredoc_literals
end

#spec_files ⇒ Object (readonly)

Returns the value of attribute spec_files.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def spec_files
  @spec_files
end

#spec_mappings ⇒ Object (readonly)

Returns the value of attribute spec_mappings.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def spec_mappings
  @spec_mappings
end

#spec_pattern ⇒ Object (readonly)

Returns the value of attribute spec_pattern.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def spec_pattern
  @spec_pattern
end

#spec_selector ⇒ Object (readonly)

Returns the value of attribute spec_selector.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def spec_selector
  @spec_selector
end

#suggest_tests ⇒ Object (readonly)

Returns the value of attribute suggest_tests.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def suggest_tests
  @suggest_tests
end

#target ⇒ Object (readonly)

Returns the value of attribute target.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def target
  @target
end

#target_files ⇒ Object (readonly)

Returns the value of attribute target_files.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def target_files
  @target_files
end

#timeout ⇒ Object (readonly)

Returns the value of attribute timeout.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def timeout
  @timeout
end

#verbose ⇒ Object (readonly)

Returns the value of attribute verbose.



24
25
26
 
# File 'lib/evilution/config.rb', line 24

def verbose
  @verbose
end

Class Method Details

.default_template ⇒ Object

Generates a default config file template.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/evilution/config.rb', line 110

def self.default_template
  <<~YAML
    # Evilution configuration
    # See: https://github.com/marinazzio/evilution

    # Per-mutation timeout in seconds (default: 30)
    # timeout: 30

    # Output format: text or json (default: text)
    # format: text

    # Minimum mutation score to pass (0.0 to 1.0, default: 0.0)
    # min_score: 0.0

    # Test integration: rspec, minitest (default: rspec)
    # integration: rspec

    # Number of parallel workers (default: 1)
    # jobs: 1

    # Stop after N surviving mutants (default: disabled)
    # fail_fast: 1

    # Generate concrete test code in suggestions, matching integration (default: false)
    # suggest_tests: false

    # Skip all string literal mutations inside heredocs (default: false).
    # Useful for Rails apps where heredoc content (SQL, templates, fixtures)
    # rarely has meaningful test coverage and produces noisy survivors.
    # skip_heredoc_literals: true

    # Opt into the RelatedSpecHeuristic, which appends request/integration/
    # feature/system specs for mutations that touch `.includes(...)` calls
    # (default: false). Off by default because the fan-out can be heavy and
    # push runs over the per-mutation timeout. Enable if you need coverage
    # of N+1 regressions that only surface in higher-level specs.
    # related_specs_heuristic: true

    # When no matching spec resolves for a mutation's source file, the
    # default is to skip that mutation and mark it :unresolved in the
    # report (a coverage gap signal). Set to true to fall back to running
    # the entire test suite for such mutations instead (slow, high memory).
    # fallback_to_full_suite: false

    # Preload file required in the parent process before forking workers.
    # For Rails projects, the autodetect chain tries (in order):
    # spec/rails_helper.rb -> spec/spec_helper.rb -> test/test_helper.rb
    # when isolation resolves to :fork. Set to false to disable.
    # preload: spec/rails_helper.rb # or spec/spec_helper.rb, test/test_helper.rb

    # Hooks: Ruby files returning a Proc, keyed by lifecycle event
    # hooks:
    #   worker_process_start: config/evilution_hooks/worker_start.rb
    #   mutation_insert_pre: config/evilution_hooks/mutation_pre.rb

    # Per-mutation example targeting (default: true). When enabled, Evilution
    # parses resolved spec files and restricts each mutation run to examples
    # whose bodies reference the mutated method/class token. Set to false
    # to run every example in the resolved spec files. You can also disable
    # without editing the file by exporting EV_DISABLE_EXAMPLE_TARGETING=1.
    # example_targeting: true

    # Behavior when targeting finds no matching example (default: full_file).
    # full_file  - run every example in the resolved spec files
    # unresolved - mark the mutation :unresolved and skip
    # example_targeting_fallback: full_file

    # LRU cache bounds for the spec AST parser that powers example targeting.
    # example_targeting_cache:
    #   max_files: 50
    #   max_blocks: 10000

    # AST patterns to skip during mutation generation (default: [])
    # See docs/ast_pattern_syntax.md for pattern syntax
    # ignore_patterns:
    #   - "call{name=info, receiver=call{name=logger}}"
    #   - "call{name=debug|warn}"

    # Operator profile: default or strict (default: default).
    # strict adds aggressive truthiness mutators (e.g. replaces
    # `x.predicate?` with `nil`) intended for pre-merge audits.
    # profile: default
  YAML
end

.file_options ⇒ Object 



105
106
107
 
# File 'lib/evilution/config.rb', line 105

def self.file_options
  FileLoader.load
end

Instance Method Details

#baseline? ⇒ Boolean

Returns:

  • (Boolean) 


65
66
67
 
# File 'lib/evilution/config.rb', line 65

def baseline?
  baseline
end

#example_targeting? ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/evilution/config.rb', line 97

def example_targeting?
  example_targeting
end

#fail_fast? ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
 
# File 'lib/evilution/config.rb', line 61

def fail_fast?
  !fail_fast.nil?
end

#fallback_to_full_suite? ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/evilution/config.rb', line 101

def fallback_to_full_suite?
  fallback_to_full_suite
end

#html? ⇒ Boolean

Returns:

  • (Boolean) 


49
50
51
 
# File 'lib/evilution/config.rb', line 49

def html?
  format == :html
end

#incremental? ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/evilution/config.rb', line 69

def incremental?
  incremental
end

#json? ⇒ Boolean

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/evilution/config.rb', line 41

def json?
  format == :json
end

#line_ranges? ⇒ Boolean

Returns:

  • (Boolean) 


53
54
55
 
# File 'lib/evilution/config.rb', line 53

def line_ranges?
  !line_ranges.empty?
end

#progress? ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/evilution/config.rb', line 77

def progress?
  progress
end

#related_specs_heuristic? ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/evilution/config.rb', line 93

def related_specs_heuristic?
  related_specs_heuristic
end

#save_session? ⇒ Boolean

Returns:

  • (Boolean) 


81
82
83
 
# File 'lib/evilution/config.rb', line 81

def save_session?
  save_session
end

#show_disabled? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/evilution/config.rb', line 85

def show_disabled?
  show_disabled
end

#skip_heredoc_literals? ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/evilution/config.rb', line 89

def skip_heredoc_literals?
  skip_heredoc_literals
end

#suggest_tests? ⇒ Boolean

Returns:

  • (Boolean) 


73
74
75
 
# File 'lib/evilution/config.rb', line 73

def suggest_tests?
  suggest_tests
end

#target? ⇒ Boolean

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/evilution/config.rb', line 57

def target?
  !target.nil?
end

#text? ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
 
# File 'lib/evilution/config.rb', line 45

def text?
  format == :text
end