Update Tests to include errors for gated exercises, and rework

Author: mmcky

sphinx_exercise/directive.py

@@ -315,6 +315,7 @@ def run(self):
                 "end": [],
                 "sequence": [],
                 "msg": [],
+                "type": "exercise",
             }
         gated_registry[self.env.docname]["start"].append(self.lineno)
         gated_registry[self.env.docname]["sequence"].append("S")
@@ -346,6 +347,7 @@ def run(self):
                 "end": [],
                 "sequence": [],
                 "msg": [],
+                "type": "exercise",
             }
         gated_registry[self.env.docname]["end"].append(self.lineno)
         gated_registry[self.env.docname]["sequence"].append("E")
@@ -383,6 +385,7 @@ def run(self):
                 "end": [],
                 "sequence": [],
                 "msg": [],
+                "type": "solution",
             }
         gated_registry[self.env.docname]["start"].append(self.lineno)
         gated_registry[self.env.docname]["sequence"].append("S")
@@ -414,6 +417,7 @@ def run(self):
                 "end": [],
                 "sequence": [],
                 "msg": [],
+                "type": "solution",
             }
         gated_registry[self.env.docname]["end"].append(self.lineno)
         gated_registry[self.env.docname]["sequence"].append("E")

sphinx_exercise/transforms.py

@@ -36,18 +36,19 @@ def check_structure(self, registry):
             end = registry[docname]["end"]
             sequence = "".join(registry[docname]["sequence"])
             structure = "\n  ".join(registry[docname]["msg"])
+            nodetype = registry[docname]["type"]
             if len(start) > len(end):
-                msg = f"The document ({docname}) is missing a solution-end directive\n  {structure}"  # noqa: E501
+                msg = f"The document ({docname}) is missing a {nodetype}-end directive\n  {structure}"  # noqa: E501
                 logger.error(msg)
                 error = True
             if len(start) < len(end):
-                msg = f"The document ({docname}) is missing a solution-start directive\n  {structure}"  # noqa: E501
+                msg = f"The document ({docname}) is missing a {nodetype}-start directive\n  {structure}"  # noqa: E501
                 logger.error(msg)
                 error = True
             if len(start) == len(end):
                 groups = re.findall("(SE)", sequence)
                 if len(groups) != len(start):
-                    msg = f"The document ({docname}) contains nested solution-start and solution-end directives\n  {structure}"  # noqa: E501
+                    msg = f"The document ({docname}) contains nested {nodetype}-start and {nodetype}-end directives\n  {structure}"  # noqa: E501
                     logger.error(msg)
                     error = True
         if error:

tests/books/test-gateddirective/conf.py

@@ -35,7 +35,12 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["build", "_build", "solution_errors_[1,2,3]*"]
+exclude_patterns = [
+    "build",
+    "_build",
+    "exercise_errors_[1,2,3]*",
+    "solution_errors_[1,2,3]*",
+]
 
 
 # -- Options for HTML output -------------------------------------------------

tests/books/test-gateddirective/exercise_errors_1.md

@@ -0,0 +1,27 @@
+---
+jupytext:
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
+
+# Exercise Errors 1
+
+Some malformed directives
+
+## Missing `-end` directive
+
+A solution using the gated directive
+
+```{exercise-start}
+:label: error-exercise-1
+```
+
+Replicate this figure using matplotlib
+
+```{figure} sphx_glr_cohere_001_2_0x.png
+```

tests/books/test-gateddirective/exercise_errors_2.md

@@ -0,0 +1,24 @@
+---
+jupytext:
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
+
+# Exercise Errors 2
+
+Some malformed directives
+
+## Missing `-start` directive
+
+Replicate this figure using matplotlib
+
+```{figure} sphx_glr_cohere_001_2_0x.png
+```
+
+```{exercise-end}
+```

tests/books/test-gateddirective/exercise_errors_3.md

@@ -0,0 +1,26 @@
+---
+jupytext:
+  text_representation:
+    extension: .md
+    format_name: myst
+kernelspec:
+  display_name: Python 3
+  language: python
+  name: python3
+---
+
+# Errors 3
+
+## Incorrect Nesting of Gated Exercise Directives
+
+```{exercise-start}
+```
+
+```{exercise-start}
+```
+
+```{exercise-end}
+```
+
+```{exercise-end}
+```

tests/books/test-gateddirective/solution-exercise.md

@@ -11,7 +11,7 @@ kernelspec:
 
 # Gated Solutions to exercise.md
 
-A solution using the gated directives
+A solution using the gated directive
 
 ```{solution-start} exercise-1
 :label: solution-gated-1

tests/books/test-gateddirective/solution_errors_1.md

@@ -9,7 +9,7 @@ kernelspec:
   name: python3
 ---
 
-# Errors 1
+# Solution Errors 1
 
 Some malformed directives
 

tests/books/test-gateddirective/solution_errors_2.md

@@ -9,7 +9,7 @@ kernelspec:
   name: python3
 ---
 
-# Errors 2
+# Solution Errors 2
 
 Some malformed directives
 

tests/books/test-gateddirective/solution_errors_3.md

@@ -9,7 +9,7 @@ kernelspec:
   name: python3
 ---
 
-# Errors 3
+# Solution Errors 3
 
 ## Incorrect Nesting of Gated Directives