Add crudkit!

crudkit/html/__init__.py

@@ -0,0 +1,3 @@
+from .ui_fragments import make_fragments_blueprint
+
+__all__ = ["make_fragments_blueprint"]

crudkit/html/templates/crudkit/_macros.html

@@ -0,0 +1,93 @@
+{% macro options(items, value_attr="id", label_path="name", getp=None) -%}
+{%- for obj in items -%}
+<option value="{{ getp(obj, value_attr) }}">{{ getp(obj, label_path) }}</option>
+{%- endfor -%}
+{% endmacro %}
+
+{% macro lis(items, label_path="name", sublabel_path=None, getp=None) -%}
+{%- for obj in items -%}
+<li data-id="{{ obj.id }}">
+    <div class="li-main">{{ getp(obj, label_path) }}</div>
+    {%- if sublabel_path %}
+    <div class="li-sub">{{ getp(obj, sublabel_path) }}</div>
+    {%- endif %}
+</li>
+{%- else -%}
+<li class="empty"><em>No results.</em></li>
+{%- endfor -%}
+{% endmacro %}
+
+{% macro rows(items, fields, getp=None) -%}
+{%- for obj in items -%}
+<tr id="row-{{ obj.id }}">
+    {%- for f in fields -%}
+    <td data-field="{{ f }}">{{ getp(obj, f) }}</td>
+    {%- endfor -%}
+</tr>
+{%- else -%}
+<tr>
+    <td colspan="{{ fields|length }}"><em>No results.</em></td>
+</tr>
+{%- endfor -%}
+{%- endmacro %}
+
+{% macro pager(model, page, pages, per_page, sort, filters) -%}
+<nav class="pager">
+    {%- if page > 1 -%}
+    <a hx-get="/{{ model }}/frag/rows?page={{ page-1 }}&per_page={{ per_page }}{% if sort %}&sort={{ sort }}{% endif %}{% for k,v in filters.items() %}&{{k}}={{v}}{% endfor %}"
+        hx-target="#rows" hx-push-url="true">Prev</a>
+    {%- endif -%}
+    <span>Page {{ page }} / {{ pages }}</span>
+    {%- if page < pages -%} <a
+        hx-get="/{{ model }}/frag/rows?page={{ page+1 }}&per_page={{ per_page }}{% if sort %}&sort={{ sort }}{% endif %}{% for k,v in filters.items() %}&{{k}}={{v}}{% endfor %}"
+        hx-target="#rows" hx-push-url="true">Next</a>
+        {%- endif -%}
+</nav>
+{%- endmacro %}
+
+{% macro form(schema, action, method="POST", obj_id=None, hx=False, csrf_token=None) -%}
+<form action="{{ action }}" method="post" {%- if hx %} hx-{{ "patch" if obj_id else "post" }}="{{ action }}"
+    hx-target="closest dialog, #modal-body, body" hx-swap="innerHTML" hx-disabled-elt="button[type=submit]" {%- endif
+    -%}>
+    {%- if csrf_token %}<input type="hidden" name="csrf_token" value="{{ csrf_token() }}">{% endif -%}
+    {%- if obj_id %}<input type="hidden" name="id" value="{{ obj_id }}">{% endif -%}
+    <input type="hidden" name="fields_csv" value="{{ request.args.get('fields_csv','id,name') }}">
+
+    {%- for f in schema -%}
+    <div class="field" data-name="{{ f.name }}">
+        {% set fid = 'f-' ~ f.name ~ '-' ~ (obj_id or 'new') %}
+        <label for="{{ fid }}">{{ f.label or f.name|replace('_',' ')|title }}</label>
+        {%- if f.type == "textarea" -%}
+        <textarea id="{{ fid }}" name="{{ f.name }}" {%- if f.required %} required{% endif %}{% if f.maxlength %}
+            maxlength="{{ f.maxlength }}" {% endif %}>{{ f.value or "" }}</textarea>
+        {%- elif f.type == "select" -%}
+        <select id="{{ fid }}" name="{{ f.name }}" {% if f.required %}required{% endif %}>
+            <option value="">{{ f.placeholder or ("Choose " ~ (f.label or f.name|replace('_',' ')|title)) }}</option>
+            {% if f.multiple %}
+            {% set selected = (f.value or [])|list %}
+            {% for val, lbl in f.choices %}
+            <option value="{{ val }}" {{ 'selected' if val in selected else '' }}>{{ lbl }}</option>
+            {% endfor %}
+            {% else %}
+            {% for val, lbl in f.choices %}
+            <option value="{{ val }}" {{ 'selected' if (f.value|string)==(val|string) else '' }}>{{ lbl }}</option>
+            {% endfor %}
+            {% endif %}
+        </select>
+        {%- elif f.type == "checkbox" -%}
+        <input type="hidden" name="{{ f.name }}" value="0">
+        <input id="{{ fid }}" type="checkbox" name="{{ f.name }}" value="1" {{ "checked" if f.value else "" }}>
+        {%- else -%}
+        <input id="{{ fid }}" type="{{ f.type }}" name="{{ f.name }}"
+            value="{{ f.value if f.value is not none else '' }}" {%- if f.required %} required{% endif %} {%- if
+            f.maxlength %} maxlength="{{ f.maxlength }}" {% endif %}>
+        {%- endif -%}
+        {%- if f.help %}<div class="help">{{ f.help }}</div>{% endif -%}
+    </div>
+    {%- endfor -%}
+
+    <div class="actions">
+        <button type="submit">Save</button>
+    </div>
+</form>
+{%- endmacro %}

crudkit/html/templates/crudkit/form.html

@@ -0,0 +1,3 @@
+{% import "_macros.html" as ui %}
+{% set action = url_for('frags.save', model=model) %}
+{{ ui.form(schema, action, method="POST", obj_id=obj.id if obj else None, hx=true) }}

crudkit/html/templates/crudkit/lis.html

@@ -0,0 +1,2 @@
+{% import "_macros.html" as ui %}
+{{ ui.lis(items, label_path=label_path, sublabel_path=sublabel_path, getp=getp) }}

crudkit/html/templates/crudkit/options.html

@@ -0,0 +1,3 @@
+{# Renders only <option>...</option> rows #}
+{% import "_macros.html" as ui %}
+{{ ui.options(items, value_attr=value_attr, label_path=label_path, getp=getp) }}

crudkit/html/templates/crudkit/row.html

@@ -0,0 +1,2 @@
+{% import "_macros.html" as ui %}
+{{ ui.rows([obj], fields, getp=getp) }}

crudkit/html/templates/crudkit/rows.html

@@ -0,0 +1,3 @@
+{% import "_macros.html" as ui %}
+{{ ui.rows(items, fields, getp=getp) }}
+{{ ui.pager(model, page, pages, per_page, sort, filters) }}

crudkit/html/type_map.py

@@ -0,0 +1,137 @@
+from __future__ import annotations
+from typing import Any, Dict, List, Optional, Tuple
+from sqlalchemy import select
+from sqlalchemy.inspection import inspect
+from sqlalchemy.orm import Mapper, RelationshipProperty
+from sqlalchemy.sql.schema import Column
+from sqlalchemy.sql.sqltypes import (
+    String, Text, Unicode, UnicodeText,
+    Integer, BigInteger, SmallInteger, Float, Numeric, Boolean,
+    Date, DateTime, Time, JSON, Enum
+)
+
+CANDIDATE_LABELS = ("name", "title", "label", "display_name")
+
+def _guess_label_attr(model_cls) -> str:
+    for cand in CANDIDATE_LABELS:
+        if hasattr(model_cls, cand):
+            return cand
+    return "id"
+
+def _pretty(label: str) -> str:
+    return label.replace("_", " ").title()
+
+def _column_input_type(col: Column) -> str:
+    t = col.type
+    if isinstance(t, (String, Unicode)):
+        return "text"
+    if isinstance(t, (Text, UnicodeText, JSON)):
+        return "textarea"
+    if isinstance(t, (Integer, SmallInteger, BigInteger)):
+        return "number"
+    if isinstance(t, (Float, Numeric)):
+        return "number"
+    if isinstance(t, Boolean):
+        return "checkbox"
+    if isinstance(t, Date):
+        return "date"
+    if isinstance(t, DateTime):
+        return "datetime-local"
+    if isinstance(t, Time):
+        return "time"
+    if isinstance(t, Enum):
+        return "select"
+    return "text"
+
+def _enum_choices(col: Column) -> Optional[List[Tuple[str, str]]]:
+    t = col.type
+    if isinstance(t, Enum):
+        if t.enum_class:
+            return [(e.name, e.value) for e in t.enum_class]
+        if t.enums:
+            return [(v, v) for v in t.enums]
+    return None
+
+def build_form_schema(model_cls, session, obj=None, *, include=None, exclude=None, fk_limit=200):
+    mapper: Mapper = inspect(model_cls)
+    include = set(include or [])
+    exclude = set(exclude or {"id", "created_at", "updated_at", "deleted", "version"})
+    fields = []
+
+    fields: List[Dict[str, Any]] = []
+
+    fk_map = {}
+    for rel in mapper.relationships:
+        for lc in rel.local_columns:
+            fk_map[lc.key] = rel
+
+    for attr in mapper.column_attrs:
+        col = attr.columns[0]
+        name = col.key
+        if include and name not in include:
+            continue
+        if name in exclude:
+            continue
+
+        field = {
+            "name": name,
+            "type": _column_input_type(col),
+            "required": not col.nullable,
+            "value": getattr(obj, name, None) if obj is not None else None,
+            "placeholder": "",
+            "help": "",
+            # default label from column name
+            "label": _pretty(name),
+        }
+
+        enum_choices = _enum_choices(col)
+        if enum_choices:
+            field["type"] = "select"
+            field["choices"] = enum_choices
+
+        if name in fk_map:
+            rel = fk_map[name]
+            target = rel.mapper.class_
+            label_attr = _guess_label_attr(target)
+            rows = session.execute(select(target).limit(fk_limit)).scalars().all()
+            field["type"] = "select"
+            field["choices"] = [(getattr(r, "id"), getattr(r, label_attr)) for r in rows]
+            field["rel"] = {"target": target.__name__, "label_attr": label_attr}
+            field["label"] = _pretty(rel.key)
+
+        if getattr(col.type, "length", None):
+            field["maxlength"] = col.type.length
+
+        fields.append(field)
+
+    for rel in mapper.relationships:
+        if not rel.uselist or rel.secondary is None:
+            continue  # only true many-to-many
+
+        if include and f"{rel.key}_ids" not in include:
+            continue
+
+        target = rel.mapper.class_
+        label_attr = _guess_label_attr(target)
+        choices = session.execute(select(target).limit(fk_limit)).scalars().all()
+
+        current = []
+        if obj is not None:
+            current = [getattr(x, "id") for x in getattr(obj, rel.key, []) or []]
+
+        fields.append({
+            "name": f"{rel.key}_ids",     # e.g. "tags_ids"
+            "label": rel.key.replace("_"," ").title(),
+            "type": "select",
+            "multiple": True,
+            "required": False,
+            "choices": [(getattr(r,"id"), getattr(r,label_attr)) for r in choices],
+            "value": current,             # list of selected IDs
+            "placeholder": f"Choose {rel.key.replace('_',' ').title()}",
+            "help": "",
+        })
+
+    if include:
+        order = list(include)
+        fields.sort(key=lambda f: order.index(f["name"]) if f["name"] in include else 10**9)
+    return fields

crudkit/html/ui_fragments.py

@@ -0,0 +1,233 @@
+from __future__ import annotations
+from typing import Any, Dict, List, Tuple
+from math import ceil
+from flask import Blueprint, request, render_template, abort, make_response
+from sqlalchemy import select
+from sqlalchemy.orm import scoped_session
+from sqlalchemy.inspection import inspect
+from sqlalchemy.sql.sqltypes import Integer, Boolean, Date, DateTime, Float, Numeric
+
+from ..dsl import QuerySpec
+from ..service import CrudService
+from ..eager import default_eager_policy
+from .type_map import build_form_schema
+
+def make_fragments_blueprint(db_session_factory, registry: Dict[str, Any], *, name="frags"):
+    """
+    HTML fragments for HTMX/Alpine. No base pages. Pure partials:
+        GET /<model>/frag/options   -> <option>...</option>
+        GET /<model>/frag/lis       -> <li>...</li>
+        GET /<model>/frag/rows      -> <tr>...</tr> + pager markup if wanted
+        GET /<model>/frag/form      -> <form>...</form> (auto-generated)
+    """
+    bp = Blueprint(name, __name__, template_folder="templates/crudkit")
+    def session(): return scoped_session(db_session_factory)()
+
+    def _parse_filters(args):
+        reserved = {"page", "per_page", "sort", "expand", "fields", "value", "label", "label_tpl", "fields_csv", "li_label", "li_sublabel"}
+        out = {}
+        for k, v in args.items():
+            if k not in reserved and v != "":
+                out[k] = v
+        return out
+
+    def _paths_from_csv(csv: str) -> List[str]:
+        return [p.strip() for p in csv.split(",") if p.strip()]
+
+    def _collect_expand_from_paths(paths: List[str]) -> List[str]:
+        rels = set()
+        for p in paths:
+            bits = p.split(".")
+            if len(bits) > 1:
+                rels.add(bits[0])
+        return list(rels)
+
+    def _getp(obj, path: str):
+        cur = obj
+        for part in path.split("."):
+            cur = getattr(cur, part, None) if cur is not None else None
+        return cur
+
+    def _extract_m2m_lists(Model, req_form) -> dict[str, list[int]]:
+        """Return {'tags': [1,2]} for any <rel>_ids fields; caller removes keys from main form."""
+        mapper = inspect(Model)
+        out = {}
+        for rel in mapper.relationships:
+            if not rel.uselist or rel.secondary is None:
+                continue
+            key = f"{rel.key}_ids"
+            ids = req_form.getlist(key)
+            if ids is None:
+                continue
+            out[rel.key] = [int(i) for i in ids if i]
+        return out
+
+    @bp.get("/<model>/frag/options")
+    def options(model):
+        Model = registry.get(model) or abort(404)
+        value_attr = request.args.get("value", default="id")
+        label_path = request.args.get("label", default="name")
+        filters = _parse_filters(request.args)
+
+        expand = _collect_expand_from_paths([label_path])
+        spec = QuerySpec(filters=filters, order_by=[], page=None, per_page=None, expand=expand)
+        s = session(); svc = CrudService(s, default_eager_policy)
+        items, _ = svc.list(Model, spec)
+
+        return render_template("options.html", items=items, value_attr=value_attr, label_path=label_path, getp=_getp)
+
+    @bp.get("/<model>/frag/lis")
+    def lis(model):
+        Model = registry.get(model) or abort(404)
+        label_path = request.args.get("li_label", default="name")
+        sublabel_path = request.args.get("li_sublabel")
+        filters = _parse_filters(request.args)
+        sort = request.args.get("sort")
+        page = request.args.get("page", type=int)
+        per_page = request.args.get("per_page", type=int)
+
+        expand = _collect_expand_from_paths([p for p in (label_path, sublabel_path) if p])
+        spec = QuerySpec(filters=filters, order_by=[sort] if sort else [], page=page, per_page=per_page, expand=expand)
+        s = session(); svc = CrudService(s, default_eager_policy)
+        rows, total = svc.list(Model, spec)
+        pages = (ceil(total / per_page) if page and per_page else 1)
+        return render_template("lis.html", items=rows, label_path=label_path, sublabel_path=sublabel_path, page=page or 1, per_page=per_page or 1, total=total, model=model, sort=sort, filters=filters, getp=_getp)
+
+    @bp.get("/<model>/frag/rows")
+    def rows(model):
+        Model = registry.get(model) or abort(404)
+        fields_csv = request.args.get("fields_csv") or "id,name"
+        fields = _paths_from_csv(fields_csv)
+        filters = _parse_filters(request.args)
+        sort = request.args.get("sort")
+        page = request.args.get("page", type=int) or 1
+        per_page = request.args.get("per_page", type=int) or 20
+
+        expand = _collect_expand_from_paths(fields)
+        spec = QuerySpec(filters=filters, order_by=[sort] if sort else [], page=page, per_page=per_page, expand=expand)
+        s = session(); svc = CrudService(s, default_eager_policy)
+        rows, total = svc.list(Model, spec)
+        pages = max(1, ceil(total / per_page))
+        return render_template("rows.html", items=rows, fields=fields, page=page, pages=pages, per_page=per_page, total=total, model=model, sort=sort, filters=filters, getp=_getp)
+
+    @bp.get("/<model>/frag/form")
+    def form(model):
+        Model = registry.get(model) or abort(404)
+        id = request.args.get("id", type=int)
+        include_csv = request.args.get("include")
+        include = [s.strip() for s in include_csv.split(",")] if include_csv else None
+
+        s = session(); svc = CrudService(s, default_eager_policy)
+        obj = svc.get(Model, id) if id else None
+
+        schema = build_form_schema(Model, s, obj=obj, include=include)
+
+        hx = request.args.get("hx", type=int) == 1
+        return render_template("form.html", model=model, obj=obj, schema=schema, hx=hx)
+
+    def coerce_form_types(Model, data: dict) -> dict:
+        """Turn HTML string inputs into the Python types your columns expect."""
+        mapper = inspect(Model)
+        for attr in mapper.column_attrs:
+            col = attr.columns[0]
+            name = col.key
+            if name not in data:
+                continue
+            v = data[name]
+            if v == "":
+                data[name] = None
+                continue
+            t = col.type
+            try:
+                if isinstance(t, Boolean):
+                    data[name] = v in ("1", "true", "on", "yes", True)
+                elif isinstance(t, Integer):
+                    data[name] = int(v)
+                elif isinstance(t, (Float, Numeric)):
+                    data[name] = float(v)
+                elif isinstance(t, DateTime):
+                    from datetime import datetime
+                    data[name] = datetime.fromisoformat(v)
+                elif isinstance(t, Date):
+                    from datetime import date
+                    data[name] = date.fromisoformat(v)
+            except Exception:
+                # Leave as string; your validator can complain later.
+                pass
+        return data
+
+    @bp.post("/<model>/frag/save")
+    def save(model):
+        Model = registry.get(model) or abort(404)
+        s = session(); svc = CrudService(s, default_eager_policy)
+
+        # grab the raw form and fields to re-render
+        raw = request.form
+        form = raw.to_dict(flat=True)
+        fields_csv = form.pop("fields_csv", "id,name")
+
+        # many-to-many lists first
+        m2m = _extract_m2m_lists(Model, raw)
+        for rel_name in list(m2m.keys()):
+            form.pop(f"{rel_name}_ids", None)
+
+        # coerce primitives for regular columns
+        form = coerce_form_types(Model, form)
+
+        id_val = form.pop("id", None)
+
+        if id_val:
+            obj = svc.get(Model, int(id_val)) or abort(404)
+            svc.update(obj, form)
+        else:
+            obj = svc.create(Model, form)
+
+        # apply many-to-many selections
+        mapper = inspect(Model)
+        for rel_name, id_list in m2m.items():
+            rel = mapper.relationships[rel_name]
+            target = rel.mapper.class_
+            selected = []
+            if id_list:
+                selected = s.execute(select(target).where(target.id.in_(id_list))).scalars().all()
+            coll = getattr(obj, rel_name)
+            coll.clear()
+            coll.extend(selected)
+
+        s.commit()
+
+        rows_html = render_template(
+            "crudkit/row.html",
+            obj=obj,
+            fields=[p.strip() for p in fields_csv.split(",") if p.strip()],
+            getp=_getp,
+        )
+        resp = make_response(rows_html)
+        if id_val:
+            resp.headers["HX-Trigger"] = '{"toast":{"level":"success","message":"Updated"}}'
+            resp.headers["HX-Retarget"] = f"#row-{obj.id}"
+            resp.headers["HX-Reswap"] = "outerHTML"
+        else:
+            resp.headers["HX-Trigger"] = '{"toast":{"level":"success","message":"Created"}}'
+            resp.headers["HX-Retarget"] = "#rows"
+            resp.headers["HX-Reswap"] = "beforeend"
+        return resp
+
+    @bp.get("/_debug/<model>/schema")
+    def debug_model(model):
+        Model = registry[model]
+        from sqlalchemy.inspection import inspect
+        m = inspect(Model)
+        return {
+            "columns": [c.key for c in m.columns],
+            "relationships": [
+                {
+                    "key": r.key,
+                    "target": r.mapper.class_.__name__,
+                    "uselist": r.uselist,
+                    "local_cols": [c.key for c in r.local_columns],
+                } for r in m.relationships
+            ],
+        }
+    return bp
+