feat: ✨ add simple helper functions

seedcase_sprout/core/sprout_checks/check_resource_id_in_data_path.py → seedcase_sprout/core/sprout_checks/check_id_in_resource_path.py

@@ -6,7 +6,7 @@
 )
 
 
-def check_resource_id_in_data_path(
+def check_id_in_resource_path(
     properties: dict, index: int | None = None
 ) -> list[CheckError]:
     """Checks if the data path in resource properties is well-formed.

seedcase_sprout/core/sprout_checks/check_no_inline_data.py

@@ -22,8 +22,8 @@ def check_no_inline_data(
     return [
         CheckError(
             message=(
-                "'data' should not be set. Sprout expects data in separate "
-                "data files specified by 'path'."
+                "Sprout doesn't use the 'data' field, instead it expects data "
+                "in separate files that are given in the 'path' field."
             ),
             json_path=get_json_path_to_resource_field("data", index),
             validator="inline-data",

seedcase_sprout/core/sprout_checks/check_data_path_string.py → seedcase_sprout/core/sprout_checks/check_resource_path_string.py

@@ -3,8 +3,10 @@
     get_json_path_to_resource_field,
 )
 
+CHECKS_TYPE_ERROR_MESSAGE = "{field_value} is not of type '{field_type}'"
 
-def check_data_path_string(
+
+def check_resource_path_string(
     properties: dict, index: int | None = None
 ) -> list[CheckError]:
     """Checks that the `path` field of a set of resource properties is of type string.
@@ -22,7 +24,9 @@ def check_data_path_string(
 
     return [
         CheckError(
-            message=f"{path} is not of type 'string'",
+            message=CHECKS_TYPE_ERROR_MESSAGE.format(
+                field_value=path, field_type="string"
+            ),
             json_path=get_json_path_to_resource_field("path", index),
             validator="type",
         )

tests/core/sprout_checks/test_check_resource_id_in_data_path.py → tests/core/sprout_checks/test_check_id_in_resource_path.py

@@ -2,8 +2,8 @@
 
 from pytest import mark
 
-from seedcase_sprout.core.sprout_checks.check_resource_id_in_data_path import (
-    check_resource_id_in_data_path,
+from seedcase_sprout.core.sprout_checks.check_id_in_resource_path import (
+    check_id_in_resource_path,
 )
 from seedcase_sprout.core.sprout_checks.get_json_path_to_resource_field import (
     get_json_path_to_resource_field,
@@ -15,13 +15,13 @@ def test_passes_if_data_path_well_formed(index):
     """Should pass if the path contains a resource ID."""
     properties = {"path": str(Path("resources", "1", "data.parquet"))}
 
-    assert check_resource_id_in_data_path(properties, index) == []
+    assert check_id_in_resource_path(properties, index) == []
 
 
 @mark.parametrize("index", [None, 2])
 def test_passes_if_data_path_not_present(index):
     """Should pass if the path is not set."""
-    assert check_resource_id_in_data_path({}, index) == []
+    assert check_id_in_resource_path({}, index) == []
 
 
 @mark.parametrize("index", [None, 2])
@@ -30,7 +30,7 @@ def test_passes_if_path_of_wrong_type(index, data_path):
     """Should pass if path is of the wrong type."""
     properties = {"path": data_path}
 
-    assert check_resource_id_in_data_path(properties, index) == []
+    assert check_id_in_resource_path(properties, index) == []
 
 
 @mark.parametrize("index", [None, 2])
@@ -47,9 +47,9 @@ def test_returns_error_if_data_path_is_malformed(index, data_path):
     """Returns list of `CheckError`s if the data path does not contain a resource ID."""
     properties = {"path": str(data_path)}
 
-    errors = check_resource_id_in_data_path(properties, index)
+    errors = check_id_in_resource_path(properties, index)
 
     assert len(errors) == 1
-    assert errors[0].message == "'path' should contain the resource ID"
+    assert errors[0].message
     assert errors[0].json_path == get_json_path_to_resource_field("path", index)
     assert errors[0].validator == "pattern"

tests/core/sprout_checks/test_check_no_inline_data.py

@@ -20,6 +20,6 @@ def test_error_found_if_data_is_set(index):
     errors = check_no_inline_data(properties, index)
 
     assert len(errors) == 1
-    assert "'data' should not be set" in errors[0].message
+    assert errors[0].message
     assert errors[0].json_path == get_json_path_to_resource_field("data", index)
     assert errors[0].validator == "inline-data"

tests/core/sprout_checks/test_check_data_path_string.py → tests/core/sprout_checks/test_check_resource_path_string.py

@@ -1,7 +1,7 @@
 from pytest import mark
 
-from seedcase_sprout.core.sprout_checks.check_data_path_string import (
-    check_data_path_string,
+from seedcase_sprout.core.sprout_checks.check_resource_path_string import (
+    check_resource_path_string,
 )
 from seedcase_sprout.core.sprout_checks.get_json_path_to_resource_field import (
     get_json_path_to_resource_field,
@@ -13,23 +13,23 @@ def test_passes_if_data_path_string(index):
     """Should pass if the path is of type string."""
     properties = {"path": "a string"}
 
-    assert check_data_path_string(properties, index) == []
+    assert check_resource_path_string(properties, index) == []
 
 
 @mark.parametrize("index", [None, 2])
 def test_passes_if_data_path_not_present(index):
     """Should pass if the path is not set."""
-    assert check_data_path_string({}, index) == []
+    assert check_resource_path_string({}, index) == []
 
 
 @mark.parametrize("index", [None, 2])
 def test_error_found_if_path_not_string(index):
     """Should find an error if the path is not of type string."""
     properties = {"path": 123}
 
-    errors = check_data_path_string(properties, index)
+    errors = check_resource_path_string(properties, index)
 
     assert len(errors) == 1
-    assert errors[0].message == "123 is not of type 'string'"
+    assert "string" in errors[0].message
     assert errors[0].json_path == get_json_path_to_resource_field("path", index)
     assert errors[0].validator == "type"