Merge pull request strictdoc-project#1308 from strictdoc-project/stan…

…islaw/no_newline_end_of_file

source coverage: fix case when source file last line is not empty

strictdoc/__init__.py

@@ -1,6 +1,6 @@
 from strictdoc.core.environment import SDocRuntimeEnvironment
 
-__version__ = "0.0.44a10"
+__version__ = "0.0.44a11"
 
 
 environment = SDocRuntimeEnvironment(__file__)

strictdoc/export/html/generators/source_file_view_generator.py

@@ -107,7 +107,7 @@ def get_pygmented_source_lines(
 
         # HACK:
         # Otherwise, Pygments will skip the first line as if it does not exist.
-        # This behavior surprisingly affects on the first line if its empty.
+        # This behavior surprisingly has an effect on the first line if its empty.
         hack_first_line: bool = False
         if source_file_lines[0] == "\n":
             source_file_lines[0] = " \n"
@@ -152,12 +152,14 @@ def get_pygmented_source_lines(
         ), "Expected marker to be in place."
         # Pop ###, pop "\n"
         pygmented_source_file_lines.pop()
-        pygmented_source_file_lines.pop()
+        if pygmented_source_file_lines[-1] == "":
+            pygmented_source_file_lines.pop()
 
         assert len(pygmented_source_file_lines) == len(source_file_lines), (
             f"Something went wrong when running Pygments against "
             f"the source file: "
-            f"{len(pygmented_source_file_lines)} == {len(source_file_lines)}"
+            f"{len(pygmented_source_file_lines)} == {len(source_file_lines)}, "
+            f"{pygmented_source_file_lines} == {source_file_lines}."
         )
 
         for pragma in coverage_info.pragmas:

tests/integration/commands/export/html/file_traceability/01_basic_req_to_file_link_full_path/test.itest

@@ -8,3 +8,4 @@ CHECK-HTML: <a{{.*}}href="../_source_files/file.py.html#REQ-001">
 
 RUN: %cat %S/Output/html/_source_files/file.py.html | filecheck %s --dump-input=fail --check-prefix CHECK-SOURCE-FILE
 CHECK-SOURCE-FILE: <a{{.*}}href="../01_basic_req_to_file_link_full_path/input.html#1-REQ-001"{{.*}}>
+CHECK-SOURCE-FILE: <span class="c1"># noqa: T201</span></pre>

tests/integration/commands/export/html/file_traceability/19_no_newline_at_end_of_file/file.py

@@ -0,0 +1,3 @@
+def hello_world():
+    print("hello world")  # noqa: T201
+123123  # noqa: W292, B018

tests/integration/commands/export/html/file_traceability/19_no_newline_at_end_of_file/input.sdoc

@@ -0,0 +1,10 @@
+[DOCUMENT]
+TITLE: Hello world doc
+
+[REQUIREMENT]
+UID: REQ-001
+REFS:
+- TYPE: File
+  VALUE: file.py
+TITLE: Requirement Title
+STATEMENT: Requirement Statement

tests/integration/commands/export/html/file_traceability/19_no_newline_at_end_of_file/test.itest

@@ -0,0 +1,11 @@
+RUN: %strictdoc export %S --experimental-enable-file-traceability --output-dir Output | filecheck %s --dump-input=fail
+CHECK: Published: Hello world doc
+
+RUN: %check_exists --file "%S/Output/html/_source_files/file.py.html"
+
+RUN: %cat %S/Output/html/19_no_newline_at_end_of_file/input.html | filecheck %s --dump-input=fail --check-prefix CHECK-HTML
+CHECK-HTML: <a{{.*}}href="../_source_files/file.py.html#REQ-001">
+
+RUN: %cat %S/Output/html/_source_files/file.py.html | filecheck %s --dump-input=fail --check-prefix CHECK-SOURCE-FILE
+CHECK-SOURCE-FILE: <a{{.*}}href="../19_no_newline_at_end_of_file/input.html#1-REQ-001"{{.*}}>
+CHECK-SOURCE-FILE: <pre class="highlight"><span class="mi">123123</span>  <span class="c1"># noqa: W292, B018</span></pre>