ferro-orm 0.2.0__tar.gz → 0.3.0__tar.gz

ferro_orm-0.3.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,43 @@
+---
+name: Bug report
+about: Report a bug or unexpected behavior
+title: "`bug` "
+labels: bug
+assignees: Ox54
+
+---
+
+## Summary
+
+<!-- Brief description of the bug. -->
+
+## Environment
+
+- **Ferro version:** <!-- e.g. 0.1.0 or git commit -->
+- **Python version:**
+- **OS:** <!-- e.g. macOS 14, Ubuntu 22.04 -->
+- **Database:** <!-- e.g. SQLite 3.43, PostgreSQL 15 -->
+
+## Steps to reproduce
+
+1.
+2.
+3.
+
+## Expected behavior
+
+<!-- What should happen. -->
+
+## Actual behavior
+
+<!-- What actually happens. Include error messages or tracebacks if relevant. -->
+
+## Minimal example (optional)
+
+```python
+# Minimal code that reproduces the issue
+```
+
+## Additional context
+
+<!-- Logs, screenshots, or other details that might help. -->

ferro_orm-0.3.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,37 @@
+---
+name: Feature request
+about: Suggest a new feature or enhancement for Ferro
+title: "`feat` "
+labels: feature
+assignees: Ox54
+
+---
+
+## Summary
+
+<!-- One or two sentences describing the feature and why it would be useful. -->
+
+## Current state
+
+**Status:** <!-- e.g. Not implemented / Partially implemented -->
+
+<!-- If partially implemented, list what works and what does not. -->
+
+**Documentation references:**
+- <!-- e.g. docs/coming-soon.md, docs/guide/queries.md (lines X–Y) -->
+
+**Current workaround:** <!-- How can users achieve this today, if at all? -->
+
+## Proposed API (examples)
+
+```python
+# Example of how the feature would be used
+```
+
+<!-- Describe how this would integrate with the existing API (query builder, models, etc.). -->
+
+## Acceptance criteria
+
+- [ ]
+- [ ]
+- [ ] Docs updated (e.g. remove from Coming Soon, add to relevant guide).

{ferro_orm-0.2.0 → ferro_orm-0.3.0}/.github/workflows/publish-docs.yml

@@ -1,6 +1,7 @@
 name: Publish Docs
 
 on:
+  workflow_dispatch:
   workflow_call:
     inputs:
       ref:
@@ -41,7 +42,7 @@ jobs:
 
       - name: Build MkDocs site
         run: |
-          uv run mkdocs build --strict
+          uv run --no-sync mkdocs build
 
       - name: Upload Pages artifact
         uses: actions/upload-pages-artifact@v3

ferro_orm-0.3.0/.github/workflows/release.yml

@@ -0,0 +1,491 @@
+name: Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      prerelease:
+        description: 'Create a pre-release'
+        required: false
+        type: boolean
+        default: false
+
+concurrency:
+  group: release-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ci-gate:
+    name: CI Gate
+    uses: ./.github/workflows/ci.yml
+
+  packaging-smoke:
+    name: Packaging Smoke Gate
+    uses: ./.github/workflows/packaging-smoke.yml
+
+  # Bump versions and changelog locally only; export a patch so every later job
+  # validates the exact tree that would be released. Nothing is pushed until
+  # publish-github-release after wheels, sdist, tests, and docs all pass.
+  prepare-release:
+    name: Prepare release (no push)
+    needs: [ci-gate, packaging-smoke]
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.verify_release.outputs.release_created }}
+      release_base_sha: ${{ steps.base_sha.outputs.release_base_sha }}
+      release_tag: ${{ steps.verify_release.outputs.release_tag }}
+      release_version: ${{ steps.verify_release.outputs.release_version }}
+    permissions:
+      contents: read
+      issues: read
+      pull-requests: read
+
+    steps:
+      - name: Record workflow base SHA
+        id: base_sha
+        run: echo "release_base_sha=${{ github.sha }}" >> "$GITHUB_OUTPUT"
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install UV
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install dependencies
+        run: |
+          uv sync --only-group release --no-install-project --python 3.13
+
+      - name: Run semantic-release (local bump only)
+        env:
+          GH_TOKEN: ${{ secrets.RELEASE_TOKEN || secrets.GITHUB_TOKEN }}
+        run: |
+          PRERELEASE_FLAG=""
+          if [ "${{ github.event.inputs.prerelease }}" == "true" ]; then
+            PRERELEASE_FLAG="--prerelease"
+          fi
+
+          # Writes version files + CHANGELOG only; no commit, push, tag, or VCS
+          # release. --skip-build defers packaging to validation jobs.
+          uv run semantic-release version $PRERELEASE_FLAG \
+            --no-vcs-release --no-tag --no-commit --no-push --skip-build
+
+      - name: Verify release candidate and write patch
+        id: verify_release
+        shell: bash
+        run: |
+          set -euo pipefail
+          # Normalize to a single index-vs-HEAD patch (stable for git apply on runners).
+          git add -A
+          git diff --cached HEAD > release.patch
+
+          if [[ ! -s release.patch ]]; then
+            echo "No semantic version bump in this run (index matches HEAD)."
+            echo "release_created=false" >> "$GITHUB_OUTPUT"
+            echo "changelog_validated=skipped" >> "$GITHUB_OUTPUT"
+            echo "release_tag=" >> "$GITHUB_OUTPUT"
+            echo "release_version=" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+
+          if ! grep -qE '^diff --git a/CHANGELOG\.md b/CHANGELOG\.md' release.patch; then
+            echo "WARNING: expected CHANGELOG.md to change for a release bump."
+            echo "release_created=false" >> "$GITHUB_OUTPUT"
+            echo "changelog_validated=missing" >> "$GITHUB_OUTPUT"
+            echo "release_tag=" >> "$GITHUB_OUTPUT"
+            echo "release_version=" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+
+          VERSION="$(python3 -c "import tomllib; print(tomllib.load(open('pyproject.toml', 'rb'))['project']['version'])")"
+          echo "release_created=true" >> "$GITHUB_OUTPUT"
+          echo "changelog_validated=passed" >> "$GITHUB_OUTPUT"
+          echo "release_tag=v${VERSION}" >> "$GITHUB_OUTPUT"
+          echo "release_version=${VERSION}" >> "$GITHUB_OUTPUT"
+          echo "Prepared v${VERSION} as patch against ${{ github.sha }}"
+
+      - name: Upload release patch
+        if: steps.verify_release.outputs.release_created == 'true'
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-patch
+          path: release.patch
+
+      - name: Release summary
+        if: always()
+        shell: bash
+        run: |
+          {
+            echo "## Release workflow summary"
+            echo ""
+            echo "- Trigger: \`${{ github.event_name }}\`"
+            echo "- Base ref: \`${{ github.ref_name }}\` @ \`${{ github.sha }}\`"
+            echo "- Release candidate prepared: \`${{ steps.verify_release.outputs.release_created || 'unknown' }}\`"
+            echo "- Changelog validation: \`${{ steps.verify_release.outputs.changelog_validated || 'unknown' }}\`"
+            echo "- Tag if published: \`${{ steps.verify_release.outputs.release_tag || 'n/a' }}\`"
+          } >> "$GITHUB_STEP_SUMMARY"
+
+  # Build and publish jobs are inlined here (not in a reusable workflow) so that
+  # PyPI Trusted Publishing sees workflow_ref = release.yml. Reusable workflows
+  # are not supported by PyPI Trusted Publishing.
+  build-wheels:
+    name: Build wheels (${{ matrix.platform.name }})
+    needs: [prepare-release]
+    if: needs.prepare-release.outputs.release_created == 'true'
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      fail-fast: false
+      matrix:
+        platform:
+          - name: linux-x86_64
+            runner: ubuntu-latest
+            target: x86_64
+            manylinux: auto
+          - name: linux-aarch64
+            runner: ubuntu-latest
+            target: aarch64
+            manylinux: auto
+          - name: macos-aarch64
+            runner: macos-latest
+            target: aarch64
+            manylinux: ''
+          - name: windows-x64
+            runner: windows-latest
+            target: x64
+            manylinux: ''
+
+    steps:
+      - name: Disable Git CRLF conversion before checkout
+        shell: bash
+        run: git config --global core.autocrlf false
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.prepare-release.outputs.release_base_sha }}
+
+      - name: Download release patch
+        uses: actions/download-artifact@v4
+        with:
+          name: release-patch
+          path: release-patch
+
+      - name: Apply release patch
+        shell: bash
+        run: |
+          git config core.autocrlf false
+          git apply release-patch/release.patch
+          rm -rf release-patch
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1.48.0
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter
+          manylinux: ${{ matrix.platform.manylinux }}
+          sccache: 'true'
+
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.platform.name }}
+          path: dist/*.whl
+
+  build-sdist:
+    name: Build sdist
+    needs: [prepare-release]
+    if: needs.prepare-release.outputs.release_created == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Disable Git CRLF conversion before checkout
+        shell: bash
+        run: git config --global core.autocrlf false
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.prepare-release.outputs.release_base_sha }}
+
+      - name: Download release patch
+        uses: actions/download-artifact@v4
+        with:
+          name: release-patch
+          path: release-patch
+
+      - name: Apply release patch
+        shell: bash
+        run: |
+          git config core.autocrlf false
+          git apply release-patch/release.patch
+          rm -rf release-patch
+
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1.48.0
+        with:
+          command: sdist
+          args: --out dist
+
+      - name: Upload sdist
+        uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  test-wheels:
+    name: Test wheels (${{ matrix.os }})
+    needs: [prepare-release, build-wheels]
+    if: needs.prepare-release.outputs.release_created == 'true'
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    steps:
+      - name: Disable Git CRLF conversion before checkout
+        shell: bash
+        run: git config --global core.autocrlf false
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.prepare-release.outputs.release_base_sha }}
+
+      - name: Download release patch
+        uses: actions/download-artifact@v4
+        with:
+          name: release-patch
+          path: release-patch
+
+      - name: Apply release patch
+        shell: bash
+        run: |
+          git config core.autocrlf false
+          git apply release-patch/release.patch
+          rm -rf release-patch
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Download wheels
+        uses: actions/download-artifact@v4
+        with:
+          path: dist
+          pattern: wheels-*
+          merge-multiple: true
+
+      - name: Install wheel
+        shell: bash
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --find-links dist ferro-orm
+
+      - name: Test import
+        shell: bash
+        run: |
+          python -c "import ferro; print('Ferro imported successfully')"
+
+      - name: Run basic smoke test
+        shell: bash
+        run: |
+          python -c "
+          import asyncio
+          from ferro import Model, FerroField, connect
+          from typing import Annotated
+
+          class TestModel(Model):
+              id: Annotated[int, FerroField(primary_key=True)]
+              name: str
+
+          async def test():
+              await connect('sqlite::memory:')
+              print('Connection test passed')
+
+          asyncio.run(test())
+          "
+
+  verify-docs:
+    name: Verify documentation build
+    needs: [prepare-release]
+    if: needs.prepare-release.outputs.release_created == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Disable Git CRLF conversion before checkout
+        shell: bash
+        run: git config --global core.autocrlf false
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.prepare-release.outputs.release_base_sha }}
+
+      - name: Download release patch
+        uses: actions/download-artifact@v4
+        with:
+          name: release-patch
+          path: release-patch
+
+      - name: Apply release patch
+        shell: bash
+        run: |
+          git config core.autocrlf false
+          git apply release-patch/release.patch
+          rm -rf release-patch
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install UV
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Install documentation dependencies
+        run: |
+          uv sync --only-group docs --no-install-project --python 3.13
+
+      - name: Build MkDocs site
+        run: |
+          uv run --no-sync mkdocs build
+
+  publish-github-release:
+    name: Commit, tag, and create GitHub Release
+    needs: [prepare-release, build-wheels, build-sdist, test-wheels, verify-docs]
+    if: needs.prepare-release.outputs.release_created == 'true'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+    steps:
+      - name: Disable Git CRLF conversion before checkout
+        shell: bash
+        run: git config --global core.autocrlf false
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.prepare-release.outputs.release_base_sha }}
+          fetch-depth: 0
+          ssh-key: ${{ secrets.RELEASE_DEPLOY_KEY }}
+          # Required so the deploy key stays loaded for git push in the next step.
+          persist-credentials: true
+
+      - name: Download release patch
+        uses: actions/download-artifact@v4
+        with:
+          name: release-patch
+          path: release-patch
+
+      - name: Apply release patch and push release commit
+        env:
+          VERSION: ${{ needs.prepare-release.outputs.release_version }}
+          TAG: ${{ needs.prepare-release.outputs.release_tag }}
+        run: |
+          set -euo pipefail
+          git config core.autocrlf false
+          git apply release-patch/release.patch
+          rm -rf release-patch
+
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git config user.name "github-actions[bot]"
+          git remote set-url origin "git@github.com:${{ github.repository }}.git"
+
+          if git ls-remote --tags origin "refs/tags/${TAG}" | grep -q .; then
+            echo "ERROR: tag ${TAG} already exists on the remote."
+            exit 1
+          fi
+
+          git add -A
+          git commit --author="semantic-release <semantic-release@github.com>" \
+            -m "chore(release): ${VERSION}" \
+            -m "Automatically generated by python-semantic-release"
+          git push origin "HEAD:refs/heads/${{ github.ref_name }}"
+
+          git tag "${TAG}"
+          git push origin "refs/tags/${TAG}"
+
+      # semantic-release matches branch config (e.g. branches.main); detached HEAD fails with
+      # "Detached HEAD state cannot match any release groups".
+      - name: Attach HEAD to branch for semantic-release
+        run: git switch -C "${{ github.ref_name }}"
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install UV
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache Rust dependencies
+        uses: Swatinem/rust-cache@v2
+        with:
+          prefix-key: "v1-rust"
+
+      - name: Install dependencies
+        run: |
+          uv sync --only-group release --no-install-project --python 3.13
+
+      - name: Publish GitHub release (assets + VCS release)
+        env:
+          GH_TOKEN: ${{ secrets.RELEASE_TOKEN || secrets.GITHUB_TOKEN }}
+        run: |
+          uv run semantic-release publish --tag "${{ needs.prepare-release.outputs.release_tag }}"
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: [prepare-release, publish-github-release]
+    if: needs.prepare-release.outputs.release_created == 'true'
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/ferro-orm
+    permissions:
+      id-token: write
+    steps:
+      - name: Download sdist
+        uses: actions/download-artifact@v4
+        with:
+          name: sdist
+          path: dist
+
+      - name: Download wheels
+        uses: actions/download-artifact@v4
+        with:
+          pattern: wheels-*
+          path: dist
+          merge-multiple: true
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true
+          verbose: true
+
+  deploy-docs:
+    name: Deploy Documentation
+    needs: [prepare-release, publish-pypi]
+    if: needs.prepare-release.outputs.release_created == 'true'
+    uses: ./.github/workflows/publish-docs.yml
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    with:
+      ref: ${{ needs.prepare-release.outputs.release_tag }}

{ferro_orm-0.2.0 → ferro_orm-0.3.0}/.gitignore

@@ -241,3 +241,7 @@ ferro_test.db
 .cursor
 playground.ipynb
 IMPLEMENTATION.md
+Cargo.lock
+demo.db
+docs/superpowers/plans/2026-04-22-shadow-fk-types.md
+docs/superpowers/specs/2026-04-22-shadow-fk-types-design.md

{ferro_orm-0.2.0 → ferro_orm-0.3.0}/CHANGELOG.md

@@ -1,6 +1,108 @@
 # CHANGELOG
 
 
+## v0.3.0 (2026-04-22)
+
+### Bug Fixes
+
+- Align composite unique index names and harden Alembic/Rust handling
+  ([`3350481`](https://github.com/syn54x/ferro-orm/commit/33504812d37d93bf69c2be8f6bee6f390803a460))
+
+- Refresh Pydantic FieldInfo when reconciling shadow FK types
+  ([`6cf1ac8`](https://github.com/syn54x/ferro-orm/commit/6cf1ac8c2e361df8de11795a8151c34d17a39445))
+
+### Chores
+
+- Remove doc
+  ([`16e4028`](https://github.com/syn54x/ferro-orm/commit/16e4028f72fc47109b2511d1feb23811c831f32c))
+
+### Continuous Integration
+
+- Fix release
+  ([`688d01b`](https://github.com/syn54x/ferro-orm/commit/688d01bdae0aff1f82e4a1bb60dd1b8ab35e1d01))
+
+- Fix release
+  ([`249e460`](https://github.com/syn54x/ferro-orm/commit/249e46058bac87215920083a9d45557f3c58b62f))
+
+- Fix release
+  ([`888e15e`](https://github.com/syn54x/ferro-orm/commit/888e15eff693d1e1bfa279d809e790e52cd7ce25))
+
+- Fix release
+  ([`58bb5b2`](https://github.com/syn54x/ferro-orm/commit/58bb5b2b0962481b3cfbf3ffbe6c6a2653b213c0))
+
+- Reorder release steps to prevent tagging before checks are complete
+  ([`ad1fd8d`](https://github.com/syn54x/ferro-orm/commit/ad1fd8d5ba08bdd7a1bcd257fff3fc12ff458c12))
+
+### Documentation
+
+- Complete documentation restructure and implementation summary
+  ([`937e75e`](https://github.com/syn54x/ferro-orm/commit/937e75ee7b5c526aca776dd8409f9e0df5f0e892))
+
+- Enhance shadow field documentation and clarify relationship resolution process
+  ([`1d350fd`](https://github.com/syn54x/ferro-orm/commit/1d350fd728310a5b9a24f129986f873a84a8592f))
+
+### Features
+
+- Composite unique constraints and default M2M pair uniqueness
+  ([`dc12880`](https://github.com/syn54x/ferro-orm/commit/dc12880b7b8676c088183edf1f32b48a36314448))
+
+- Derive shadow FK types from related PK and reconcile after resolve
+  ([`d3ae486`](https://github.com/syn54x/ferro-orm/commit/d3ae4862858ccd51f62d62a939e6a90b8efb8980))
+
+### Testing
+
+- UUID FK save reparenting and bulk_create coverage
+  ([`6c93cea`](https://github.com/syn54x/ferro-orm/commit/6c93cea7906ac264b266342ecf71602c7aff6ed6))
+
+
+## v0.2.1 (2026-04-20)
+
+### Bug Fixes
+
+- Defer annotations resolution
+  ([`edd39ab`](https://github.com/syn54x/ferro-orm/commit/edd39abdec7b34410040394d430fd30833e02aee))
+
+### Chores
+
+- Update patch_tags in pyproject.toml to include refactor
+  ([`36c29a7`](https://github.com/syn54x/ferro-orm/commit/36c29a71f0f95845d50d1dd6fdbc14b2c4b20ac2))
+
+### Continuous Integration
+
+- Fix release & mkdocs publish workflows
+  ([`630dc7c`](https://github.com/syn54x/ferro-orm/commit/630dc7cea32da02602acc037e1d8da722d3fb593))
+
+### Documentation
+
+- Restructure documentation following Diátaxis framework
+  ([`b3c2cde`](https://github.com/syn54x/ferro-orm/commit/b3c2cde1d0bde589ad0f08a34002202bca81e5e5))
+
+- Update BackRef references and enhance field documentation
+  ([`baf73ba`](https://github.com/syn54x/ferro-orm/commit/baf73ba03abd554ca8159bc718aa1785b08691ae))
+
+- Update model field annotations to support optional back references
+  ([`2044896`](https://github.com/syn54x/ferro-orm/commit/20448966854d33e64c03a97831f640af279e93b4))
+
+### Refactoring
+
+- Enhance model relationship descriptors and improve field handling
+  ([`6275ebb`](https://github.com/syn54x/ferro-orm/commit/6275ebb9be3ce7a419fb84c381c0a90eec22a5e9))
+
+- Modularize metaclass __new__ method for easier testing and maintenance
+  ([`e514b95`](https://github.com/syn54x/ferro-orm/commit/e514b950cb94e333418f7bd556b8e5b48bf7298e))
+
+- Rename BackRelationship to BackRef and add back_ref to Field
+  ([`d24d32d`](https://github.com/syn54x/ferro-orm/commit/d24d32d3402b51cb738ac2a2c8f396b98d4de632))
+
+- Update demo_queries to use BackRef instead of BackRelationship
+  ([`51799ad`](https://github.com/syn54x/ferro-orm/commit/51799adc1a0b90f937cab7651cf8276f53a16100))
+
+### Testing
+
+- Update references from BackRelationship to BackRef in test files
+  ([`60a1d87`](https://github.com/syn54x/ferro-orm/commit/60a1d87d88fe93996dc0b479c75d40aad3ff143b))
+
+
 ## v0.2.0 (2026-02-14)
 
 ### Chores