Addressing PR comments and refactoring code

Author: adrianoaru-nhs

pages/datasets/investigation_dataset_page.py

@@ -713,33 +713,49 @@ def label_matches(idx: int) -> bool:
 
     def check_visibility_of_drug_type(
         self, drug_type: str, drug_number: int, visible: bool
-    ) -> bool:
+    ) -> None:
         """
         Checks the visibility of the drug type input cell.
         Args:
             drug_type (str): The drug type to check
             drug_number (int): The number of the drug type cell to check.
             expected_text (str): The expected text content of the cell.
-        Returns:
-            bool: True if the visibility matches the expectation, False otherwise.
+        Raises:
+            AssertionError: If the visibility does not match the expectation.
         """
         locator = self.get_drug_type_locator(drug_type, drug_number)
-        return locator.is_visible() == visible
+        actual_visibility = locator.is_visible()
+        assert actual_visibility == visible, (
+            f"The {ordinal(drug_number)} {drug_type} drug type input cell visibility was {actual_visibility}, "
+            f"expected {visible}"
+        )
+        logging.info(
+            f"The {ordinal(drug_number)} {drug_type} drug type input cell is "
+            f"{'visible' if actual_visibility else 'not visible'} as expected"
+        )
 
     def check_visibility_of_drug_dose(
         self, drug_type: str, drug_number: int, visible: bool
-    ) -> bool:
+    ) -> None:
         """
-        Checks the visibility of the drug dose input cell.
+        Asserts the visibility of the drug dose input cell and logs the result.
         Args:
-            drug_type (str): The drug type to check
+            drug_type (str): The drug type to check.
             drug_number (int): The number of the drug dose cell to check.
             visible (bool): True if the field should be visible, False if it should not.
-        Returns:
-            bool: True if the visibility matches the expectation, False otherwise.
+        Raises:
+            AssertionError: If the visibility does not match the expectation.
         """
         locator = self.get_drug_dose_locator(drug_type, drug_number)
-        return locator.is_visible() == visible
+        actual_visibility = locator.is_visible()
+        assert actual_visibility == visible, (
+            f"The {ordinal(drug_number)} {drug_type} drug dose input cell visibility was {actual_visibility}, "
+            f"expected {visible}"
+        )
+        logging.info(
+            f"The {ordinal(drug_number)} {drug_type} drug dose input cell is "
+            f"{'visible' if actual_visibility else 'not visible'} as expected"
+        )
 
     def assert_drug_type_text(
         self, drug_type: str, drug_number: int, expected_text: str
@@ -1444,3 +1460,14 @@ def to_enum_name_or_value(val: Any) -> Union[str, Any]:
 
     # Fallback: return unchanged
     return val
+
+
+def ordinal(n: int) -> str:
+    """
+    Converts an integer to its ordinal representation (e.g., 1 -> '1st', 2 -> '2nd').
+    """
+    if 10 <= n % 100 <= 20:
+        suffix = "th"
+    else:
+        suffix = {1: "st", 2: "nd", 3: "rd"}.get(n % 10, "th")
+    return f"{n}{suffix}"