Add test template for ocr-numbers (#2127)

* Add test template for ocr-numbers

* Add hints

* Update hints

Author: tqa236

exercises/ocr-numbers/.meta/hints.md

@@ -0,0 +1,3 @@
+## Hints
+
+Your converter should validate its input and raise a ValueError with a meaningful message if it receives a string that isn't a valid OCR number.

exercises/ocr-numbers/.meta/template.j2

@@ -0,0 +1,19 @@
+{%- import "generator_macros.j2" as macros with context -%}
+{{ macros.header() }}
+
+class {{ exercise | camel_case }}Test(unittest.TestCase):
+    {% for case in cases[0]["cases"] -%}
+    def test_{{ case["description"] | to_snake }}(self):
+        {% set candidate = case["input"]["rows"] -%}
+        {% set output = case["expected"] -%}
+        {% if output is mapping -%}
+        with self.assertRaisesWithMessage(ValueError):
+            {{ case["property"] | to_snake }}({{ candidate }})
+        {% else -%}
+        {% set expected = case["expected"] -%}
+        self.assertEqual({{ case["property"] | to_snake }}({{ candidate }}), "{{ expected }}")
+        {% endif %}
+
+    {% endfor %}
+
+{{ macros.footer(True) }}

exercises/ocr-numbers/README.md

@@ -40,10 +40,10 @@ Update your program to recognize multi-character binary strings, replacing garbl
 Update your program to recognize all numbers 0 through 9, both individually and as part of a larger string.
 
 ```text
- _
+ _ 
  _|
-|_
-
+|_ 
+   
 ```
 
 Is converted to "2"
@@ -62,22 +62,26 @@ Is converted to "1234567890"
 Update your program to handle multiple numbers, one per line. When converting several lines, join the lines with commas.
 
 ```text
-    _  _
+    _  _ 
   | _| _|
   ||_  _|
-
-    _  _
-|_||_ |_
+         
+    _  _ 
+|_||_ |_ 
   | _||_|
-
- _  _  _
+         
+ _  _  _ 
   ||_||_|
   ||_| _|
-
+         
 ```
 
 Is converted to "123,456,789"
 
+## Hints
+
+ocr.convert should validate its input and raise ValueErrors with meaningful error messages if necessary.
+
 
 ## Exception messages
 

exercises/ocr-numbers/ocr_numbers_test.py

@@ -1,146 +1,122 @@
-"""Tests for the ocr-numbers exercise
-
-Implementation note:
-ocr.convert should validate its input and
-raise ValueErrors with meaningful error messages
-if necessary.
-"""
-
 import unittest
 
 from ocr_numbers import convert
 
-
 # Tests adapted from `problem-specifications//canonical-data.json` @ v1.2.0
 
+
 class OcrNumbersTest(unittest.TestCase):
     def test_recognizes_0(self):
-        self.assertEqual(convert([" _ ",
-                                  "| |",
-                                  "|_|",
-                                  "   "]), '0')
+        self.assertEqual(convert([" _ ", "| |", "|_|", "   "]), "0")
 
     def test_recognizes_1(self):
-        self.assertEqual(convert(["   ",
-                                  "  |",
-                                  "  |",
-                                  "   "]), '1')
-
-    def test_unreadable_but_correctly_sized(self):
-        self.assertEqual(convert(["   ",
-                                  "  _",
-                                  "  |",
-                                  "   "]), '?')
-
-    def test_line_number_not_multiple_of_four(self):
+        self.assertEqual(convert(["   ", "  |", "  |", "   "]), "1")
+
+    def test_unreadable_but_correctly_sized_inputs_return(self):
+        self.assertEqual(convert(["   ", "  _", "  |", "   "]), "?")
+
+    def test_input_with_a_number_of_lines_that_is_not_a_multiple_of_four_raises_an_error(
+        self
+    ):
         with self.assertRaisesWithMessage(ValueError):
-            convert([" _ ",
-                     "| |",
-                     "   "])
+            convert([" _ ", "| |", "   "])
 
-    def test_col_number_not_multiple_of_three(self):
+    def test_input_with_a_number_of_columns_that_is_not_a_multiple_of_three_raises_an_error(
+        self
+    ):
         with self.assertRaisesWithMessage(ValueError):
-            convert(["    ",
-                     "   |",
-                     "   |",
-                     "    "])
+            convert(["    ", "   |", "   |", "    "])
 
     def test_recognizes_110101100(self):
-        input_grid = [
-            "       _     _        _  _ ",
-            "  |  || |  || |  |  || || |",
-            "  |  ||_|  ||_|  |  ||_||_|",
-            "                           "
-        ]
-        self.assertEqual(convert(input_grid), "110101100")
-
-    def test_garbled_numbers_in_string(self):
-        input_grid = [
-            "       _     _           _ ",
-            "  |  || |  || |     || || |",
-            "  |  | _|  ||_|  |  ||_||_|",
-            "                           "
-        ]
-        self.assertEqual(convert(input_grid), "11?10?1?0")
+        self.assertEqual(
+            convert(
+                [
+                    "       _     _        _  _ ",
+                    "  |  || |  || |  |  || || |",
+                    "  |  ||_|  ||_|  |  ||_||_|",
+                    "                           ",
+                ]
+            ),
+            "110101100",
+        )
+
+    def test_garbled_numbers_in_a_string_are_replaced_with(self):
+        self.assertEqual(
+            convert(
+                [
+                    "       _     _           _ ",
+                    "  |  || |  || |     || || |",
+                    "  |  | _|  ||_|  |  ||_||_|",
+                    "                           ",
+                ]
+            ),
+            "11?10?1?0",
+        )
 
     def test_recognizes_2(self):
-        self.assertEqual(convert([" _ ",
-                                  " _|",
-                                  "|_ ",
-                                  "   "]), "2")
+        self.assertEqual(convert([" _ ", " _|", "|_ ", "   "]), "2")
 
     def test_recognizes_3(self):
-        self.assertEqual(convert([" _ ",
-                                  " _|",
-                                  " _|",
-                                  "   "]), "3")
+        self.assertEqual(convert([" _ ", " _|", " _|", "   "]), "3")
 
     def test_recognizes_4(self):
-        self.assertEqual(convert(["   ",
-                                  "|_|",
-                                  "  |",
-                                  "   "]), "4")
+        self.assertEqual(convert(["   ", "|_|", "  |", "   "]), "4")
 
     def test_recognizes_5(self):
-        self.assertEqual(convert([" _ ",
-                                  "|_ ",
-                                  " _|",
-                                  "   "]), "5")
+        self.assertEqual(convert([" _ ", "|_ ", " _|", "   "]), "5")
 
     def test_recognizes_6(self):
-        self.assertEqual(convert([" _ ",
-                                  "|_ ",
-                                  "|_|",
-                                  "   "]), "6")
+        self.assertEqual(convert([" _ ", "|_ ", "|_|", "   "]), "6")
 
     def test_recognizes_7(self):
-        self.assertEqual(convert([" _ ",
-                                  "  |",
-                                  "  |",
-                                  "   "]), "7")
+        self.assertEqual(convert([" _ ", "  |", "  |", "   "]), "7")
 
     def test_recognizes_8(self):
-        self.assertEqual(convert([" _ ",
-                                  "|_|",
-                                  "|_|",
-                                  "   "]), "8")
+        self.assertEqual(convert([" _ ", "|_|", "|_|", "   "]), "8")
 
     def test_recognizes_9(self):
-        self.assertEqual(convert([" _ ",
-                                  "|_|",
-                                  " _|",
-                                  "   "]), "9")
+        self.assertEqual(convert([" _ ", "|_|", " _|", "   "]), "9")
 
     def test_recognizes_string_of_decimal_numbers(self):
-        input_grid = [
-            "    _  _     _  _  _  _  _  _ ",
-            "  | _| _||_||_ |_   ||_||_|| |",
-            "  ||_  _|  | _||_|  ||_| _||_|",
-            "                              "
-        ]
-        self.assertEqual(convert(input_grid), "1234567890")
-
-    def test_recognizes_numbers_separated_by_empty_lines(self):
-        input_grid = [
-            "    _  _ ",
-            "  | _| _|",
-            "  ||_  _|",
-            "         ",
-            "    _  _ ",
-            "|_||_ |_ ",
-            "  | _||_|",
-            "         ",
-            " _  _  _ ",
-            "  ||_||_|",
-            "  ||_| _|",
-            "         "
-        ]
-        self.assertEqual(convert(input_grid), "123,456,789")
+        self.assertEqual(
+            convert(
+                [
+                    "    _  _     _  _  _  _  _  _ ",
+                    "  | _| _||_||_ |_   ||_||_|| |",
+                    "  ||_  _|  | _||_|  ||_| _||_|",
+                    "                              ",
+                ]
+            ),
+            "1234567890",
+        )
+
+    def test_numbers_separated_by_empty_lines_are_recognized_lines_are_joined_by_commas(
+        self
+    ):
+        self.assertEqual(
+            convert(
+                [
+                    "    _  _ ",
+                    "  | _| _|",
+                    "  ||_  _|",
+                    "         ",
+                    "    _  _ ",
+                    "|_||_ |_ ",
+                    "  | _||_|",
+                    "         ",
+                    " _  _  _ ",
+                    "  ||_||_|",
+                    "  ||_| _|",
+                    "         ",
+                ]
+            ),
+            "123,456,789",
+        )
 
     # Utility functions
     def assertRaisesWithMessage(self, exception):
         return self.assertRaisesRegex(exception, r".+")
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     unittest.main()