Fix test coverage of wordlist dialog

novelwriter/dialogs/about.py

@@ -114,7 +114,7 @@ class GuiAbout(QDialog):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
         logger.debug("Delete: GuiAbout")
         return
 

novelwriter/dialogs/docmerge.py

@@ -113,7 +113,7 @@ class GuiDocMerge(QDialog):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
         logger.debug("Delete: GuiDocMerge")
         return
 

novelwriter/dialogs/docsplit.py

@@ -142,7 +142,7 @@ class GuiDocSplit(QDialog):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
         logger.debug("Delete: GuiDocSplit")
         return
 

novelwriter/dialogs/preferences.py

@@ -87,7 +87,7 @@ class GuiPreferences(NPagedDialog):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
         logger.debug("Delete: GuiPreferences")
         return
 

novelwriter/dialogs/projdetails.py

@@ -82,7 +82,7 @@ class GuiProjectDetails(NPagedDialog):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
         logger.debug("Delete: GuiProjectDetails")
         return
 

novelwriter/dialogs/projload.py

@@ -151,7 +151,7 @@ class GuiProjectLoad(QDialog):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
         logger.debug("Delete: GuiProjectLoad")
         return
 

novelwriter/dialogs/projsettings.py

@@ -97,7 +97,7 @@ class GuiProjectSettings(NPagedDialog):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
         logger.debug("Delete: GuiProjectSettings")
         return
 

novelwriter/dialogs/updates.py

@@ -117,7 +117,7 @@ class GuiUpdates(QDialog):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
         logger.debug("Delete: GuiUpdates")
         return
 

novelwriter/dialogs/wordlist.py

@@ -114,7 +114,7 @@ class GuiWordList(QDialog):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
         logger.debug("Delete: GuiWordList")
         return
 
@@ -122,25 +122,25 @@ class GuiWordList(QDialog):
     #  Slots
     ##
 
-    def _doAdd(self) -> bool:
+    def _doAdd(self):
         """Add a new word to the word list."""
         word = self.newEntry.text().strip()
         if word == "":
             self.mainGui.makeAlert(self.tr(
                 "Cannot add a blank word."
             ), nwAlert.ERROR)
-            return False
+            return
 
         if self.listBox.findItems(word, Qt.MatchExactly):
             self.mainGui.makeAlert(self.tr(
                 "The word '{0}' is already in the word list."
             ).format(word), nwAlert.ERROR)
-            return False
+            return
 
         self.listBox.addItem(word)
         self.newEntry.setText("")
 
-        return True
+        return
 
     def _doDelete(self):
         """Delete the selected item."""

novelwriter/tools/lipsum.py

@@ -111,7 +111,7 @@ class GuiLipsum(QDialog):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
         logger.debug("Delete: GuiLipsum")
         return
 

novelwriter/tools/manusbuild.py

@@ -235,8 +235,7 @@ class GuiManuscriptBuild(QDialog):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
-        """For debug use only."""
         logger.debug("Delete: GuiManuscriptBuild")
         return
 

novelwriter/tools/manuscript.py

@@ -196,8 +196,7 @@ class GuiManuscript(QDialog):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
-        """For debug use only."""
         logger.debug("Delete: GuiManuscript")
         return
 

novelwriter/tools/manussettings.py

@@ -167,8 +167,7 @@ class GuiBuildSettings(QDialog):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
-        """For debug use only."""
         logger.debug("Delete: GuiBuildSettings")
 
     def loadContent(self):

novelwriter/tools/projwizard.py

@@ -80,7 +80,7 @@ class GuiProjectWizard(QWizard):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
         logger.debug("Delete: GuiProjectWizard")
         return
 

novelwriter/tools/writingstats.py

@@ -297,7 +297,7 @@ class GuiWritingStats(QDialog):
 
         return
 
-    def __del__(self):
+    def __del__(self):  # pragma: no cover
         logger.debug("Delete: GuiWritingStats")
         return
 

tests/conftest.py

@@ -61,8 +61,7 @@ def resetConfigVars():
 
 @pytest.fixture(scope="session", autouse=True)
 def sessionFixture():
-    """A session wide fixture to set up the test environment.
+    """A session wide fixture to set up the test environment."""
-    """
     if _TMP_ROOT.exists():
         shutil.rmtree(_TMP_ROOT)
     _TMP_ROOT.mkdir()
@@ -111,8 +110,7 @@ def tstPaths():
 
 @pytest.fixture(scope="function")
 def fncPath():
-    """A temporary folder for a single test function.
+    """A temporary folder for a single test function."""
-    """
     fncPath = _TMP_ROOT / "function"
     if fncPath.is_dir():
         shutil.rmtree(fncPath)
@@ -139,16 +137,14 @@ def projPath(fncPath):
 
 @pytest.fixture(scope="function")
 def mockGUI():
-    """Create a mock instance of novelWriter's main GUI class.
+    """Create a mock instance of novelWriter's main GUI class."""
-    """
     theGui = MockGuiMain()
     return theGui
 
 
 @pytest.fixture(scope="function")
 def nwGUI(qtbot, monkeypatch, functionFixture):
-    """Create an instance of the novelWriter GUI.
+    """Create an instance of the novelWriter GUI."""
-    """
     monkeypatch.setattr(QMessageBox, "warning", lambda *a: QMessageBox.Ok)
     monkeypatch.setattr(QMessageBox, "critical", lambda *a: QMessageBox.Ok)
     monkeypatch.setattr(QMessageBox, "information", lambda *a: QMessageBox.Ok)

tests/test_dialogs/test_dlg_wordlist.py

@@ -24,9 +24,9 @@ import pytest
 from PyQt5.QtCore import Qt
 from PyQt5.QtWidgets import QDialog, QAction
 
-from tools import buildTestProject, writeFile, readFile, getGuiItem
+from tools import buildTestProject, getGuiItem
-from mocked import causeOSError
 
+from novelwriter.core.spellcheck import UserDictionary
 from novelwriter.dialogs.wordlist import GuiWordList
 
 
@@ -42,7 +42,6 @@ def testDlgWordList_Dialog(qtbot, monkeypatch, nwGUI, projPath):
 
     # Open project
     nwGUI.openProject(projPath)
-    dictFile = projPath / "meta" / "wordlist.txt"
 
     # Load the dialog
     nwGUI.mainMenu.aEditWordList.activate(QAction.Trigger)
@@ -56,15 +55,15 @@ def testDlgWordList_Dialog(qtbot, monkeypatch, nwGUI, projPath):
     assert wList.listBox.count() == 0
 
     # Add words
-    writeFile(dictFile, (
+    userDict = UserDictionary(nwGUI.theProject)
-        "word_a\n"
+    userDict.add("word_a")
-        "word_c\n"
+    userDict.add("word_c")
-        "word_g\n"
+    userDict.add("word_g")
-        "      \n"  # Should be ignored
+    userDict.add("word_f")
-        "word_f\n"
+    userDict.add("word_b")
-        "word_b\n"
+    userDict.save()
-    ))
+
-    assert wList._loadWordList()
+    wList._loadWordList()
 
     # Check that the content was loaded
     assert wList.listBox.item(0).text() == "word_a"
@@ -72,18 +71,22 @@ def testDlgWordList_Dialog(qtbot, monkeypatch, nwGUI, projPath):
     assert wList.listBox.item(2).text() == "word_c"
     assert wList.listBox.item(3).text() == "word_f"
     assert wList.listBox.item(4).text() == "word_g"
+    assert wList.listBox.count() == 5
 
-    # Add a blank word
+    # Add a blank word, which is ignored
     wList.newEntry.setText("   ")
-    assert not wList._doAdd()
+    wList._doAdd()
+    assert wList.listBox.count() == 5
 
-    # Add an existing word
+    # Add an existing word, which is ignored
     wList.newEntry.setText("word_c")
-    assert not wList._doAdd()
+    wList._doAdd()
+    assert wList.listBox.count() == 5
 
     # Add a new word
     wList.newEntry.setText("word_d")
-    assert wList._doAdd()
+    wList._doAdd()
+    assert wList.listBox.count() == 6
 
     # Check that the content now
     assert wList.listBox.item(0).text() == "word_a"
@@ -95,7 +98,7 @@ def testDlgWordList_Dialog(qtbot, monkeypatch, nwGUI, projPath):
 
     # Delete a word
     wList.newEntry.setText("delete_me")
-    assert wList._doAdd()
+    wList._doAdd()
     assert wList.listBox.item(0).text() == "delete_me"
 
     delItem = wList.listBox.findItems("delete_me", Qt.MatchExactly)[0]
@@ -107,18 +110,14 @@ def testDlgWordList_Dialog(qtbot, monkeypatch, nwGUI, projPath):
 
     # Save files
     assert wList._doSave()
-    assert readFile(dictFile) == (
+    userDict.load()
-        "word_a\n"
+    assert len(list(userDict)) == 6
-        "word_b\n"
+    assert "word_a" in userDict
-        "word_c\n"
+    assert "word_b" in userDict
-        "word_d\n"
+    assert "word_c" in userDict
-        "word_f\n"
+    assert "word_d" in userDict
-        "word_g\n"
+    assert "word_f" in userDict
-    )
+    assert "word_g" in userDict
-
-    # Save again and make it fail
-    monkeypatch.setattr("builtins.open", causeOSError)
-    assert not wList._doSave()
 
     # qtbot.stop()
     wList._doClose()