Merge pull request #2190 from strictdoc-project/stanislaw/code_climate

 Code climate: backend/sdoc/writer: remove unused code

Author: stanislaw

strictdoc/backend/sdoc/writer.py

@@ -1,6 +1,5 @@
 # mypy: disable-error-code="arg-type,attr-defined,no-untyped-call,no-untyped-def,union-attr,type-arg"
 import os.path
-from enum import Enum
 from pathlib import Path
 from typing import Dict, List, Tuple, Union
 
@@ -24,7 +23,6 @@
 )
 from strictdoc.backend.sdoc.models.section import SDocSection
 from strictdoc.backend.sdoc.models.type_system import (
-    FileEntry,
     GrammarElementFieldMultipleChoice,
     GrammarElementFieldSingleChoice,
     GrammarElementFieldString,
@@ -38,12 +36,6 @@
 from strictdoc.helpers.string import ensure_newline
 
 
-class TAG(Enum):
-    SECTION = 1
-    REQUIREMENT = 2
-    COMPOSITE_REQUIREMENT = 3
-
-
 class SDWriter:
     def __init__(self, project_config: ProjectConfig):
         self.project_config: ProjectConfig = project_config
@@ -405,39 +397,24 @@ def _print_requirement_fields(
             fields = section_content.ordered_fields_lookup[field_name]
             for field in fields:
                 field_value = field.get_text_value()
+                assert len(field_value) > 0
+
                 if field.is_multiline():
                     output += f"{field_name}: >>>"
                     output += "\n"
-                    if len(field_value) > 0:
-                        if field_value != "\n":
-                            output += ensure_newline(field_value)
+                    if field_value != "\n":
+                        output += ensure_newline(field_value)
                     output += "<<<"
                     output += "\n"
                 else:
-                    if len(field_value) > 0:
-                        output += f"{field_name}: "
-                        output += field_value
-                    else:
-                        output += f"{field_name}:"
+                    output += f"{field_name}: "
+                    output += field_value
                     output += "\n"
 
         output += SDWriter._print_requirement_relations(section_content)
 
         return output
 
-    @staticmethod
-    def _print_closing_tag(closing_tag):
-        output = ""
-        if closing_tag == TAG.SECTION:
-            output += "\n"
-            output += "[/SECTION]"
-            output += "\n"
-        if closing_tag == TAG.COMPOSITE_REQUIREMENT:
-            output += "\n"
-            output += "[/COMPOSITE_REQUIREMENT]"
-            output += "\n"
-        return output
-
     @staticmethod
     def _print_grammar_field_type(grammar_field):
         output = ""
@@ -465,31 +442,14 @@ def _print_grammar_field_type(grammar_field):
         elif isinstance(grammar_field, GrammarElementFieldTag):
             output += RequirementFieldType.TAG
         else:
-            raise NotImplementedError from None
+            raise NotImplementedError from None  # pragma: no cover
 
         output += "\n"
         output += "    REQUIRED: "
         output += "True" if grammar_field.required else "False"
         output += "\n"
         return output
 
-    @staticmethod
-    def _print_file_entry(row_separator, file_entry: FileEntry) -> str:
-        output = ""
-        if row_separator:
-            output += "- "
-        else:
-            output += "  "
-        if file_entry.g_file_format:
-            output += "FORMAT: "
-            output += file_entry.g_file_format
-            output += "\n  "
-        output += "VALUE: "
-        output += file_entry.g_file_path
-        output += "\n"
-
-        return output
-
     @classmethod
     def _print_requirement_relations(cls, requirement: SDocNode):
         assert isinstance(requirement, SDocNode)
@@ -541,5 +501,5 @@ def _print_requirement_relations(cls, requirement: SDocNode):
                     output += child_reference.role
                     output += "\n"
             else:
-                raise AssertionError("Must not reach here.")
+                raise AssertionError("Must not reach here.")  # pragma: no cover
         return output

strictdoc/core/project_config.py

@@ -370,7 +370,7 @@ def load_from_path_or_get_default(
                 f"{exception}."
             ) from None
         except Exception as exception:
-            raise NotImplementedError from exception
+            raise NotImplementedError from exception  # pragma: no cover
 
         config_last_update = get_file_modification_time(path_to_config)
 

strictdoc/export/json/json_generator.py

@@ -345,7 +345,7 @@ def _write_requirement_relations(node: SDocNode) -> List:
                 if child_reference.role is not None:
                     relation_dict["ROLE"] = child_reference.role
             else:
-                raise AssertionError("Must not reach here.")
+                raise AssertionError("Must not reach here.")  # pragma: no cover
 
             relations_list.append(relation_dict)
 

strictdoc/git/change.py

@@ -104,7 +104,7 @@ def __init__(
             assert lhs_section is None, lhs_section
             change_type = ChangeType.SECTION_ADDED
         else:
-            raise AssertionError("Must not reach here.")
+            raise AssertionError("Must not reach here.")  # pragma: no cover
         self.change_type = change_type
 
     def is_paired_change(self) -> bool:
@@ -186,7 +186,7 @@ def __init__(
         elif rhs_requirement is not None:
             change_type = ChangeType.REQUIREMENT_ADDED
         else:
-            raise AssertionError("Must not reach here.")
+            raise AssertionError("Must not reach here.")  # pragma: no cover
         self.change_type = change_type
 
     def is_paired_change(self) -> bool:

strictdoc/helpers/form_data.py

@@ -45,7 +45,7 @@ def _set_value_by_key_path(obj, parts, value):
                 assert isinstance(cursor, dict)
                 cursor[part] = value
             else:
-                raise NotImplementedError from None
+                raise NotImplementedError from None  # pragma: no cover
 
 
 FIELD_NAME = "[A-Za-z0-9_]*"

tasks.py

@@ -473,6 +473,13 @@ def coverage_combine(context):
                 build/coverage/unit_server/.coverage
         """,
     )
+    run_invoke_with_tox(
+        context,
+        ToxEnvironment.CHECK,
+        """
+            coverage html --data-file build/coverage/.coverage.combined
+        """,
+    )
 
 
 @task