Merge pull request #622 from neerdoc/fixes_toward_3.0

Rework of HTML publisher.

.coveragerc

@@ -19,6 +19,5 @@ exclude_lines =
     pragma: no cover
     raise NotImplementedError
     except DistributionNotFound
-    if __name__ == '__main__'
 
 skip_covered = true

.github/workflows/execute-tests.yml

@@ -65,18 +65,8 @@ jobs:
         with:
           command: make test
           current_path: ${{ inputs.workpath }}
-          attempt_limit: 3
+          attempt_limit: 5
           attempt_delay: 2000
-
-      # - name: Run tests attempt 1
-      #   run: make test
-      # - name: Run tests attempt 2
-      #   if: ${{ failure() }}
-      #   run: make test
-      # - name: Run tests attempt 3
-      #   if: ${{ failure() }}
-      #   run: make test
-
       - name: Upload coverage
         uses: codecov/codecov-action@v1
         if: ${{ inputs.os == 'ubuntu-latest' && matrix.python-version == '3.9' && github.repository == 'doorstop-dev/doorstop' }}

.tool-versions

@@ -1,2 +1,2 @@
 python 3.8.13
-poetry 1.6.1
+poetry 1.7.1

.verchew.ini

@@ -11,12 +11,12 @@ version = 3.8 || 3.9 || 3.10 || 3.11 || 3.12
 [Poetry]
 
 cli = poetry
-version = 1
+version = 1.7
 
 [Graphviz]
 
 cli = dot
 cli_version_arg = -V
-version = 7
+version = 9
 optional = true
 message = This is only needed to generate UML diagrams for documentation.

CONTRIBUTING.md

@@ -60,6 +60,12 @@ Clean everything:
 $ make clean
 ```
 
+Compare coverage to current `develop` branch to see if changes causes reduced coverage.
+Please run before creating a PR.
+```sh
+$ make test-cover
+```
+
 ## Automatic
 
 Keep all of the above tasks running on change:

Makefile

@@ -111,6 +111,13 @@ ifndef DISABLE_COVERAGE
 	poetry run coveragespace update overall
 endif
 
+.PHONY: test-cover
+test-cover: install
+# Run first to generate coverage data current code.
+	TEST_INTEGRATION=true poetry run pytest doorstop --doctest-modules --cov=doorstop --cov-report=xml --cov-report=term-missing
+# Run second to generate coverage data for the code in the develop branch.
+	TEST_INTEGRATION=true diff-cover ./coverage.xml --compare-branch=$(shell git for-each-ref --sort=-committerdate refs/heads/develop | cut -f 1 -d ' ')
+
 .PHONY: read-coverage
 read-coverage:
 	bin/open htmlcov/index.html

doorstop/__init__.py

@@ -2,7 +2,7 @@
 
 """Package for doorstop."""
 
-from pkg_resources import DistributionNotFound, get_distribution
+from importlib.metadata import PackageNotFoundError, version
 
 from doorstop.common import DoorstopError, DoorstopInfo, DoorstopWarning
 from doorstop.core import (
@@ -22,8 +22,8 @@
 __project__ = "Doorstop"
 
 try:
-    __version__ = get_distribution(__project__).version
-except DistributionNotFound:
+    __version__ = version(__project__)
+except PackageNotFoundError:
     __version__ = "(local)"
 
 CLI = "doorstop"

doorstop/cli/tests/test_all.py

@@ -782,15 +782,12 @@ def test_publish_document_markdown_file(self):
         self.assertIs(None, main(["publish", "req", path]))
         self.assertTrue(os.path.isfile(path))
 
-    def test_publish_document_html(self):
-        """Verify 'doorstop publish' can create HTML output."""
-        self.assertIs(None, main(["publish", "hlt", "--html"]))
-
     def test_publish_document_html_file(self):
         """Verify 'doorstop publish' can create an HTML file."""
         path = os.path.join(self.temp, "req.html")
         self.assertIs(None, main(["publish", "req", path]))
-        self.assertTrue(os.path.isfile(path))
+        filePath = os.path.join(self.temp, "documents", "req.html")
+        self.assertTrue(os.path.isfile(filePath))
 
     def test_publish_tree_html(self):
         """Verify 'doorstop publish' can create an HTML directory."""

doorstop/cli/tests/test_main.py

@@ -2,6 +2,9 @@
 
 """Unit tests for the doorstop.cli.main module."""
 
+import importlib.util
+import sys
+from os import sep
 from unittest.mock import Mock, patch
 
 from doorstop import settings
@@ -72,3 +75,12 @@ def test_options(self):
         self.assertFalse(settings.CACHE_PATHS)
         self.assertTrue(settings.WARN_ALL)
         self.assertTrue(settings.ERROR_ALL)
+
+    def test_main(self):
+        testargs = [sep.join(["doorstop", "cli", "main.py"])]
+        with patch.object(sys, "argv", testargs):
+            spec = importlib.util.spec_from_file_location("__main__", testargs[0])
+            runpy = importlib.util.module_from_spec(spec)
+            spec.loader.exec_module(runpy)
+            # Assert
+            self.assertIsNotNone(runpy)

doorstop/core/files/templates/html/doorstop.css

@@ -0,0 +1,7 @@
+/* Doorstop.css file. */
+.caption {
+    text-align: center;
+    font-size:15px;
+    }
+
+#img {width: 100%}

doorstop/core/files/templates/html/general.css

@@ -1,7 +1,7 @@
 body {
-    padding-left: 20px;
-    padding-top: 20px;
-    padding-right: 20px;
+    padding-left: 0px;
+    padding-top: 0px;
+    padding-right: 0px;
 }
 
 /* indent everything within a section */