mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-13 10:36:35 +00:00
The editor took the whole layout section over but matched offsets to style rows by exact key. A hand-written schema's two blocks were never named alike -- football styles score_text but positions score -- so of football's eleven positionable things only status_text had a control. Score, odds, both logos, timeouts, possession, down-and-distance, date, time and records were options the schema advertised and the renderer reads, reachable nowhere in the UI. Core now resolves each style element's layout key through alias_keys, the map the resolver already reads offsets with, and records it as x-layout-key. The widget reads that rather than carrying a second copy of the rules, and posts under the key the schema declares: football's own offset reader looks up layout.score, so a value saved as layout.score_text would be kept and never drawn. Layout entries no style element claims get an "Other positions" table with its own columns, in every mode panel as well as the base one, in the order the plugin declared them. Verified in a browser against football's real schema: 92 of 92 layout fields (23 base, 23 per mode) rendered exactly once under their declared names, none posted under a style key, no duplicated field names, favorite_result_colors still editable. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
224 lines
10 KiB
Python
224 lines
10 KiB
Python
"""When the style editor takes over a customization block, it takes over
|
|
exactly its own part of it -- and it actually gets to take over at all.
|
|
|
|
Two defects this pins, both found by rendering the real partial in a browser
|
|
rather than by reading the code:
|
|
|
|
1. The hand-off guard asked "do any fallback controls differ from their
|
|
server-rendered defaults?" as a proxy for "is someone editing this?". The
|
|
fallback contains this block's own font fields, and the font-selector
|
|
widget populates them on the same 50ms timer -- so a plain page load with
|
|
nobody touching anything raced into "dirty" (seven customization.*.font
|
|
selects, measured ~60ms after injection) and the style editor removed
|
|
itself, leaving the accordion form it exists to replace. The question is
|
|
whether a *person* typed, and isTrusted answers exactly that.
|
|
|
|
2. Taking over used to remove the whole fallback section. A customization
|
|
block can hold more than styling -- football keeps favorite_result_colors
|
|
there -- so that removed the only UI those fields had.
|
|
|
|
These assert on the template source because the behaviour lives in an inline
|
|
script that no Python test executes; the browser check that found both is not
|
|
something CI runs.
|
|
"""
|
|
|
|
import re
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
import pytest
|
|
|
|
PROJECT_ROOT = Path(__file__).parent.parent.parent
|
|
sys.path.insert(0, str(PROJECT_ROOT))
|
|
|
|
TEMPLATE = (PROJECT_ROOT / "web_interface" / "templates" / "v3" / "partials"
|
|
/ "plugin_config.html")
|
|
|
|
|
|
@pytest.fixture(scope="module")
|
|
def source():
|
|
return TEMPLATE.read_text(encoding="utf-8")
|
|
|
|
|
|
class TestTheHandOffGuard:
|
|
def test_it_asks_whether_a_person_typed(self, source):
|
|
assert "isTrusted" in source, (
|
|
"a programmatic change by a sibling widget must not read as a "
|
|
"user edit -- that is what removed the editor on a plain load")
|
|
assert "userEdited" in source
|
|
|
|
def test_it_no_longer_diffs_values_against_defaults(self, source):
|
|
assert "fallbackIsDirty" not in source, (
|
|
"value-diffing cannot distinguish a user's edit from another "
|
|
"widget populating this block's own fields")
|
|
assert "defaultSelected" not in source
|
|
|
|
def test_the_listeners_are_attached_synchronously(self, source):
|
|
"""The edit worth protecting can happen before initWidget runs, so
|
|
the listeners cannot wait for it.
|
|
|
|
Scoped to this branch: the template defines an initWidget for every
|
|
widget it can render, and the first one in the file belongs to a
|
|
different branch entirely.
|
|
"""
|
|
start = source.index("obj_widget == 'style-editor'")
|
|
branch = source[start:source.index("{% elif prop.properties %}", start)]
|
|
assert "watchForRealEdits" in branch
|
|
assert branch.index("watchForRealEdits") < branch.index("function initWidget"), (
|
|
"the watcher must be installed above this branch's initWidget, "
|
|
"and invoked immediately rather than from inside it")
|
|
|
|
def test_the_guard_still_backs_off_for_a_real_edit(self, source):
|
|
assert re.search(r"if \(userEdited\) \{ container\.remove\(\); return; \}",
|
|
source), "a genuine in-progress edit must still win"
|
|
|
|
|
|
class TestItTakesOverOnlyItsOwnBlocks:
|
|
def test_children_are_individually_addressable(self, source):
|
|
assert 'data-child-key="{{ nested_key }}"' in source, (
|
|
"without a handle per child the only options are removing the "
|
|
"whole section or none of it")
|
|
|
|
def test_removal_is_driven_by_what_the_widget_reported(self, source):
|
|
assert "ownedKeys" in source
|
|
assert "fallback.querySelector(" in source
|
|
|
|
def test_an_unowned_child_survives(self, source):
|
|
"""The empty-section case still removes the lot, so a block that is
|
|
entirely styling looks exactly as it did before."""
|
|
assert "!fallback.querySelector('[data-child-key]')" in source
|
|
|
|
|
|
class TestTheSchemaSaysWhichBlocksAreStyling:
|
|
def test_adopted_blocks_are_marked_and_others_are_not(self):
|
|
from src.element_style import expand_style_elements
|
|
|
|
schema = {
|
|
"type": "object",
|
|
"properties": {
|
|
"customization": {
|
|
"type": "object",
|
|
"properties": {
|
|
"score_text": {
|
|
"type": "object",
|
|
"properties": {
|
|
"font": {"type": "string",
|
|
"default": "PressStart2P-Regular.ttf"},
|
|
"font_size": {"type": "integer", "default": 10},
|
|
"text_color": {"type": "array",
|
|
"default": [255, 255, 255]},
|
|
},
|
|
},
|
|
# Not styling: a feature that happens to live here.
|
|
"favorite_result_colors": {
|
|
"type": "object",
|
|
"properties": {
|
|
"enabled": {"type": "boolean", "default": False},
|
|
"win_color": {"type": "array",
|
|
"default": [0, 255, 0]},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
props = expand_style_elements(schema)["properties"]["customization"]["properties"]
|
|
assert props["score_text"]["x-style-managed"] is True
|
|
assert "x-style-managed" not in props["favorite_result_colors"]
|
|
|
|
|
|
# Football's real layout keys, in its schema's order. The style block and the
|
|
# layout block were written years apart and never agreed on names.
|
|
FOOTBALL_LAYOUT = ["home_logo", "away_logo", "score", "status_text", "date",
|
|
"time", "down_distance", "timeouts", "possession",
|
|
"records", "odds"]
|
|
|
|
|
|
def _offsets(*axes):
|
|
return {"type": "object",
|
|
"properties": {a: {"type": "integer", "default": 0} for a in axes}}
|
|
|
|
|
|
def _style_block():
|
|
return {"type": "object", "properties": {
|
|
"font": {"type": "string", "default": "PressStart2P-Regular.ttf"},
|
|
"font_size": {"type": "integer", "default": 10},
|
|
"text_color": {"type": "array", "default": [255, 255, 255]},
|
|
}}
|
|
|
|
|
|
def _football_shaped():
|
|
layout = {k: _offsets("x_offset", "y_offset") for k in FOOTBALL_LAYOUT}
|
|
layout["records"] = _offsets("away_x_offset", "home_x_offset", "y_offset")
|
|
return {"type": "object", "properties": {"customization": {
|
|
"type": "object",
|
|
"x-style-modes": ["live", "recent"],
|
|
"properties": {
|
|
**{k: _style_block() for k in (
|
|
"score_text", "period_text", "team_name", "status_text",
|
|
"detail_text", "odds_text", "rank_text")},
|
|
"layout": {"type": "object", "properties": layout},
|
|
}}}}
|
|
|
|
|
|
class TestEveryAdvertisedOffsetGetsAControl:
|
|
"""The style editor took the layout section over but only drew offsets
|
|
whose layout key matched a style key exactly. In football that was
|
|
status_text alone: score, odds, both logos, timeouts, possession,
|
|
down-and-distance, date, time and records -- options the schema
|
|
advertises and the renderer reads -- had no control anywhere."""
|
|
|
|
def _customization(self):
|
|
from src.element_style import expand_style_elements
|
|
return expand_style_elements(_football_shaped())[
|
|
"properties"]["customization"]
|
|
|
|
def test_a_style_element_is_told_where_its_offsets_live(self):
|
|
"""Resolved in core through the same alias map the resolver reads
|
|
offsets with, so the editor cannot drift from the renderer."""
|
|
props = self._customization()["properties"]
|
|
assert props["score_text"]["x-layout-key"] == "score"
|
|
assert props["odds_text"]["x-layout-key"] == "odds"
|
|
assert props["status_text"]["x-layout-key"] == "status_text"
|
|
|
|
def test_an_element_with_no_offsets_claims_nothing(self):
|
|
props = self._customization()["properties"]
|
|
for key in ("period_text", "detail_text", "team_name", "rank_text"):
|
|
assert "x-layout-key" not in props[key], key
|
|
|
|
def test_the_mode_copies_carry_it_too(self):
|
|
live = self._customization()["properties"]["modes"]["properties"][
|
|
"live"]["properties"]
|
|
assert live["score_text"]["x-layout-key"] == "score"
|
|
|
|
def test_positions_keep_the_order_the_plugin_declared(self):
|
|
"""Flask sorts keys when it serialises the schema, which would
|
|
otherwise list the logos after the date."""
|
|
c = self._customization()
|
|
assert c["properties"]["layout"]["x-propertyOrder"] == FOOTBALL_LAYOUT
|
|
live_layout = c["properties"]["modes"]["properties"]["live"][
|
|
"properties"]["layout"]
|
|
assert live_layout["x-propertyOrder"] == FOOTBALL_LAYOUT
|
|
|
|
def test_every_layout_entry_is_claimed_or_listed_as_a_position(self):
|
|
"""Mirrors the widget's split: a layout entry either belongs to a
|
|
style row or gets a row of its own. Nothing is left over."""
|
|
props = self._customization()["properties"]
|
|
layout = props["layout"]["properties"]
|
|
claimed = {props[k]["x-layout-key"] for k in props
|
|
if isinstance(props[k], dict) and "x-layout-key" in props[k]}
|
|
positions = [k for k in props["layout"]["x-propertyOrder"]
|
|
if k not in claimed]
|
|
assert claimed | set(positions) == set(layout)
|
|
assert positions == ["home_logo", "away_logo", "date", "time",
|
|
"down_distance", "timeouts", "possession",
|
|
"records"]
|
|
|
|
def test_the_widget_reads_the_annotation_and_lists_positions(self):
|
|
js = (PROJECT_ROOT / "web_interface" / "static" / "v3" / "js"
|
|
/ "widgets" / "style-editor.js").read_text(encoding="utf-8")
|
|
assert "x-layout-key" in js, (
|
|
"the alias rules live in element_style.py; the widget must read "
|
|
"their result rather than carry a second copy")
|
|
assert "function positionRows" in js
|