velocity-python 0.0.237__tar.gz → 0.0.238__tar.gz

{velocity_python-0.0.237/src/velocity_python.egg-info → velocity_python-0.0.238}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: velocity-python
-Version: 0.0.237
+Version: 0.0.238
 Summary: A rapid application development library for interfacing with data storage
 Author-email: Velocity Team <info@codeclubs.org>
 License-Expression: MIT

{velocity_python-0.0.237 → velocity_python-0.0.238}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "velocity-python"
-version = "0.0.237"
+version = "0.0.238"
 authors = [
   { name="Velocity Team", email="info@codeclubs.org" },
 ]

{velocity_python-0.0.237 → velocity_python-0.0.238}/src/velocity/__init__.py

@@ -1,4 +1,4 @@
-__version__ = version = "0.0.237"
+__version__ = version = "0.0.238"
 
 from . import aws
 from . import db

velocity_python-0.0.238/src/velocity/app/formbuilder/__init__.py

@@ -0,0 +1 @@
+"""velocity.app.formbuilder — shared logic for form_builder_template records."""

velocity_python-0.0.238/src/velocity/app/formbuilder/reshaper.py

@@ -0,0 +1,174 @@
+"""velocity.app.formbuilder.reshaper
+
+Reshape a raw ``form_builder_template`` database row into the public ``fb``
+payload structure as produced by ``DonateMainEvents.OnActionGetFormBuilder``.
+
+The single public entry-point is :func:`reshape_formbuilder_template`.  It is
+a **pure function** — the input is deep-copied and never mutated.
+
+Payment tokens, reCAPTCHA keys, and live thermometer totals are **not**
+included; those are runtime secrets and database query results that the caller
+must add separately (as DonateMain does in
+``OnActionGetFormBuilder``).  The returned dict is safe to serialise and
+return as a preview payload.
+
+Usage::
+
+    from velocity.app.formbuilder.reshaper import reshape_formbuilder_template
+
+    fb = reshape_formbuilder_template(template_row.to_dict())
+"""
+
+import ast
+import copy
+from typing import Any, Dict, Optional
+
+
+# ---------------------------------------------------------------------------
+# Internal per-metric / per-donation helpers
+# ---------------------------------------------------------------------------
+
+def _parse_key_value_string(raw: Optional[str]) -> Dict[str, Any]:
+    """Parse a ``"key1: val1, key2: val2"`` string into a dict.
+
+    Wraps the string in braces and calls ``ast.literal_eval``, exactly as the
+    original DonateMain ``getMetric`` / ``getDonation`` functions do.
+    Returns an empty dict on failure so a bad value never crashes the reshaper.
+    """
+    if not raw:
+        return {}
+    try:
+        return ast.literal_eval("{" + raw + "}")
+    except Exception:
+        return {}
+
+
+def _extract_metric(count: int, data: Dict[str, Any]) -> Dict[str, Any]:
+    """Extract metric_{count}_* fields from *data* (mutates *data*).
+
+    Returns the nested metric dict when the metric has a label and is not
+    hidden, otherwise returns ``{}``.  Either way all flat metric_N_* keys
+    are removed from *data*.
+    """
+    prefix = f"metric_{count}_"
+    flat_keys = [
+        "header", "image", "label", "secondarytext", "helpertext",
+        "values", "defaultvalue", "show_other", "other_minimum_value",
+        "orientation",
+    ]
+
+    is_hidden = data.get(f"{prefix}hide_donation_from_ui")
+    has_label = data.get(f"{prefix}label")
+
+    if not is_hidden and has_label:
+        result = {
+            "header": data.pop(f"{prefix}header", None),
+            "image": data.pop(f"{prefix}image", None),
+            "label": data.pop(f"{prefix}label", None),
+            "secondarytext": data.pop(f"{prefix}secondarytext", None),
+            "helpertext": data.pop(f"{prefix}helpertext", None),
+            "values": _parse_key_value_string(data.pop(f"{prefix}values", None)),
+            "defaultvalue": data.pop(f"{prefix}defaultvalue", None),
+            "show_other": data.pop(f"{prefix}show_other", ""),
+            "other_minimum_value": data.pop(f"{prefix}other_minimum_value", ""),
+            "orientation": data.pop(f"{prefix}orientation", ""),
+        }
+        data.pop(f"{prefix}hide_donation_from_ui", None)
+        return result
+
+    # Strip all flat keys even when hidden / empty
+    for key in flat_keys:
+        data.pop(f"{prefix}{key}", None)
+    data.pop(f"{prefix}hide_donation_from_ui", None)
+    return {}
+
+
+def _extract_donation(count: int, data: Dict[str, Any]) -> Dict[str, Any]:
+    """Extract donation_{count}_* fields from *data* (mutates *data*).
+
+    Returns the nested donation dict when the donation has a label and is not
+    hidden, otherwise returns ``{}``.  Either way all flat donation_N_* keys
+    are removed from *data*.
+    """
+    prefix = f"donation_{count}_"
+    flat_keys = [
+        "header", "image", "html", "label", "secondarytext", "helpertext",
+        "values", "defaultvalue", "show_other", "other_minimum_value",
+        "orientation", "dropdown", "dropdown_label",
+    ]
+
+    is_hidden = data.get(f"{prefix}hide_donation_from_ui")
+    has_label = data.get(f"{prefix}label")
+
+    if not is_hidden and has_label:
+        result = {
+            "header": data.pop(f"{prefix}header", None),
+            "image": data.pop(f"{prefix}image", None),
+            "html": data.pop(f"{prefix}html", None),
+            "label": data.pop(f"{prefix}label", None),
+            "secondarytext": data.pop(f"{prefix}secondarytext", None),
+            "helpertext": data.pop(f"{prefix}helpertext", None),
+            "values": _parse_key_value_string(data.pop(f"{prefix}values", None)),
+            "defaultvalue": data.pop(f"{prefix}defaultvalue", None),
+            "show_other": data.pop(f"{prefix}show_other", ""),
+            "other_minimum_value": data.pop(f"{prefix}other_minimum_value", ""),
+            "orientation": data.pop(f"{prefix}orientation", ""),
+            "dropdown": data.pop(f"{prefix}dropdown", None),
+            "dropdown_label": data.pop(f"{prefix}dropdown_label", None),
+        }
+        data.pop(f"{prefix}hide_donation_from_ui", None)
+        return result
+
+    for key in flat_keys:
+        data.pop(f"{prefix}{key}", None)
+    data.pop(f"{prefix}hide_donation_from_ui", None)
+    return {}
+
+
+# ---------------------------------------------------------------------------
+# Public API
+# ---------------------------------------------------------------------------
+
+def reshape_formbuilder_template(raw_row: Dict[str, Any]) -> Dict[str, Any]:
+    """Reshape a raw ``form_builder_template`` DB row into the public ``fb`` dict.
+
+    This replicates exactly what ``DonateMainEvents.OnActionGetFormBuilder``
+    does to reshape the flat database row before returning it to the browser,
+    without the live DB queries (thermometer totals) or runtime secrets
+    (payment tokens, reCAPTCHA keys).
+
+    The caller is responsible for:
+
+    - Passing in a plain Python dict (call ``.to_dict()`` on a velocity DB
+      row first so that Decimal and datetime values are already serialisable).
+    - Optionally adding ``fb["thermometer"]`` / ``fb["rival_thermometer"]``
+      after the call if live totals are desired.
+
+    Returns a new dict; the input is never mutated.
+
+    Example::
+
+        row = tx.table("form_builder_template").one({"sys_id": sys_id})
+        fb  = reshape_formbuilder_template(row.to_dict())
+    """
+    fb = copy.deepcopy(raw_row)
+
+    fb["metrics"] = {
+        f"metric_{i}": _extract_metric(i, fb) for i in range(1, 10)
+    }
+    fb["donations"] = {
+        f"donation_{i}": _extract_donation(i, fb) for i in range(1, 10)
+    }
+
+    # Expose the primary key under the public name used by DonateMain
+    fb["_num_entries"] = fb.get("sys_id")
+
+    # Strip internal / private fields
+    for key in list(fb.keys()):
+        if key.startswith("sys_"):
+            del fb[key]
+
+    for key in ("url_slug", "url_slug_alternate"):
+        fb.pop(key, None)
+
+    return fb

{velocity_python-0.0.237 → velocity_python-0.0.238/src/velocity_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: velocity-python
-Version: 0.0.237
+Version: 0.0.238
 Summary: A rapid application development library for interfacing with data storage
 Author-email: Velocity Team <info@codeclubs.org>
 License-Expression: MIT

{velocity_python-0.0.237 → velocity_python-0.0.238}/src/velocity_python.egg-info/SOURCES.txt

@@ -8,6 +8,8 @@ src/velocity/app/invoices.py
 src/velocity/app/orders.py
 src/velocity/app/payments.py
 src/velocity/app/purchase_orders.py
+src/velocity/app/formbuilder/__init__.py
+src/velocity/app/formbuilder/reshaper.py
 src/velocity/app/tests/__init__.py
 src/velocity/app/tests/test_email_processing.py
 src/velocity/app/tests/test_payment_profile_sorting.py
@@ -147,6 +149,7 @@ src/velocity_python.egg-info/requires.txt
 src/velocity_python.egg-info/top_level.txt
 tests/test_amplify_build.py
 tests/test_decorators.py
+tests/test_formbuilder_reshaper.py
 tests/test_formbuilder_template_validator.py
 tests/test_iconv_money_to_cents.py
 tests/test_lambda_handler.py

velocity_python-0.0.238/tests/test_formbuilder_reshaper.py

@@ -0,0 +1,262 @@
+"""Tests for velocity.app.formbuilder.reshaper."""
+import copy
+import pytest
+from velocity.app.formbuilder.reshaper import (
+    reshape_formbuilder_template,
+    _extract_metric,
+    _extract_donation,
+    _parse_key_value_string,
+)
+
+
+# ---------------------------------------------------------------------------
+# Helpers
+# ---------------------------------------------------------------------------
+
+def _make_row(**overrides):
+    """Return a minimal form_builder_template dict with all expected fields."""
+    base = {
+        "sys_id": 42,
+        "sys_created": "2024-01-01",
+        "sys_modified": "2024-01-02",
+        "client": "TIGERS",
+        "campaign": "2024",
+        "sub_campaign": "",
+        "is_published": True,
+        "url_slug": "tigers-2024",
+        "url_slug_alternate": "",
+        "primary_color": "#003087",
+        "secondary_color": "#FF7900",
+        "header_font": "Roboto",
+        "text_font": "Open Sans",
+        "page_title": "Give to Tigers",
+        "descriptor": "TIGERS DONATION",
+        "campaign_end_date": None,
+        "show_rival_thermometer": False,
+        "rival_client": None,
+        "rival_campaign": None,
+        "campaign_start_dollars": None,
+        "campaign_start_donors": None,
+        "campaign_goal_dollars": None,
+        "campaign_goal_donors": None,
+    }
+    # Add 9 empty metric slots
+    for i in range(1, 10):
+        p = f"metric_{i}_"
+        base.update({
+            f"{p}hide_donation_from_ui": False,
+            f"{p}header": "",
+            f"{p}image": "",
+            f"{p}label": "",
+            f"{p}secondarytext": "",
+            f"{p}helpertext": "",
+            f"{p}values": "",
+            f"{p}defaultvalue": "",
+            f"{p}show_other": False,
+            f"{p}other_minimum_value": "",
+            f"{p}orientation": "horizontal",
+        })
+    # Add 9 empty donation slots
+    for i in range(1, 10):
+        p = f"donation_{i}_"
+        base.update({
+            f"{p}hide_donation_from_ui": False,
+            f"{p}header": "",
+            f"{p}html": "",
+            f"{p}image": "",
+            f"{p}label": "",
+            f"{p}secondarytext": "",
+            f"{p}helpertext": "",
+            f"{p}values": "",
+            f"{p}defaultvalue": "",
+            f"{p}show_other": False,
+            f"{p}other_minimum_value": "",
+            f"{p}orientation": "vertical",
+            f"{p}dropdown": "",
+            f"{p}dropdown_label": "",
+        })
+    base.update(overrides)
+    return base
+
+
+# ---------------------------------------------------------------------------
+# _parse_key_value_string
+# ---------------------------------------------------------------------------
+
+class TestParseKeyValueString:
+    def test_empty_string_returns_empty_dict(self):
+        assert _parse_key_value_string("") == {}
+
+    def test_none_returns_empty_dict(self):
+        assert _parse_key_value_string(None) == {}
+
+    def test_simple_string_values(self):
+        result = _parse_key_value_string('"Entry A": "25", "Entry B": "50"')
+        assert result == {"Entry A": "25", "Entry B": "50"}
+
+    def test_numeric_values(self):
+        result = _parse_key_value_string('"$25": 25, "$50": 50')
+        assert result == {"$25": 25, "$50": 50}
+
+    def test_malformed_string_returns_empty_dict(self):
+        assert _parse_key_value_string("not valid python") == {}
+
+
+# ---------------------------------------------------------------------------
+# Input immutability
+# ---------------------------------------------------------------------------
+
+class TestImmutability:
+    def test_input_dict_not_mutated(self):
+        row = _make_row(metric_1_label="Seats", metric_1_values='"A": "1"')
+        original = copy.deepcopy(row)
+        reshape_formbuilder_template(row)
+        assert row == original
+
+    def test_returns_new_object(self):
+        row = _make_row()
+        result = reshape_formbuilder_template(row)
+        assert result is not row
+
+
+# ---------------------------------------------------------------------------
+# Field stripping
+# ---------------------------------------------------------------------------
+
+class TestFieldStripping:
+    def test_sys_fields_stripped(self):
+        row = _make_row()
+        result = reshape_formbuilder_template(row)
+        assert not any(k.startswith("sys_") for k in result)
+
+    def test_url_slug_stripped(self):
+        row = _make_row(url_slug="tigers", url_slug_alternate="t2024")
+        result = reshape_formbuilder_template(row)
+        assert "url_slug" not in result
+        assert "url_slug_alternate" not in result
+
+    def test_num_entries_added(self):
+        row = _make_row()
+        result = reshape_formbuilder_template(row)
+        assert result["_num_entries"] == 42
+
+    def test_flat_metric_keys_stripped(self):
+        row = _make_row(metric_1_label="Seats")
+        result = reshape_formbuilder_template(row)
+        flat_metric_keys = [k for k in result if k.startswith("metric_")]
+        assert flat_metric_keys == [], flat_metric_keys
+
+    def test_flat_donation_keys_stripped(self):
+        row = _make_row(donation_1_label="Game")
+        result = reshape_formbuilder_template(row)
+        flat_donation_keys = [k for k in result if k.startswith("donation_")]
+        assert flat_donation_keys == [], flat_donation_keys
+
+
+# ---------------------------------------------------------------------------
+# Metric reshaping
+# ---------------------------------------------------------------------------
+
+class TestMetricReshaping:
+    def test_metric_with_label_included(self):
+        row = _make_row(
+            metric_1_label="Seats",
+            metric_1_header="Choose seats",
+            metric_1_values='"1 Seat": "1", "2 Seats": "2"',
+            metric_1_defaultvalue="1",
+            metric_1_orientation="vertical",
+        )
+        result = reshape_formbuilder_template(row)
+        m = result["metrics"]["metric_1"]
+        assert m["label"] == "Seats"
+        assert m["header"] == "Choose seats"
+        assert m["values"] == {"1 Seat": "1", "2 Seats": "2"}
+        assert m["defaultvalue"] == "1"
+        assert m["orientation"] == "vertical"
+
+    def test_metric_without_label_is_empty_dict(self):
+        row = _make_row()
+        result = reshape_formbuilder_template(row)
+        for i in range(1, 10):
+            assert result["metrics"][f"metric_{i}"] == {}
+
+    def test_hidden_metric_is_empty_dict(self):
+        row = _make_row(metric_1_label="Seats", metric_1_hide_donation_from_ui=True)
+        result = reshape_formbuilder_template(row)
+        assert result["metrics"]["metric_1"] == {}
+
+    def test_all_9_metric_slots_present(self):
+        row = _make_row()
+        result = reshape_formbuilder_template(row)
+        assert set(result["metrics"].keys()) == {f"metric_{i}" for i in range(1, 10)}
+
+    def test_multiple_active_metrics(self):
+        row = _make_row(metric_1_label="A", metric_2_label="B", metric_3_label="C")
+        result = reshape_formbuilder_template(row)
+        for key in ("metric_1", "metric_2", "metric_3"):
+            assert result["metrics"][key] != {}
+        for key in (f"metric_{i}" for i in range(4, 10)):
+            assert result["metrics"][key] == {}
+
+
+# ---------------------------------------------------------------------------
+# Donation reshaping
+# ---------------------------------------------------------------------------
+
+class TestDonationReshaping:
+    def test_donation_with_label_included(self):
+        row = _make_row(
+            donation_1_label="General Gift",
+            donation_1_header="Support us",
+            donation_1_values='"$25": 25, "$50": 50',
+            donation_1_defaultvalue="25",
+            donation_1_html="<b>Thanks</b>",
+            donation_1_dropdown_label="Fund",
+            donation_1_dropdown="General,Athletics",
+        )
+        result = reshape_formbuilder_template(row)
+        d = result["donations"]["donation_1"]
+        assert d["label"] == "General Gift"
+        assert d["values"] == {"$25": 25, "$50": 50}
+        assert d["html"] == "<b>Thanks</b>"
+        assert d["dropdown_label"] == "Fund"
+
+    def test_donation_without_label_is_empty_dict(self):
+        row = _make_row()
+        result = reshape_formbuilder_template(row)
+        for i in range(1, 10):
+            assert result["donations"][f"donation_{i}"] == {}
+
+    def test_hidden_donation_is_empty_dict(self):
+        row = _make_row(donation_1_label="Gift", donation_1_hide_donation_from_ui=True)
+        result = reshape_formbuilder_template(row)
+        assert result["donations"]["donation_1"] == {}
+
+    def test_all_9_donation_slots_present(self):
+        row = _make_row()
+        result = reshape_formbuilder_template(row)
+        assert set(result["donations"].keys()) == {f"donation_{i}" for i in range(1, 10)}
+
+
+# ---------------------------------------------------------------------------
+# Top-level field preservation
+# ---------------------------------------------------------------------------
+
+class TestTopLevelFields:
+    def test_branding_fields_preserved(self):
+        row = _make_row(primary_color="#003087", page_title="Give Now")
+        result = reshape_formbuilder_template(row)
+        assert result["primary_color"] == "#003087"
+        assert result["page_title"] == "Give Now"
+
+    def test_client_campaign_preserved(self):
+        row = _make_row(client="TIGERS", campaign="2024")
+        result = reshape_formbuilder_template(row)
+        assert result["client"] == "TIGERS"
+        assert result["campaign"] == "2024"
+
+    def test_unknown_custom_fields_preserved(self):
+        """Extra columns added to the DB table should pass through untouched."""
+        row = _make_row(custom_new_field="hello")
+        result = reshape_formbuilder_template(row)
+        assert result["custom_new_field"] == "hello"