Test _human_join (#6)

* Add custom coverage test

* Revert "Add custom coverage test"

* Add test

* Add coverages to report

.gitignore

@@ -16,3 +16,4 @@ docs/crowdin.py
 *.mo
 /.coverage
 build/*
+!assets/*

README.md

@@ -13,15 +13,15 @@ Programming language: <TODO>
 ## Coverage measurement
 
 ### Existing tool
-The coverage tool [coverage.py](https://coverage.readthedocs.io/en/7.5.3/) was used for this project. 
+
+The coverage tool [coverage.py](https://coverage.readthedocs.io/en/7.5.3/) was used for this project.
 After installing the dependencies and executing `coverage run -m pytest` we get the following output:
 ![63781](https://github.com/tthijm/sep/assets/74216566/0962f4e0-a7f4-45c0-ab12-59110c55d6c2)
 
 Running `coverage html` and opening the document in the browser gives the following:
 ![23724](https://github.com/tthijm/sep/assets/74216566/5991a9ef-81a1-494f-8016-700ee72d375e)
 ![4629](https://github.com/tthijm/sep/assets/74216566/83bdba3d-9217-4be0-a67c-9ae2f0db3ad9)
 
-
 ### Your own coverage tool
 
 <The following is supposed to be repeated for each group member>
@@ -38,6 +38,14 @@ Running `coverage html` and opening the document in the browser gives the follow
 
 <Provide the same kind of information provided for Function 1>
 
+Thijmen
+
+\_human_join
+
+[commit](https://github.com/tthijm/sep/commit/88c98ebc05c4d67bcdce7d3046ffa786f79b9284)
+
+![](./assets/_human_join_custom.png)
+
 ## Coverage improvement
 
 ### Individual tests
@@ -60,6 +68,19 @@ Running `coverage html` and opening the document in the browser gives the follow
 
 <Provide the same kind of information provided for Test 1>
 
+Thijmen
+
+test\_\_human_join
+
+[commit](https://github.com/tthijm/sep/commit/92796db0afb5feff4b51b3c7e4874c2ba0eae7b9)
+
+![](./assets/_human_join_before.png)
+
+![](./assets/_human_join_after.png)
+
+The coverage improvement is +100%.
+The coverage has been improved, because `_human_join` used to not be tested, while the new `test__human_join` considers every branch to be taken.
+
 ### Overall
 
 <Provide a screenshot of the old coverage results by running an existing tool (the same as you already showed above)>

tests/test_utils.py

@@ -334,3 +334,11 @@ def test_is_inside_class():
 )
 def test_format_dt(dt: datetime.datetime, style: typing.Optional[utils.TimestampStyle], formatted: str):
     assert utils.format_dt(dt, style=style) == formatted
+
+
+def test__human_join() -> None:
+    assert utils._human_join([]) == ""
+    assert utils._human_join(["cat"]) == "cat"
+    assert utils._human_join(["cat", "dog"]) == "cat or dog"
+    assert utils._human_join(["cat", "dog", "fish"]) == "cat, dog or fish"
+    assert utils._human_join(["cat", "dog", "fish", "bird"], delimiter="; ", final="and") == "cat; dog; fish and bird"