Move main word counter to new module

tests/test_core/test_core_index.py

@@ -31,7 +31,7 @@ from tools import C, buildTestProject, cmpFiles, writeFile
 
 from novelwriter.enum import nwComment, nwItemClass, nwItemLayout
 from novelwriter.constants import nwFiles
-from novelwriter.core.index import IndexItem, NWIndex, countWords, TagsIndex, processComment
+from novelwriter.core.index import IndexItem, NWIndex, TagsIndex, processComment
 from novelwriter.core.project import NWProject
 
 
@@ -1319,105 +1319,3 @@ def testCoreIndex_processComment():
     assert processComment("% \t  SHORT  : Hi:You") == (nwComment.SHORT, "Hi:You", 13)
 
 # END Test testCoreIndex_processComment
-
-
-@pytest.mark.core
-def testCoreIndex_countWords():
-    """Test the word counter and the exclusion filers."""
-    # Non-Text
-    assert countWords(None) == (0, 0, 0)  # type: ignore
-    assert countWords(1234) == (0, 0, 0)  # type: ignore
-
-    # General Text
-    cC, wC, pC = countWords((
-        "# Heading One\n"
-        "## Heading Two\n"
-        "### Heading Three\n"
-        "#### Heading Four\n\n"
-        "@tag: value\n\n"
-        "% A comment that should not be counted.\n\n"
-        "The first paragraph.\n\n"
-        "The second paragraph.\n\n\n"
-        "The third paragraph.\n\n"
-        "Dashes\u2013and even longer\u2014dashes."
-    ))
-    assert cC == 138
-    assert wC == 22
-    assert pC == 4
-
-    # Text Alignment
-    cC, wC, pC = countWords((
-        "# Title\n\n"
-        "Left aligned<<\n\n"
-        "Left aligned <<\n\n"
-        "Right indent<\n\n"
-        "Right indent <\n\n"
-    ))
-    assert cC == 53
-    assert wC == 9
-    assert pC == 4
-
-    cC, wC, pC = countWords((
-        "# Title\n\n"
-        ">>Right aligned\n\n"
-        ">> Right aligned\n\n"
-        ">Left indent\n\n"
-        "> Left indent\n\n"
-    ))
-    assert cC == 53
-    assert wC == 9
-    assert pC == 4
-
-    cC, wC, pC = countWords((
-        "# Title\n\n"
-        ">>Centre aligned<<\n\n"
-        ">> Centre aligned <<\n\n"
-        ">Double indent<\n\n"
-        "> Double indent <\n\n"
-    ))
-    assert cC == 59
-    assert wC == 9
-    assert pC == 4
-
-    # Formatting Codes, Upper Case (Old Implementation)
-    cC, wC, pC = countWords((
-        "Some text\n\n"
-        "[NEWPAGE]\n\n"
-        "more text\n\n"
-        "[NEW PAGE]]\n\n"
-        "even more text\n\n"
-        "[VSPACE]\n\n"
-        "and some final text\n\n"
-        "[VSPACE:4]\n\n"
-        "THE END\n\n"
-    ))
-    assert cC == 58
-    assert wC == 13
-    assert pC == 5
-
-    # Formatting Codes, Lower Case (Current Implementation)
-    cC, wC, pC = countWords((
-        "Some text\n\n"
-        "[newpage]\n\n"
-        "more text\n\n"
-        "[new page]]\n\n"
-        "even more text\n\n"
-        "[vspace]\n\n"
-        "and some final text\n\n"
-        "[vspace:4]\n\n"
-        "THE END\n\n"
-    ))
-    assert cC == 58
-    assert wC == 13
-    assert pC == 5
-
-    # Check ShortCodes
-    cC, wC, pC = countWords((
-        "Text with [b]bold[/b] text and padded [b] bold [/b] text.\n\n"
-        "Text with [b][i] nested [/i] emphasis [/b] in it.\n\n"
-    ))
-    assert cC == 78
-    assert wC == 14
-    assert pC == 2
-
-# END Test testCoreIndex_countWords

tests/test_gui/test_gui_doceditor.py

@@ -32,8 +32,8 @@ from PyQt5.QtWidgets import QAction, QMenu, qApp
 from novelwriter import CONFIG, SHARED
 from novelwriter.enum import nwDocAction, nwDocInsert, nwItemLayout, nwTrinary, nwWidget
 from novelwriter.constants import nwKeyWords, nwUnicode
-from novelwriter.core.index import countWords
 from novelwriter.gui.doceditor import GuiDocEditor, GuiDocToolBar
+from novelwriter.text.counting import standardCounter
 from novelwriter.dialogs.editlabel import GuiEditLabel
 
 KEY_DELAY = 1
@@ -1673,7 +1673,7 @@ def testGuiEditor_WordCounters(qtbot, monkeypatch, nwGUI, projPath, ipsumText, m
     assert nwGUI.openDocument(C.hSceneDoc) is True
 
     text = "\n\n".join(ipsumText)
-    cC, wC, pC = countWords(text)
+    cC, wC, pC = standardCounter(text)
     nwGUI.docEditor.replaceText(text)
 
     # Check that a busy counter is blocked

tests/test_text/test_core_counting.py

@@ -0,0 +1,127 @@
+"""
+novelWriter – Counter Module Tester
+===================================
+
+This file is a part of novelWriter
+Copyright 2018–2024, Veronica Berglyd Olsen
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.
+"""
+from __future__ import annotations
+
+import pytest
+
+from novelwriter.text.counting import standardCounter
+
+
+@pytest.mark.core
+def testTextCounting_standardCounter():
+    """Test the word counter and the exclusion filers."""
+    # Non-Text
+    assert standardCounter(None) == (0, 0, 0)  # type: ignore
+    assert standardCounter(1234) == (0, 0, 0)  # type: ignore
+
+    # General Text
+    cC, wC, pC = standardCounter((
+        "# Heading One\n"
+        "## Heading Two\n"
+        "### Heading Three\n"
+        "#### Heading Four\n\n"
+        "@tag: value\n\n"
+        "% A comment that should not be counted.\n\n"
+        "The first paragraph.\n\n"
+        "The second paragraph.\n\n\n"
+        "The third paragraph.\n\n"
+        "Dashes\u2013and even longer\u2014dashes."
+    ))
+    assert cC == 138
+    assert wC == 22
+    assert pC == 4
+
+    # Text Alignment
+    cC, wC, pC = standardCounter((
+        "# Title\n\n"
+        "Left aligned<<\n\n"
+        "Left aligned <<\n\n"
+        "Right indent<\n\n"
+        "Right indent <\n\n"
+    ))
+    assert cC == 53
+    assert wC == 9
+    assert pC == 4
+
+    cC, wC, pC = standardCounter((
+        "# Title\n\n"
+        ">>Right aligned\n\n"
+        ">> Right aligned\n\n"
+        ">Left indent\n\n"
+        "> Left indent\n\n"
+    ))
+    assert cC == 53
+    assert wC == 9
+    assert pC == 4
+
+    cC, wC, pC = standardCounter((
+        "# Title\n\n"
+        ">>Centre aligned<<\n\n"
+        ">> Centre aligned <<\n\n"
+        ">Double indent<\n\n"
+        "> Double indent <\n\n"
+    ))
+    assert cC == 59
+    assert wC == 9
+    assert pC == 4
+
+    # Formatting Codes, Upper Case (Old Implementation)
+    cC, wC, pC = standardCounter((
+        "Some text\n\n"
+        "[NEWPAGE]\n\n"
+        "more text\n\n"
+        "[NEW PAGE]\n\n"
+        "even more text\n\n"
+        "[VSPACE]\n\n"
+        "and some final text\n\n"
+        "[VSPACE:4]\n\n"
+        "THE END\n\n"
+    ))
+    assert cC == 58
+    assert wC == 13
+    assert pC == 5
+
+    # Formatting Codes, Lower Case (Current Implementation)
+    cC, wC, pC = standardCounter((
+        "Some text\n\n"
+        "[newpage]\n\n"
+        "more text\n\n"
+        "[new page]\n\n"
+        "even more text\n\n"
+        "[vspace]\n\n"
+        "and some final text\n\n"
+        "[vspace:4]\n\n"
+        "THE END\n\n"
+    ))
+    assert cC == 58
+    assert wC == 13
+    assert pC == 5
+
+    # Check ShortCodes
+    cC, wC, pC = standardCounter((
+        "Text with [b]bold[/b] text and padded [b] bold [/b] text.\n\n"
+        "Text with [b][i] nested [/i] emphasis [/b] in it.\n\n"
+    ))
+    assert cC == 78
+    assert wC == 14
+    assert pC == 2
+
+# END Test testTextCounting_standardCounter