branchproof 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c5027104f6aeb6181f75ccc463ef93d6cf78489ba28e8c6824308d13546a5586
+  data.tar.gz: 442f07bf0dc87e1f3ed5bcc371d130da1612afd91f69837f8869b81fdf7c95f6
+SHA512:
+  metadata.gz: 707ca0fff8681d36f7a0e635513c3914ed403ddaf0e96c1ddec646574abee54daf50e60f05c16a79d2b522a7f568a09ee99da3807161dd471646291442f80323
+  data.tar.gz: 3c446a3c71dd5a89cc0f12fa77ef61ef96a339a81bffd744dad86db4d2d7044f28c34a294342b29868b2ed848be1892892d8e28eff29f4e55f9b72a4ee57be62

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+## [Unreleased]
+
+## [0.2.0] - 2026-09-09
+
+- Prepared the initial public-release candidate.
+- Embedded evidence snapshots now report the package version used to produce them.
+
+- Added the `mcdc analyze` command for one serial Minitest run.
+- Added Levels 1–3 reports for observations, supporting sets, and MC/DC
+  independence evidence in terminal and JSON formats.
+- Added bounded analysis limits and explicit diagnostics for unsupported or
+  incomplete evidence.
+- Added automatic and explicit Ruby and Rails project selection for
+  `mcdc analyze`.
+- Added deterministic Minitest discovery for both `*_test.rb` and `test_*.rb`
+  files.
+- Added isolated Rails test boot with serial, test-environment defaults and
+  Rails project metadata in reports.
+- Added support documentation for plain Ruby and Rails projects, including
+  the tested Rails 8.1 integration boundary.
+- Added support for ordinary Ruby ternary (`condition ? left : right`)
+  predicates, including existing `&&`/`||` condition trees and predicate
+  outcome semantics independent of the selected branch value.
+- Improved terminal reports with readable decision and condition labels,
+  test names, compact collision-safe IDs, witness and constraint details, and
+  named supporting-test sets while preserving the full JSON report.
+- Fixed nested predicate selection so executed ternary decisions are recorded
+  across all nested levels without instrumenting unchosen branches.
+- Changed the project license to Apache-2.0; packaged `LICENSE.txt` and
+  `NOTICE`.
+- Renamed the gem and public namespace to `branchproof` and `Branchproof`;
+  retained `mcdc` and `MCDC` as compatibility surfaces.
+
+## [0.1.0] - 2026-09-09 (unpublished internal milestone)
+
+- Initial analytical core and Minitest instrumentation milestone.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"branchproof" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["lucianghinda@users.noreply.github.com"](mailto:"lucianghinda@users.noreply.github.com").

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,3 @@
+Copyright 2026 Lucian Ghinda
+
+Branchproof is distributed under the Apache License, Version 2.0.

data/README.md

@@ -0,0 +1,242 @@
+# Branchproof
+
+Branchproof measures modified condition/decision coverage (MC/DC) from one
+serial Minitest run. It inventories supported `if`, `unless`, `elsif`,
+modifier, and ordinary ternary (`?:`) decisions, records observed vectors,
+and reports independence evidence, missing counterpart constraints, and
+smaller supporting test sets.
+
+The gem is named `branchproof`; its command and compatibility namespace are
+`mcdc` and `MCDC`.
+
+## Installation
+
+```sh
+gem install branchproof
+```
+
+Or add it to a bundle:
+
+```sh
+bundle add branchproof
+```
+
+Branchproof targets CRuby 3.3 and 3.4, Minitest 5.x, and Prism 1.x. The
+published core runtime matrix is the CI matrix. Rails support is optional and
+has been locally checked against Rails 8.1.3.1 on CRuby 3.4.5; Rails is
+supplied by the application and is not a runtime dependency of this gem.
+Unsupported syntax and incomplete observations remain visible in the report
+instead of being counted as coverage.
+
+## Analyze a test run
+
+Run `mcdc analyze` with the source files or globs to inspect, followed by
+options. A second `--` separates Branchproof options from arguments passed to
+Minitest unchanged:
+
+```sh
+mcdc analyze 'lib/**/*.rb' --test 'test/**/*_test.rb' \
+  --level 3 \
+  --format terminal \
+  --output tmp/branchproof.txt \
+  --limits branchproof-limits.json \
+  -- --seed 1234
+```
+
+For a plain Ruby application, select the project policy explicitly when
+running from the application root:
+
+```sh
+bundle exec mcdc analyze 'lib/**/*.rb' --project ruby --test 'test/**/*_test.rb'
+```
+
+For a Rails application, run the same command from the application root so
+the application's bundle and Rails version remain in effect:
+
+```sh
+bundle exec mcdc analyze 'app/**/*.rb' --project rails --test 'test/**/*_test.rb'
+```
+
+For a project rooted at the current directory, `--project auto` is the
+default. It selects Rails only when both `config/application.rb` and
+`config/environment.rb` exist; otherwise it selects a plain Ruby project.
+Use `--project ruby` or `--project rails` to override detection. An explicit
+Rails project without both boot files is a usage error.
+
+Project defaults discover the sorted, de-duplicated union of
+`test/**/*_test.rb` and `test/**/test_*.rb`. Helper, support, and fixture files
+are excluded from that default set. `--test` remains authoritative when test
+files are selected explicitly. The worker prepends the project's `lib` and
+`test` directories to its child load path, so application `require` calls
+resolve without changing the parent process.
+
+Rails analysis boots `config/environment.rb` and `rails/test_help` inside the
+isolated worker after Branchproof's loader and Minitest hooks are installed. The
+child receives `RAILS_ENV=test`, `RACK_ENV=test`, `PARALLEL_WORKERS=1`,
+`DISABLE_BOOTSNAP=1`, and `DISABLE_SPRING=1`; the invoking process environment
+is unchanged. The Rails metadata in the report identifies the selected
+project and Rails version.
+
+`--output` writes the report through an atomic replacement. Without it, the
+report is written to standard output. `--format` accepts `terminal` (the
+default) or `json`. JSON includes source identities, criterion and schema
+versions, baseline status, diagnostics, completeness, observations, and
+analysis fields.
+
+The terminal format is a compact reading view of the same report. It keeps
+JSON's full stable identifiers and schema unchanged, while shortening IDs to
+eight-character prefixes (extending a prefix when two IDs collide) and
+displaying known Minitest owners as `ClassName#test_method`. When test
+metadata is unavailable, the owner falls back to its short ID. Level 3 adds
+the witness pair or missing counterpart constraints beside each condition;
+Level 2 and Level 3 also list named supporting tests. Repeated supporting-set
+rows are collapsed in terminal output only.
+
+For example, running the contents of the small `decision.rb` /
+`test_decision_test.rb` fixture from a project `lib/` and `test/` directory
+with the terminal format produces a summary like this:
+
+```text
+Branchproof 0.2.0
+Tests: PASSED (3 tests, 0 failed, 0 skipped)
+MC/DC: 100.0% (2/2 conditions proven)
+Analysis: COMPLETE
+Decisions: 1 supported, 0 excluded, 0 unexecuted (1 discovered)
+Observations: 3 completed, 0 aborted, 0 unattributed
+Values: T=true, F=false, -=short-circuited
+Scope: supported decisions and conditions
+
+Decision dde7aede lib/decision.rb:7
+  Decision: left && right
+  Status: SUPPORTED
+  Condition 0: left
+    PROVEN (witness 484eab21 + 8908881e)
+  Condition 1: right
+    PROVEN (witness e5ec8058 + 8908881e)
+  Vector e5ec8058 [TF] => F owners=CliFixtureTest#test_true_false_vector
+  Vector 8908881e [TT] => T owners=CliFixtureTest#test_true_true_vector
+  Vector 484eab21 [F-] => F owners=CliFixtureTest#test_false_true_vector
+
+Supporting sets:
+  Vectors (EXACT_MINIMUM, decisions: [dde7aede]): 484eab21, 8908881e, e5ec8058
+  Tests (EXACT_MINIMUM, decisions: [dde7aede]): CliFixtureTest#test_true_true_vector, CliFixtureTest#test_false_true_vector, CliFixtureTest#test_true_false_vector
+Additional tests outside this MC/DC evidence set may improve coverage.
+```
+
+The test execution still runs once for the selected level. Use `--format
+json` when a consumer needs the complete identifiers and versioned schema.
+
+The levels select how much of the one-run result is displayed:
+
+* Level 1 reports observed vectors grouped by their raw decision outcomes.
+* Level 2 includes the smallest supporting sets found for vectors and tests.
+* Level 3 (the default) includes condition independence witnesses and
+  counterpart constraints, as well as the Level 1 and 2 evidence.
+
+Level 2 and Level 3 compute from the same captured run. They do not rerun the
+test suite. A failed, unsupported, or incomplete run is reported with its
+status and diagnostics and cannot become a successful coverage result by
+changing the display level.
+
+### Supported conditional forms
+
+Ordinary Ruby ternaries use the same predicate instrumentation and `&&`/`||`
+condition trees as supported `if` decisions. For example:
+
+```ruby
+value = ready ? false : true
+```
+
+Branchproof records `ready` as the ternary predicate. The decision outcome is
+therefore the truth value of `ready`, even though the selected branch returns
+`false` or `true`; branch selection, returned values, object identity, and
+evaluation order are unchanged. Ternaries nested inside other predicates are
+also inventoried at their own level, including all executed nested levels.
+Expanding the supported syntax increases the eligible-condition denominator,
+so percentages should be compared with that changed scope in mind.
+
+The existing predicate exclusions and analysis limits still apply. Keyword
+`and`/`or` expressions, contextual syntax, unsafe or ambiguous predicates,
+and limit overflows remain diagnostics rather than eligible coverage.
+
+### Limits
+
+`--limits` accepts a JSON object containing positive integer overrides. The
+available keys are `conditions_per_decision`, `vectors_per_decision`,
+`owner_associations_per_run`, `tests_per_run`, `exact_candidates`,
+`exact_search_nodes`, and `constraint_search_states`.
+
+```json
+{
+  "vectors_per_decision": 4096,
+  "exact_search_nodes": 50000
+}
+```
+
+Unknown keys and non-positive values are usage errors. When a limit is
+reached, the report says that evidence or analysis is incomplete; it does not
+claim a complete result from truncated data.
+
+### Runner arguments
+
+Everything after the argument separator is passed as individual arguments to
+the serial Minitest runner. This is useful for seeds and name filters:
+
+```sh
+mcdc analyze 'lib/**/*.rb' --level 1 -- --seed 9001 -n /checkout/
+```
+
+The 0.2 release supports serial Minitest execution in plain Ruby projects and
+Rails applications. Rails lazy and eager loading are supported when the
+application does not enable reloading for the test run. RSpec, parallel or
+forked runners, mutation execution, Rails system/browser tests, custom Rails
+test commands, generated tests, and reloading configurations are outside this
+release and produce diagnostics rather than a passing analysis.
+
+## Library entry points
+
+```ruby
+require "branchproof"
+
+Branchproof::Limits.default
+Branchproof::Records.id(name: "stable identity")
+```
+
+`require "mcdc"` and `MCDC` are compatibility aliases for the same public
+namespace. The CLI is the supported way to run a complete analysis;
+`Branchproof::Project` exposes project selection and child-environment policy,
+and `Branchproof::RailsSupport` is the optional Rails boot boundary. The library
+classes expose the source, runtime, evidence, analysis, and report contracts
+for adapters and integrations.
+
+## Development
+
+Use an explicit Ruby executable on systems with multiple Rubies. Clearing
+inherited gem paths prevents one Ruby installation from loading another's
+gems:
+
+```sh
+bundle install
+bundle exec rake
+```
+
+To run the real Rails integration locally, install the optional test bundle
+and set its required flag:
+
+```sh
+BRANCHPROOF_RAILS_INTEGRATION=1 bundle install
+BRANCHPROOF_RAILS_INTEGRATION=1 bundle exec ruby -Ilib:test test/test_rails_integration.rb
+```
+
+The flag makes a missing Rails dependency a failure in the integration job;
+the core suite does not require Rails. Bootsnap is disabled for the child
+Rails process so its compilation cache cannot own the load path during an
+analysis.
+
+Run the commands with the Ruby executable you intend to validate. The checked
+release environments are CRuby 3.3.6 and 3.4.5. Each runtime
+must provide the declared Minitest 5.x and Prism 1.x dependencies.
+
+## License
+
+Branchproof is available under the [Apache License, Version 2.0](LICENSE.txt).

data/doc/Branchproof/Analyzer.md

@@ -0,0 +1,26 @@
+# Class Branchproof::Analyzer <a id="class-Branchproof-Analyzer"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | Object |
+| **Defined in** | lib/branchproof/analyzer.rb |
+
+Performs the Boolean, occurrence-level masking analysis. It deliberately
+accepts plain records so the core does not depend on Minitest or Runtime.
+
+## Constants
+### `CRITERION` <a id="constant-CRITERION"></a> <a id="CRITERION-constant"></a>
+Not documented.
+
+## Public Instance Methods
+### `call()` <a id="method-i-call"></a> <a id="call-instance_method"></a>
+Not documented.
+
+### `initialize(inventory:, evidence:, limits:)` <a id="method-i-initialize"></a> <a id="initialize-instance_method"></a>
+- **@return** [Analyzer] a new instance of Analyzer
+
+### `missing(decision_id:, condition_index:)` <a id="method-i-missing"></a> <a id="missing-instance_method"></a>
+Not documented.
+
+### `pair?(decision_id:, condition_index:, left:, right:)` <a id="method-i-pair-3F"></a> <a id="pair?-instance_method"></a>
+- **@return** [Boolean]

data/doc/Branchproof/CLI.md

@@ -0,0 +1,15 @@
+# Class Branchproof::CLI <a id="class-Branchproof-CLI"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | Object |
+| **Defined in** | lib/branchproof/cli.rb |
+
+Coordinates source inventory, isolated test execution, and report output.
+
+## Public Instance Methods
+### `call(argv)` <a id="method-i-call"></a> <a id="call-instance_method"></a>
+Not documented.
+
+### `initialize(stdout:, stderr:)` <a id="method-i-initialize"></a> <a id="initialize-instance_method"></a>
+- **@return** [CLI] a new instance of CLI

data/doc/Branchproof/Error.md

@@ -0,0 +1,6 @@
+# Class Branchproof::Error <a id="class-Branchproof-Error"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | StandardError |
+| **Defined in** | lib/branchproof.rb |

data/doc/Branchproof/Evidence.md

@@ -0,0 +1,46 @@
+# Class Branchproof::Evidence <a id="class-Branchproof-Evidence"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | Object |
+| **Defined in** | lib/branchproof/evidence.rb |
+
+Validates, groups, and merges adapter-neutral execution evidence. Stores
+validated observations and merges compatible worker snapshots.
+
+## Constants
+### `CRITERION_VERSION` <a id="constant-CRITERION_VERSION"></a> <a id="CRITERION_VERSION-constant"></a>
+Not documented.
+
+### `SCHEMA_VERSION` <a id="constant-SCHEMA_VERSION"></a> <a id="SCHEMA_VERSION-constant"></a>
+Not documented.
+
+### `TOOL_VERSION` <a id="constant-TOOL_VERSION"></a> <a id="TOOL_VERSION-constant"></a>
+Not documented.
+
+## Attributes
+### `inventory` [R] <a id="attribute-i-inventory"></a> <a id="inventory-instance_method"></a>
+Returns the value of attribute inventory.
+
+### `run_id` [R] <a id="attribute-i-run_id"></a> <a id="run_id-instance_method"></a>
+Returns the value of attribute run_id.
+
+## Public Instance Methods
+### `diagnose(diagnostic:)` <a id="method-i-diagnose"></a> <a id="diagnose-instance_method"></a>
+Not documented.
+
+### `initialize(inventory:, limits:, run_id:)` <a id="method-i-initialize"></a> <a id="initialize-instance_method"></a>
+- **@raise** [ArgumentError]
+- **@return** [Evidence] a new instance of Evidence
+
+### `merge(snapshot:)` <a id="method-i-merge"></a> <a id="merge-instance_method"></a>
+Not documented.
+
+### `record(execution:)` <a id="method-i-record"></a> <a id="record-instance_method"></a>
+Not documented.
+
+### `register_test(test:)` <a id="method-i-register_test"></a> <a id="register_test-instance_method"></a>
+Not documented.
+
+### `snapshot()` <a id="method-i-snapshot"></a> <a id="snapshot-instance_method"></a>
+Not documented.

data/doc/Branchproof/Instrumenter.md

@@ -0,0 +1,18 @@
+# Class Branchproof::Instrumenter <a id="class-Branchproof-Instrumenter"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | Object |
+| **Defined in** | lib/branchproof/instrumenter.rb |
+
+Applies the smallest possible source edits around inventoried expressions. The
+edits are deliberately textual: Prism owns the ranges, while this class never
+evaluates application code or introduces a Ruby scope.
+
+## Constants
+### `RUNTIME` <a id="constant-RUNTIME"></a> <a id="RUNTIME-constant"></a>
+Not documented.
+
+## Public Instance Methods
+### `rewrite(unit:)` <a id="method-i-rewrite"></a> <a id="rewrite-instance_method"></a>
+Not documented.

data/doc/Branchproof/Limits.md

@@ -0,0 +1,21 @@
+# Module Branchproof::Limits <a id="module-Branchproof-Limits"></a>
+
+|  |  |
+| --- | --- |
+| **Defined in** | lib/branchproof/limits.rb |
+
+Defines bounded storage and search limits for one analysis.
+
+## Constants
+### `DEFAULTS` <a id="constant-DEFAULTS"></a> <a id="DEFAULTS-constant"></a>
+Not documented.
+
+### `KEYS` <a id="constant-KEYS"></a> <a id="KEYS-constant"></a>
+Not documented.
+
+## Public Class Methods
+### `default()` <a id="method-c-default"></a> <a id="default-class_method"></a>
+Not documented.
+
+### `normalize(overrides = {})` <a id="method-c-normalize"></a> <a id="normalize-class_method"></a>
+- **@raise** [ArgumentError]

data/doc/Branchproof/Loader.md

@@ -0,0 +1,25 @@
+# Class Branchproof::Loader <a id="class-Branchproof-Loader"></a>
+
+|  |  |
+| --- | --- |
+| **Inherits** | Object |
+| **Defined in** | lib/branchproof/loader.rb |
+
+Owns the process-local CRuby compilation hook when the VM exposes it.
+
+## Constants
+### `STATUS_KEYS` <a id="constant-STATUS_KEYS"></a> <a id="STATUS_KEYS-constant"></a>
+Not documented.
+
+## Public Instance Methods
+### `diagnostics()` <a id="method-i-diagnostics"></a> <a id="diagnostics-instance_method"></a>
+Not documented.
+
+### `initialize(inventory:, instrumenter:)` <a id="method-i-initialize"></a> <a id="initialize-instance_method"></a>
+- **@return** [Loader] a new instance of Loader
+
+### `install()` <a id="method-i-install"></a> <a id="install-instance_method"></a>
+Not documented.
+
+### `load_iseq(path)` <a id="method-i-load_iseq"></a> <a id="load_iseq-instance_method"></a>
+Not documented.