git 5.0.0.beta.3 → 5.0.0.beta.4

data/redesign/3_architecture_implementation.md

@@ -9,7 +9,7 @@ risk and allows for a gradual, controlled migration to the new architecture.
   - [Facade Modules Completed](#facade-modules-completed)
     - [Facade module naming convention](#facade-module-naming-convention)
   - [Next Task](#next-task)
-    - [D2 / Phase 4 is the remaining redesign step](#d2--phase-4-is-the-remaining-redesign-step)
+    - [Phase 4 complete — architectural redesign is done 🎉](#phase-4-complete--architectural-redesign-is-done-)
     - [Phase 3 Overview](#phase-3-overview)
     - [Workstream A — Fill facade coverage gaps](#workstream-a--fill-facade-coverage-gaps)
     - [Workstream B — C0: Redirect `Git::Base` factory methods to `facade_repository`](#workstream-b--c0-redirect-gitbase-factory-methods-to-facade_repository)
@@ -44,8 +44,8 @@ risk and allows for a gradual, controlled migration to the new architecture.
 | Phase 1 | ✅ Complete | Foundation and scaffolding | 5% | 100% |
 | Phase 2 | ✅ Complete | Migrating commands (all checklist items done) | 40% | 100% |
 | Phase 3 | ✅ Complete | Refactoring public interface — see [Facade Modules Completed](#facade-modules-completed) and [Facade coverage checklist](#facade-coverage-checklist) | 45% | 100% |
-| Phase 4 | 🚧 In Progress | Final cleanup and release — Step A complete; Steps B and C remain | 10% | 33% |
-| **TOTAL** | -- | -- | **100%** | **93%** |
+| Phase 4 | ✅ Complete | Final cleanup and release — Steps A, B, and C all complete | 10% | 100% |
+| **TOTAL** | ✅ **Complete** | -- | **100%** | **100%** |
 
 ### Facade Modules Completed
 
@@ -85,7 +85,7 @@ such as `Branch`, `Diff`, `Log`, `Object`, `Remote`, `Status`, `Worktree`, etc.
 
 ### Next Task
 
-#### Phase 4 Step B (finalize test suite) is the next step
+#### Phase 4 complete — architectural redesign is done 🎉
 
 Phase 4 **Step A — Remove old code** is ✅ complete. The atomic removal landed in
 [PR #1456](https://github.com/ruby-git/ruby-git/pull/1456) (commit `c1c53999`),
@@ -96,13 +96,31 @@ item. The only remaining `Git::Base` / `Git::Lib` strings in `lib/` are YARD/com
 references to historical 4.x behavior, which the Step A done-criteria explicitly
 allow.
 
-The remaining redesign work is the rest of Phase 4:
+Phase 4 **Step B — Finalize test suite** is ✅ complete. All 159 PORT rows (after dedup) were ported
+to RSpec (batches U1–U21), `tests/` and the Test::Unit tooling were removed (W3), the
+`extract-*` skills were deprecated (W4a), Test::Unit documentation references were
+removed (W4b), the full quality gate was verified green (W5 — 5668 unit + 893
+integration examples, 0 failures), and stale `Git::Base`/`Git::Lib` references were
+removed from active Copilot skills (W6 — [PR #1509](https://github.com/ruby-git/ruby-git/pull/1509)).
+
+Phase 4 **Step C — Update documentation** is ✅ complete. C1a–C1d (YARD audit and
+coverage gate), C2a–C2b (`UPGRADING.md` and `README.md`), and C3 (documentation
+completeness verification) are all done. Final state: all unit and integration examples
+pass, 0 failures; 100.00% documented; `yard:lint` no offenses; gem builds.
+One gap found and fixed during C3b: `Git::Status` was missing a class-level
+`@example` (added in this PR).
+
+All Phase 4 steps are now complete:
 
 | Step | Status | Summary |
 | ---- | ------ | ------- |
 | A — Remove old code | ✅ Complete | `Git::Base`/`Git::Lib` and the bridge deleted ([PR #1456](https://github.com/ruby-git/ruby-git/pull/1456)) |
-| B — Finalize test suite | 🔲 Not Started | Port remaining Test::Unit coverage in `tests/units/` to RSpec, drop the `test-unit` dependency from `git.gemspec`, remove the `test`/`test-all` Rake tasks, and remove the `tests/` directory |
-| C — Update documentation | 🚧 Partial | `UPGRADING.md` and broad `@api private` coverage exist; verify `yard stats` reports no missing public-API docs and that `README.md` reflects the new entry points |
+| B — Finalize test suite | ✅ Complete | W2 ✅ (all 159 PORT rows ported and merged after dedup, batches U1–U21); W3 ✅ (removed `tests/` and Test::Unit tooling); W4a ✅ (deprecated `extract-*` skills); W4b ✅ (removed Test::Unit doc references); W5 ✅ (gate green: 5668 unit + 893 integration, 0 failures); W6 ✅ (removed stale `Git::Base`/`Git::Lib` skill refs, [PR #1509](https://github.com/ruby-git/ruby-git/pull/1509)) |
+| C — Update documentation | ✅ Complete | C1a–C1d ✅ (YARD audit + coverage gate); C2a ✅ (`UPGRADING.md`); C2b ✅ (`README.md`); C3 ✅ (docs verification: CI green, spot-check passed, links valid) |
+
+The architectural redesign is now **fully complete**. The codebase is ready for the
+v5.0.0 release process (see the
+[release-management](../.github/skills/release-management/SKILL.md) skill).
 
 The following earlier prerequisites are all ✅ complete:
 
@@ -132,10 +150,10 @@ All 9 domain-object migrations are ✅ complete:
 | `Git::Branches` | [PR #1356](https://github.com/ruby-git/ruby-git/pull/1356), [PR #1357](https://github.com/ruby-git/ruby-git/pull/1357), [PR #1358](https://github.com/ruby-git/ruby-git/pull/1358), [PR #1359](https://github.com/ruby-git/ruby-git/pull/1359) |
 | `Git::Worktree` + `Git::Worktrees` | — |
 
-The work was organized into six workstreams (A–F). All workstreams that are
-prerequisites for C1d are now ✅ complete. F1 and F2 are both ✅ complete — F2
-moved the remaining `Git` module utility methods off `Git::Lib`. Phase 4 Step A
-is complete; Steps B and C remain (see [Next Task](#next-task)).
+The work was organized into six workstreams (A–F). All workstreams are ✅ complete.
+F1 and F2 are both ✅ complete — F2 moved the remaining `Git` module utility methods
+off `Git::Lib`. Phase 4 Steps A, B, and C are all ✅ complete (see
+[Next Task](#next-task)).
 
 **Sequencing** (see [Phase 3 dependency order](#phase-3-dependency-order) for the
 reasoning behind each edge):
@@ -1550,8 +1568,8 @@ release.*
 
 ```mermaid
 graph LR
-    A --> B
-    B --> C
+    A["A ✅ Remove old code"] --> B["B ✅ Finalize test suite"]
+    B --> C["C 🚧 Update documentation"]
 ```
 
 #### Step A — Remove old code
@@ -1570,24 +1588,36 @@ graph LR
 
 #### Step B — Finalize test suite
 
-**Status: 🔲 Not Started.**
+**Status: ✅ Complete.**
 
-- Convert any remaining, relevant Test::Unit tests to RSpec.
-- Remove the `test-unit` dependency from `git.gemspec`.
-- Ensure the RSpec suite has comprehensive coverage for the new architecture.
+All 159 PORT rows (after dedup) from the W1/W1.5 audit were ported to RSpec across batches U1–U21
+(W2). The `tests/` directory and all Test::Unit tooling were removed (W3). The
+`extract-*` skills were deprecated (W4a). All Test::Unit documentation references
+were removed (W4b). The full quality gate was verified green (W5): 5668 unit examples
++ 893 integration examples, 0 failures; RuboCop clean; YARD 83.6% (threshold 75%);
+gem build successful. W6 (remove stale `Git::Base`/`Git::Lib` skill references from
+active skills) is complete — both plan ([PR #1506](https://github.com/ruby-git/ruby-git/pull/1506)) and execution ([PR #1509](https://github.com/ruby-git/ruby-git/pull/1509)) have merged.
 
-**Done when**: The `tests/` directory is empty or removed; `test-unit` is no longer
-in `git.gemspec`; RSpec is the sole test framework.
+See the detailed execution plan in
+[Phase 4 - Step B.md](Phase%204%20-%20Step%20B.md).
 
 #### Step C — Update documentation
 
-**Status: 🚧 Partial.**
-
-- Thoroughly document the new public API (`Git`, `Git::Repository`, etc.).
-- Mark all internal classes (`ExecutionContext`, `Commands`, `*Path`) with `@api private` in the YARD documentation.
-- Update the `README.md` and create a `UPGRADING.md` guide explaining the breaking changes for v5.0.0.
-
-**Done when**: `yard stats` reports no missing docs on public API; `UPGRADING.md`
-covers all breaking changes; `README.md` reflects the new entry points. `UPGRADING.md`
-exists and `@api private` markers are applied broadly; remaining work is to confirm
-full public-API doc coverage and that `README.md` reflects the new entry points.
+**Status: 🚧 Partial.** See detailed execution plan in
+[Phase 4 - Step C.md](Phase%204%20-%20Step%20C.md).
+
+- ✅ Thoroughly document the new public API (`Git`, `Git::Repository`, etc.) and all
+  of `lib/` — **done**: every file passes `yard-lint` (which replaced the retired
+  `yardstick` tooling) with no offenses.
+- Set correct `@api` tags across `lib/` (including flipping the `Git::Repository::*`
+  topic modules to `@api private`).
+- Update the `README.md` and expand the existing `UPGRADING.md` guide explaining the
+  breaking changes for v5.0.0.
+
+**Done when**: the criteria in the Step C execution plan
+([Phase 4 - Step C.md](Phase%204%20-%20Step%20C.md) → "Done-When Criteria") are all
+met. In brief: documentation coverage is complete and enforced by `yard-lint`
+(`.yard-lint.yml`; `rake yard:lint` passes with no offenses) — already done — the
+`@api`-visibility tags are correct, `UPGRADING.md` covers all breaking changes,
+`README.md` reflects the new entry points, and the full CI pipeline is green. This
+tracker defers to the Step C plan as the single source of truth to avoid drift.