Add snake_to_camel and transform_options utils

Also add tests

Author: labkey-alan

labkey/utils.py

@@ -17,6 +17,7 @@
 from functools import wraps
 from datetime import date, datetime
 from base64 import b64encode
+from typing import List
 from urllib import parse
 
 
@@ -91,3 +92,34 @@ def waf_encode(value: str) -> str:
     if value:
         return "/*{{base64/x-www-form-urlencoded/wafText}}*/" + btoa(encode_uri_component(value))
     return value
+
+
+def snake_to_camel(value: str):
+    """
+    Converts a snake_case string to camelCase
+    """
+    if not value:
+        return value
+
+    if "_" not in value:
+        return value
+
+    parts = [part for part in value.split("_") if part]
+
+    if len(parts) == 0:
+        return ""
+
+    return parts[0].lower() + "".join([part.title() for part in parts[1:]])
+
+
+def transform_options(options: dict, expected_keys: List[str]) -> dict:
+    """
+    Converts a dict with snake_case keys to a new dict with camelCase keys, only copying keys from expected_keys
+    """
+    transformed_options = {}
+
+    for key, item in options.items():
+        if key in expected_keys:
+            transformed_options[snake_to_camel(key)] = item
+
+    return transformed_options

test/unit/test_utils.py

@@ -1,4 +1,4 @@
-from labkey.utils import btoa, encode_uri_component, waf_encode
+from labkey.utils import btoa, encode_uri_component, waf_encode, snake_to_camel, transform_options
 
 
 def test_btoa():
@@ -30,3 +30,64 @@ def test_waf_encode():
         waf_encode("><&/%' \"1äöüÅ")
         == prefix + "JTNFJTNDJTI2JTJGJTI1JyUyMCUyMjElQzMlQTQlQzMlQjYlQzMlQkMlQzMlODU="
     )
+
+
+def test_snake_to_camel():
+    assert snake_to_camel("snake_case") == "snakeCase"
+    assert snake_to_camel("multiple_word_snake_case") == "multipleWordSnakeCase"
+    assert snake_to_camel("alreadyCamelCase") == "alreadyCamelCase"
+    assert snake_to_camel("single") == "single"
+    assert snake_to_camel("UPPER_SNAKE_CASE") == "upperSnakeCase"
+    assert snake_to_camel("_leading_underscore") == "leadingUnderscore"
+    assert snake_to_camel("trailing_underscore_") == "trailingUnderscore"
+    assert snake_to_camel("multiple__underscores") == "multipleUnderscores"
+    assert snake_to_camel("") == ""
+
+
+def test_transform_options():
+    options = {
+        "include_columns": True,
+        "include_system_queries": False,
+        "include_title": False,
+        "include_user_queries": False,
+        "include_view_data_url": True,
+        "query_detail_columns": False,
+    }
+    expected_keys = [
+        "include_columns",
+        "include_system_queries",
+        "include_user_queries",
+        "include_view_data_url",
+    ]
+    transformed_options = transform_options(options, expected_keys)
+    assert transformed_options == {
+        "includeColumns": True,
+        "includeSystemQueries": False,
+        "includeUserQueries": False,
+        "includeViewDataUrl": True,
+    }
+    assert transformed_options["includeColumns"] is True
+
+    # Empty options
+    assert transform_options({}, ["any_key"]) == {}
+
+    # Empty expected_keys
+    assert transform_options({"any_key": 1}, []) == {}
+
+    # Filtering behavior: only keys in expected_keys are kept and transformed
+    options = {"keep_me": 1, "ignore_me": 2}
+    expected = ["keep_me"]
+    result = transform_options(options, expected)
+    assert result == {"keepMe": 1}
+
+    # Keys in expected_keys but not in options are ignored
+    options = {"present_key": "I am present!"}
+    expected = ["present_key", "absent_key"]
+    result = transform_options(options, expected)
+    assert result == {"presentKey": "I am present!"}
+
+    # Non-snake_case keys that are in expected_keys
+    options = {"alreadyCamel": 1, "simple": 2, "UPPER_SNAKE": 3}
+    expected = ["alreadyCamel", "simple", "UPPER_SNAKE"]
+    result = transform_options(options, expected)
+    assert result == {"alreadyCamel": 1, "simple": 2, "upperSnake": 3}