interface updates

Author: vkottler

svgen/app.py

@@ -15,12 +15,10 @@
 
 # internal
 from svgen import PKG_NAME
-from svgen.attribute.viewbox import ViewBox
 from svgen.color.theme.manager import DEFAULT_THEME, THEMES
-from svgen.element.svg import Svg, add_background_grid
+from svgen.element.svg import Svg
 from svgen.generation.images import generate_images
 from svgen.script import invoke_script
-from svgen.shapes.border import compose_borders
 
 
 def generate(
@@ -41,12 +39,7 @@ def generate(
     if cwd_str not in path:
         path.append(cwd_str)
 
-    doc = Svg(ViewBox.from_dict(cast(GenericStrDict, config)))
-    add_background_grid(doc, config["background"], config["grid"])
-    if "border" in config:
-        doc.children.extend(compose_borders(doc.viewbox, config["border"]))
-    if "opacity" in config:
-        doc["opacity"] = config["opacity"]
+    doc = Svg.app(cast(GenericStrDict, config))
 
     # Compose the document, via the external script.
     for script in list(scripts) + [Path(x) for x in config["scripts"]]:

svgen/element/path.py

@@ -4,10 +4,13 @@
 
 # built-in
 from enum import StrEnum
+from typing import Any
 
 # internal
+from svgen.attribute.viewbox import ViewBox
 from svgen.cartesian.mutate import Translation
 from svgen.cartesian.point import Point
+from svgen.color.resolve import get_color
 from svgen.element import Element
 
 
@@ -63,3 +66,25 @@ def translation(self, translation: Translation, cmd: PathCmd) -> None:
     def path(self, **kwargs) -> Path:
         """Get a path element based on this builder's state."""
         return Path.create(*self.cmds, **kwargs)
+
+
+def compose_borders(viewbox: ViewBox, config: dict[str, Any]) -> list[Element]:
+    """An example function for composing a document."""
+
+    builder = PathBuilder()
+    builder.point(viewbox.box.top_left, PathCmd.MOVE)
+
+    builder.horizontal(viewbox.width)
+    builder.vertical(viewbox.height)
+    builder.horizontal(-viewbox.width)
+    builder.close()
+
+    data = {
+        "fill": "none",
+        "stroke-width": config.get("stroke_width", 2),
+        "stroke": get_color(config["color"]),
+    }
+    if "opacity" in config:
+        data["stroke-opacity"] = config["opacity"]
+
+    return [builder.path(attrib=data)]

svgen/element/svg.py

@@ -9,6 +9,7 @@
 from svgen.attribute import XMLNS, Attribute
 from svgen.attribute.viewbox import ViewBox
 from svgen.element import Element
+from svgen.element.path import compose_borders
 from svgen.element.rect import Rect
 
 
@@ -26,6 +27,20 @@ def __init__(
             attrs.append(XMLNS)
         super().__init__(attrib=attrs, **extra)
 
+    @staticmethod
+    def app(config: GenericStrDict) -> "Svg":
+        """Get an application SVG document."""
+
+        doc = Svg(ViewBox.from_dict(config))
+
+        add_background_grid(doc, config["background"], config["grid"])
+        if "border" in config:
+            doc.children.extend(compose_borders(doc.viewbox, config["border"]))
+        if "opacity" in config:
+            doc["opacity"] = config["opacity"]
+
+        return doc
+
 
 def add_background_grid(
     svg: Svg, background: GenericStrDict, grid: GenericStrDict