splent-cli 1.27.1__tar.gz → 1.28.0__tar.gz

{splent_cli-1.27.1/src/splent_cli.egg-info → splent_cli-1.28.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splent_cli
-Version: 1.27.1
+Version: 1.28.0
 Summary: SPLENT-CLI is a CLI to be able to work on your development more easily.
 Author-email: DiversoLab <diversolab@us.es>
 Project-URL: Homepage, https://github.com/diverso-lab/splent_cli
@@ -14,7 +14,7 @@ Requires-Dist: packaging>=24.0
 Requires-Dist: python-dotenv>=1.0
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: requests>=2.31.0
-Requires-Dist: splent_framework<2,>=1.16.1
+Requires-Dist: splent_framework<2,>=1.18.0
 Requires-Dist: tomli_w>=1.0.0
 Provides-Extra: dev
 Requires-Dist: setuptools==80.3.1; extra == "dev"

{splent_cli-1.27.1 → splent_cli-1.28.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "splent_cli"
-version = "1.27.1"
+version = "1.28.0"
 description = "SPLENT-CLI is a CLI to be able to work on your development more easily."
 readme = "README.md"
 requires-python = ">=3.13"
@@ -23,8 +23,11 @@ dependencies = [
     "pyyaml>=6.0",
     "requests>=2.31.0",
     # The CLI drives the framework (paths, feature order, migrations, the
-    # app factory) and only works with the same major version of it.
-    "splent_framework>=1.16.1,<2",
+    # app factory) and only works with the same major version of it. 1.18.0
+    # resolves a feature to the copy feature:test names (SPLENT_FEATURE_SOURCES)
+    # and brings the production defaults the deploy templates explain; 1.17.0
+    # the refinement rules product:validate shares with the boot.
+    "splent_framework>=1.18.0,<2",
     "tomli_w>=1.0.0",
 ]
 

{splent_cli-1.27.1 → splent_cli-1.28.0}/src/splent_cli/commands/check/check_product.py

@@ -6,9 +6,11 @@ Validates that the active product is correctly wired:
   2. Feature symlinks resolve to real directories
   3. Config overwrites are flagged
   4. Features that loaded but registered no blueprints are warned
+  5. Product templates that link a static file that does not exist are warned
 """
 
 import os
+import re
 import tomllib
 
 import click
@@ -304,6 +306,94 @@ def _check_blueprints(counters):
     counters["ok"] += 1
 
 
+# ── Static links ─────────────────────────────────────────────────────────────
+
+# A literal filename only. One built at render time ('img/' ~ name) cannot be
+# checked without rendering, so it is left alone.
+_STATIC_LINK = re.compile(
+    r"""url_for\(\s*['"]static['"]\s*,\s*filename\s*=\s*['"]([^'"{}~]+)['"]\s*\)"""
+)
+# The icon a broken icon link should point at instead, best first: the
+# scaffold's favicon.svg, then what products that replaced it tend to ship.
+_FAVICONS = (
+    ("favicon.svg", "image/svg+xml"),
+    ("favicon.ico", "image/x-icon"),
+    ("favicon-32.png", "image/png"),
+    ("favicon.png", "image/png"),
+)
+
+
+def _favicon_line(static: str) -> str | None:
+    for filename, mime in _FAVICONS:
+        if os.path.isfile(os.path.join(static, filename)):
+            return (
+                f'<link rel="icon" type="{mime}" '
+                f"href=\"{{{{ url_for('static', filename='{filename}') }}}}\">"
+            )
+    return None
+
+
+def _broken_static_links(product_path: str, product: str) -> list[tuple]:
+    """(template, line number, line, filename) for each link to a missing file.
+
+    Only the product's own templates and the app's static folder, which is
+    what url_for('static', ...) serves. A feature's templates link their
+    blueprint's static folder and ship with the feature.
+    """
+    package = os.path.join(product_path, "src", product)
+    templates = os.path.join(package, "templates")
+    static = os.path.join(package, "static")
+    broken = []
+    if not os.path.isdir(templates):
+        return broken
+    for root, dirs, files in os.walk(templates):
+        dirs.sort()
+        for name in sorted(files):
+            if not name.endswith((".html", ".j2", ".jinja", ".jinja2")):
+                continue
+            path = os.path.join(root, name)
+            try:
+                with open(path, encoding="utf-8") as fh:
+                    lines = fh.read().splitlines()
+            except (OSError, UnicodeDecodeError):
+                continue
+            rel = os.path.relpath(path, package).replace(os.sep, "/")
+            for number, line in enumerate(lines, start=1):
+                for filename in _STATIC_LINK.findall(line):
+                    target = os.path.join(static, *filename.strip("/").split("/"))
+                    if not os.path.isfile(target):
+                        broken.append((rel, number, line.strip(), filename))
+    return broken
+
+
+def _check_static_links(product_path, product, counters):
+    """Warn about product templates linking a static file that is not there."""
+    click.echo()
+    click.secho("  Static links", bold=True, fg="cyan")
+    click.echo()
+
+    broken = _broken_static_links(product_path, product)
+    if not broken:
+        click.echo("  All static links in the product templates resolve.")
+        counters["ok"] += 1
+        return
+
+    favicon_line = _favicon_line(os.path.join(product_path, "src", product, "static"))
+    for rel, number, line, filename in broken:
+        click.echo(
+            click.style("  ⚠  ", fg="yellow")
+            + f"{rel} line {number} links static/{filename}, which does not exist."
+        )
+        if favicon_line and re.search(r"rel=['\"](shortcut )?icon['\"]", line):
+            click.echo(f"     Replace that line with {favicon_line}")
+        else:
+            click.echo(
+                f"     Add the file under src/{product}/static or point the link "
+                "at a file that exists there."
+            )
+    counters["warn"] += len(broken)
+
+
 # ── Command ──────────────────────────────────────────────────────────────────
 
 
@@ -329,9 +419,11 @@ def check_product():
         click.secho("  pyproject.toml not found", fg="red")
         raise SystemExit(1)
 
+    _check_static_links(product_path, product, counters)
+
     if not features:
         click.secho("  No features declared.", fg="yellow")
-        click.echo()
+        _print_summary(counters)
         return
 
     # Report stale contracts before reading them. A check never rewrites a
@@ -345,8 +437,13 @@ def check_product():
     _check_symlinks(product_path, features, counters)
     _check_config_overwrites(counters)
     _check_blueprints(counters)
+    _print_summary(counters)
+
+    if counters["fail"]:
+        raise SystemExit(1)
 
-    # Summary
+
+def _print_summary(counters):
     click.echo()
     parts = []
     if counters["ok"]:
@@ -358,8 +455,5 @@ def check_product():
     click.echo("  " + ", ".join(parts))
     click.echo()
 
-    if counters["fail"]:
-        raise SystemExit(1)
-
 
 cli_command = check_product

{splent_cli-1.27.1 → splent_cli-1.28.0}/src/splent_cli/commands/database/db_console.py

@@ -3,6 +3,7 @@ from dotenv import load_dotenv
 import os
 
 from splent_cli.services import context
+from splent_cli.utils import db_client
 from splent_cli.utils.proc import run, require_tool
 
 
@@ -38,16 +39,14 @@ def db_console():
         )
         raise SystemExit(1)
 
-    require_tool(
-        "mysql",
-        "Install the MariaDB/MySQL client (e.g. 'mariadb-client') and ensure it is on your PATH.",
-    )
+    tool = db_client.client_tool()
+    require_tool(tool, db_client.INSTALL_HINT)
 
     # The password goes in MYSQL_PWD, as in db:dump and db:restore, so it
     # never shows up in the process list.
     result = run(
         [
-            "mysql",
+            tool,
             f"-h{mariadb_hostname}",
             f"-u{mariadb_user}",
             mariadb_database,
@@ -57,7 +56,7 @@ def db_console():
     )
     if result.returncode != 0:
         click.secho(
-            f"❌ Could not open the MariaDB console (mysql exited {result.returncode}).",
+            f"❌ Could not open the MariaDB console ({tool} exited {result.returncode}).",
             fg="red",
         )
         click.secho(

{splent_cli-1.27.1 → splent_cli-1.28.0}/src/splent_cli/commands/database/db_dump.py

@@ -8,6 +8,7 @@ import tempfile
 from datetime import datetime
 
 from splent_cli.services import context
+from splent_cli.utils import db_client
 from splent_cli.utils.proc import run, require_tool
 
 # A dump below this size cannot be a real database export (even an empty
@@ -133,10 +134,8 @@ def db_dump(filename, gzip_output, retention):
             "Create it first or choose another path."
         )
 
-    require_tool(
-        "mysqldump",
-        "Install the MariaDB/MySQL client tools (provides 'mysqldump').",
-    )
+    dump_tool = db_client.dump_tool()
+    require_tool(dump_tool, db_client.INSTALL_HINT)
 
     env = {**os.environ, "MYSQL_PWD": mariadb_password or ""}
 
@@ -153,7 +152,7 @@ def db_dump(filename, gzip_output, retention):
         with os.fdopen(fd, "wb") as out:
             run(
                 [
-                    "mysqldump",
+                    dump_tool,
                     # Reliability flags. --single-transaction takes a
                     # consistent snapshot without locking tables, --quick
                     # streams rows instead of buffering whole tables in
@@ -169,7 +168,7 @@ def db_dump(filename, gzip_output, retention):
                 stdout=out,
                 text=False,
                 env=env,
-                tool_hint="Install the MariaDB/MySQL client tools (provides 'mysqldump').",
+                tool_hint=db_client.INSTALL_HINT,
             )
 
         # A truncated dump restores as an empty or partial database, which is

{splent_cli-1.27.1 → splent_cli-1.28.0}/src/splent_cli/commands/database/db_restore.py

@@ -10,6 +10,7 @@ from datetime import datetime
 from dotenv import load_dotenv
 
 from splent_cli.services import context
+from splent_cli.utils import db_client
 from splent_cli.utils.proc import run
 
 # Same-second collisions get _1, _2, ... ; this many tries means something
@@ -108,7 +109,7 @@ def db_restore(filename, yes):
     tmp_sql_path = None
 
     try:
-        # Accept gzip-compressed dumps transparently. mysql needs a plain SQL
+        # Accept gzip-compressed dumps transparently. The client needs a plain SQL
         # stream on stdin, so decompress to a temp file next to the dump and
         # feed that instead. Doing this before the pre-restore backup means a
         # corrupt archive aborts the command before anything else happens.
@@ -140,7 +141,7 @@ def db_restore(filename, yes):
             with os.fdopen(backup_fd, "wb") as backup_out:
                 run(
                     [
-                        "mysqldump",
+                        db_client.dump_tool(),
                         # Same reliability flags as db:dump, so the safety-net
                         # backup is itself a consistent, restorable dump.
                         "--single-transaction",
@@ -152,13 +153,10 @@ def db_restore(filename, yes):
                     ],
                     stdout=backup_out,
                     env=env,
-                    tool_hint=(
-                        "Install the MariaDB/MySQL client tools (provides 'mysqldump'), "
-                        "e.g. 'mysql-client' / 'mariadb-client'."
-                    ),
+                    tool_hint=db_client.INSTALL_HINT,
                 )
         except click.ClickException:
-            # mysqldump missing/failed (often a connection failure): do not proceed
+            # The dump tool missing or failed (often a connection failure): do not proceed
             # to overwrite the live database without a safety net.
             # Only ever the file this run created (O_EXCL above).
             if backup_filename and os.path.exists(backup_filename):
@@ -176,13 +174,10 @@ def db_restore(filename, yes):
         try:
             with open(restore_path, "rb") as sql_file:
                 run(
-                    ["mysql", f"-h{host}", f"-u{user}", database],
+                    [db_client.client_tool(), f"-h{host}", f"-u{user}", database],
                     stdin=sql_file,
                     env=env,
-                    tool_hint=(
-                        "Install the MariaDB/MySQL client tools (provides 'mysql'), "
-                        "e.g. 'mysql-client' / 'mariadb-client'."
-                    ),
+                    tool_hint=db_client.INSTALL_HINT,
                 )
             click.secho(f"✅ Database restored from: {filename}", fg="green")
         except click.ClickException as e:

{splent_cli-1.27.1 → splent_cli-1.28.0}/src/splent_cli/commands/database/db_rollback.py

@@ -14,6 +14,7 @@ from splent_cli.commands.database.db_upgrade import (
 from splent_cli.utils.decorators import requires_db
 from splent_cli.services import context
 from splent_cli.utils.lifecycle import advance_state, resolve_feature_key_from_entry
+from splent_cli.utils.refinement_facts import read_refines
 from splent_framework.managers.migration_manager import MigrationManager
 from splent_framework.managers.feature_order import FeatureLoadOrderResolver
 from splent_framework.utils.feature_utils import get_features_from_pyproject
@@ -22,11 +23,35 @@ from splent_framework.utils.pyproject_reader import PyprojectReader
 
 
 def _find_dependents(feature: str, product_dir: str) -> list[str]:
-    """Find features that depend on `feature` via UVL constraints.
+    """Find the features that depend on `feature`, to roll back first.
 
-    Uses FeatureLoadOrderResolver's UVL parsing (same logic as feature:order).
-    Returns list of dependent feature package names.
+    The UVL constraints name them (``A => feature``, in constraint order, the
+    logic feature:order uses), and so does the refinement metadata the boot
+    reads: a refiner's migrations change its base's tables, so it is rolled
+    back before its base even when the UVL does not relate them. Returns
+    package names, the UVL dependents first and then any other refiner.
     """
+    dependents = _uvl_dependents(feature, product_dir)
+    for refiner in _refiners_of(feature, product_dir):
+        if refiner not in dependents:
+            dependents.append(refiner)
+    return dependents
+
+
+def _refiners_of(feature: str, product_dir: str) -> list[str]:
+    """The product's features that refine `feature`, in declared order."""
+    try:
+        entries = PyprojectReader.for_product(product_dir).features_for_env(
+            os.getenv("SPLENT_ENV")
+        )
+        refines = read_refines(product_dir, entries)
+    except Exception:
+        return []
+    return [refiner for refiner, base in refines.items() if base == feature]
+
+
+def _uvl_dependents(feature: str, product_dir: str) -> list[str]:
+    """Features whose UVL constraint says they require `feature`."""
     from splent_cli.services import spl_store
 
     try:

{splent_cli-1.27.1 → splent_cli-1.28.0}/src/splent_cli/commands/database/db_seed.py

@@ -6,6 +6,7 @@ import click
 from splent_cli.utils.decorators import requires_db
 from splent_cli.services import context
 from splent_cli.utils.lifecycle import resolve_feature_key_from_entry
+from splent_cli.utils.refinement_facts import read_refines
 from splent_cli.utils.feature_utils import (
     get_features_from_pyproject,
     normalize_namespace,
@@ -16,9 +17,11 @@ from splent_framework.utils.pyproject_reader import PyprojectReader
 
 
 def _resolve_feature_order(features_raw: list[str]) -> list[str]:
-    """Return features in topological order using the product's UVL constraints.
+    """Return features in the order the product loads them.
 
-    Falls back to the declared order in pyproject.toml if no UVL is available.
+    The UVL constraints order them, and every refiner comes after the
+    feature it refines (the refinement metadata the boot reads), with or
+    without a UVL. Features with neither keep their declared order.
     """
     splent_app = os.getenv("SPLENT_APP", "")
     working_dir = os.getenv("WORKING_DIR", "/workspace")
@@ -39,7 +42,8 @@ def _resolve_feature_order(features_raw: list[str]) -> list[str]:
         except (OSError, KeyError, AttributeError):
             pass
 
-    return FeatureLoadOrderResolver().resolve(features_raw, uvl_path)
+    refines = read_refines(product_dir, features_raw) if product_dir else {}
+    return FeatureLoadOrderResolver().resolve(features_raw, uvl_path, refines=refines)
 
 
 def _collect_seeders(module_name):

{splent_cli-1.27.1 → splent_cli-1.28.0}/src/splent_cli/commands/feature/feature_add.py

@@ -1,5 +1,4 @@
 import os
-import tomli_w
 import click
 from splent_cli.services import context
 from splent_cli.utils.feature_utils import (
@@ -14,7 +13,8 @@ from splent_cli.utils.feature_utils import (
     remove_feature_link,
     write_features_to_data,
 )
-from splent_cli.utils.io_utils import load_toml, atomic_write
+from splent_cli.utils.io_utils import load_toml
+from splent_cli.utils.toml_edit import write_toml
 from splent_cli.utils.manifest import feature_key, remove_feature, set_feature_state
 
 
@@ -126,6 +126,15 @@ def feature_add(full_name, env_scope):
         click.echo(f"  {short} already in {where}.")
         return
 
+    drop_feature_entries(data, feature_name, namespace=org_safe)
+    for key in target_keys:
+        features = read_feature_list(data, key)
+        features.append(full_name)
+        write_features_to_data(data, features, key=key)
+    # Written first: when the edit cannot be made exactly it is refused with
+    # nothing written, and the stale links and manifest entries are still there.
+    write_toml(pyproject_path, data)
+
     # Drop the stale declarations (other list, pinned version, other spelling of
     # the namespace) together with what each one created, so the feature ends up
     # declared once per list and with a single symlink.
@@ -137,13 +146,6 @@ def feature_add(full_name, env_scope):
         )
         click.echo(click.style(f"  replacing {stale_entry} in {stale_key}", dim=True))
 
-    drop_feature_entries(data, feature_name, namespace=org_safe)
-    for key in target_keys:
-        features = read_feature_list(data, key)
-        features.append(full_name)
-        write_features_to_data(data, features, key=key)
-    atomic_write(pyproject_path, tomli_w.dumps(data))
-
     scope_label = f" ({env_scope} only)" if env_scope else ""
     click.echo(f"  {short} added to {where}{scope_label}")
 

{splent_cli-1.27.1 → splent_cli-1.28.0}/src/splent_cli/commands/feature/feature_attach.py

@@ -1,5 +1,4 @@
 import os
-import tomli_w
 import click
 from splent_cli.services import context, compose
 from splent_cli.utils.feature_utils import (
@@ -15,7 +14,8 @@ from splent_cli.utils.feature_utils import (
     set_feature_distribution,
     write_features_to_data,
 )
-from splent_cli.utils.io_utils import load_toml, atomic_write
+from splent_cli.utils.io_utils import load_toml
+from splent_cli.utils.toml_edit import write_toml
 from splent_cli.utils.manifest import feature_key, remove_feature, set_feature_state
 
 
@@ -156,7 +156,29 @@ def feature_attach(feature_identifier, version, env_scope):
     stale = [pair for pair in declared if pair not in wanted]
     where = ", ".join(target_keys)
 
-    if sorted(declared) == sorted(wanted):
+    attaching = sorted(declared) != sorted(wanted)
+    if attaching:
+        drop_feature_entries(data, feature_name, namespace=namespace_fs)
+        for key in target_keys:
+            features = read_feature_list(data, key)
+            features.append(full_name)
+            write_features_to_data(data, features, key=key)
+
+    # ── PyPI name, when it is not the feature's own ──────────────────
+    # The production image installs pinned features from PyPI, so it has to
+    # know the name this version was published under. A release under a name
+    # of one's own (splent-feature-notes-alice) keeps the import package, and
+    # this pin, as splent_feature_notes.
+    distribution = read_project_name(versioned_dir)
+    renamed = set_feature_distribution(data, feature_name, distribution)
+
+    # One write, before anything else changes. When the edit cannot be made
+    # exactly it is refused with nothing written, and the old links and
+    # manifest entries are still there.
+    if attaching or renamed:
+        write_toml(pyproject_path, data)
+
+    if not attaching:
         click.echo(f"  {short}@{version} already in {where}.")
     else:
         # Drop the stale declarations (other list, other version, other spelling
@@ -173,13 +195,6 @@ def feature_attach(feature_identifier, version, env_scope):
             click.echo(
                 click.style(f"  replacing {stale_entry} in {stale_key}", dim=True)
             )
-
-        drop_feature_entries(data, feature_name, namespace=namespace_fs)
-        for key in target_keys:
-            features = read_feature_list(data, key)
-            features.append(full_name)
-            write_features_to_data(data, features, key=key)
-        atomic_write(pyproject_path, tomli_w.dumps(data))
         if env_scope:
             scope_label = f" ({env_scope} only)"
         elif target_keys != ["features"]:
@@ -188,17 +203,8 @@ def feature_attach(feature_identifier, version, env_scope):
             scope_label = ""
         click.echo(f"  {short}@{version} attached{scope_label}")
 
-    # ── PyPI name, when it is not the feature's own ──────────────────
-    # The production image installs pinned features from PyPI, so it has to
-    # know the name this version was published under. A release under a name
-    # of one's own (splent-feature-notes-alice) keeps the import package, and
-    # this pin, as splent_feature_notes.
-    distribution = read_project_name(versioned_dir)
-    data = load_toml(pyproject_path, what="pyproject.toml")
-    if set_feature_distribution(data, feature_name, distribution):
-        atomic_write(pyproject_path, tomli_w.dumps(data))
-        if distribution and distribution != feature_name:
-            click.echo(f"  pypi     {short} is published on PyPI as {distribution}")
+    if renamed and distribution and distribution != feature_name:
+        click.echo(f"  pypi     {short} is published on PyPI as {distribution}")
 
     # ── Create/update symlink ─────────────────────────────────────────
     product_features_dir = os.path.join(product_path, "features", namespace_fs)