Check tick alignment for labelset values

Author: lognaturel

pyxform/errors.py

@@ -465,7 +465,7 @@ class ErrorCode(Enum):
         msg=(
             "[row : {row}] On the 'survey' sheet, the 'parameters' value is invalid. "
             "For the 'range' question type, the parameter 'tick_labelset' choices must "
-            "be a within the range (between the 'start' and 'end' values, inclusive)."
+            "be between the 'start' and 'end' values, inclusive."
         ),
     )
     RANGE_011 = Detail(

pyxform/validators/pyxform/question_types.py

@@ -184,7 +184,7 @@ def process_parameter(name: str) -> Decimal | None:
         parameters["odk:tick-interval"] = parameters.pop("tick_interval")
 
     if placeholder is not None:
-        if (abs(placeholder - start) % step) != 0:
+        if (placeholder - start) % step != 0:
             raise PyXFormError(
                 ErrorCode.RANGE_004.value.format(row=row_number, name="placeholder")
             )
@@ -200,28 +200,28 @@ def process_parameter(name: str) -> Decimal | None:
             raise PyXFormError(ErrorCode.RANGE_006.value.format(row=row_number))
 
         no_ticks_labels = set()
-        for label in tick_list:
+        for item in tick_list:
             errored = False
             try:
-                label = Decimal(label.get("name"))
+                value = Decimal(item.get("name"))
             except InvalidOperation:
                 errored = True
 
-            if errored or isinf(label):
+            if errored or isinf(value):
                 raise PyXFormError(ErrorCode.RANGE_009.value.format(row=row_number))
 
-            if label < start or label > end:
+            if value < min(start, end) or value > max(start, end):
                 raise PyXFormError(ErrorCode.RANGE_010.value.format(row=row_number))
-            if tick_interval is not None and (label % tick_interval) != 0:
+            if tick_interval is not None and (value - start) % tick_interval != 0:
                 raise PyXFormError(
                     ErrorCode.RANGE_011.value.format(row=row_number, name="tick_interval")
                 )
-            elif (label % step) != 0:
+            elif (value - start) % step != 0:
                 raise PyXFormError(
                     ErrorCode.RANGE_011.value.format(row=row_number, name="step")
                 )
             if no_ticks_appearance:
-                no_ticks_labels.add(label)
+                no_ticks_labels.add(value)
 
         if no_ticks_appearance:
             if len(no_ticks_labels) > 2:

tests/test_range.py

@@ -751,6 +751,27 @@ def test_tick_labelset_choice_outside_range__error(self):
                     error__contains=[ErrorCode.RANGE_010.value.format(row=2)],
                 )
 
+    def test_tick_labelset_choice_outside_inverted_range__error(self):
+        """Should raise an error if any tick_labelset choices are outside the inverted range."""
+        # RL004
+        md = """
+        | survey |
+        | | type  | name | label | parameters                            |
+        | | range | q1   | Q1    | start=7 end=3 step=2 tick_labelset=c1 |
+
+        | choices |
+        | | list_name | name    | label |
+        | | c1        | {value} | N1    |
+        """
+        cases = ("9", "1")
+        for value in cases:
+            with self.subTest(value):
+                self.assertPyxformXform(
+                    md=md.format(value=value),
+                    errored=True,
+                    error__contains=[ErrorCode.RANGE_010.value.format(row=2)],
+                )
+
     def test_tick_labelset_choice_outside_range__ok(self):
         """Should not raise an error if any tick_labelset choices are inside the range."""
         # RL004
@@ -781,6 +802,36 @@ def test_tick_labelset_choice_outside_range__ok(self):
                     ],
                 )
 
+    def test_tick_labelset_choice_outside_inverted_range__ok(self):
+        """Should not raise an error if any tick_labelset choices are inside the range."""
+        # RL004
+        md = """
+        | survey |
+        | | type  | name | label | parameters                            |
+        | | range | q1   | Q1    | start=7 end=3 step=2 tick_labelset=c1 |
+
+        | choices |
+        | | list_name | name    | label |
+        | | c1        | {value} | N1    |
+        """
+        cases = ("7", "5", "3")
+        for value in cases:
+            with self.subTest(value):
+                self.assertPyxformXform(
+                    md=md.format(value=value),
+                    xml__xpath_match=[
+                        xpq.body_range(
+                            "q1",
+                            {
+                                "start": "7",
+                                "end": "3",
+                                "step": "2",
+                                "odk:tick-labelset": "c1",
+                            },
+                        ),
+                    ],
+                )
+
     def test_tick_labelset_choice_not_a_multiple_of_tick__error(self):
         """Should raise an error if the relevant ticks parameter is not a multiple of 'step'."""
         # RL003
@@ -836,8 +887,8 @@ def test_tick_labelset_choice_not_a_multiple_of_step__ok(self):
                     ],
                 )
 
-    def test_tick_labelset_choice_not_a_multiple_of_step__both__ok(self):
-        """Should not raise an error if the choice is a multiple of 'step'."""
+    def test_tick_labelset_choice_not_aligned_with_tick_interval__both__ok(self):
+        """Should not raise an error if the choice is aligned with ticks."""
         # RL003
         md = """
         | survey |
@@ -846,7 +897,9 @@ def test_tick_labelset_choice_not_a_multiple_of_step__both__ok(self):
 
         | choices |
         | | list_name | name    | label |
-        | | c1        | 8       | N1    |
+        | | c1        | 1       | N1    |
+        | | c1        | 5       | N2    |
+        | | c1        | 9       | N3    |
         """
         self.assertPyxformXform(
             md=md,