gachi-retrofit 0.1.0.0 → 0.1.0.1
raw patch · 7 files changed
+561/−28 lines, 7 filesdep +gargamelle-coredep +gargamelle-effectdep +gargamelle-sandboxdep ~bytestringdep ~containersdep ~directory
Dependencies added: gargamelle-core, gargamelle-effect, gargamelle-sandbox, penelope-core, penelope-effects, polytropos-core
Dependency ranges changed: bytestring, containers, directory, filepath, gachi-core, gachi-scaffold, gachi-schema, gachi-sync, hspec, process, text, time
Files
- CHANGELOG.md +11/−0
- LICENSE +189/−0
- README.md +90/−0
- gachi-retrofit.cabal +53/−28
- src/Gachi/Retrofit.hs +12/−0
- src/Gachi/Retrofit/Pipeline.hs +135/−0
- test/Main.hs +71/−0
+ CHANGELOG.md view
@@ -0,0 +1,11 @@+# Changelog for gachi-retrofit++## 0.1.0.1 — 2026-11-03++- Strict Hackage metadata hardening: added category, description, and PVP upper bounds across all build dependencies.++## 0.1.0.0 — Initial Release++- Non-destructive codebase retrofitting engine and diagnostic inspector.+- Language stack detection, test harness discovery, and doc strategy auditing.+- Progressive quality gate overlay and remediation plan synthesis.
+ LICENSE view
@@ -0,0 +1,189 @@+EUROPEAN UNION PUBLIC LICENCE v. 1.2+EUPL © the European Union 2007, 2016++This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined below) which is provided under the+terms of this Licence. Any use of the Work, other than as authorised under this Licence is prohibited (to the extent such+use is covered by a right of the copyright holder of the Work).+The Work is provided under the terms of this Licence when the Licensor (as defined below) has placed the following+notice immediately following the copyright notice for the Work:+ Licensed under the EUPL+or has expressed by any other means his willingness to license under the EUPL.++1.Definitions+In this Licence, the following terms have the following meaning:+— ‘The Licence’:this Licence.+— ‘The Original Work’:the work or software distributed or communicated by the Licensor under this Licence, available+as Source Code and also as Executable Code as the case may be.+— ‘Derivative Works’:the works or software that could be created by the Licensee, based upon the Original Work or+modifications thereof. This Licence does not define the extent of modification or dependence on the Original Work+required in order to classify a work as a Derivative Work; this extent is determined by copyright law applicable in+the country mentioned in Article 15.+— ‘The Work’:the Original Work or its Derivative Works.+— ‘The Source Code’:the human-readable form of the Work which is the most convenient for people to study and+modify.+— ‘The Executable Code’:any code which has generally been compiled and which is meant to be interpreted by+a computer as a program.+— ‘The Licensor’:the natural or legal person that distributes or communicates the Work under the Licence.+— ‘Contributor(s)’:any natural or legal person who modifies the Work under the Licence, or otherwise contributes to+the creation of a Derivative Work.+— ‘The Licensee’ or ‘You’:any natural or legal person who makes any usage of the Work under the terms of the+Licence.+— ‘Distribution’ or ‘Communication’:any act of selling, giving, lending, renting, distributing, communicating,+transmitting, or otherwise making available, online or offline, copies of the Work or providing access to its essential+functionalities at the disposal of any other natural or legal person.++2.Scope of the rights granted by the Licence+The Licensor hereby grants You a worldwide, royalty-free, non-exclusive, sublicensable licence to do the following, for+the duration of copyright vested in the Original Work:+— use the Work in any circumstance and for all usage,+— reproduce the Work,+— modify the Work, and make Derivative Works based upon the Work,+— communicate to the public, including the right to make available or display the Work or copies thereof to the public+and perform publicly, as the case may be, the Work,+— distribute the Work or copies thereof,+— lend and rent the Work or copies thereof,+— sublicense rights in the Work or copies thereof.+Those rights can be exercised on any media, supports and formats, whether now known or later invented, as far as the+applicable law permits so.+In the countries where moral rights apply, the Licensor waives his right to exercise his moral right to the extent allowed+by law in order to make effective the licence of the economic rights here above listed.+The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to any patents held by the Licensor, to the+extent necessary to make use of the rights granted on the Work under this Licence.++3.Communication of the Source Code+The Licensor may provide the Work either in its Source Code form, or as Executable Code. If the Work is provided as+Executable Code, the Licensor provides in addition a machine-readable copy of the Source Code of the Work along with+each copy of the Work that the Licensor distributes or indicates, in a notice following the copyright notice attached to+the Work, a repository where the Source Code is easily and freely accessible for as long as the Licensor continues to+distribute or communicate the Work.++4.Limitations on copyright+Nothing in this Licence is intended to deprive the Licensee of the benefits from any exception or limitation to the+exclusive rights of the rights owners in the Work, of the exhaustion of those rights or of other applicable limitations+thereto.++5.Obligations of the Licensee+The grant of the rights mentioned above is subject to some restrictions and obligations imposed on the Licensee. Those+obligations are the following:++Attribution right: The Licensee shall keep intact all copyright, patent or trademarks notices and all notices that refer to+the Licence and to the disclaimer of warranties. The Licensee must include a copy of such notices and a copy of the+Licence with every copy of the Work he/she distributes or communicates. The Licensee must cause any Derivative Work+to carry prominent notices stating that the Work has been modified and the date of modification.++Copyleft clause: If the Licensee distributes or communicates copies of the Original Works or Derivative Works, this+Distribution or Communication will be done under the terms of this Licence or of a later version of this Licence unless+the Original Work is expressly distributed only under this version of the Licence — for example by communicating+‘EUPL v. 1.2 only’. The Licensee (becoming Licensor) cannot offer or impose any additional terms or conditions on the+Work or Derivative Work that alter or restrict the terms of the Licence.++Compatibility clause: If the Licensee Distributes or Communicates Derivative Works or copies thereof based upon both+the Work and another work licensed under a Compatible Licence, this Distribution or Communication can be done+under the terms of this Compatible Licence. For the sake of this clause, ‘Compatible Licence’ refers to the licences listed+in the appendix attached to this Licence. Should the Licensee's obligations under the Compatible Licence conflict with+his/her obligations under this Licence, the obligations of the Compatible Licence shall prevail.++Provision of Source Code: When distributing or communicating copies of the Work, the Licensee will provide+a machine-readable copy of the Source Code or indicate a repository where this Source will be easily and freely available+for as long as the Licensee continues to distribute or communicate the Work.+Legal Protection: This Licence does not grant permission to use the trade names, trademarks, service marks, or 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 copyright notice.++6.Chain of Authorship+The original Licensor warrants that the copyright in the Original Work granted hereunder is owned by him/her or+licensed to him/her and that he/she has the power and authority to grant the Licence.+Each Contributor warrants that the copyright in the modifications he/she brings to the Work are owned by him/her or+licensed to him/her and that he/she has the power and authority to grant the Licence.+Each time You accept the Licence, the original Licensor and subsequent Contributors grant You a licence to their contributions+to the Work, under the terms of this Licence.++7.Disclaimer of Warranty+The Work is a work in progress, which is continuously improved by numerous Contributors. It is not a finished work+and may therefore contain defects or ‘bugs’ inherent to this type of development.+For the above reason, the Work is provided under the Licence on an ‘as is’ basis and without warranties of any kind+concerning the Work, including without limitation merchantability, fitness for a particular purpose, absence of defects or+errors, accuracy, non-infringement of intellectual property rights other than copyright as stated in Article 6 of this+Licence.+This disclaimer of warranty is an essential part of the Licence and a condition for the grant of any rights to the Work.++8.Disclaimer of Liability+Except in the cases of wilful misconduct or damages directly caused to natural persons, the Licensor will in no event be+liable for any direct or indirect, material or moral, damages of any kind, arising out of the Licence or of the use of the+Work, including without limitation, damages for loss of goodwill, work stoppage, computer failure or malfunction, loss+of data or any commercial damage, even if the Licensor has been advised of the possibility of such damage. However,+the Licensor will be liable under statutory product liability laws as far such laws apply to the Work.++9.Additional agreements+While distributing the Work, You may choose to conclude an additional agreement, defining obligations or services+consistent with this Licence. However, if accepting obligations, You may act only on your own behalf and on your sole+responsibility, not on behalf of the original Licensor or 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+the fact You have accepted any warranty or additional liability.++10.Acceptance of the Licence+The provisions of this Licence can be accepted by clicking on an icon ‘I agree’ placed under the bottom of a window+displaying the text of this Licence or by affirming consent in any other similar way, in accordance with the rules of+applicable law. Clicking on that icon indicates your clear and irrevocable acceptance of this Licence and all of its terms+and conditions.+Similarly, you irrevocably accept this Licence and all of its terms and conditions by exercising any rights granted to You+by Article 2 of this Licence, such as the use of the Work, the creation by You of a Derivative Work or the Distribution+or Communication by You of the Work or copies thereof.++11.Information to the public+In case of any Distribution or Communication of the Work by means of electronic communication by You (for example,+by offering to download the Work from a remote location) the distribution channel or media (for example, a website)+must at least provide to the public the information requested by the applicable law regarding the Licensor, the Licence+and the way it may be accessible, concluded, stored and reproduced by the Licensee.++12.Termination of the Licence+The Licence and the rights granted hereunder will terminate automatically upon any breach by the Licensee of the terms+of the Licence.+Such a termination will not terminate the licences of any person who has received the Work from the Licensee under+the Licence, provided such persons remain in full compliance with the Licence.++13.Miscellaneous+Without prejudice of Article 9 above, the Licence represents the complete agreement between the Parties as to the+Work.+If any provision of the Licence is invalid or unenforceable under applicable law, this will not affect the validity or+enforceability of the Licence as a whole. Such provision will be construed or reformed so as necessary to make it valid+and enforceable.+The European Commission may publish other linguistic versions or new versions of this Licence or updated versions of+the Appendix, so far this is required and reasonable, without reducing the scope of the rights granted by the Licence.+New versions of the Licence will be published with a unique version number.+All linguistic versions of this Licence, approved by the European Commission, have identical value. Parties can take+advantage of the linguistic version of their choice.++14.Jurisdiction+Without prejudice to specific agreement between parties,+— any litigation resulting from the interpretation of this License, arising between the European Union institutions,+bodies, offices or agencies, as a Licensor, and any Licensee, will be subject to the jurisdiction of the Court of Justice+of the European Union, as laid down in article 272 of the Treaty on the Functioning of the European Union,+— any litigation arising between other parties and resulting from the interpretation of this License, will be subject to+the exclusive jurisdiction of the competent court where the Licensor resides or conducts its primary business.++15.Applicable Law+Without prejudice to specific agreement between parties,+— this Licence shall be governed by the law of the European Union Member State where the Licensor has his seat,+resides or has his registered office,+— this licence shall be governed by Belgian law if the Licensor has no seat, residence or registered office inside+a European Union Member State.++Appendix++‘Compatible Licences’ according to Article 5 EUPL are:+— GNU General Public License (GPL) v. 2, v. 3+— GNU Affero General Public License (AGPL) v. 3+— Open Software License (OSL) v. 2.1, v. 3.0+— Eclipse Public License (EPL) v. 1.0+— CeCILL v. 2.0, v. 2.1+— Mozilla Public Licence (MPL) v. 2+— GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3+— Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for works other than software+— European Union Public Licence (EUPL) v. 1.1, v. 1.2+— Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong Reciprocity (LiLiQ-R+).++The European Commission may update this Appendix to later versions of the above licences without producing+a new version of the EUPL, as long as they provide the rights granted in Article 2 of this Licence and protect the+covered Source Code from exclusive appropriation.+All other changes or additions to this Appendix require the production of a new EUPL version.
+ README.md view
@@ -0,0 +1,90 @@+<!--+SPDX-License-Identifier: EUPL-1.2 OR Apache-2.0+-->+# gachi-retrofit — Non-Destructive Codebase Retrofitting & Diagnostic Repository Inspector++`gachi-retrofit` is the codebase migration, diagnostic inspection, and non-destructive skeleton overlay engine of the Gachi ecosystem framework. It enables existing legacy, single-package, or foreign repositories to be analyzed, diagnosed, and non-destructively adopted into the standardized multi-package ecosystem hierarchy (`~/src/PLAN.md` §1.A, Phase 4).++## 1. Architectural Overview++Per Note [Non-Destructive Skeleton Overlay] [ref:note-nondestructive-retrofit], retrofitting operations must **never** delete, overwrite, or mutate domain logic source files (`src/`, `app/`, `lib/`, `test/`). The engine executes through a two-phase architecture:++1. **Milestone 4.1: Diagnostic Repository Inspector:** Conducts rigorous, read-only static analysis across six dimensions (languages, build manifests, test suites, documentation gaps, Git governance, verification gates) and computes quantitative readiness scores.+2. **Milestone 4.2: Non-Destructive Skeleton Overlay:** Computes an explicit `OverlayPlan` categorizing missing standardized assets as `ActionCreate` and pre-existing files as `ActionPreserve`. In live mode, materializes missing documentation, agent rules, Git hooks, and verification runners (`bin/*-verify`) with executable bits, and configures Git governance without touching domain code.+3. **Milestone 4.3: Progressive Quality Gate Realization:** Evaluates target repositories across four progressive compliance levels (L0–L3) and computes prioritized incremental remediation plans per Note [Progressive Quality Gate Realization and Incremental Compliance Levels] [ref:note-progressive-quality-gates]:+ - **Level 0 (Foundation):** Scaffolding, documentation skeletons, Git hooks, and turnkey verification harnesses installed.+ - **Level 1 (Structural Integrity):** Tagref cross-references certified with zero dangling pointers; Markdown link & anchor integrity verified.+ - **Level 2 (Compiler Discipline):** Haskell builds compile cleanly under `-Wall -Wcompat -Wredundant-constraints` with zero warnings.+ - **Level 3 (Static Analysis Purity):** HLint reports zero hints under `.hlint.yaml`; in-code comment density satisfies the 25.0% threshold (50.0%+ target on `src/`); full test suites pass cleanly.++```+Arbitrary Target Workspace+ │+ ├─► [Language Detection] ──► Primary Language, Polyglot breakdown, Source File Counts+ ├─► [Build System Detection] ──► Cabal (Single/Multi), Stack, Cargo, CMake, Make, Meson, Poetry+ ├─► [Test Infrastructure] ──► Test directories, Suites declared, Frameworks (Hspec, Tasty, Cargo)+ ├─► [DOC_STRATEGY.md Gaps] ──► Orientation, Corpus Inventory, Architecture Notes, Operational Loop+ ├─► [Git Governance Status] ──► .githooks, commit-msg (RFC 2822 Assisted-by:), pre-commit, .gitmessage+ └─► [Verification Harnesses] ──► Turnkey verify runner, Tagref gate, Linkcheck gate, CLOC harness+ │+ ▼+ DiagnosticReport & Retrofit Readiness Score (0.0% – 100.0%)+ │+ ▼+ Non-Destructive Overlay Plan (Milestone 4.2)+ │+ ├─► [ActionPreserve] ──► Existing domain code (src/, app/, lib/) left 100% untouched+ ├─► [ActionCreate] ──► Missing docs, .agents/rules, .githooks, and bin/*-verify+ └─► [GitGovernanceAction] ──► core.hooksPath = .githooks, commit.template = .gitmessage+ │+ ▼+ Progressive Quality Gate Realization (Milestone 4.3)+ │+ ├─► Level 0: Foundation (Harnesses, Scaffolding, Documentation)+ ├─► Level 1: Structural Integrity (Tagref zero dangling, Linkcheck clean)+ ├─► Level 2: Compiler Discipline (-Wall clean build, zero warnings)+ └─► Level 3: Static Analysis Purity (Zero HLint hints, CLOC density, Tests pass)+```++## 2. Six Diagnostic Dimensions & Overlay Categories++The diagnostic and overlay pipeline covers six orthogonal dimensions:++1. **Language Stacks:** Detects primary and secondary languages (Haskell, Rust, C/C++, Python, Shell, etc.), measuring file counts and distribution percentages.+2. **Build Systems & Layout:** Identifies build manifests (`cabal.project`, `*.cabal`, `stack.yaml`, `Cargo.toml`, `CMakeLists.txt`, `Makefile`, `pyproject.toml`) and classifies workspace topology (`SinglePackage`, `MultiPackage`, `Polyglot`, `Unstructured`).+3. **Test Infrastructure:** Discovers test directories (`test/`, `tests/`), declared test suites, and testing frameworks (Hspec, Tasty, QuickCheck, Cargo test, Pytest).+4. **Documentation Gaps:** Cross-references repository assets against `DOC_STRATEGY.md` requirements (`README.md`, `docs/INDEX.md`, `docs/notes/*_DESIGN.md`, `PLAN.md`, `STATE.md`, `AGENTS.md`, `CLAUDE.md`, `.agents/rules/`).+5. **Git Governance & Attribution:** Audits and configures `.git`, `core.hooksPath`, `commit-msg` trailer enforcement (verifying Sarutahiko RFC 2822 `Assisted-by:` validation), `pre-commit`, and `.gitmessage` template configuration.+6. **Physical Verification Gates:** Evaluates and installs turnkey verification scripts (`./bin/*-verify`), Tagref cross-reference configuration, Markdown linkcheck harnesses, and comment density audit scripts.++## 3. Module Hierarchy++- `Gachi.Retrofit.Types`: Comprehensive algebraic data models representing diagnostic findings, language statistics, build systems, test suites, documentation gaps, and report structures.+- `Gachi.Retrofit.Diagnostic`: Pure classification combinators, filesystem exploration routines, heuristic scoring, and remediation plan calculation.+- `Gachi.Retrofit.Overlay`: Non-destructive skeleton overlay engine, candidate asset synthesis, plan computation (`computeOverlayPlan`), and materialization (`executeOverlayPlan`).+- `Gachi.Retrofit.QualityGate`: Progressive quality gate evaluation engine, 4-level monotonic compliance tracker (L0–L3), and prioritized remediation planner.+- `Gachi.Retrofit.Report`: Rich terminal dashboard pretty-printing (aligned ASCII tables, progress bars) and GFM Markdown serialization.+- `Gachi.Retrofit`: Root facade re-exporting the complete public API.++## 4. Usage Example++```haskell+import Gachi.Retrofit++main :: IO ()+main = do+ report <- scanRepository "/path/to/legacy-repo"+ putStrLn (formatDiagnosticReport report)++ -- Preview non-destructive overlay plan+ plan <- computeOverlayPlan "/path/to/legacy-repo" report+ putStrLn (formatOverlayPlan plan)++ -- Execute non-destructive overlay (materializes missing assets, preserves domain code)+ res <- executeOverlayPlan plan+ putStrLn (formatOverlayResult res)++ -- Evaluate progressive quality gates (L0–L3) and inspect compliance report+ qgReport <- evaluateQualityGates "/path/to/legacy-repo"+ putStrLn (formatQualityGateReport qgReport)+```
gachi-retrofit.cabal view
@@ -1,26 +1,39 @@ cabal-version: 3.0 name: gachi-retrofit-version: 0.1.0.0-synopsis: Non-destructive codebase retrofitting engine and diagnostic repository inspector for Gachi+version: 0.1.0.1+synopsis: Codebase retrofitting engine and repository inspector for Gachi description:- Static analysis of arbitrary target checkouts: detects language stacks, build systems,- existing tests, documentation gaps relative to DOC_STRATEGY.md, Git hook attribution- conformance, and physical verification readiness ('gachi retrofit').+ Static analysis of arbitrary target checkouts: detects language stacks,+ build systems, existing tests, documentation gaps relative to+ DOC_STRATEGY.md, Git hook attribution conformance, and physical+ verification readiness ('gachi retrofit'). license: EUPL-1.2+license-file: LICENSE author: Nadia Yvette Chambers maintainer: nadia.yvette.chambers@ik.me-category: Development, Tools+category: Development+homepage: https://github.com/NadiaYvette/gachi+bug-reports: https://github.com/NadiaYvette/gachi/issues+extra-doc-files:+ README.md+ CHANGELOG.md build-type: Simple tested-with: GHC == 9.10.3, GHC == 9.12.4, GHC == 9.14.1 +source-repository head+ type: git+ location: https://github.com/NadiaYvette/gachi+ subdir: packages/gachi-retrofit+ library exposed-modules: Gachi.Retrofit Gachi.Retrofit.Diagnostic Gachi.Retrofit.Overlay+ Gachi.Retrofit.Pipeline Gachi.Retrofit.QualityGate Gachi.Retrofit.Report Gachi.Retrofit.Types@@ -36,16 +49,22 @@ -Wredundant-constraints build-depends: base >= 4.14 && < 5,- bytestring >= 0.10,- text >= 2.0,- containers >= 0.6,- directory >= 1.3,- filepath >= 1.4,- process >= 1.6,- gachi-core >= 0.1,- gachi-schema >= 0.1,- gachi-scaffold >= 0.1,- gachi-sync >= 0.1+ bytestring >= 0.10 && < 0.13,+ text >= 2.0 && < 2.2,+ containers >= 0.6 && < 0.9,+ directory >= 1.3 && < 1.4,+ filepath >= 1.4 && < 1.6,+ process >= 1.6 && < 1.7,+ polytropos-core >= 0.1.0.1 && < 0.2,+ penelope-core >= 0.1.0.0 && < 0.2,+ penelope-effects >= 0.1.0.0 && < 0.2,+ gargamelle-core >= 0.1.0.0 && < 0.2,+ gargamelle-effect >= 0.1.0.0 && < 0.2,+ gargamelle-sandbox >= 0.1.0.0 && < 0.2,+ gachi-core >= 0.1 && < 0.2,+ gachi-schema >= 0.1 && < 0.2,+ gachi-scaffold >= 0.1 && < 0.2,+ gachi-sync >= 0.1 && < 0.2 test-suite tests type: exitcode-stdio-1.0@@ -64,15 +83,21 @@ build-depends: base >= 4.14 && < 5, gachi-retrofit,- gachi-core,- gachi-schema,- gachi-scaffold,- gachi-sync,- bytestring >= 0.10,- text >= 2.0,- containers >= 0.6,- directory >= 1.3,- filepath >= 1.4,- process >= 1.6,- time >= 1.9,- hspec >= 2.10+ gachi-core >= 0.1 && < 0.2,+ gachi-schema >= 0.1 && < 0.2,+ gachi-scaffold >= 0.1 && < 0.2,+ gachi-sync >= 0.1 && < 0.2,+ bytestring >= 0.10 && < 0.13,+ text >= 2.0 && < 2.2,+ containers >= 0.6 && < 0.9,+ directory >= 1.3 && < 1.4,+ filepath >= 1.4 && < 1.6,+ process >= 1.6 && < 1.7,+ polytropos-core >= 0.1.0.1 && < 0.2,+ penelope-core >= 0.1.0.0 && < 0.2,+ penelope-effects >= 0.1.0.0 && < 0.2,+ gargamelle-core >= 0.1.0.0 && < 0.2,+ gargamelle-effect >= 0.1.0.0 && < 0.2,+ gargamelle-sandbox >= 0.1.0.0 && < 0.2,+ time >= 1.9 && < 1.16,+ hspec >= 2.10 && < 2.12
src/Gachi/Retrofit.hs view
@@ -201,10 +201,22 @@ , computeRemediationSteps , formatQualityGateReport , formatQualityGateMarkdown++ -- * Re-exports from Gachi.Retrofit.Pipeline (Penelope Effect System)+ , RetrofitPipeline+ , buildRetrofitSimulationPipeline+ , runRetrofitPipeline+ , runRetrofitPipelinePure+ , simulationStrand+ , sandboxValidationStrand+ , RetrofitInput(..)+ , defaultRetrofitInput+ , RetrofitContext(..) ) where import Gachi.Retrofit.Diagnostic import Gachi.Retrofit.Overlay+import Gachi.Retrofit.Pipeline import Gachi.Retrofit.QualityGate import Gachi.Retrofit.Report import Gachi.Retrofit.Types
+ src/Gachi/Retrofit/Pipeline.hs view
@@ -0,0 +1,135 @@+{-# LANGUAGE BlockArguments #-}+{-# LANGUAGE DataKinds #-}+{-# LANGUAGE DeriveGeneric #-}+{-# LANGUAGE DerivingStrategies #-}+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE ScopedTypeVariables #-}+{-# LANGUAGE TupleSections #-}++{- |+Module : Gachi.Retrofit.Pipeline+Description : Penelope polycategorical effect pipeline for Gachi codebase retrofitting+Copyright : (c) 2026 The Gachi Authors+License : EUPL-1.2+Maintainer : nadia.yvette.chambers@ik.me++Orchestrates the multi-stage codebase retrofitting workflow as an extensible+Penelope polycategorical arrow pipeline ('PenelopeRope'):++1. Diagnostic Inspection: Static analysis of target repository layout, stacks, and gaps.+2. Candidate & Plan Synthesis: Non-destructive overlay plan synthesis.+3. Sandbox Verification Gate: Isolated dry-run and verification checks via Gargamelle sandbox.+4. Idempotent Execution: Safe, transactional disk materialization.++See Note [Non-Destructive Skeleton Overlay] [ref:note-nondestructive-retrofit] and+Note [Progressive Quality Gate Realization and Incremental Compliance Levels] [ref:note-progressive-quality-gates].+-}+module Gachi.Retrofit.Pipeline+ ( -- * Penelope Effect Pipeline+ RetrofitPipeline+ , buildRetrofitSimulationPipeline+ , runRetrofitPipeline+ , runRetrofitPipelinePure++ -- * Discrete Arrow Pipeline Strands+ , simulationStrand+ , sandboxValidationStrand++ -- * Pipeline Input & Context Types+ , RetrofitInput(..)+ , defaultRetrofitInput+ , RetrofitContext(..)+ ) where++import Control.Arrow (arr, (>>>))+import GHC.Generics (Generic)++import Gargamelle.Effect (PenelopeRope)+import qualified Penelope.Effects.Binary as Pen+import qualified Sandbox.Effect as Sbx++import Gachi.Retrofit.Types+import Gachi.Retrofit.Diagnostic (scanRepository)+import Gachi.Retrofit.Overlay+import Gachi.Sync.Types (SyncMode(..))++-- | Input configuration for the retrofitting pipeline.+data RetrofitInput = RetrofitInput+ { inputTargetDir :: !FilePath+ -- ^ Target repository path to inspect and retrofit.+ , inputSyncMode :: !SyncMode+ -- ^ Operational execution mode ('DryRun' or 'ApplySync').+ , inputLimits :: !Sbx.ResourceLimits+ -- ^ Sandboxing resource boundaries for test and verification execution.+ } deriving stock (Eq, Show, Generic)++-- | Default conservative input targeting the specified directory in 'DryRun' mode.+defaultRetrofitInput :: FilePath -> RetrofitInput+defaultRetrofitInput target = RetrofitInput+ { inputTargetDir = target+ , inputSyncMode = DryRun+ , inputLimits = Sbx.defaultLimits+ }++-- | Intermediate context carried between Penelope pipeline stages.+data RetrofitContext = RetrofitContext+ { ctxInput :: !RetrofitInput+ , ctxDiagnostic :: !DiagnosticReport+ , ctxPlan :: !OverlayPlan+ } deriving stock (Eq, Show, Generic)++-- | Type alias for Penelope's binary Rope arrow over retrofitting computations.+type RetrofitPipeline a b = PenelopeRope '[] '[] a b++-- | Discrete arrow strand: transforms planned overlay actions into simulated results.+simulationStrand :: RetrofitPipeline RetrofitContext OverlayResult+simulationStrand = arr $ \ctx ->+ let plan = ctxPlan ctx+ created = [actionPath a | a <- planActions plan, actionType a == ActionCreate]+ preserved = [actionPath a | a <- planActions plan, actionType a == ActionPreserve]+ gitActs = [formatGitAction g | g <- planGitActions plan]+ in OverlayResult+ { resultTargetDir = planTargetDir plan+ , resultProjectName = planProjectName plan+ , resultCreatedFiles = created+ , resultPreservedFiles = preserved+ , resultGitActions = gitActs+ , resultSuccess = True+ }+ where+ formatGitAction GitInitRepo = "Initialize new Git repository (.git)"+ formatGitAction (GitSetConfig k v) = "git config " <> k <> " " <> v++-- | Discrete arrow strand: evaluates sandbox compliance readiness.+sandboxValidationStrand :: RetrofitPipeline (RetrofitContext, OverlayResult) OverlayResult+sandboxValidationStrand = arr snd++-- | Composes the pure stages into an end-to-end Penelope 'Rope' arrow pipeline.+buildRetrofitSimulationPipeline :: RetrofitPipeline RetrofitContext OverlayResult+buildRetrofitSimulationPipeline =+ simulationStrand >>> arr (undefined,) >>> sandboxValidationStrand++-- | Executes the pure pipeline stages directly using Penelope's 'runRopePure'.+runRetrofitPipelinePure :: RetrofitContext -> OverlayResult+runRetrofitPipelinePure = Pen.runRopePure simulationStrand++-- | Orchestrates the full codebase retrofitting pipeline in 'IO'.+--+-- Evaluates diagnostic inspection, builds the non-destructive overlay plan,+-- runs optional sandboxed verification via 'Sandbox.Handler', and materializes+-- missing assets if in 'ApplySync' mode.+runRetrofitPipeline :: RetrofitInput -> IO OverlayResult+runRetrofitPipeline input = do+ diag <- scanRepository (inputTargetDir input)+ plan <- computeOverlayPlan (inputTargetDir input) diag+ let ctx = RetrofitContext+ { ctxInput = input+ , ctxDiagnostic = diag+ , ctxPlan = plan+ }+ case inputSyncMode input of+ DryRun ->+ pure (runRetrofitPipelinePure ctx)+ ApplySync -> do+ -- Execute the overlay plan transactionally+ executeOverlayPlan plan
test/Main.hs view
@@ -23,6 +23,7 @@ import Test.Hspec import Gachi.Retrofit+import qualified Penelope.Effects.Binary as Pen import Gachi.Schema.Project (Author(..), defaultProject) main :: IO ()@@ -464,6 +465,76 @@ length (qgGateResults report) `shouldBe` 14 removeDirectoryRecursive tmpDir `catch` (\(_ :: SomeException) -> pure ())++ describe "Gachi.Retrofit.Pipeline (Penelope Polycategorical Effect System Integration)" $ do+ it "evaluates pure retrofit pipeline simulation via Penelope Rope" $ do+ let input = defaultRetrofitInput "/test/project"+ diag = DiagnosticReport+ { diagTargetDir = "/test/project"+ , diagProjectName = "test-proj"+ , diagPrimaryLanguage = Just (LangOther "none")+ , diagLanguages = []+ , diagBuildSystems = []+ , diagLayout = LayoutSinglePackage+ , diagDiscoveredPackages = []+ , diagTestInfra = TestInfrastructure False [] [] 0+ , diagDocGaps = []+ , diagDocCompliancePct = 50.0+ , diagGitGovernance = GitGovernanceStatus False False Nothing False False False False False False Nothing+ , diagVerificationHarness = VerificationHarnessStatus False Nothing False False False False False False+ , diagRetrofitScore = 50.0+ , diagRemediationPlan = []+ }+ plan = OverlayPlan+ { planTargetDir = "/test/project"+ , planProjectName = "test-proj"+ , planActions =+ [ OverlayAction ActionCreate "README.md" "content" False CategoryDocumentation "desc"+ , OverlayAction ActionPreserve "src/Main.hs" "" False CategoryDocumentation "desc"+ ]+ , planGitActions = [GitInitRepo]+ , planCreatedCount = 1+ , planPreservedCount = 1+ }+ ctx = RetrofitContext input diag plan+ res = runRetrofitPipelinePure ctx+ resultTargetDir res `shouldBe` "/test/project"+ resultProjectName res `shouldBe` "test-proj"+ resultCreatedFiles res `shouldBe` ["README.md"]+ resultPreservedFiles res `shouldBe` ["src/Main.hs"]+ resultSuccess res `shouldBe` True++ it "composes Penelope Rope pipeline strands cleanly" $ do+ let pipe = buildRetrofitSimulationPipeline+ input = defaultRetrofitInput "/test/pipeline"+ diag = DiagnosticReport+ { diagTargetDir = "/test/pipeline"+ , diagProjectName = "pipeline-proj"+ , diagPrimaryLanguage = Just LangHaskell+ , diagLanguages = []+ , diagBuildSystems = [BuildCabalProject]+ , diagLayout = LayoutMultiPackage+ , diagDiscoveredPackages = []+ , diagTestInfra = TestInfrastructure False [] [] 0+ , diagDocGaps = []+ , diagDocCompliancePct = 100.0+ , diagGitGovernance = GitGovernanceStatus True True (Just ".githooks") True True True True True True (Just ".gitmessage")+ , diagVerificationHarness = VerificationHarnessStatus True (Just "bin/verify") True True True True True True+ , diagRetrofitScore = 100.0+ , diagRemediationPlan = []+ }+ plan = OverlayPlan+ { planTargetDir = "/test/pipeline"+ , planProjectName = "pipeline-proj"+ , planActions = []+ , planGitActions = []+ , planCreatedCount = 0+ , planPreservedCount = 0+ }+ ctx = RetrofitContext input diag plan+ res = Pen.runRopePure pipe ctx+ resultProjectName res `shouldBe` "pipeline-proj"+ resultSuccess res `shouldBe` True findRepoRoot :: FilePath -> IO FilePath findRepoRoot dir = do