resforge 0.1.0__py3-none-any.whl

resforge/android/__init__.py

@@ -0,0 +1,15 @@
+from .dimension import Dimension, dp, inch, mm, pt, px, sp
+from .plural import PluralValues
+from .values import ValuesWriter
+
+__all__ = [
+    "Dimension",
+    "dp",
+    "inch",
+    "mm",
+    "pt",
+    "px",
+    "sp",
+    "PluralValues",
+    "ValuesWriter",
+]

resforge/android/dimension.py

@@ -0,0 +1,61 @@
+from typing import Any, Callable, Literal
+
+DimensionUnit = Literal["dp", "sp", "px", "pt", "mm", "in"]
+
+
+class Dimension:
+    """Represents an Android dimension value (e.g., '16dp', '12sp')."""
+
+    value: int | float
+    unit: DimensionUnit
+
+    def __init__(self, value: int | float, unit: DimensionUnit):
+        """
+        Args:
+            value: The numeric dimension value. Negative values are permitted
+                to support negative margins/offsets, though they are
+                typically ignored by padding and size attributes.
+            unit: The unit of measure (dp, sp, px, pt, mm, in).
+        """
+        self.value = value
+        self.unit = unit
+
+    def __str__(self) -> str:
+        return f"{self.value:g}{self.unit}"
+
+    def __repr__(self) -> str:
+        return f"Dimension(value={self.value!r}, unit={self.unit!r})"
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, Dimension):
+            return NotImplemented
+        return self.value == other.value and self.unit == other.unit
+
+    def __mul__(self, other: Any) -> "Dimension":
+        if not isinstance(other, (int, float)):
+            return NotImplemented
+        return Dimension(self.value * other, self.unit)
+
+    def __rmul__(self, other: Any) -> "Dimension":
+        return self.__mul__(other)
+
+
+def _make_unit_func(
+    unit: DimensionUnit, doc: str
+) -> Callable[[int | float], Dimension]:
+    def f(value: int | float) -> Dimension:
+        return Dimension(value, unit)
+
+    f.__name__ = unit
+    f.__doc__ = doc
+    return f
+
+
+dp = _make_unit_func("dp", "Create a dimension in density-independent pixels (dp).")
+sp = _make_unit_func(
+    "sp", "Create a dimension in scale-independent pixels (sp). Use for text sizes."
+)
+px = _make_unit_func("px", "Create a dimension in pixels (px).")
+pt = _make_unit_func("pt", "Create a dimension in points (pt).")
+mm = _make_unit_func("mm", "Create a dimension in millimeters (mm).")
+inch = _make_unit_func("in", "Create a dimension in inches (in).")

resforge/android/plural.py

@@ -0,0 +1,22 @@
+from typing import NotRequired, TypedDict
+
+
+class PluralValues(TypedDict):
+    """
+    Represents the quantity-based strings for an Android plurals resource.
+
+    Attributes:
+        zero: String for quantity 0 (optional).
+        one: String for quantity 1 (optional).
+        two: String for quantity 2 (optional).
+        few: String for quantity 'few' (optional).
+        many: String for quantity 'many' (optional).
+        other: The default fallback string (required).
+    """
+
+    zero: NotRequired[str]
+    one: NotRequired[str]
+    two: NotRequired[str]
+    few: NotRequired[str]
+    many: NotRequired[str]
+    other: str

resforge/android/values.py

@@ -0,0 +1,239 @@
+import re
+import xml.etree.ElementTree as ET
+from pathlib import Path
+from typing import Pattern, Self
+
+from .dimension import Dimension
+from .plural import PluralValues
+
+_NAME_PATTERN = re.compile(r"^[a-z_][a-z0-9_]*$")
+_STYLE_NAME_PATTERN = re.compile(r"^[a-zA-Z_][a-zA-Z0-9_\.]*$")
+_COLOR_PATTERN = re.compile(
+    r"^#([A-Fa-f0-9]{3}|[A-Fa-f0-9]{4}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$"
+)
+
+
+class ValuesWriter:
+    """
+    A fluent context manager for generating Android XML resource files.
+
+    Provides a type-safe interface for creating strings, dimensions, colors,
+    and arrays. Validates resource names and color formats at runtime.
+
+    Example:
+        >>> with ValuesWriter("res/values/my_values.xml") as res:
+        ...     res.dimension(padding_small=dp(8)).color(primary=0xFF0000)
+    """
+
+    def __init__(self, path: str | Path):
+        """
+        Args:
+            path: The filesystem path where the XML will be saved.
+        """
+        self._path = Path(path)
+        self._root: ET.Element | None = None
+        self._seen_names: dict[str, set[str]] = {}
+
+    def __enter__(self) -> Self:
+        self._root = ET.Element("resources")
+        self._seen_names = {}
+        return self
+
+    def __exit__(self, exc_type, *_) -> None:
+        try:
+            if exc_type is None and self._root is not None:
+                self._path.parent.mkdir(parents=True, exist_ok=True)
+
+                ET.indent(self._root, space="    ", level=0)
+
+                tree = ET.ElementTree(self._root)
+                tree.write(
+                    self._path,
+                    encoding="utf-8",
+                    xml_declaration=True,
+                    short_empty_elements=True,
+                )
+        finally:
+            self._root = None
+            self._seen_names.clear()
+
+    def _prepare_text(self, text: str) -> str:
+        text = text.replace("'", r"\'")
+        text = text.replace('"', r"\"")
+        text = text.replace("\n", r"\n")
+        if text.startswith(("@", "?")):
+            text = "\\" + text
+        return text
+
+    def _append(
+        self,
+        tag: str,
+        name: str,
+        text: str | None = None,
+        attrs: dict[str, str] | None = None,
+        name_validation_pattern: Pattern[str] = _NAME_PATTERN,
+    ) -> ET.Element:
+        if self._root is None:
+            raise RuntimeError("ValuesWriter must be used as a context manager.")
+
+        if not name_validation_pattern.match(name):
+            raise ValueError(f"Invalid resource name '{name}'.")
+
+        seen_for_tag = self._seen_names.setdefault(tag, set())
+        if name in seen_for_tag:
+            raise ValueError(
+                f"Duplicate resource name '{name}' for tag <{tag}>. "
+                f"The name '{name}' has already been defined with this type."
+            )
+        seen_for_tag.add(name)
+
+        all_attrs = {"name": name}
+        if attrs:
+            all_attrs.update(attrs)
+        elem = ET.SubElement(self._root, tag, attrib=all_attrs)
+        if text is not None:
+            elem.text = text
+        return elem
+
+    def comment(self, text: str) -> Self:
+        """Appends an XML comment to group or annotate resources."""
+        if self._root is None:
+            raise RuntimeError("ValuesWriter must be used as a context manager.")
+        sanitized = text.replace("--", "- -")
+        self._root.append(ET.Comment(f" {sanitized} "))
+        return self
+
+    def string(self, **values: str) -> Self:
+        """
+        Appends one or more <string> resources.
+        """
+        for name, val in values.items():
+            self._append("string", name, self._prepare_text(val))
+        return self
+
+    def boolean(self, **values: bool) -> Self:
+        """
+        Appends one or more <bool> resources.
+        Converts Python booleans to lowercase 'true'/'false'.
+        """
+        for name, val in values.items():
+            self._append("bool", name, str(val).lower())
+        return self
+
+    def color(self, **values: str | int) -> Self:
+        """
+        Appends one or more <color> resources.
+
+        Supports hex integers (0xAARRGGBB) and
+        standard Android hex strings (#RGB, #ARGB, #RRGGBB, #AARRGGBB).
+
+        Raises:
+            ValueError: If the integer range is invalid or string format is incorrect.
+        """
+        for name, val in values.items():
+            if isinstance(val, int):
+                if 0 <= val <= 0xFFFFFF:
+                    color_str = f"#FF{val:06X}"
+                elif 0xFFFFFF < val <= 0xFFFFFFFF:
+                    color_str = f"#{val:08X}"
+                else:
+                    raise ValueError(
+                        f"Color '{name}' has invalid integer value: {val:#x}"
+                    )
+
+            elif isinstance(val, str):
+                if not _COLOR_PATTERN.match(val):
+                    raise ValueError(
+                        f"Color '{name}' has invalid format: '{val}'. "
+                        "Expected #RGB, #ARGB, #RRGGBB, or #AARRGGBB."
+                    )
+                color_str = val
+
+            else:
+                raise TypeError(
+                    f"Color '{name}' must be str or int, got {type(val).__name__}"
+                )
+
+            self._append("color", name, color_str.upper())
+        return self
+
+    def dimension(self, **values: Dimension) -> Self:
+        """
+        Appends one or more <dimen> resources using Dimension objects.
+        """
+        for name, val in values.items():
+            self._append("dimen", name, str(val))
+        return self
+
+    def res_id(self, *values: str) -> Self:
+        """
+        Appends one or more <item type="id"> resources.
+        Typically used in ids.xml to pre-declare resource IDs.
+        """
+        for name in values:
+            self._append("item", name, attrs={"type": "id"})
+        return self
+
+    def integer(self, **values: int) -> Self:
+        """Appends one or more <integer> resources."""
+        for name, val in values.items():
+            self._append("integer", name, str(val))
+        return self
+
+    def _array(
+        self, tag: str, name: str, values: list[int] | list[str], escape: bool = False
+    ) -> Self:
+        parent = self._append(tag, name)
+        for val in values:
+            item = ET.SubElement(parent, "item")
+            sanitized = self._prepare_text(str(val)) if escape else str(val)
+            item.text = str(val).lower() if isinstance(val, bool) else sanitized
+        return self
+
+    def typed_array(self, name: str, values: list[str]) -> Self:
+        """
+        Appends a generic <array> (Typed Array).
+        Used for arrays of references (e.g., drawables or colors).
+        """
+        return self._array("array", name, values)
+
+    def integer_array(self, name: str, values: list[int]) -> Self:
+        """Appends an <integer-array> resource."""
+        return self._array("integer-array", name, values)
+
+    def string_array(self, name: str, values: list[str]) -> Self:
+        """Appends a <string-array> resource."""
+        return self._array("string-array", name, values)
+
+    def plurals(self, **values: PluralValues) -> Self:
+        """
+        Appends a <plurals> resource with quantity-specific strings.
+
+        Args:
+            name: The resource name.
+            values: A dictionary of quantities (zero, one, etc.) to strings.
+        """
+        for name, val in values.items():
+            parent = self._append("plurals", name)
+            for quantity, text in val.items():
+                item = ET.SubElement(parent, "item", attrib={"quantity": quantity})
+                item.text = self._prepare_text(str(text))
+        return self
+
+    def style(self, name: str, parent: str | None = None, **items: str) -> Self:
+        """
+        Appends a <style> resource.
+
+        Example:
+            writer.style("AppTheme", parent="Theme.Material", colorPrimary="@color/blue")
+        """
+        attrs = {}
+        if parent:
+            attrs["parent"] = parent
+
+        style_elem = self._append(
+            "style", name, attrs=attrs, name_validation_pattern=_STYLE_NAME_PATTERN
+        )
+        for attr_name, val in items.items():
+            ET.SubElement(style_elem, "item", attrib={"name": attr_name}).text = val
+        return self

resforge-0.1.0.dist-info/METADATA

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: resforge
+Version: 0.1.0
+Summary: Fluent builder for Android resources
+Project-URL: Homepage, https://kipila.dev
+Project-URL: Repository, https://github.com/ok100/resforge
+Author-email: Ondrej Kipila <ondrej@kipila.dev>
+License: MIT
+License-File: LICENSE
+Keywords: android,asset,builder,ci,mobile,pipeline,resources,tooling
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# resforge
+
+A fluent Python library for generating Android XML resource files.
+
+## Installation
+
+```bash
+pip install resforge
+```
+
+## Android
+
+```python
+from resforge.android import PluralValues, ValuesWriter, dp, sp
+
+with ValuesWriter("res/values/resources.xml") as res:
+    res.comment("Strings")
+    res.string(
+        app_name="My App",
+        welcome_message="Welcome to My App!",
+    )
+
+    res.comment("Booleans")
+    res.boolean(
+        feature_enabled=True,
+        dark_mode=False,
+    )
+
+    res.comment("Colors")
+    res.color(
+        primary="#FF6200EE",
+        secondary="#FF03DAC5",
+        accent=0x6200EE,
+    )
+
+    res.comment("Dimensions")
+    res.dimension(
+        padding_small=dp(8),
+        padding_large=dp(24),
+        text_body=sp(16),
+        text_heading=sp(24),
+    )
+
+    res.comment("Integers")
+    res.integer(
+        max_retries=3,
+        timeout_seconds=30,
+    )
+
+    res.comment("Resource IDs")
+    res.res_id("btn_submit", "tv_title", "iv_logo")
+
+    res.comment("String arrays")
+    res.string_array("planets", ["Mercury", "Venus", "Earth", "Mars"])
+
+    res.comment("Integer arrays")
+    res.integer_array("fibonacci", [1, 1, 2, 3, 5, 8, 13])
+
+    res.comment("Typed arrays")
+    res.typed_array(
+        "icons", ["@drawable/home", "@drawable/settings", "@drawable/logout"]
+    )
+
+    res.comment("Plurals")
+    res.plurals(
+        item_count=PluralValues(one="%d item", other="%d items"),
+        file_count=PluralValues(one="%d file", other="%d files"),
+    )
+
+    res.comment("Styles")
+    res.style(
+        "AppTheme",
+        parent="Theme.MaterialComponents.DayNight",
+        colorPrimary="@color/primary",
+        colorSecondary="@color/secondary",
+    )
+```
+
+## iOS
+
+Coming in v0.2.0.
+
+## License
+
+MIT

resforge-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+resforge/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+resforge/android/__init__.py,sha256=xh8272LaiOtlFFrii40QLJlzDFBlwOLTu9cHYfqmA_w,259
+resforge/android/dimension.py,sha256=ES-EZTWUV8DJnMXBPs-PNKaT1A2TCqMKAp1XNV2Y5FU,2021
+resforge/android/plural.py,sha256=npUGImwJkog1v3-GyDJ9dnM-2NzP2dCNbZhulStqDDs,632
+resforge/android/values.py,sha256=Eertoq2bkPXwWuVUC2rC4cZ9e2ug2hYK1oHXQ9kHp6Q,8267
+resforge-0.1.0.dist-info/METADATA,sha256=uywEDGSqxZ3gw5UuwoGzsvXzH9GaUWNezoLruLmE910,2488
+resforge-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+resforge-0.1.0.dist-info/licenses/LICENSE,sha256=Vww-ranhESd4qdCVuImsBMy79L9mSNcGq9NOgujpJQI,1070
+resforge-0.1.0.dist-info/RECORD,,

resforge-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

resforge-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ondrej Kipila
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.