Merge pull request #107 from GatorEducator/fix/utf-encode

Use unicode symbols that are more likely to work correctly on Windows

gatorgrade/output/check_result.py

@@ -1,4 +1,5 @@
 """Define check result class."""
+
 import rich
 
 
@@ -32,7 +33,7 @@ def display_result(self, show_diagnostic: bool = False) -> str:
             show_diagnostic: If true, show the diagnostic message if the check has failed.
                 Defaults to false.
         """
-        icon = "" if self.passed else "✘"
+        icon = "✓" if self.passed else "✕"
         icon_color = "green" if self.passed else "red"
         message = f"[{icon_color}]{icon}[/]  {self.description}"
         if not self.passed and show_diagnostic:

pyproject.toml

@@ -1,8 +1,9 @@
 [tool.poetry]
 name = "gatorgrade"
-version = "0.3.0"
-description = "Python tool to execute GatorGrader"
+version = "0.3.1"
+description = "GatorGrade executes GatorGrader checks!"
 authors = ["Michael Abraham", "Jacob Allebach", "Liam Black", "Katherine Burgess", "Yanqiao Chen", "Ochirsaikhan Davaajambal", "Tuguldurnemekh Gantulga", "Anthony Grant-Cook", "Dylan Holland", "Gregory M. Kapfhammer", "Peyton Kelly", "Luke Lacaria", "Lauren Nevill", "Jack Turner", "Daniel Ullrich", "Garrison Vanzin", "Rian Watson"]
+readme = "README.md"
 
 [tool.poetry.dependencies]
 python = ">=3.7,<4.0"

tests/output/test_output.py

@@ -28,7 +28,7 @@ def test_run_checks_gg_check_should_show_passed(capsys):
     output.run_checks([check])
     # Then the output shows that the check has passed
     out, _ = capsys.readouterr()
-    assert "  Check TODOs" in out
+    assert "✓  Check TODOs" in out
 
 
 def test_run_checks_invalid_gg_args_prints_exception(capsys):

tests/test_main.py

@@ -87,8 +87,8 @@ def cleanup_files(monkeypatch):
             [
                 ("Complete all TODOs", 2),
                 ("Use an if statement", 1),
-                ("", 3),
-                ("✘", 0),
+                ("✓", 3),
+                ("✕", 0),
                 ("Passed 3/3 (100%) of checks", 1),
             ],
         )