add activity level validation

Makefile

@@ -3,7 +3,4 @@ remark: package.json
 	npx remark *.md docs/*.md docs/**/*.md --rc-path .remarkrc
 
 package.json:
-	npm install `cat npm-requirements.txt`
-
-serve_app:
-	cd reproschema-ui/src && npm install && npm run serve
+	npm install `cat npm-requirements.txt`

ecobidas/create_schema.py

@@ -85,6 +85,9 @@ def create_schema(
 
             item_info = get_item_info(this_item)
 
+            if "message" in item_info and item_info["message"]:
+                activity.messages.append(item_info["message"])
+
             print_item_info(activity_idx, item_idx, item_info)
 
             item = define_new_item(item_info)
@@ -138,6 +141,7 @@ def initialize_activity(items: pd.DataFrame, output_dir: str | Path) -> tuple[Ac
         name=activity_name,
         prefLabel=activity_pref_label,
         output_dir=f"{output_dir}/activities/{activity_name}/",
+        messages = []
     )
 
     print_info("activity", activity_pref_label, activity.URI)

ecobidas/inputs/data-dictionary.json

@@ -202,5 +202,15 @@
     "VariableName": "mri_type",
     "Description": "Mention the type of MRI this item is applicable to.",
     "RequirementLevel": "optional"
+  },
+  "validation": {
+    "VariableName": "validation",
+    "Description": "Extra validation to perform on the item value. For example, `item_1 > item_2, Item 1 must be less then item 2.` means that the alert `'Item 1 must be less then item 2.'` will be displayed if `item_1 > item_2`. Comma act as separator between the cvheck to perform and alert to display.",
+    "RequirementLevel": "optional"
+  },
+  "UUID": {
+    "VariableName": "UUID",
+    "Description": "Unique identifier of the item.",
+    "RequirementLevel": "optional"
   }
-}
+}

ecobidas/item.py

@@ -63,6 +63,12 @@ def get_item_info(this_item: dict) -> dict:
 
     mandatory = get_mandatory(this_item)
 
+    message = None
+    if "validation" in this_item and this_item["validation"].any():
+        tokens = convert_to_str(this_item["validation"]).split(",")
+        if len(tokens) > 1:
+            message = {"message": tokens[1].strip(), "jsExpression": tokens[0].strip()}
+
     return {
         "name": item_name,
         "pref_label": pref_label,
@@ -75,6 +81,7 @@ def get_item_info(this_item: dict) -> dict:
         "visibility": visibility,
         "mandatory": mandatory,
         "sub_section": sub_section,
+        "message": message
     }
 
 

tests/data/activities/visibility/visibility_schema.jsonld

@@ -151,5 +151,11 @@
             "reproschema:AutoAdvance",
             "reproschema:AllowExport"
         ]
-    }
-}
+    },
+    "messages": [
+        {
+            "message": "Radio vis must be greater than Foo.",
+            "jsExpression": "multi_2_or_5 < radio_vis"
+        }
+    ]
+}

tests/inputs/test.tsv

@@ -1,4 +1,4 @@
-activity_order	include	activity	activity_pref_label	preamble	item	item_pref_label	item_description	item_order	mandatory	visibility	skip	question	field_type	choices
+activity_order	include	activity	activity_pref_label	preamble	item	item_pref_label	item_description	item_order	mandatory	visibility	skip	question	field_type	choices	validation
 1	1		Activity 2			number of subjects	number of subjects	1	1	1	1	Number of subjects entering into the analysis	integer
 2	1		Activity 3	same activity		integer item	integer item	1	1	1	1	This is an integer item	integer
 2	1		Activity 3	different preamble		slider item	slider item	2	1	1	1	This is a slider item	slider	1 | 100 | 10
@@ -17,7 +17,7 @@ activity_order	include	activity	activity_pref_label	preamble	item	item_pref_labe
 5	1		Visibility			radio_vis		4	1	1	1	select one or several answer	radio_multiple	1 | 2 | 3 | 4 | 5 | 6
 5	1		Visibility			multi_gt_5		5	1	radio_vis>5	1	should appear for answers greater than 5	text
 5	1		Visibility			multi_lt_2		6	1	radio_vis<=2	1	should appear for answers less than 2	text
-5	1		Visibility			multi_2_or_5		7	1	radio_vis == 2 OR radio_vis == 5	1	should appear for answers 2 or 5	text
+5	1		Visibility			multi_2_or_5		7	1	radio_vis == 2 OR radio_vis == 5	1	should appear for answers 2 or 5	text		multi_2_or_5 < radio_vis,  Radio vis must be greater than Foo. 
 5	1		Visibility			select_boolean		8	1	1	1	select one answer	select	preset:boolean
 5	1		Visibility			select_boolean==1		9	1	select_boolean==1	1	this should only show if you selected ‘yes’	text
 5	1		Visibility			select_boolean==0		10	1	select_boolean==0	1	this should only show if you selected ‘no’	text

tests/test_convert_to_schema.py

@@ -15,8 +15,8 @@ def data_path():
 def test_create_schema(tmp_path):
     this_schema = Path(__file__).parent / "inputs" / "test.tsv"
 
+    out_dir = tmp_path
     out_dir = Path(__file__).parent / "outputs"
-    # out_dir = tmp_path
 
     print("\n")
 

tests/test_item.py

@@ -93,6 +93,7 @@ def test_get_item_info():
         "mandatory": True,
         "description": "item name",
         "sub_section": "",
+        "message": None
     }
 
     assert item_info == expected
@@ -126,6 +127,7 @@ def test_get_item_info_with_name():
         "mandatory": True,
         "description": "desc",
         "sub_section": "",
+        "message": None        
     }
 
     assert item_info == expected
@@ -158,6 +160,7 @@ def test_get_item_info_with_only_name():
         "mandatory": True,
         "description": "desc",
         "sub_section": "",
+                "message": None    
     }
 
     assert item_info == expected