Merge pull request #32 from Mr-Neutr0n/fix/icons-quoted-attributes
fix(icons): normalize quoted URL SVG attributes
This commit is contained in:
@@ -29,6 +29,9 @@ jobs:
|
|||||||
- name: Verify accessible SVG contract
|
- name: Verify accessible SVG contract
|
||||||
run: python3 scripts/test-lint-a11y.py
|
run: python3 scripts/test-lint-a11y.py
|
||||||
|
|
||||||
|
- name: Verify URL SVG normalization
|
||||||
|
run: python3 scripts/test-build-icons-quoted-attributes.py
|
||||||
|
|
||||||
- name: Verify Devicon normalization
|
- name: Verify Devicon normalization
|
||||||
run: python3 scripts/test-build-icons-devicon.py
|
run: python3 scripts/test-build-icons-devicon.py
|
||||||
|
|
||||||
|
|||||||
+45
-15
@@ -246,11 +246,13 @@ def normalize_url(raw: str) -> str:
|
|||||||
- White / near-white fills (#fff, #ffffff, white) are kept as-is — they
|
- White / near-white fills (#fff, #ffffff, white) are kept as-is — they
|
||||||
act as contrast cutouts in 2-colour logos (e.g. white letter on coloured
|
act as contrast cutouts in 2-colour logos (e.g. white letter on coloured
|
||||||
circle). Every other colour becomes currentColor.
|
circle). Every other colour becomes currentColor.
|
||||||
- inline style="fill:#..." is rewritten to a fill= attribute.
|
- inline fill/stroke colours are normalized without discarding other styles.
|
||||||
- Inkscape layer translate() transforms are stripped (canvas offset artefact).
|
- Inkscape layer translate() transforms are stripped (canvas offset artefact).
|
||||||
"""
|
"""
|
||||||
vb_match = re.search(r'viewBox="([^"]+)"', raw, re.IGNORECASE)
|
vb_match = re.search(
|
||||||
viewbox = vb_match.group(1) if vb_match else "0 0 128 128"
|
r'\bviewBox\s*=\s*(["\'])(.*?)\1', raw, flags=re.IGNORECASE
|
||||||
|
)
|
||||||
|
viewbox = vb_match.group(2).strip() if vb_match else "0 0 128 128"
|
||||||
inner = re.search(r"<svg\b[^>]*>(.*?)</svg>", raw, flags=re.DOTALL | re.IGNORECASE)
|
inner = re.search(r"<svg\b[^>]*>(.*?)</svg>", raw, flags=re.DOTALL | re.IGNORECASE)
|
||||||
if not inner:
|
if not inner:
|
||||||
raise ValueError("no <svg> in payload")
|
raise ValueError("no <svg> in payload")
|
||||||
@@ -261,27 +263,55 @@ def normalize_url(raw: str) -> str:
|
|||||||
# Strip Inkscape canvas-offset translate transforms from group wrappers
|
# Strip Inkscape canvas-offset translate transforms from group wrappers
|
||||||
body = re.sub(r'\btransform="translate\([^"]+\)"', '', body)
|
body = re.sub(r'\btransform="translate\([^"]+\)"', '', body)
|
||||||
|
|
||||||
def _rewrite_fill(m: re.Match) -> str:
|
def _normalized_fill(value: str) -> str:
|
||||||
"""Keep white; turn everything else into currentColor."""
|
"""Keep white; turn everything else into currentColor."""
|
||||||
hex_val = m.group(1).lower().strip()
|
hex_val = value.lower().strip()
|
||||||
if hex_val in ("#fff", "#ffffff", "white", "#fefefe", "#fdfdfd"):
|
if hex_val in ("#fff", "#ffffff", "white", "#fefefe", "#fdfdfd"):
|
||||||
return 'fill="#fff"'
|
return "#fff"
|
||||||
return 'fill="currentColor"'
|
return "currentColor"
|
||||||
|
|
||||||
# Rewrite inline style="fill:#rrggbb" → standalone fill= attribute
|
def _normalize_inline_style(match: re.Match) -> str:
|
||||||
|
quote, declarations = match.group(1), match.group(2)
|
||||||
|
declarations = re.sub(
|
||||||
|
r'(\bfill\s*:\s*)(#[0-9a-fA-F]{3,8}|white)\b',
|
||||||
|
lambda fill: f"{fill.group(1)}{_normalized_fill(fill.group(2))}",
|
||||||
|
declarations,
|
||||||
|
flags=re.IGNORECASE,
|
||||||
|
)
|
||||||
|
declarations = re.sub(
|
||||||
|
r'(\bstroke\s*:\s*)#[0-9a-fA-F]{3,8}\b',
|
||||||
|
lambda stroke: f"{stroke.group(1)}currentColor",
|
||||||
|
declarations,
|
||||||
|
flags=re.IGNORECASE,
|
||||||
|
)
|
||||||
|
return f"style={quote}{declarations}{quote}"
|
||||||
|
|
||||||
|
# Normalize supported inline colours while preserving unrelated declarations.
|
||||||
body = re.sub(
|
body = re.sub(
|
||||||
r'style="[^"]*fill:\s*(#[0-9a-fA-F]{3,8}|white)[^"]*"',
|
r'style\s*=\s*(["\'])(.*?)\1',
|
||||||
lambda m: _rewrite_fill(re.search(r'(#[0-9a-fA-F]{3,8}|white)', m.group(0))),
|
_normalize_inline_style,
|
||||||
body,
|
body,
|
||||||
|
flags=re.IGNORECASE,
|
||||||
)
|
)
|
||||||
# Rewrite standalone fill="#rrggbb" attributes
|
# Rewrite standalone fill="#rrggbb" attributes.
|
||||||
body = re.sub(
|
body = re.sub(
|
||||||
r'\bfill="(#[0-9a-fA-F]{3,8}|white)"',
|
r'\bfill\s*=\s*(["\'])(#[0-9a-fA-F]{3,8}|white)\1',
|
||||||
_rewrite_fill,
|
lambda m: f'fill="{_normalized_fill(m.group(2))}"',
|
||||||
body,
|
body,
|
||||||
|
flags=re.IGNORECASE,
|
||||||
|
)
|
||||||
|
body = re.sub(
|
||||||
|
r'\bstroke\s*=\s*(["\'])#[0-9a-fA-F]{3,8}\1',
|
||||||
|
'stroke="currentColor"',
|
||||||
|
body,
|
||||||
|
flags=re.IGNORECASE,
|
||||||
|
)
|
||||||
|
body = re.sub(
|
||||||
|
r'\bfill\s*=\s*(["\'])none\1',
|
||||||
|
'',
|
||||||
|
body,
|
||||||
|
flags=re.IGNORECASE,
|
||||||
)
|
)
|
||||||
body = re.sub(r'\bstroke="#[0-9a-fA-F]{3,8}"', 'stroke="currentColor"', body)
|
|
||||||
body = re.sub(r'\bfill="none"', '', body)
|
|
||||||
body = re.sub(r"\s+", " ", body).strip()
|
body = re.sub(r"\s+", " ", body).strip()
|
||||||
return (
|
return (
|
||||||
f'<svg aria-hidden="true" width="24" height="24" viewBox="{viewbox}" '
|
f'<svg aria-hidden="true" width="24" height="24" viewBox="{viewbox}" '
|
||||||
|
|||||||
+58
@@ -0,0 +1,58 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Regression tests for quote-independent URL SVG normalization."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import importlib.util
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
|
||||||
|
ROOT = Path(__file__).resolve().parent.parent
|
||||||
|
BUILD = ROOT / "scripts" / "build-icons.py"
|
||||||
|
|
||||||
|
|
||||||
|
def load_build_module():
|
||||||
|
sys.dont_write_bytecode = True
|
||||||
|
spec = importlib.util.spec_from_file_location("diagram_design_build_icons", BUILD)
|
||||||
|
if spec is None or spec.loader is None:
|
||||||
|
raise AssertionError("could not load build-icons.py")
|
||||||
|
module = importlib.util.module_from_spec(spec)
|
||||||
|
spec.loader.exec_module(module)
|
||||||
|
return module
|
||||||
|
|
||||||
|
|
||||||
|
def main() -> int:
|
||||||
|
build_icons = load_build_module()
|
||||||
|
svg = (
|
||||||
|
"<svg viewBox='0 0 32 16'>"
|
||||||
|
"<path style='fill:#123456;stroke:#654321;opacity:.5' d='M0 0h32v16H0z'/>"
|
||||||
|
"<circle fill='#abcdef' stroke='#111111' cx='8' cy='8' r='4'/>"
|
||||||
|
"</svg>"
|
||||||
|
)
|
||||||
|
normalized = build_icons.normalize_url(svg)
|
||||||
|
if 'viewBox="0 0 32 16"' not in normalized:
|
||||||
|
raise AssertionError(f"single-quoted viewBox was not preserved: {normalized}")
|
||||||
|
if any(color in normalized for color in ("#123456", "#654321", "#abcdef", "#111111")):
|
||||||
|
raise AssertionError(f"source colors escaped normalization: {normalized}")
|
||||||
|
path = re.search(r"<path\b([^>]*)>", normalized)
|
||||||
|
if path is None:
|
||||||
|
raise AssertionError(f"normalized path is missing: {normalized}")
|
||||||
|
path_attributes = path.group(1)
|
||||||
|
for declaration in ("fill:currentColor", "stroke:currentColor", "opacity:.5"):
|
||||||
|
if declaration not in path_attributes:
|
||||||
|
raise AssertionError(
|
||||||
|
f"path lost or failed to normalize {declaration}: {normalized}"
|
||||||
|
)
|
||||||
|
if (
|
||||||
|
'fill="currentColor"' not in normalized
|
||||||
|
or 'stroke="currentColor"' not in normalized
|
||||||
|
):
|
||||||
|
raise AssertionError(f"standalone quoted colours were not normalized: {normalized}")
|
||||||
|
print("PASS: URL SVG normalization handles single-quoted attributes")
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
raise SystemExit(main())
|
||||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user