Repository navigation
Corrected TODO phase statuses against merged code - #18
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the TODO.complete/ phase documentation to accurately reflect what is actually merged on the default branch, correcting previously overstated COMPLETED statuses and adding evidence-backed “Gaps” notes where work is incomplete.
Changes:
- Reclassifies phases across
COMPLETED/PARTIAL/PENDINGbased on an audit of the merged code. - Adds
PARTIALto the README legend and adds per-phase## Gapssections with file/line evidence for incomplete deliverables. - Updates multiple phase docs to align descriptions, file lists, and claims with the current repository state (docs-only PR).
Reviewed changes
Copilot reviewed 40 out of 40 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| TODO.complete/README.md | Updates status legend (adds PARTIAL) and corrects the phase index/status totals and “Remaining” narrative. |
| TODO.complete/45-eliminate-respond-to.md | Marks phase as PARTIAL and documents remaining respond_to? call sites. |
| TODO.complete/43-performance-memoization.md | Marks phase as PENDING and lists uncached paths / missing benchmark spec. |
| TODO.complete/42-changelog-contributing.md | Marks phase as PARTIAL and documents inaccuracies in CHANGELOG.adoc. |
| TODO.complete/41-yard-documentation.md | Marks phase as PARTIAL and documents missing YARD annotations + missing yard dependency. |
| TODO.complete/38-convert-pending-specs.md | Adds outcome notes clarifying removed vs fixed pending specs. |
| TODO.complete/37-implement-stub-schematron-rules.md | Marks phase as PARTIAL and documents missing wiring/spec depth for stubs. |
| TODO.complete/36-remove-require-relative.md | Tightens verification instructions and evidence for require_relative removal. |
| TODO.complete/35-documentation.md | Marks phase as PARTIAL and documents missing docs artifacts/scripts/doctests. |
| TODO.complete/34-plugin-system.md | Marks phase as PARTIAL and documents missing plugin consumption/auto-discovery. |
| TODO.complete/33-streaming-parser.md | Marks phase as PENDING and documents missing files/specs/usage. |
| TODO.complete/32-i18n-helpers.md | Marks phase as PARTIAL and documents missing failure behavior / API surface. |
| TODO.complete/31-rest-api.md | Marks phase as PARTIAL and documents REST server gaps vs stated PTB endpoints/storage. |
| TODO.complete/30-quantity-format.md | Marks phase as PARTIAL and documents output mismatch + bigdecimal require coupling. |
| TODO.complete/29-uncertainty-propagation.md | Marks phase as PARTIAL and documents missing complex/matrix support. |
| TODO.complete/28-migration.md | Marks phase as PARTIAL and documents missing migrate subsystem vs shim behavior. |
| TODO.complete/27-diff-tool.md | Corrects delivered implementation details vs planned comparator/tolerance features. |
| TODO.complete/26-builder-dsl.md | Marks phase as PARTIAL and documents missing DSL surface + limited spec coverage. |
| TODO.complete/25-yaml-csv-html-converters.md | Marks phase as PARTIAL and documents HTML report feature gaps + corrects templating engine notes. |
| TODO.complete/24-cli-scaffold.md | Marks phase as PARTIAL and documents missing command groups/structure + notes dcc serve. |
| TODO.complete/23-output-models.md | Marks phase as PARTIAL and documents missing shared output concern + inconsistent formatter coverage. |
| TODO.complete/22-inspect-report.md | Marks phase as PARTIAL and documents missing report sections + incorrect signature detection logic. |
| TODO.complete/21-xslt-transform.md | Updates transform engine documentation to match current implementation (xsltproc). |
| TODO.complete/20-signature.md | Updates signature implementation notes to match current approach (Moxml::Signature). |
| TODO.complete/19-formula-extraction.md | Marks phase as PENDING and documents missing extractor + stale autoload/spec removal. |
| TODO.complete/18-file-extraction.md | Marks phase as PARTIAL and documents ring detection + fallback misclassification issues. |
| TODO.complete/17-json-converter.md | Marks phase as PARTIAL and documents missing style selector + approach divergence. |
| TODO.complete/16-business-rules.md | Marks phase as PARTIAL and documents which rules exist vs planned set. |
| TODO.complete/15-schematron.md | Marks phase as PARTIAL and documents missing rule wiring + profile implementation differences. |
| TODO.complete/14-xsd-validation.md | Corrects documentation about error/types file layout vs actual implementation. |
| TODO.complete/13-round-trip-specs.md | Marks phase as PARTIAL and documents insufficient round-trip assertions + fixture coverage gaps. |
| TODO.complete/12-root-parser-api.md | Corrects documentation of spec coverage and clarifies missing :dcc_v3_4 context. |
| TODO.complete/11-wire-dcc-dsi.md | Corrects verification notes and clarifies modeling decisions for si:real typing. |
| TODO.complete/10-d-si-model.md | Marks phase as PARTIAL and documents missing modules + unmodeled multivariate uncertainty. |
| TODO.complete/09-dcc-v3-wrappers.md | Marks phase as PARTIAL and documents missing context registration/fixtures + corrects signature/XSD note. |
| TODO.complete/07-dcc-base-modules.md | Marks phase as PARTIAL and documents missing v3.4.0-rc.2 modules + corrects delivered file naming. |
| TODO.complete/06-errors.md | Corrects error hierarchy documentation to match actual class nesting/placement. |
| TODO.complete/05-bundle-schemas-and-fixtures.md | Corrects bundled schema/fixture path documentation to match repo layout. |
| TODO.complete/04-custom-types.md | Marks phase as PARTIAL and documents Base64Binary/SchemaVersion gaps. |
| TODO.complete/01-scaffolding.md | Updates dependency/tooling documentation to reflect current gemspec/Gemfile realities. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 42 out of 42 changed files in this pull request and generated no new comments.
Suppressed comments (2)
TODO.complete/01-scaffolding.md:9
- This bullet calls
tty-tablea "Gemfile dev dependency", but in this repo it’s listed in the top-level Gemfile (not under a:development/:testgroup). The actionable point is thattty-tableis required at load time yet is not declared as a runtime dependency indcc.gemspec, so wording should reflect that to avoid confusion.
- `dcc.gemspec` — modelled on reqif.gemspec; deps: `lutaml-model ~> 0.8`, `moxml`, `mml`, `liquid`, `thor`. Note: `tty-table` is required at load by `lib/dcc/cli/cli.rb` but is only a Gemfile dev dependency.
TODO.complete/20-signature.md:16
- These notes correctly say the implementation uses
Moxml::Signature, butlib/dcc/signature.rbstill has a header comment claiming XMLDSig sign/verify uses thexmldsiggem as a soft dependency. That inconsistency will be confusing for readers following the "Files" list here; consider updating thelib/dcc/signature.rbcomment to match the actual Moxml-based implementation.
- Implemented with `Moxml::Signature`, plus OpenSSL for keys and certificates.
Neither the `xmldsig` gem nor an `xmlsec1` fallback is used.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
All 45 files in
TODO.complete/claimedCOMPLETED. 28 of them were wrong.Phase 19 claimed done while
lib/dcc/extract/formula.rbdid not exist, andlib/dcc/extract.rb:7still autoloaded it, so referencingDcc::Extract::Formularaised
LoadError. Phase 33 claimed a streaming reader nobody had written.Corrects them to 17
COMPLETED, 25PARTIAL, 3PENDING, each wrong one carrying a## Gapssection with file-and-line evidence. AddsPARTIALto the legend.Docs only, no code touched.
Known and accepted:
mainonly, audited against9fbbb4a. The README says so andpoints at the open PRs for work in flight. Six phases here have open PRs and will
need their status bumped when those land.
PARTIALis a fourth status.IN PROGRESSmeans active work,PARTIALmeansmerged and incomplete. Different states.
AdministrativeDataCompletenessiswritten and wired into nothing, and
formatter.rbnever requiresbigdecimal.