velocity-python 0.1.117__tar.gz → 0.1.118__tar.gz

{velocity_python-0.1.117/src/velocity_python.egg-info → velocity_python-0.1.118}/PKG-INFO

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

{velocity_python-0.1.117 → velocity_python-0.1.118}/pyproject.toml

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

{velocity_python-0.1.117 → velocity_python-0.1.118}/src/velocity/__init__.py

@@ -1,4 +1,4 @@
-__version__ = version = "0.1.117"
+__version__ = version = "0.1.118"
 
 import importlib as _importlib
 

{velocity_python-0.1.117 → velocity_python-0.1.118}/src/velocity/aws/facets.py

@@ -34,7 +34,9 @@ Facets AND together; the values of one facet OR together. Kinds:
               database's session time zone.
 ``text``      a write-in, case-insensitive, against ``field::text``:
               ``match`` is ``contains`` (default), ``equals`` or ``starts``.
-              The user's ``%`` and ``_`` are literal.
+              The user's ``%`` and ``_`` are literal. With ``fields`` (a list
+              of columns) the term is matched against each, OR'd — one box
+              that searches subject *or* snippet.
 
 Anything malformed — an unknown kind, a field that is not a bare identifier,
 too many or too long values — raises :class:`FacetError` rather than being
@@ -62,6 +64,7 @@ MATCHES = ("contains", "equals", "starts")
 PRESENCE = ("present", "absent")
 
 MAX_FACETS = 40
+MAX_FIELDS = 10
 MAX_VALUES = 200
 MAX_VALUE_CHARS = 500
 MAX_DAYS = 3660
@@ -183,6 +186,27 @@ def _kind_since(column: str, entry: Dict[str, Any], field: str) -> Optional[Pred
     return f"{column} >= now() - make_interval(days => %s)", (days,)
 
 
+def _columns(entry: Dict[str, Any], column: str, field: str) -> List[str]:
+    """The column(s) a text facet matches: ``fields`` when given, else the field."""
+    fields = entry.get("fields")
+    if fields in (None, "", []):
+        return [column]
+    if not isinstance(fields, (list, tuple)):
+        raise FacetError(f"facet {field}: 'fields' must be a list of column names")
+    if len(fields) > MAX_FIELDS:
+        raise FacetError(f"facet {field}: more than {MAX_FIELDS} fields")
+    out = []
+    for name in fields:
+        if not isinstance(name, str) or not _IDENTIFIER.match(name):
+            raise FacetError(
+                f"facet {field}: fields must be column names, got {name!r}"
+            )
+        quoted = TableHelper.quote(name)
+        if quoted not in out:
+            out.append(quoted)
+    return out
+
+
 def _kind_text(column: str, entry: Dict[str, Any], field: str) -> Optional[Predicate]:
     value = _one(entry, field)
     if not value:
@@ -196,7 +220,11 @@ def _kind_text(column: str, entry: Dict[str, Any], field: str) -> Optional[Predi
         "starts": f"{escaped}%",
         "equals": escaped,
     }[match]
-    return f"{column}::text ILIKE %s", (pattern,)
+    columns = _columns(entry, column, field)
+    if len(columns) == 1:
+        return f"{columns[0]}::text ILIKE %s", (pattern,)
+    parts = " OR ".join(f"{name}::text ILIKE %s" for name in columns)
+    return f"({parts})", tuple(pattern for _ in columns)
 
 
 _BUILDERS = {

{velocity_python-0.1.117 → velocity_python-0.1.118/src/velocity_python.egg-info}/PKG-INFO

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

{velocity_python-0.1.117 → velocity_python-0.1.118}/tests/test_facets.py

@@ -81,6 +81,39 @@ def test_text_matches_are_case_insensitive_and_escape_like_wildcards():
         facets.predicate({"field": "x", "kind": "text", "value": "a", "match": "regex"})
 
 
+def test_text_over_several_fields_ors_one_term_across_them():
+    sql, params = facets.predicate(
+        {
+            "field": "subject",
+            "kind": "text",
+            "value": "invoice",
+            "fields": ["subject", "snippet"],
+        }
+    )
+    assert sql == "(subject::text ILIKE %s OR snippet::text ILIKE %s)"
+    assert params == ("%invoice%", "%invoice%")
+    # one field, or the facet's own field, is the plain form
+    assert facets.predicate(
+        {"field": "subject", "kind": "text", "value": "x", "fields": ["snippet"]}
+    ) == ("snippet::text ILIKE %s", ("%x%",))
+    assert facets.predicate(
+        {"field": "subject", "kind": "text", "value": "x", "fields": []}
+    ) == (
+        "subject::text ILIKE %s",
+        ("%x%",),
+    )
+    # duplicates collapse, reserved words are quoted, junk is refused
+    sql, _params = facets.predicate(
+        {"field": "a", "kind": "text", "value": "x", "fields": ["order", "order", "b"]}
+    )
+    assert sql == '("order"::text ILIKE %s OR b::text ILIKE %s)'
+    for fields in ("subject", ["subject; drop"], [1], ["a"] * (facets.MAX_FIELDS + 1)):
+        with pytest.raises(facets.FacetError):
+            facets.predicate(
+                {"field": "a", "kind": "text", "value": "x", "fields": fields}
+            )
+
+
 def test_an_empty_selection_is_no_predicate_not_an_error():
     for entry in (
         {"field": "a", "values": []},