rspec-signal 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +68 -0
  3. data/LICENSE +21 -0
  4. data/README.md +672 -0
  5. data/exe/rspec-signal +11 -0
  6. data/exe/rspec-signal-parallel +52 -0
  7. data/lib/rspec/signal/backtrace/classifier.rb +88 -0
  8. data/lib/rspec/signal/backtrace/frame.rb +31 -0
  9. data/lib/rspec/signal/backtrace/parser.rb +61 -0
  10. data/lib/rspec/signal/backtrace/reducer.rb +244 -0
  11. data/lib/rspec/signal/cluster.rb +68 -0
  12. data/lib/rspec/signal/clusterer.rb +49 -0
  13. data/lib/rspec/signal/configuration.rb +144 -0
  14. data/lib/rspec/signal/failure.rb +62 -0
  15. data/lib/rspec/signal/failure_builder.rb +224 -0
  16. data/lib/rspec/signal/fingerprint.rb +56 -0
  17. data/lib/rspec/signal/formatter.rb +207 -0
  18. data/lib/rspec/signal/group.rb +61 -0
  19. data/lib/rspec/signal/grouper.rb +28 -0
  20. data/lib/rspec/signal/html_summary.rb +224 -0
  21. data/lib/rspec/signal/integrations/capybara.rb +102 -0
  22. data/lib/rspec/signal/message.rb +161 -0
  23. data/lib/rspec/signal/parallel_merger.rb +125 -0
  24. data/lib/rspec/signal/parallel_run.rb +56 -0
  25. data/lib/rspec/signal/project.rb +158 -0
  26. data/lib/rspec/signal/redactor.rb +91 -0
  27. data/lib/rspec/signal/report.rb +88 -0
  28. data/lib/rspec/signal/reporters/full_output.rb +38 -0
  29. data/lib/rspec/signal/reporters/json_report.rb +20 -0
  30. data/lib/rspec/signal/reporters/markdown.rb +271 -0
  31. data/lib/rspec/signal/reporters/related_failures.rb +101 -0
  32. data/lib/rspec/signal/symptom.rb +22 -0
  33. data/lib/rspec/signal/symptoms/exception_class.rb +46 -0
  34. data/lib/rspec/signal/symptoms/http_status.rb +98 -0
  35. data/lib/rspec/signal/symptoms/record.rb +56 -0
  36. data/lib/rspec/signal/symptoms/route.rb +45 -0
  37. data/lib/rspec/signal/symptoms/ruby_error.rb +55 -0
  38. data/lib/rspec/signal/symptoms/selector.rb +72 -0
  39. data/lib/rspec/signal/symptoms.rb +42 -0
  40. data/lib/rspec/signal/version.rb +7 -0
  41. data/lib/rspec/signal/writer.rb +88 -0
  42. data/lib/rspec/signal.rb +156 -0
  43. data/lib/rspec-signal.rb +3 -0
  44. metadata +117 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 865646144fc7ea9cdb902ea7256972fd93b0e5282726195b1bfa60d333de0ac6
4
+ data.tar.gz: d9a8a241a52e38b52d3b5b3f3f0d999323277a12f5b186bab8b04fdc41e36dee
5
+ SHA512:
6
+ metadata.gz: 96e69e65c7994aa49d186d3211b1d38783c65a261ef0ce065dc9fd2507b08be5fad1fa167faf413537d151cc48a07dddcae729a721961ea5ca297890e5af75e3
7
+ data.tar.gz: 4f27334a9cf98604a33229f8c86253c855c92a91ad8f509fab93665a36a9c200340919d8c55337d10e861789e70026bfea094d88b76c26472c0281b789f56c38
data/CHANGELOG.md ADDED
@@ -0,0 +1,68 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project are documented here.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ ## [0.1.0] - 2026-08-26
11
+
12
+ Initial release.
13
+
14
+ ### Added
15
+
16
+ - `rspec-signal-parallel`, a quiet `parallel_tests` wrapper that isolates worker
17
+ JSON by run and test-process number, then globally merges failures into the
18
+ normal top-level artifacts without changing the parallel test exit status.
19
+ - Opt-in quiet agent mode through `--format RSpec::Signal::Formatter`, preserving
20
+ RSpec exit status while suppressing verbose failure rendering.
21
+ - `signal.md` as the primary and sole Markdown artifact, with `full.txt` opt-in.
22
+ - Generic `expected`/`got` HTTP status mismatch recognition when the failing
23
+ expression explicitly reads `response.status`.
24
+
25
+ - **Related failure clustering.** A second, looser grouping layer beside the exact
26
+ signatures. Failures are clustered on one shared diagnostic symptom — the HTTP
27
+ status that actually came back, a missing Capybara selector, a route that does
28
+ not exist, an ActiveRecord model or schema shape, an undefined method and its
29
+ receiver, an uninitialized constant, or a namespaced exception class with nothing
30
+ finer to go on. Reported as a short `## Related failures` section, in `signal.json`
31
+ as `related`, and counted on the terminal summary. Exact signatures remain the
32
+ authoritative grouping; a cluster only ever claims a likely common cause.
33
+ - A cluster is only reported when it spans more than one exact signature, so the
34
+ layer never restates what the signature section already said.
35
+ - **HTML response reduction.** When a failure's actual value is a large HTML
36
+ document — most often a Rails exception page — the markup is replaced by its
37
+ size, `<title>`, headings and leading visible text. The expected value is left
38
+ untouched, and the original is still written verbatim to `full.txt`.
39
+ - `config.relate_failures`, `config.max_clusters`, `config.max_cluster_specs`,
40
+ `config.reduce_html` and `config.max_html_chars`.
41
+
42
+ - `RSpec::Signal::Formatter`, installed automatically by `require "rspec/signal"`,
43
+ which writes a compact failure report without displacing RSpec's default
44
+ terminal formatter.
45
+ - Three-way backtrace classification (project / library / framework) with
46
+ first-party detection that covers Bundler `path:` gems and local Rails engines.
47
+ - Backtrace reduction that keeps every first-party frame plus the library frames
48
+ adjacent to them, and never produces an empty trace.
49
+ - Deterministic failure fingerprinting and grouping on exception class,
50
+ normalized message, culprit frame and application context.
51
+ - Artifacts in `tmp/rspec-signal/`: `signal.md`, `signal.json`, `full.txt`, and a
52
+ `.gitignore`. Artifacts are removed when a run has no failures.
53
+ - Exception `cause` chains folded into the failure message, including the
54
+ first-party frame each cause came from.
55
+ - Recovery of message and backtrace for `:aggregate_failures`, which RSpec exposes
56
+ only through formatter-only callbacks.
57
+ - Capybara and Rails system-test diagnostics: URL, path, page title, status code,
58
+ browser console output, and the screenshot path Rails writes.
59
+ - Credential scrubbing for auth headers, credential-shaped assignments, URL
60
+ userinfo, and well-known token formats, with hooks for project-specific patterns.
61
+
62
+ ### Changed
63
+
64
+ - Diff hunk headers and HTML summary sizes are normalized out of the fingerprint,
65
+ so a page one line longer is no longer a different failure.
66
+
67
+ [Unreleased]: https://github.com/SilenceDogood1984/rspec-signal/compare/v0.1.0...HEAD
68
+ [0.1.0]: https://github.com/SilenceDogood1984/rspec-signal/releases/tag/v0.1.0
data/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Chad Snow
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.