mutineer 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a96e7bad1e1cf8d106957e770418e6a1854c677943114b9bc45421c4e06da7f2
-  data.tar.gz: c404d87071f3d270566e368ac70153f1e87c940eb170b220b972fb1b28b29889
+  metadata.gz: 77a6283314f6511b6ea8165477cda70f0e54bc5ba25d9e80b7afb95903d168b8
+  data.tar.gz: a7172bbd15af300e3064fa4df50a4845e4710d31c5458f6c535cb54472634a75
 SHA512:
-  metadata.gz: 15417ab5322c43c537953eaa438c18a9a89794f199a9c4666f031daf60f55f6c3ffabcb2e69e15b7ffd030e48b6f2d5d3ab41ee01ccfe9d52dd6c9ee22b4971c
-  data.tar.gz: 1e68e920b3aa610ea1715c16e48e89060e8eba2b2511aafb3c7db0c44e21f8fac077529173befd9acf3afbe2962829cf4534dce371a2f6262628dd507f37469b
+  metadata.gz: da4882d841268217538cd4e2f327efbc5630d0d198ff38636203cb304a4a5b219af9f317097c10cfa69fc85da4c8b55570add95ff5d36cfb7a23dcf4dc12b8d9
+  data.tar.gz: 7eee3c779742a39f0828027a96d1843e9dbd0843434eba9de07bdbf8528fbbf926828471253c38e05f4ef2af5a09bc3c966f11a0482685bfce560fdd3763f228

data/CHANGELOG.md

@@ -6,6 +6,21 @@ All notable changes to this project are documented here. The format is based on
 
 ## [Unreleased]
 
+## [1.0.2] - 2026-09-21
+
+### Added
+- **AI-readable docs wiring**: HTML pages with Markdown twins now advertise
+  `rel="alternate" type="text/markdown"`, `index.md` is the landing/CLI
+  essentials twin, `skill.md` is listed under Optional in `llms.txt`, and
+  `sitemap.xml` is generated from the same catalog as `llms.txt` (#91).
+- **Single-source CLI contract**: exit codes and `--threshold` live in
+  `docs/fragments/contract.yml`; `rake docs:generate` writes `llms-full.txt`,
+  `json-schema.html`, and the marked copies so they cannot drift (#82).
+- **YARD API on Pages**: the current gem's YARD HTML is published at
+  `/api/`, linked from the docs site, and `rake yard:pages:check` keeps it
+  from lagging the shipped sources. `documentation_uri` stays the Pages
+  root (#92).
+
 ## [1.0.1] - 2026-09-18
 
 ### Added
@@ -407,6 +422,7 @@ Rails hardening + CI batch (issues #8–#13), all verified Rails-free.
 - `.mutineer.yml` configuration (CLI > config > default precedence).
 - Byte-correct source handling for multibyte (UTF-8) sources.
 
+[1.0.2]: https://github.com/davidteren/mutineer/releases/tag/v1.0.2
 [1.0.1]: https://github.com/davidteren/mutineer/releases/tag/v1.0.1
 [1.0.0]: https://github.com/davidteren/mutineer/releases/tag/v1.0.0
 [0.11.4]: https://github.com/davidteren/mutineer/releases/tag/v0.11.4

data/README.md

@@ -68,11 +68,13 @@ mutineer run lib/calculator.rb --test test/calculator_test.rb --threshold 90
 
 ### Exit codes
 
+<!-- contract:exit-codes -->
 | Code | Meaning |
 |------|---------|
-| `0` | Score ≥ threshold (or no threshold set) |
-| `1` | Score below threshold, nothing could be scored and something broke, or more than one mutant produced no verdict and they exceed 10% of those attempted, a `--baseline` regression, or a runtime error |
-| `2` | Usage / invalid-flag error |
+| `0` | Score ≥ threshold (or no gate) **and** no baseline regression. |
+| `1` | Score below `--threshold`, OR nothing could be scored and something broke, or more than one mutant produced no verdict and they exceed 10% of those attempted, OR a `--baseline` regression, OR a runtime error. |
+| `2` | Usage / invalid-flag error (mistyped flag, bad path, unreadable baseline). |
+<!-- /contract:exit-codes -->
 
 ### Operators
 
@@ -273,6 +275,8 @@ structured exit codes, and diff-scoped runs. See:
   contract:
   [rendered](https://davidteren.github.io/mutineer/json-schema.html) ·
   [source](docs/json-schema.md)
+- **Ruby API (YARD)** — class reference for the shipped gem:
+  [https://davidteren.github.io/mutineer/api/](https://davidteren.github.io/mutineer/api/)
 
 ## Configuration
 

data/lib/mutineer/daemon_client.rb

@@ -56,7 +56,7 @@ module Mutineer
     # this mutant. Never a wrong verdict, never a wedged run.
     #
     # @param id [Integer] request id (echoed back for ordering safety).
-    # @param payload [Hash] {"code" => mutated ruby, "source_file" => path}.
+    # @param payload [Hash] mutated ruby under the "code" key, path under "source_file".
     # @param tests [Array<String>] covering test file paths.
     # @param timeout [Numeric] per-mutant wall-clock timeout (seconds).
     # @param worker [Integer] worker slot; the daemon routes the fork to

data/lib/mutineer/file_swap.rb

@@ -7,6 +7,8 @@ module Mutineer
   # Raised when another process already holds exclusive ownership of a source
   # file. Aborting beats silently restoring (or capturing) the other run's mutant.
   class ConcurrentRunError < StandardError
+    # @param path [String] the source file the other run already owns.
+    # @return [ConcurrentRunError]
     def initialize(path)
       super("another mutineer run owns #{path} — aborting to avoid corrupting the source file.")
     end

data/lib/mutineer/minitest_integration.rb

@@ -10,14 +10,16 @@ module Mutineer
   # Never call this in the parent — it manipulates global Minitest state
   # (autorun, runnables) that only makes sense in a throwaway forked child.
   #
-  # No `rescue` here: Isolation.run's fork block is the single exception
-  # boundary (any exception there becomes exit 2). Adding a rescue would
-  # create a second exit-2 path and break this method's 0/1 return contract.
+  # A missing minitest is rescued as FrameworkUnavailable (Isolation.run
+  # still turns that raise into exit 2). There is no rescue around the
+  # suite run itself: Isolation.run's fork block is the single exception
+  # boundary for unexpected errors. Swallowing those here would create a
+  # second exit-2 path and break this method's 0/1 return contract.
   class MinitestIntegration
-    # ponytail: tested via runner_test.rb (U6), not in isolation — a direct
-    # unit test would require forking and duplicate isolation_test's coverage.
+    # Tested via runner_test.rb, not in isolation — a direct unit test
+    # would require forking and duplicate isolation_test's coverage.
     #
-    # `test_files` is one path or an Array of paths (M3 coverage selection
+    # `test_files` is one path or an Array of paths (coverage selection
     # passes the covering subset); each is loaded before the single
     # Minitest.run.
     #

data/lib/mutineer/mutant_id.rb

@@ -19,7 +19,7 @@ module Mutineer
     # Computes the stable id for a single mutant.
     #
     # NUL-joined so token delimiters (`||=`, spaces, `::`, `#`) can never collide
-    # with the separator; SHA256[0,12] gives a fixed-length, copy-pasteable key.
+    # with the separator; `SHA256[0,12]` gives a fixed-length, copy-pasteable key.
     #
     # @param subject [Mutineer::Subject] the subject (method) the mutant lives in;
     #   its `qualified_name` anchors the id to a method rather than a byte position.

data/lib/mutineer/mutator_registry.rb

@@ -15,12 +15,11 @@ require_relative "mutators/collection_method"
 module Mutineer
   # Maps operator names to operator classes.
   #
-  # DEFAULT_NAMES is the v1 default set
-  # (the M4 Tier-1 + statement-removal operators per locked decision #2). The
-  # three Tier-2 operators live in ALL but are OFF by default — they only run
-  # when named via --operators or `operators:` in .mutineer.yml (KTD8). Keeping
-  # DEFAULT_NAMES an explicit subset (not ALL.keys) is what keeps the M4 default
-  # survivor set unchanged.
+  # DEFAULT_NAMES is the v1 default set (Tier-1 plus statement-removal).
+  # The six Tier-2 operators live in ALL but are OFF by default — they only
+  # run when named via `--operators` or `operators:` in `.mutineer.yml`.
+  # Keeping DEFAULT_NAMES an explicit subset (not ALL.keys) is what keeps
+  # the default survivor set unchanged.
   class MutatorRegistry
     # All available mutator classes keyed by operator name.
     ALL = {

data/lib/mutineer/version.rb

@@ -2,5 +2,5 @@
 
 module Mutineer
   # Current Mutineer release version.
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mutineer
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - David Teren