Class: RSpec::Signal::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/rspec/signal/configuration.rb

Overview

Everything tunable, with defaults chosen to need no tuning.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



38
39
40
41
42
43
44
45
46
 
# File 'lib/rspec/signal/configuration.rb', line 38

def initialize
  default_budgets
  default_artifacts
  default_classification

  @output_dir       = ENV.fetch("RSPEC_SIGNAL_OUTPUT_DIR", "tmp/rspec-signal")
  @enabled          = !truthy?(ENV.fetch("RSPEC_SIGNAL_DISABLE", nil))
  @terminal_summary = true
end

Instance Attribute Details

#capture_capybara ⇒ Object

Behaviour.



33
34
35
 
# File 'lib/rspec/signal/configuration.rb', line 33

def capture_capybara
  @capture_capybara
end

#capture_page_html ⇒ Object

Behaviour.



33
34
35
 
# File 'lib/rspec/signal/configuration.rb', line 33

def capture_page_html
  @capture_page_html
end

#enabled ⇒ Object

Behaviour.



33
34
35
 
# File 'lib/rspec/signal/configuration.rb', line 33

def enabled
  @enabled
end

#extra_first_party ⇒ Object

Classification.



36
37
38
 
# File 'lib/rspec/signal/configuration.rb', line 36

def extra_first_party
  @extra_first_party
end

#fallback_frames ⇒ Object

Backtrace reduction budgets.



11
12
13
 
# File 'lib/rspec/signal/configuration.rb', line 11

def fallback_frames
  @fallback_frames
end

#framework_patterns ⇒ Object

Classification.



36
37
38
 
# File 'lib/rspec/signal/configuration.rb', line 36

def framework_patterns
  @framework_patterns
end

#ignore_patterns ⇒ Object

Classification.



36
37
38
 
# File 'lib/rspec/signal/configuration.rb', line 36

def ignore_patterns
  @ignore_patterns
end

#max_affected_examples ⇒ Object

Report budgets. max_affected_examples caps the per-group list of other failing examples; max_groups caps how many signatures are rendered in full (nil means all).



20
21
22
 
# File 'lib/rspec/signal/configuration.rb', line 20

def max_affected_examples
  @max_affected_examples
end

#max_cluster_specs ⇒ Object

Related-failure clustering. relate_failures turns the whole layer off; the budgets cap how much of it reaches the Markdown report.



24
25
26
 
# File 'lib/rspec/signal/configuration.rb', line 24

def max_cluster_specs
  @max_cluster_specs
end

#max_clusters ⇒ Object

Related-failure clustering. relate_failures turns the whole layer off; the budgets cap how much of it reaches the Markdown report.



24
25
26
 
# File 'lib/rspec/signal/configuration.rb', line 24

def max_clusters
  @max_clusters
end

#max_diff_lines ⇒ Object

Message budgets. max_html_chars is the smallest HTML blob replaced by a summary; reduce_html turns that off entirely.



15
16
17
 
# File 'lib/rspec/signal/configuration.rb', line 15

def max_diff_lines
  @max_diff_lines
end

#max_external_context ⇒ Object

Backtrace reduction budgets.



11
12
13
 
# File 'lib/rspec/signal/configuration.rb', line 11

def max_external_context
  @max_external_context
end

#max_frames ⇒ Object

Backtrace reduction budgets.



11
12
13
 
# File 'lib/rspec/signal/configuration.rb', line 11

def max_frames
  @max_frames
end

#max_groups ⇒ Object

Report budgets. max_affected_examples caps the per-group list of other failing examples; max_groups caps how many signatures are rendered in full (nil means all).



20
21
22
 
# File 'lib/rspec/signal/configuration.rb', line 20

def max_groups
  @max_groups
end

#max_html_chars ⇒ Object

Message budgets. max_html_chars is the smallest HTML blob replaced by a summary; reduce_html turns that off entirely.



15
16
17
 
# File 'lib/rspec/signal/configuration.rb', line 15

def max_html_chars
  @max_html_chars
end

#max_message_lines ⇒ Object

Message budgets. max_html_chars is the smallest HTML blob replaced by a summary; reduce_html turns that off entirely.



15
16
17
 
# File 'lib/rspec/signal/configuration.rb', line 15

def max_message_lines
  @max_message_lines
end

#max_project_frames ⇒ Object

Backtrace reduction budgets.



11
12
13
 
# File 'lib/rspec/signal/configuration.rb', line 11

def max_project_frames
  @max_project_frames
end

#output_dir ⇒ Object

Where artifacts are written, relative to the project root unless absolute.



8
9
10
 
# File 'lib/rspec/signal/configuration.rb', line 8

def output_dir
  @output_dir
end

#project_root ⇒ Object

Classification.



36
37
38
 
# File 'lib/rspec/signal/configuration.rb', line 36

def project_root
  @project_root
end

#redact ⇒ Object

Secret scrubbing.



27
28
29
 
# File 'lib/rspec/signal/configuration.rb', line 27

def redact
  @redact
end

#redaction_filter ⇒ Object

Secret scrubbing.



27
28
29
 
# File 'lib/rspec/signal/configuration.rb', line 27

def redaction_filter
  @redaction_filter
end

#redaction_patterns ⇒ Object

Secret scrubbing.



27
28
29
 
# File 'lib/rspec/signal/configuration.rb', line 27

def redaction_patterns
  @redaction_patterns
end

#reduce_html ⇒ Object

Message budgets. max_html_chars is the smallest HTML blob replaced by a summary; reduce_html turns that off entirely.



15
16
17
 
# File 'lib/rspec/signal/configuration.rb', line 15

def reduce_html
  @reduce_html
end

#relate_failures ⇒ Object

Related-failure clustering. relate_failures turns the whole layer off; the budgets cap how much of it reaches the Markdown report.



24
25
26
 
# File 'lib/rspec/signal/configuration.rb', line 24

def relate_failures
  @relate_failures
end

#terminal_summary ⇒ Object

Behaviour.



33
34
35
 
# File 'lib/rspec/signal/configuration.rb', line 33

def terminal_summary
  @terminal_summary
end

#write_full ⇒ Object

Artifacts.



30
31
32
 
# File 'lib/rspec/signal/configuration.rb', line 30

def write_full
  @write_full
end

#write_gitignore ⇒ Object

Artifacts.



30
31
32
 
# File 'lib/rspec/signal/configuration.rb', line 30

def write_gitignore
  @write_gitignore
end

#write_json ⇒ Object

Artifacts.



30
31
32
 
# File 'lib/rspec/signal/configuration.rb', line 30

def write_json
  @write_json
end

Instance Method Details

#classifier ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/rspec/signal/configuration.rb', line 74

def classifier
  @classifier ||= Backtrace::Classifier.new(
    project: project,
    framework_patterns: framework_patterns,
    ignore_patterns: ignore_patterns
  )
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


48
 
# File 'lib/rspec/signal/configuration.rb', line 48

def enabled? = !!@enabled

#html_threshold ⇒ Object

Nil means "leave HTML alone", which is what Message expects.



52
 
# File 'lib/rspec/signal/configuration.rb', line 52

def html_threshold = reduce_html ? max_html_chars : nil

#output_path ⇒ Object 



58
59
60
 
# File 'lib/rspec/signal/configuration.rb', line 58

def output_path
  @output_path ||= File.expand_path(@output_dir, root)
end

#project ⇒ Object 



62
63
64
 
# File 'lib/rspec/signal/configuration.rb', line 62

def project
  @project ||= Project.new(root: root, extra_first_party: extra_first_party)
end

#redact? ⇒ Boolean

Returns:

  • (Boolean) 


49
 
# File 'lib/rspec/signal/configuration.rb', line 49

def redact?  = !!@redact

#redactor ⇒ Object 



66
67
68
69
70
71
72
 
# File 'lib/rspec/signal/configuration.rb', line 66

def redactor
  @redactor ||= Redactor.new(
    enabled: redact?,
    extra_patterns: redaction_patterns,
    filter: redaction_filter
  )
end

#reducer ⇒ Object 



82
83
84
85
86
87
88
89
 
# File 'lib/rspec/signal/configuration.rb', line 82

def reducer
  @reducer ||= Backtrace::Reducer.new(
    max_frames: max_frames,
    max_external_context: max_external_context,
    max_project_frames: max_project_frames,
    fallback_frames: fallback_frames
  )
end

#reset_memoized! ⇒ Object

Memoized collaborators must be rebuilt if the user reconfigures.



92
93
94
95
 
# File 'lib/rspec/signal/configuration.rb', line 92

def reset_memoized!
  @root = @output_path = @project = @redactor = @classifier = @reducer = nil
  self
end

#root ⇒ Object 



54
55
56
 
# File 'lib/rspec/signal/configuration.rb', line 54

def root
  @root ||= File.expand_path(@project_root || default_root)
end