Files
paper-doc/backend/app/crud/template.py
T
govin 199e328b48 refactor: call a heading a title, and its use a placement
`template_field_library` and `template_field` were one word apart and meant
opposite kinds of thing — a catalogue of rows versus one row — and neither name
said what a row actually is. Every row of the library is a **heading**: a piece
of text like 「1. Introduction」 with a level and typography, which is what the
reader sees at the top of a paragraph; and every row of the join table is that
heading *placed* in a template, `sort` included.

    template_field_library  -> template_title
    template_field          -> template_title_placement
    field_id (the column)   -> title_id
    TemplateFieldLibrary    -> TemplateTitle
    TemplateField           -> TemplateTitlePlacement

The join table keeps its own name rather than becoming `_link`, because it is
not a bare link: it carries `sort`, the only place display order is stored, and
it deliberately allows the same title twice in one template. `_link` would
describe two foreign keys and hide the column the ordering rule rests on.

Carried through every level, because a half-renamed layer is how the confusing
pair got there in the first place: HTTP paths (`/template-field-library` ->
`/template-titles`), the template payload (`fields`/`field_id` ->
`placements`/`title_id`, and `field_count` -> `placement_count`), the Pydantic
schemas, the CRUD modules, the seed script, the frontend API module and types,
and `docs/OVERVIEW.md`, which now states the naming rules outright.

Two deliberate exceptions:

* `paper_template_filed_sort` is untouched — it is a column of the paper module
  and is spelled as the feature was specified.
* The MCP tools keep their agent-facing names (`field_list`, `field_ids`, and
  the `fields`/`field_id` keys in their responses). Agents already call them by
  those names; the storage names they read underneath have changed.

The migration renames in place (data preserved: 4 templates, 45 titles, 63
placements) and is written to tolerate a database where part of it already ran,
which is not hypothetical — the first attempt renamed the tables and then failed
on the column, because Alembic's MySQL dialect wants an explicit type for
`alter_column` and will not rename a column without one. TiDB carries the
foreign key along with both the renamed table and the renamed column, rehearsed
against the cluster first, and it stays enforced.

Verified: seed re-runs clean, the paper smoke test's 45 checks and the MCP
smoke test's 47 pass, `vue-tsc` and the build are clean, and the UI was driven
in a headless browser through the template list, its preview drawer, the title
library page, the template form (which now posts `placements` with `title_id`)
and the paper document with no console errors.
2026-09-22 16:55:02 +08:00

185 lines
5.6 KiB
Python

"""Data access for templates and their ordered title selections."""
from collections.abc import Sequence
from sqlalchemy import func, or_, select
from sqlalchemy.orm import Session
from app.crud.filters import LIKE_ESCAPE, like_pattern
from app.models import Template, TemplateTitle, TemplateTitlePlacement
from app.schemas.template import TemplateListItem, TemplateTitlePlacementInput
def _conditions(keyword: str | None) -> list:
"""Search both the name and the abstract from one box."""
if not keyword:
return []
pattern = like_pattern(keyword)
return [
or_(
Template.name.like(pattern, escape=LIKE_ESCAPE),
Template.abstract.like(pattern, escape=LIKE_ESCAPE),
)
]
def _placement_count_column():
"""A correlated ``COUNT`` of the template's placement rows."""
return (
select(func.count(TemplateTitlePlacement.id))
.where(TemplateTitlePlacement.template_id == Template.id)
.correlate(Template)
.scalar_subquery()
)
def list_templates(
db: Session,
*,
keyword: str | None = None,
page: int = 1,
page_size: int = 20,
) -> tuple[list[TemplateListItem], int]:
"""Return one page of templates with their placement counts, plus the total.
The outline itself is left out: a table row needs the count, not the rows.
Recently edited templates come first, since that is what a user returns to.
"""
conditions = _conditions(keyword)
total = db.scalar(
select(func.count(Template.id)).where(*conditions)
) or 0
stmt = (
select(Template, _placement_count_column().label("placement_count"))
.where(*conditions)
.order_by(Template.updated_at.desc(), Template.id.desc())
.offset((page - 1) * page_size)
.limit(page_size)
)
items = [
TemplateListItem(
id=template.id,
name=template.name,
abstract=template.abstract,
placement_count=placement_count,
created_at=template.created_at,
updated_at=template.updated_at,
)
for template, placement_count in db.execute(stmt).all()
]
return items, total
def get(db: Session, template_id: int) -> Template | None:
"""Return one template with its outline already loaded, or ``None``.
``placements`` (ordered by ``sort``) and each placement's ``title`` are
both configured for eager loading on the relationships, so this is a fixed
number of queries rather than one per title.
"""
return db.get(Template, template_id)
def name_taken(db: Session, name: str, *, exclude_id: int | None = None) -> bool:
"""Whether another template already uses ``name``."""
stmt = select(func.count(Template.id)).where(Template.name == name)
if exclude_id is not None:
stmt = stmt.where(Template.id != exclude_id)
return bool(db.scalar(stmt))
def missing_title_ids(db: Session, title_ids: Sequence[int]) -> list[int]:
"""Which of ``title_ids`` do not exist in the title library.
Returning the offenders rather than a boolean lets the API name them, which
is the difference between a usable error and "invalid request".
"""
wanted = set(title_ids)
if not wanted:
return []
found = set(
db.scalars(select(TemplateTitle.id).where(TemplateTitle.id.in_(wanted))).all()
)
return sorted(wanted - found)
def _build_placements(
placements: Sequence[TemplateTitlePlacementInput],
) -> list[TemplateTitlePlacement]:
"""Materialise the client's selection into placement rows."""
return [
TemplateTitlePlacement(title_id=item.title_id, sort=item.sort)
for item in placements
]
def create(
db: Session,
*,
name: str,
abstract: str | None,
placements: Sequence[TemplateTitlePlacementInput],
) -> Template:
"""Insert a template together with its ordered selection."""
template = Template(name=name, abstract=abstract)
template.placements = _build_placements(placements)
db.add(template)
db.commit()
db.refresh(template)
return template
def update(
db: Session,
template: Template,
*,
name: str | None = None,
abstract: str | None = None,
abstract_provided: bool = False,
placements: Sequence[TemplateTitlePlacementInput] | None = None,
) -> Template:
"""Apply a partial update. ``placements=None`` leaves the selection untouched.
``abstract_provided`` distinguishes "clear the abstract" from "leave it" —
both arrive as ``None`` in the payload, and only the caller knows which the
client meant.
"""
if name is not None:
template.name = name
if abstract_provided:
template.abstract = abstract
if placements is not None:
# delete-orphan removes the dropped rows on flush. The ORM cascade is
# what cleans up the join table, whether or not the database would.
template.placements.clear()
db.flush()
template.placements.extend(_build_placements(placements))
db.commit()
db.refresh(template)
return template
def delete(db: Session, template: Template) -> None:
"""Delete a template and its placement rows."""
db.delete(template)
db.commit()
def delete_many(db: Session, template_ids: Sequence[int]) -> int:
"""Delete several templates, returning how many actually existed."""
if not template_ids:
return 0
templates = list(
db.scalars(
select(Template).where(Template.id.in_(list(template_ids)))
).all()
)
for template in templates:
db.delete(template)
db.commit()
return len(templates)