prophet-cli 0.6.1__tar.gz

prophet_cli-0.6.1/LICENSE

@@ -0,0 +1,201 @@
+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 2026 Prophet Contributors
+
+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.

prophet_cli-0.6.1/PKG-INFO

@@ -0,0 +1,317 @@
+Metadata-Version: 2.4
+Name: prophet-cli
+Version: 0.6.1
+Summary: Prophet ontology tooling CLI
+Author: Prophet Contributors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Chainso/prophet
+Project-URL: Repository, https://github.com/Chainso/prophet
+Project-URL: Issues, https://github.com/Chainso/prophet/issues
+Project-URL: Changelog, https://github.com/Chainso/prophet/blob/main/prophet-cli/CHANGELOG.md
+Keywords: ontology,codegen,dsl,spring,openapi
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0
+Dynamic: license-file
+
+# prophet-cli
+
+`prophet-cli` is the tooling package for Prophet's ontology workflow:
+
+1. Parse DSL (path configured via `project.ontology_file`)
+2. Validate model semantics
+3. Build canonical IR (`.prophet/ir/current.ir.json`) including versioned `query_contracts`
+4. Generate deterministic artifacts (`gen/sql`, `gen/openapi`, `gen/migrations`, `gen/spring-boot`)
+5. Check compatibility against baseline IR
+
+## Install
+
+From PyPI:
+
+```bash
+python3 -m pip install --upgrade prophet-cli
+prophet --help
+```
+
+From source (editable):
+
+From repo root:
+
+```bash
+python3 -m venv .venv --system-site-packages
+.venv/bin/pip install --no-build-isolation -e ./prophet-cli
+```
+
+Run via venv script:
+
+```bash
+.venv/bin/prophet --help
+```
+
+## Commands
+
+### `prophet init`
+Creates starter `prophet.yaml` and internal `.prophet` directories.
+
+```bash
+prophet init
+```
+
+### `prophet validate`
+Parses + validates ontology references, IDs, states/transitions, action contracts, list types, and action/event/trigger links.
+
+```bash
+prophet validate
+```
+
+### `prophet plan`
+Computes deterministic file changes without writing files.
+
+```bash
+prophet plan
+prophet plan --show-reasons
+prophet plan --json
+```
+
+### `prophet check`
+Runs a CI-style gate in one command:
+1. ontology validation
+2. generated output cleanliness check
+3. compatibility/version-bump check against baseline IR
+
+```bash
+prophet check
+prophet check --show-reasons
+prophet check --json
+prophet check --against .prophet/baselines/main.ir.json
+```
+
+`--json` emits structured diagnostics for CI bots and automation.
+
+### `prophet stacks`
+Lists supported stack ids, framework/ORM pairings, implementation status, and capability metadata.
+Entries come from a schema-validated stack manifest.
+Schema reference: `docs/prophet-stack-manifest-schema-v0.1.md`.
+
+```bash
+prophet stacks
+prophet stacks --json
+```
+
+### `prophet hooks`
+Lists generated extension hook surfaces from `gen/manifest/extension-hooks.json`.
+Useful for wiring user-owned implementations against generated interfaces.
+Safety/reference docs:
+- `docs/prophet-extension-hooks-safety-v0.1.md`
+
+```bash
+prophet hooks
+prophet hooks --json
+```
+
+### `prophet generate` / `prophet gen`
+Writes generated artifacts and current IR.
+
+```bash
+prophet generate
+prophet gen
+prophet gen --skip-unchanged
+```
+
+Also syncs generated Spring artifacts into `examples/java/prophet_example_spring` when present.
+
+Stack selection is configured in `prophet.yaml`:
+
+```yaml
+generation:
+  stack:
+    id: java_spring_jpa
+```
+
+Current generator implementation supports artifact generation for `java_spring_jpa`.
+Other declared stacks are validated and reserved for upcoming target implementations.
+Allowed `generation.stack` keys are: `id`, `language`, `framework`, `orm`.
+
+Equivalent tuple form is also supported:
+
+```yaml
+generation:
+  stack:
+    language: java
+    framework: spring_boot
+    orm: jpa
+```
+
+Default generated targets:
+- `sql`
+- `openapi`
+- `spring_boot`
+- `flyway`
+- `liquibase`
+- `manifest` (generated file ownership + hashes)
+
+When baseline IR differs from current IR, Prophet also emits delta migration artifacts:
+- `gen/migrations/flyway/V2__prophet_delta.sql`
+- `gen/migrations/liquibase/prophet/0002-delta.sql`
+- `gen/migrations/delta/report.json`
+
+Delta SQL includes safety flags and warnings (`destructive`, `backfill_required`, `manual_review`) as comments.
+Delta report JSON includes:
+- `summary` counts (`safe_auto_apply_count`, `manual_review_count`, `destructive_count`)
+- structured `findings` entries with classification and optional suggestions
+- heuristic rename hints (`object_rename_hint`, `column_rename_hint`) for manual migration planning
+
+Generated ownership manifest:
+- `gen/manifest/generated-files.json`
+- includes stack metadata and deterministic hashes for generated outputs
+
+Generated extension hook manifest:
+- `gen/manifest/extension-hooks.json`
+- lists generated extension points (for example action handler interfaces + default classes)
+
+Spring runtime migration wiring is auto-detected from the host Gradle project:
+- if Flyway dependency/plugin is present, Prophet syncs Flyway resources
+- if Liquibase dependency/plugin is present, Prophet syncs Liquibase resources
+- if neither is present, migration files are still generated under `gen/migrations/**` but not auto-wired into Spring runtime resources
+
+### `prophet gen --wire-gradle`
+Auto-wires the current Gradle project as a multi-module setup:
+- adds `:prophet_generated` in `settings.gradle.kts`/`settings.gradle`
+- maps it to `gen/spring-boot`
+- adds app dependency `implementation(project(\":prophet_generated\"))` in `build.gradle.kts`
+
+```bash
+prophet gen --wire-gradle
+```
+
+Wiring is idempotent (safe to run repeatedly).
+
+### `prophet generate --verify-clean`
+CI mode. Fails if committed generated files differ from current generation.
+
+```bash
+prophet generate --verify-clean
+```
+
+### `prophet gen --skip-unchanged`
+Skips no-op regeneration when the current config + IR signature matches the last successful generation cache.
+
+- cache file: `.prophet/cache/generation.json`
+- ignored when `--wire-gradle` is used
+- incompatible with `--verify-clean`
+
+```bash
+prophet gen --skip-unchanged
+```
+
+### `prophet clean`
+Removes generated artifacts from current project.
+
+Default removals:
+- `gen/`
+- `.prophet/ir/current.ir.json`
+- `.prophet/cache/generation.json`
+- `src/main/java/<base_package>/<ontology_name>/generated`
+- `src/main/resources/application-prophet.yml`
+- `src/main/resources/schema.sql` (only if it looks generated)
+- `src/main/resources/db/migration/V1__prophet_init.sql` (if generated)
+- `src/main/resources/db/migration/V2__prophet_delta.sql` (if generated)
+- `src/main/resources/db/changelog/**` Prophet-managed generated files, including `0002-delta.sql`
+- Gradle multi-module wiring for `:prophet_generated` in `settings.gradle(.kts)` and `build.gradle(.kts)`
+
+```bash
+prophet clean
+prophet clean --verbose
+prophet clean --remove-baseline
+prophet clean --keep-gradle-wire
+```
+
+### `prophet version check`
+Compares current IR against baseline and reports compatibility + required bump.
+
+```bash
+prophet version check --against .prophet/baselines/main.ir.json
+```
+
+Compatibility rules used by CLI are documented in:
+- `docs/prophet-compatibility-policy-v0.2.md`
+
+## Expected Project Files
+
+- `prophet.yaml`
+- `<your ontology file>` (configured in `project.ontology_file`)
+- `.prophet/baselines/main.ir.json`
+- `.prophet/ir/current.ir.json` (generated)
+- `gen/` (generated)
+
+## DSL Notes
+
+- Field types support scalars, custom types, object refs (`ref(User)`), lists (`string[]`, `list(string)`), and reusable `struct` types.
+- Nested list types are supported (for example `string[][]`, `list(list(string))`).
+- Description metadata supports both `description "..."` and `documentation "..."`.
+- Object keys support field-level and object-level declarations:
+  - `key primary`
+  - `key primary (fieldA, fieldB)` (composite)
+  - `key display (...)` (metadata marker)
+- Generated Java record component order follows DSL field declaration order.
+- Actions are not auto-implemented; generated endpoints call handler beans.
+- Generated action services (`generated.actions.services.*`) are the API boundary used by controllers.
+- Default generated services delegate to handler beans; generated default handler stubs throw `UnsupportedOperationException` until user handlers are provided.
+
+## Config (`prophet.yaml`)
+
+Required keys currently used by CLI:
+
+```yaml
+project:
+  ontology_file: path/to/your-ontology.prophet
+generation:
+  out_dir: gen
+  targets: [sql, openapi, spring_boot, flyway, liquibase]
+  spring_boot:
+    base_package: com.example.prophet
+    boot_version: 3.3
+compatibility:
+  baseline_ir: .prophet/baselines/main.ir.json
+  strict_enums: false
+```
+
+Note: generated Spring package root is `<base_package>.<ontology_name>`.
+
+## Release Prep
+
+- Release process: `prophet-cli/RELEASING.md`
+- Changelog: `prophet-cli/CHANGELOG.md`
+- Version sync is test-enforced between:
+  - `prophet-cli/pyproject.toml` `[project].version`
+  - `prophet-cli/src/prophet_cli/cli.py` `TOOLCHAIN_VERSION`
+
+## Development Notes
+
+- Entry point module: `src/prophet_cli/cli.py`
+- Console script: `prophet`
+- No-op benchmark script: `scripts/benchmark_noop_generation.py`
+- Spring query APIs generated by v0.1 include:
+  - `GET /<objects>/{id}` for single-field primary keys
+  - `GET /<objects>/{k1}/{k2}/...` for composite primary keys
+  - `GET /<objects>` with pagination/sort only
+  - `POST /<objects>/query` with typed filter DSL (`eq`, `in`, `gte`, `lte`, `contains`) for all filtering
+  - list responses returned as generated `*ListResponse` DTOs (no raw Spring `Page` payload)
+- Generated Spring query layer now uses dedicated `generated.mapping.*DomainMapper` classes for entity-to-domain mapping.
+- Example Spring app includes both `h2` (default) and `postgres` runtime profiles with context tests for both.
+
+## Contributing
+
+- See root contribution guide: `CONTRIBUTING.md`
+- Open contributor backlog: `CONTRIBUTING.md` (`Open Items`)
+
+## License
+
+Apache-2.0. See `LICENSE`.