strictdoc 0.2.0__tar.gz → 0.3.0__tar.gz

{strictdoc-0.2.0 → strictdoc-0.3.0}/PKG-INFO

@@ -1,14 +1,12 @@
 Metadata-Version: 2.3
 Name: strictdoc
-Version: 0.2.0
+Version: 0.3.0
 Summary: StrictDoc is open-source software for technical documentation and requirements management.
 Project-URL: Changelog, https://github.com/strictdoc-project/strictdoc/blob/main/CHANGELOG.md
 Project-URL: Homepage, https://strictdoc.readthedocs.io/en/stable/
 Project-URL: Source, https://github.com/strictdoc-project/strictdoc
 Author-email: Stanislav Pankevich <s.pankevich@gmail.com>, Maryna Balioura <mettta@gmail.com>
-License-Expression: Apache-2.0
-License-File: LICENSE
-License-File: NOTICE
+License: Apache-2.0
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/__init__.py

@@ -1,6 +1,6 @@
 from strictdoc.core.environment import SDocRuntimeEnvironment
 
-__version__ = "0.2.0"
+__version__ = "0.3.0"
 
 
 environment = SDocRuntimeEnvironment(__file__)

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc/models/document.py

@@ -1,3 +1,7 @@
+"""
+@relation(SDOC-SRS-109, scope=file)
+"""
+
 # mypy: disable-error-code="union-attr,type-arg"
 from typing import Generator, List, Optional
 

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc/models/document_config.py

@@ -5,7 +5,7 @@ from strictdoc.helpers.auto_described import auto_described
 
 
 @auto_described
-class DocumentConfig:  # pylint: disable=too-many-instance-attributes
+class DocumentConfig:
     @staticmethod
     def default_config(document) -> "DocumentConfig":
         return DocumentConfig(

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc/models/document_from_file.py

@@ -1,3 +1,7 @@
+"""
+@relation(SDOC-SRS-109, scope=file)
+"""
+
 # mypy: disable-error-code="no-untyped-def,type-arg"
 from typing import List, Optional
 

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc/models/document_grammar.py

@@ -210,7 +210,7 @@ class DocumentGrammar:
             DocumentGrammar.create_default_text_element()
         )
 
-        # @sdoc[SDOC-SRS-132]
+        # @relation(SDOC-SRS-132, scope=range_start)
         fields: List[
             Union[
                 GrammarElementFieldString,
@@ -270,7 +270,7 @@ class DocumentGrammar:
         requirement_element = GrammarElement(
             parent=None, tag="REQUIREMENT", fields=fields, relations=[]
         )
-        # @sdoc[/SDOC-SRS-132]
+        # @relation(SDOC-SRS-132, scope=range_end)
 
         requirement_element.relations = create_default_relations(
             requirement_element

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc/models/free_text.py

@@ -1,3 +1,7 @@
+"""
+@relation(SDOC-SRS-135, scope=file)
+"""
+
 from typing import Any, List, Optional
 
 from strictdoc.backend.sdoc.models.anchor import Anchor

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc/models/node.py

@@ -1,3 +1,7 @@
+"""
+@relation(SDOC-SRS-26, scope=file)
+"""
+
 # mypy: disable-error-code="union-attr"
 from collections import OrderedDict
 from typing import Any, Generator, List, Optional, Tuple, Union

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc/models/section.py

@@ -1,3 +1,7 @@
+"""
+@relation(SDOC-SRS-99, scope=file)
+"""
+
 # mypy: disable-error-code="attr-defined,no-untyped-call,no-untyped-def,union-attr"
 from typing import List, Optional, Union
 
@@ -16,7 +20,7 @@ class SectionContext:
 
 
 @auto_described
-class SDocSection(SDocObject):  # pylint: disable=too-many-instance-attributes
+class SDocSection(SDocObject):
     def __init__(
         self,
         parent,

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc_source_code/caching_reader.py

@@ -54,6 +54,6 @@ class SourceFileTraceabilityCachingReader:
         if project_config.is_activated_source_file_language_parsers():
             if path_to_file.endswith(".py"):
                 return SourceFileTraceabilityReader_Python()
-            if path_to_file.endswith(".c"):
+            if path_to_file.endswith(".c") or path_to_file.endswith(".h"):
                 return SourceFileTraceabilityReader_C()
         return SourceFileTraceabilityReader()

strictdoc-0.3.0/strictdoc/backend/sdoc_source_code/constants.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+
+class FunctionAttribute(Enum):
+    STATIC = "static"
+    DECLARATION = "declaration"
+    DEFINITION = "definition"

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc_source_code/grammar.py

@@ -1,6 +1,6 @@
 SOURCE_FILE_GRAMMAR = """
 SourceFileTraceabilityInfo[noskipws]:
-  parts += Part
+  g_parts += Part
 ;
 
 Part[noskipws]:
@@ -33,7 +33,7 @@ RangeMarker[noskipws]:
 
 FunctionRangeMarker[noskipws]:
   /^.*?@relation/
-  "(" (reqs_objs += Req[', ']) ', scope=file)' '\n'?
+  "(" (reqs_objs += Req[', ']) ', scope=' scope="file" ')' '\n'?
 ;
 
 LineMarker[noskipws]:

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc_source_code/marker_parser.py

@@ -58,7 +58,9 @@ class MarkerParser:
                 requirements.append(requirement)
 
             if marker_type in ("file", "class", "function"):
-                function_marker = FunctionRangeMarker(None, requirements)
+                function_marker = FunctionRangeMarker(
+                    None, requirements, scope=marker_type
+                )
                 function_marker.ng_source_line_begin = line_start
                 function_marker.ng_range_line_begin = line_start
                 function_marker.ng_range_line_end = line_end
@@ -80,7 +82,7 @@ class MarkerParser:
                 range_marker.ng_source_column_begin = first_requirement_column
                 range_marker.ng_range_line_begin = line_start
                 range_marker.ng_range_line_end = line_end
-                range_marker.ng_is_language_parsed = True
+                range_marker.ng_new_relation_keyword = True
                 markers.append(range_marker)
             elif marker_type == "line":
                 line_marker = LineMarker(None, requirements)

strictdoc-0.3.0/strictdoc/backend/sdoc_source_code/models/function.py

@@ -0,0 +1,42 @@
+from typing import Any, List, Set
+
+from strictdoc.backend.sdoc_source_code.constants import FunctionAttribute
+from strictdoc.backend.sdoc_source_code.models.function_range_marker import (
+    FunctionRangeMarker,
+)
+from strictdoc.helpers.auto_described import auto_described
+
+
+@auto_described
+class Function:
+    def __init__(
+        self,
+        parent: Any,
+        name: str,
+        line_begin: int,
+        line_end: int,
+        child_functions: List[Any],
+        markers: List[FunctionRangeMarker],
+        attributes: Set[FunctionAttribute],
+    ):
+        assert parent is not None
+        self.parent = parent
+        self.name = name
+        # Child functions are supported in programming languages that can nest
+        # functions, for example, Python.
+        self.child_functions: List[Function] = child_functions
+        self.markers: List[FunctionRangeMarker] = markers
+        self.line_begin = line_begin
+        self.line_end = line_end
+        self.attributes: Set[FunctionAttribute] = attributes
+
+    def is_declaration(self) -> bool:
+        return FunctionAttribute.DECLARATION in self.attributes
+
+    def is_definition(self) -> bool:
+        return FunctionAttribute.DEFINITION in self.attributes
+
+    def is_public(self) -> bool:
+        if FunctionAttribute.STATIC in self.attributes:
+            return False
+        return True

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc_source_code/models/function_range_marker.py

@@ -14,12 +14,15 @@ class RangeMarkerType(Enum):
 
 @auto_described
 class FunctionRangeMarker:
-    def __init__(self, parent, reqs_objs: List[Req]):
+    def __init__(self, parent, reqs_objs: List[Req], scope: str):
         assert isinstance(reqs_objs, list)
+        assert isinstance(scope, str), scope
         self.parent = parent
         self.reqs_objs: List[Req] = reqs_objs
         self.reqs: List[str] = list(map(lambda req: req.uid, reqs_objs))
 
+        self.scope: RangeMarkerType = RangeMarkerType(scope)
+
         # Line number of the marker in the source code.
         self.ng_source_line_begin: Optional[int] = None
         self.ng_source_column_begin: Optional[int] = None
@@ -64,5 +67,5 @@ class FunctionRangeMarker:
 
 @auto_described
 class ForwardFunctionRangeMarker(FunctionRangeMarker):
-    def __init__(self, parent, reqs_objs: List[Req]):
-        super().__init__(parent, reqs_objs)
+    def __init__(self, parent, reqs_objs: List[Req], scope: str):
+        super().__init__(parent, reqs_objs, scope)

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc_source_code/models/range_marker.py

@@ -24,6 +24,7 @@ class RangeMarker:
         else:
             assert scope in ("range_start", "range_end")
             self.begin_or_end = "[" if scope == "range_start" else "[/"
+            self.ng_new_relation_keyword = True
 
         self.reqs_objs: List[Req] = reqs_objs
         self.reqs: List[str] = list(map(lambda req: req.uid, reqs_objs))
@@ -44,7 +45,7 @@ class RangeMarker:
         self.ng_range_line_end: Optional[int] = None
 
         self.ng_is_nodoc = "nosdoc" in self.reqs
-        self.ng_is_language_parsed = False
+        self.ng_new_relation_keyword = scope is not None and len(scope) > 0
 
     def is_begin(self) -> bool:
         return self.begin_or_end == "["

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc_source_code/models/source_file_info.py

@@ -1,5 +1,5 @@
 # mypy: disable-error-code="no-untyped-def,type-arg,var-annotated"
-from typing import List, Union
+from typing import Dict, List, Union
 
 from strictdoc.backend.sdoc_source_code.models.function import Function
 from strictdoc.backend.sdoc_source_code.models.function_range_marker import (
@@ -15,7 +15,7 @@ from strictdoc.helpers.auto_described import auto_described
 
 @auto_described
 class SourceFileTraceabilityInfo:
-    def __init__(self, parts: List):
+    def __init__(self, g_parts: List):
         """
         At the init time, only the backward RangeMarkers are available from
         a source file. At runtime, the ForwardRangeMarkers are mixed in
@@ -23,7 +23,7 @@ class SourceFileTraceabilityInfo:
         is a union.
         """
 
-        self.parts: List = parts
+        self.g_parts: List = g_parts
         self.functions: List[Function] = []
 
         """
@@ -34,6 +34,9 @@ class SourceFileTraceabilityInfo:
         """
         self.ng_map_reqs_to_markers = {}
 
+        self.ng_map_names_to_markers: Dict[str, List] = {}
+        self.ng_map_names_to_definition_functions: Dict[str, Function] = {}
+
         self.ng_lines_total = 0
         self.ng_lines_covered = 0
         self._coverage: float = 0

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc_source_code/reader_c.py

@@ -7,6 +7,7 @@ import tree_sitter_c
 from tree_sitter import Language, Node, Parser
 
 from strictdoc.backend.sdoc.error_handling import StrictDocSemanticError
+from strictdoc.backend.sdoc_source_code.constants import FunctionAttribute
 from strictdoc.backend.sdoc_source_code.marker_parser import MarkerParser
 from strictdoc.backend.sdoc_source_code.models.function import Function
 from strictdoc.backend.sdoc_source_code.models.function_range_marker import (
@@ -26,7 +27,11 @@ from strictdoc.backend.sdoc_source_code.processors.general_language_marker_proce
     range_marker_processor,
     source_file_traceability_info_processor,
 )
-from strictdoc.backend.sdoc_source_code.tree_sitter_helpers import traverse_tree
+from strictdoc.backend.sdoc_source_code.tree_sitter_helpers import (
+    traverse_tree,
+    ts_find_child_node_by_type,
+    ts_find_child_nodes_by_type,
+)
 from strictdoc.helpers.string import get_lines_count
 
 
@@ -86,6 +91,83 @@ class SourceFileTraceabilityReader_C:
                                 traceability_info.markers.append(
                                     function_range_marker_
                                 )
+            elif node_.type == "declaration":
+                function_declarator_node = ts_find_child_node_by_type(
+                    node_, "function_declarator"
+                )
+                if function_declarator_node is None:
+                    continue
+
+                function_identifier_node = ts_find_child_node_by_type(
+                    function_declarator_node, "identifier"
+                )
+                if function_identifier_node is None:
+                    continue
+
+                if function_identifier_node.text is None:
+                    continue
+
+                function_name: str = function_identifier_node.text.decode(
+                    "utf8"
+                )
+                assert function_name is not None, function_name
+
+                function_attributes = {FunctionAttribute.DECLARATION}
+                for specifier_node_ in ts_find_child_nodes_by_type(
+                    node_, "storage_class_specifier"
+                ):
+                    if specifier_node_.text == b"static":
+                        function_attributes.add(FunctionAttribute.STATIC)
+
+                function_markers: List[FunctionRangeMarker] = []
+                function_comment_node: Optional[Node] = None
+                function_comment_text = None
+                if (
+                    node_.prev_sibling is not None
+                    and node_.prev_sibling.type == "comment"
+                ):
+                    function_comment_node = node_.prev_sibling
+                    assert function_comment_node.text is not None
+                    function_comment_text = function_comment_node.text.decode(
+                        "utf8"
+                    )
+
+                    function_last_line = node_.end_point[0] + 1
+
+                    markers = MarkerParser.parse(
+                        function_comment_text,
+                        function_comment_node.start_point[0] + 1,
+                        function_last_line,
+                        function_comment_node.start_point[0] + 1,
+                        function_comment_node.start_point[1] + 1,
+                        entity_name=function_name,
+                    )
+                    for marker_ in markers:
+                        if isinstance(marker_, FunctionRangeMarker) and (
+                            function_range_marker_ := marker_
+                        ):
+                            function_range_marker_processor(
+                                function_range_marker_, parse_context
+                            )
+                            traceability_info.markers.append(
+                                function_range_marker_
+                            )
+                            function_markers.append(marker_)
+
+                # The function range includes the top comment if it exists.
+                new_function = Function(
+                    parent=traceability_info,
+                    name=function_name,
+                    line_begin=function_comment_node.start_point[0] + 1
+                    if function_comment_node is not None
+                    else node_.range.start_point[0] + 1,
+                    line_end=node_.range.end_point[0] + 1,
+                    child_functions=[],
+                    markers=function_markers,
+                    attributes=function_attributes,
+                )
+                traceability_info.functions.append(new_function)
+
             elif node_.type == "function_definition":
                 function_name: str = ""
 
@@ -97,6 +179,7 @@ class SourceFileTraceabilityReader_C:
                         function_name = child_.children[0].text.decode("utf8")
                 assert function_name is not None, "Function name"
 
+                function_markers: List[FunctionRangeMarker] = []
                 function_comment_node: Optional[Node] = None
                 function_comment_text = None
                 if (
@@ -111,9 +194,7 @@ class SourceFileTraceabilityReader_C:
 
                     function_last_line = node_.end_point[0] + 1
 
-                    markers: List[
-                        Union[FunctionRangeMarker, RangeMarker, LineMarker]
-                    ] = MarkerParser.parse(
+                    markers = MarkerParser.parse(
                         function_comment_text,
                         function_comment_node.start_point[0] + 1,
                         function_last_line,
@@ -131,21 +212,28 @@ class SourceFileTraceabilityReader_C:
                             traceability_info.markers.append(
                                 function_range_marker_
                             )
-                            traceability_info.parts.append(
-                                function_range_marker_
-                            )
+                            function_markers.append(marker_)
 
                 # The function range includes the top comment if it exists.
                 new_function = Function(
-                    parent=None,
+                    parent=traceability_info,
                     name=function_name,
                     line_begin=function_comment_node.start_point[0] + 1
                     if function_comment_node is not None
                     else node_.range.start_point[0] + 1,
                     line_end=node_.range.end_point[0] + 1,
-                    parts=[],
+                    child_functions=[],
+                    markers=function_markers,
+                    attributes={FunctionAttribute.DEFINITION},
                 )
                 traceability_info.functions.append(new_function)
+                if len(function_markers) > 0:
+                    traceability_info.ng_map_names_to_markers[function_name] = (
+                        function_markers
+                    )
+                    traceability_info.ng_map_names_to_definition_functions[
+                        function_name
+                    ] = new_function
             elif node_.type == "comment":
                 if node_.text is None:
                     raise NotImplementedError("Comment without a text")
@@ -166,12 +254,10 @@ class SourceFileTraceabilityReader_C:
                         range_marker_ := marker_
                     ):
                         range_marker_processor(range_marker_, parse_context)
-                        traceability_info.parts.append(range_marker_)
                     elif isinstance(marker_, LineMarker) and (
                         line_marker_ := marker_
                     ):
                         line_marker_processor(line_marker_, parse_context)
-                        traceability_info.parts.append(line_marker_)
                     else:
                         continue
             else:

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc_source_code/reader_python.py

@@ -62,11 +62,13 @@ class SourceFileTraceabilityReader_Python:
         for node_ in nodes:
             if node_.type == "module":
                 function = Function(
-                    parent=None,
+                    parent=traceability_info,
                     name="module",
                     line_begin=node_.start_point[0] + 1,
                     line_end=node_.end_point[0] + 1,
-                    parts=[],
+                    child_functions=[],
+                    markers=[],
+                    attributes=set(),
                 )
                 functions_stack.append(function)
                 map_function_to_node[function] = node_
@@ -183,17 +185,20 @@ class SourceFileTraceabilityReader_Python:
                     functions_stack = functions_stack[:1]
 
                 new_function = Function(
-                    parent=None,
+                    parent=traceability_info,
                     name=function_name,
                     line_begin=node_.range.start_point[0] + 1,
                     line_end=node_.range.end_point[0] + 1,
-                    parts=[],
+                    child_functions=[],
+                    # Python functions do not need to track markers.
+                    markers=[],
+                    attributes=set(),
                 )
                 map_function_to_node[new_function] = node_
 
                 parent_function = functions_stack[-1]
 
-                parent_function.parts.append(new_function)
+                parent_function.child_functions.append(new_function)
                 functions_stack.append(new_function)
                 traceability_info.functions.append(new_function)
             elif node_.type == "comment":
@@ -231,8 +236,6 @@ class SourceFileTraceabilityReader_Python:
             or functions_stack[0].name == "translation_unit"
         )
 
-        traceability_info.parts = functions_stack[0].parts
-
         source_file_traceability_info_processor(
             traceability_info, parse_context
         )

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/backend/sdoc_source_code/tree_sitter_helpers.py

@@ -1,4 +1,4 @@
-from typing import Generator
+from typing import Generator, Optional
 
 from tree_sitter import Node, Tree
 
@@ -16,3 +16,18 @@ def traverse_tree(tree: Tree) -> Generator[Node, None, None]:
             visited_children = False
         elif not cursor.goto_parent():
             break
+
+
+def ts_find_child_node_by_type(node: Node, node_type: str) -> Optional[Node]:
+    for child_ in node.children:
+        if child_.type == node_type:
+            return child_
+    return None
+
+
+def ts_find_child_nodes_by_type(
+    node: Node, node_type: str
+) -> Generator[Node, None, None]:
+    for child_ in node.children:
+        if child_.type == node_type:
+            yield child_

{strictdoc-0.2.0 → strictdoc-0.3.0}/strictdoc/cli/cli_arg_parser.py

@@ -109,7 +109,7 @@ class ServerCommandConfig:
 
 
 @auto_described
-class ExportCommandConfig:  # pylint: disable=too-many-instance-attributes
+class ExportCommandConfig:
     def __init__(
         self,
         input_paths,