strictdoc 0.2.1__tar.gz → 0.4.0__tar.gz

{strictdoc-0.2.1 → strictdoc-0.4.0}/.gitignore

@@ -43,8 +43,6 @@ latest_logs/
 # Files downloaded during tests are stored here.
 downloaded_files/
 
-### StrictDoc's documentation ###
-strictdoc-project.github.io/
 
 ### StrictDoc's developer test ###
 __*.sdoc

{strictdoc-0.2.1 → strictdoc-0.4.0}/PKG-INFO

@@ -1,11 +1,14 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: strictdoc
-Version: 0.2.1
+Version: 0.4.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
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
@@ -31,7 +34,7 @@ Requires-Dist: spdx-tools
 Requires-Dist: textx==3.*,>=3.0.0
 Requires-Dist: toml
 Requires-Dist: tree-sitter
-Requires-Dist: tree-sitter-c
+Requires-Dist: tree-sitter-cpp
 Requires-Dist: tree-sitter-python
 Requires-Dist: uvicorn[standard]>=0.14.0
 Requires-Dist: webdriver-manager

{strictdoc-0.2.1 → strictdoc-0.4.0}/pyproject.toml

@@ -58,7 +58,7 @@ dependencies = [
 
     # Tree Sitter is used for language/AST-aware parsing of Python, C and other files.
     "tree-sitter",
-    "tree-sitter-c",
+    "tree_sitter_cpp",
     "tree-sitter-python",
 
     # Requirements-to-source traceability. Colored syntax for source files.

{strictdoc-0.2.1 → strictdoc-0.4.0}/strictdoc/__init__.py

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

{strictdoc-0.2.1 → strictdoc-0.4.0}/strictdoc/backend/sdoc/grammar/grammar.py

@@ -70,6 +70,7 @@ SDocDocument[noskipws]:
 DocumentConfig[noskipws]:
   ('UID: ' uid = /{REGEX_UID}/ '\n')?
   ('VERSION: ' version = SingleLineString '\n')?
+  ('DATE: ' date = SingleLineString '\n')?
   ('CLASSIFICATION: ' classification = SingleLineString '\n')?
   ('REQ_PREFIX: ' requirement_prefix = SingleLineString '\n')?
   ('ROOT: ' (root = BooleanChoice) '\n')?

{strictdoc-0.2.1 → strictdoc-0.4.0}/strictdoc/backend/sdoc/models/document_config.py

@@ -5,12 +5,13 @@ 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(
             parent=document,
             version=None,
+            date=None,
             uid=None,
             classification=None,
             requirement_prefix=None,
@@ -29,6 +30,7 @@ class DocumentConfig:  # pylint: disable=too-many-instance-attributes
         *,
         parent,
         version: Optional[str],
+        date: Optional[str],
         uid: Optional[str],
         classification: Optional[str],
         requirement_prefix: Optional[str],
@@ -43,6 +45,7 @@ class DocumentConfig:  # pylint: disable=too-many-instance-attributes
     ) -> None:
         self.parent = parent
         self.version: Optional[str] = version
+        self.date: Optional[str] = date
 
         meaningful_uid: Optional[str] = None
         if uid is not None and len(uid) > 0:

{strictdoc-0.2.1 → strictdoc-0.4.0}/strictdoc/backend/sdoc/models/section.py

@@ -20,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.1 → strictdoc-0.4.0}/strictdoc/backend/sdoc_source_code/caching_reader.py

@@ -1,4 +1,4 @@
-from typing import Union
+from typing import Optional, Union
 
 from strictdoc.backend.sdoc.pickle_cache import PickleCache
 from strictdoc.backend.sdoc_source_code.models.source_file_info import (
@@ -20,7 +20,7 @@ class SourceFileTraceabilityCachingReader:
     @staticmethod
     def read_from_file(
         path_to_file: str, project_config: ProjectConfig
-    ) -> SourceFileTraceabilityInfo:
+    ) -> Optional[SourceFileTraceabilityInfo]:
         unpickled_content = PickleCache.read_from_cache(
             path_to_file, project_config, "source_file"
         )
@@ -34,12 +34,21 @@ class SourceFileTraceabilityCachingReader:
         reader = SourceFileTraceabilityCachingReader._get_reader(
             path_to_file, project_config
         )
-        traceability_info: SourceFileTraceabilityInfo = reader.read_from_file(
-            path_to_file
-        )
-        PickleCache.save_to_cache(
-            traceability_info, path_to_file, project_config, "source_file"
-        )
+        try:
+            if (
+                traceability_info := reader.read_from_file(path_to_file)
+            ) is not None:
+                PickleCache.save_to_cache(
+                    traceability_info,
+                    path_to_file,
+                    project_config,
+                    "source_file",
+                )
+        except UnicodeDecodeError:
+            print(  # noqa: T201
+                f"warning: Skip tracing binary file {path_to_file}."
+            )
+            return None
 
         return traceability_info
 
@@ -54,6 +63,13 @@ 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(".cc")
+                or path_to_file.endswith(".h")
+                or path_to_file.endswith(".hh")
+                or path_to_file.endswith(".hpp")
+                or path_to_file.endswith(".cpp")
+            ):
                 return SourceFileTraceabilityReader_C()
         return SourceFileTraceabilityReader()

strictdoc-0.4.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.1 → strictdoc-0.4.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.1 → strictdoc-0.4.0}/strictdoc/backend/sdoc_source_code/marker_parser.py

@@ -11,8 +11,10 @@ from strictdoc.backend.sdoc_source_code.models.range_marker import (
 from strictdoc.backend.sdoc_source_code.models.requirement_marker import Req
 
 REGEX_REQ = r"[A-Za-z][A-Za-z0-9\\-]+"
-# @relation(REQ-1, scope=function)
-REGEX_MARKER = rf"@relation\(({REGEX_REQ}(?:, {REGEX_REQ})*)\, scope=(file|class|function|line|range_start|range_end)\)"
+# @relation(REQ-1, scope=function) or @relation{REQ-1, scope=function}
+REGEX_MARKER = re.compile(
+    rf"@relation[({{]({REGEX_REQ}(?:, {REGEX_REQ})*), scope=(file|class|function|line|range_start|range_end)[)}}]"
+)
 
 
 class MarkerParser:
@@ -29,7 +31,7 @@ class MarkerParser:
         for input_line_idx_, input_line_ in enumerate(
             input_string.splitlines()
         ):
-            match = re.search(REGEX_MARKER, input_line_)
+            match = REGEX_MARKER.search(input_line_)
             if match is None:
                 continue
 
@@ -58,7 +60,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

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

@@ -0,0 +1,45 @@
+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,
+        display_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
+        self.display_name = display_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.1 → strictdoc-0.4.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.1 → strictdoc-0.4.0}/strictdoc/backend/sdoc_source_code/models/range_marker.py

@@ -45,7 +45,7 @@ class RangeMarker:
         self.ng_range_line_end: Optional[int] = None
 
         self.ng_is_nodoc = "nosdoc" in self.reqs
-        self.ng_new_relation_keyword = 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.1 → strictdoc-0.4.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, Optional, Union
 
 from strictdoc.backend.sdoc_source_code.models.function import Function
 from strictdoc.backend.sdoc_source_code.models.function_range_marker import (
@@ -10,12 +10,13 @@ from strictdoc.backend.sdoc_source_code.models.range_marker import (
     LineMarker,
     RangeMarker,
 )
+from strictdoc.core.source_tree import SourceFile
 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 +24,8 @@ class SourceFileTraceabilityInfo:
         is a union.
         """
 
-        self.parts: List = parts
+        self.g_parts: List = g_parts
+        self.source_file: Optional[SourceFile] = None
         self.functions: List[Function] = []
 
         """
@@ -34,6 +36,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.1 → strictdoc-0.4.0}/strictdoc/backend/sdoc_source_code/reader.py

@@ -305,12 +305,14 @@ class SourceFileTraceabilityReader:
         drop_textx_meta(source_file_traceability_info)
         return source_file_traceability_info
 
-    def read_from_file(self, file_path) -> SourceFileTraceabilityInfo:
+    def read_from_file(self, file_path: str) -> SourceFileTraceabilityInfo:
         try:
             with open(file_path, encoding="utf-8") as file:
                 sdoc_content = file.read()
                 sdoc = self.read(sdoc_content, file_path=file_path)
                 return sdoc
+        except UnicodeDecodeError:
+            raise
         except NotImplementedError:
             traceback.print_exc()
             sys.exit(1)