strictdoc 0.0.52__tar.gz → 0.0.54a1__tar.gz

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strictdoc
-Version: 0.0.52
+Version: 0.0.54a1
 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/
@@ -27,14 +27,12 @@ Requires-Dist: graphviz>=0.20.1
 Requires-Dist: html5lib>=1.1
 Requires-Dist: jinja2>=2.11.2
 Requires-Dist: lxml==4.*,>=4.6.2
-Requires-Dist: pybtex==0.*,>=0.23.0
 Requires-Dist: pygments==2.*,>=2.10.0
 Requires-Dist: python-datauri==0.*,>=0.2.9
 Requires-Dist: python-multipart
 Requires-Dist: reqif==0.*,>=0.0.39
 Requires-Dist: requests
 Requires-Dist: selenium
-Requires-Dist: setuptools
 Requires-Dist: spdx-tools
 Requires-Dist: textx==3.*,>=3.0.0
 Requires-Dist: toml

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/pyproject.toml

@@ -78,15 +78,6 @@ dependencies = [
     # SPDX
     "spdx-tools",
 
-    # Bibtex
-    "pybtex >= 0.23.0, == 0.*",
-    # Bibtex fails with:
-    # ModuleNotFoundError: No module named 'pkg_resources'
-    # because pkg_resources has been deprecated.
-    # Installing setuptools fixes the issue for now, see
-    # https://bitbucket.org/pybtex-devs/pybtex/issues/169
-    "setuptools",
-
     # Web server dependencies
     "fastapi >= 0.83.0",
     # FastAPI: To receive uploaded files and/or form data, first install python-multipart.

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/__init__.py

@@ -1,6 +1,6 @@
 from strictdoc.core.environment import SDocRuntimeEnvironment
 
-__version__ = "0.0.52"
+__version__ = "0.0.54a1"
 
 
 environment = SDocRuntimeEnvironment(__file__)

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/excel/export/excel_generator.py

@@ -9,7 +9,6 @@ from xlsxwriter.worksheet import Worksheet
 from strictdoc.backend.sdoc.models.document import SDocDocument
 from strictdoc.backend.sdoc.models.node import SDocNode
 from strictdoc.backend.sdoc.models.reference import (
-    BibReference,
     FileReference,
     ParentReqReference,
 )
@@ -164,13 +163,6 @@ class ExcelGenerator:
                                             + ref.get_posix_path()
                                             + "\n"
                                         )
-                                    elif isinstance(ref, BibReference):
-                                        value += (
-                                            ref.ref_type
-                                            + ": "
-                                            + ref.bib_entry.bib_value
-                                            + "\n"
-                                        )
                             else:
                                 value = req_field.get_value()
                             worksheet.write(row, idx, value)

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/excel/import_/excel_to_sdoc_converter.py

@@ -120,7 +120,13 @@ class ExcelToSDocConverter:
         document_config = DocumentConfig.default_config(None)
         document_title = title if title else "<No title>"
         document = SDocDocument(
-            None, document_title, document_config, None, None, None, [], []
+            mid=None,
+            title=document_title,
+            config=document_config,
+            view=None,
+            grammar=None,
+            free_texts=[],
+            section_contents=[],
         )
 
         fields = list(
@@ -219,6 +225,5 @@ class ExcelToSDocConverter:
             mid=None,
             fields=list(template_requirement.enumerate_fields()),
         )
-        requirement.ng_level = 1
 
         return requirement

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/reqif/p01_sdoc/reqif_to_sdoc_converter.py

@@ -275,7 +275,7 @@ class P01_ReqIFToSDocConverter:  # pylint: disable=invalid-name
         document_config = DocumentConfig.default_config(None)
         document_title = title if title else "<No title>"
         document = SDocDocument(
-            None, document_title, document_config, None, None, None, [], []
+            None, document_title, document_config, None, None, [], []
         )
         document.grammar = DocumentGrammar.create_default(document)
         # FIXME: One day this will go away.

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/reqif/p11_polarion/reqif_to_sdoc_converter.py

@@ -290,7 +290,7 @@ class P11_ReqIFToSDocConverter:  # pylint: disable=invalid-name
         document_config.markup = "HTML"
         document_title = title if title else "<No title>"
         document = SDocDocument(
-            None, document_title, document_config, None, None, None, [], []
+            None, document_title, document_config, None, None, [], []
         )
         document.grammar = DocumentGrammar.create_default(document)
         return document

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/sdoc/grammar/grammar.py

@@ -37,19 +37,10 @@ SDocDocument[noskipws]:
   (config = DocumentConfig)?
   (view = DocumentView)?
   ('\n' grammar = DocumentGrammar)?
-  ('\n' bibliography = DocumentBibliography)?
   free_texts *= SpaceThenFreeText
   section_contents *= SectionOrRequirement
 ;
 
-DocumentBibliography[noskipws]:
-  '[BIBLIOGRAPHY]' '\n'
-  ( 'BIBFILES:' '\n'
-    bib_files *= BibFileEntry )?
-  ( 'ENTRIES:' '\n'
-    bib_entries += BibEntry )?
-;
-
 DocumentConfig[noskipws]:
   ('UID: ' uid = /{REGEX_UID}/ '\n')?
   ('VERSION: ' version = SingleLineString '\n')?
@@ -136,16 +127,16 @@ SDocSection[noskipws]:
 ;
 
 SectionOrRequirement[noskipws]:
-  '\n' (SDocSection | SDocNode | CompositeRequirement | FragmentFromFile)
+  '\n' (SDocSection | SDocNode | SDocCompositeNode | DocumentFromFile)
 ;
 
-FragmentFromFile[noskipws]:
+DocumentFromFile[noskipws]:
   '[DOCUMENT_FROM_FILE]' '\n'
   'FILE: ' file = /.+$/ '\n'
 ;
 
 SpaceThenRequirement[noskipws]:
-  '\n' (SDocNode | CompositeRequirement)
+  '\n' (SDocNode | SDocCompositeNode)
 ;
 
 SpaceThenFreeText[noskipws]:
@@ -157,12 +148,12 @@ ReservedKeyword[noskipws]:
 ;
 
 SDocNode[noskipws]:
-  '[' !CompositeRequirementTagName requirement_type = RequirementType ']' '\n'
+  '[' !SDocCompositeNodeTagName requirement_type = RequirementType ']' '\n'
   ('MID: ' mid = SingleLineString '\n')?
   fields *= SDocNodeField
 ;
 
-CompositeRequirementTagName[noskipws]:
+SDocCompositeNodeTagName[noskipws]:
   'COMPOSITE_'
 ;
 
@@ -180,7 +171,7 @@ SDocNodeField[noskipws]:
   )
 ;
 
-CompositeRequirement[noskipws]:
+SDocCompositeNode[noskipws]:
   '[COMPOSITE_' requirement_type = RequirementType ']' '\n'
 
   ('MID: ' mid = SingleLineString '\n')?

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/sdoc/grammar/grammar_grammar.py

@@ -24,7 +24,7 @@ GrammarElement[noskipws]:
 ;
 
 GrammarElementRelation[noskipws]:
-  (GrammarElementRelationParent | GrammarElementRelationChild | GrammarElementRelationFile | GrammarElementRelationBibtex)
+  (GrammarElementRelationParent | GrammarElementRelationChild | GrammarElementRelationFile)
 ;
 
 GrammarElementRelationParent[noskipws]:
@@ -41,10 +41,6 @@ GrammarElementRelationFile[noskipws]:
   '  - TYPE: ' relation_type='File' '\n'
 ;
 
-GrammarElementRelationBibtex[noskipws]:
-  '  - TYPE: ' relation_type='BibTex' '\n'
-;
-
 GrammarElementField[noskipws]:
   GrammarElementFieldString |
   GrammarElementFieldSingleChoice |
@@ -91,7 +87,7 @@ GrammarElementFieldReference[noskipws]:
 ;
 
 ReferenceType[noskipws]:
-  ('ParentReqReference' | 'ChildReqReference' | 'FileReference' | 'BibReference')
+  ('ParentReqReference' | 'ChildReqReference' | 'FileReference')
 ;
 
 ReferenceTypeXs[noskipws]:

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/sdoc/grammar/type_system.py

@@ -36,12 +36,12 @@ RequirementType[noskipws]:
 ;
 
 ReservedKeyword[noskipws]:
-  'DOCUMENT' | 'GRAMMAR' | 'BIBLIOGRAPHY'
+  'DOCUMENT' | 'GRAMMAR'
 ;
 
 Reference[noskipws]:
   // FileReference is an early, experimental feature. Do not use yet.
-  ParentReqReference | ChildReqReference | FileReference | BibReference
+  ParentReqReference | ChildReqReference | FileReference
 ;
 
 ParentReqReference[noskipws]:
@@ -63,11 +63,6 @@ FileReference[noskipws]:
   g_file_entry = FileEntry
 ;
 
-BibFileEntry[noskipws]:
-  '- FORMAT: BibTex\n'
-  '  VALUE: ' file_path = /.*$/ '\n'
-;
-
 FileEntry[noskipws]:
   ('  FORMAT: ' g_file_format = FileEntryFormat '\n')?
    '  VALUE: ' g_file_path = /.*$/ '\n'
@@ -75,21 +70,7 @@ FileEntry[noskipws]:
 ;
 
 FileEntryFormat[noskipws]:
-  'BibTex' | 'Sourcecode' | 'Python' | /[A-Z]+[A-Z_]*/
-;
-
-BibReference[noskipws]:
-  '- TYPE: BibTex' '\n'
- ('  FORMAT: ' bib_format = BibEntryFormat '\n')?
-  '  VALUE: ' bib_value = /.*$/ '\n'
+  'Sourcecode' | 'Python' | /[A-Z]+[A-Z_]*/
 ;
 
-BibEntry[noskipws]:
- ('- FORMAT: ' bib_format = BibEntryFormat '\n')?
-  '  VALUE: ' bib_value = /.*$/ '\n'
-;
-
-BibEntryFormat[noskipws]:
-  'String' | 'BibTex' | 'Citation'
-;
 """

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/sdoc/models/constants.py

@@ -1,10 +1,7 @@
 from strictdoc.backend.sdoc.models.anchor import Anchor
 from strictdoc.backend.sdoc.models.document import SDocDocument
-from strictdoc.backend.sdoc.models.document_bibliography import (
-    DocumentBibliography,
-)
 from strictdoc.backend.sdoc.models.document_config import DocumentConfig
-from strictdoc.backend.sdoc.models.document_from_file import FragmentFromFile
+from strictdoc.backend.sdoc.models.document_from_file import DocumentFromFile
 from strictdoc.backend.sdoc.models.document_grammar import (
     DocumentGrammar,
     GrammarElement,
@@ -15,12 +12,11 @@ from strictdoc.backend.sdoc.models.document_view import (
 )
 from strictdoc.backend.sdoc.models.inline_link import InlineLink
 from strictdoc.backend.sdoc.models.node import (
-    CompositeRequirement,
+    SDocCompositeNode,
     SDocNode,
     SDocNodeField,
 )
 from strictdoc.backend.sdoc.models.reference import (
-    BibReference,
     ChildReqReference,
     FileReference,
     ParentReqReference,
@@ -28,15 +24,12 @@ from strictdoc.backend.sdoc.models.reference import (
 )
 from strictdoc.backend.sdoc.models.section import FreeText, SDocSection
 from strictdoc.backend.sdoc.models.type_system import (
-    BibEntry,
-    BibFileEntry,
     FileEntry,
     GrammarElementFieldMultipleChoice,
     GrammarElementFieldReference,
     GrammarElementFieldSingleChoice,
     GrammarElementFieldString,
     GrammarElementFieldTag,
-    GrammarElementRelationBibtex,
     GrammarElementRelationChild,
     GrammarElementRelationFile,
     GrammarElementRelationParent,
@@ -47,21 +40,18 @@ from strictdoc.backend.sdoc.models.type_system import (
 
 SECTION_MODELS = [
     SDocSection,
-    FragmentFromFile,
+    DocumentFromFile,
     SDocNode,
     SDocNodeField,
-    CompositeRequirement,
+    SDocCompositeNode,
     Reference,
     ParentReqReference,
     ChildReqReference,
     FileReference,
-    BibReference,
     FreeText,
     InlineLink,
     Anchor,
-    BibFileEntry,
     FileEntry,
-    BibEntry,
 ]
 
 GRAMMAR_MODELS = [
@@ -72,7 +62,6 @@ GRAMMAR_MODELS = [
     GrammarElementFieldMultipleChoice,
     GrammarElementFieldTag,
     GrammarElementFieldReference,
-    GrammarElementRelationBibtex,
     GrammarElementRelationParent,
     GrammarElementRelationChild,
     GrammarElementRelationFile,
@@ -82,7 +71,6 @@ DOCUMENT_MODELS = [
     DocumentConfig,
     SDocDocument,
     DocumentView,
-    DocumentBibliography,
     ViewElement,
     ViewElementField,
     ViewElementTags,

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/sdoc/models/document.py

@@ -1,8 +1,5 @@
 from typing import List, Optional
 
-from strictdoc.backend.sdoc.models.document_bibliography import (
-    DocumentBibliography,
-)
 from strictdoc.backend.sdoc.models.document_config import DocumentConfig
 from strictdoc.backend.sdoc.models.document_grammar import DocumentGrammar
 from strictdoc.backend.sdoc.models.document_view import DocumentView
@@ -12,6 +9,12 @@ from strictdoc.helpers.auto_described import auto_described
 from strictdoc.helpers.mid import MID
 
 
+@auto_described
+class SDocDocumentContext:
+    def __init__(self):
+        self.title_number_string = None
+
+
 @auto_described
 class SDocDocument:  # pylint: disable=too-many-instance-attributes
     def __init__(
@@ -21,7 +24,6 @@ class SDocDocument:  # pylint: disable=too-many-instance-attributes
         config: Optional[DocumentConfig],
         view: Optional[DocumentView],
         grammar: Optional[DocumentGrammar],
-        bibliography: Optional[DocumentBibliography],
         free_texts,
         section_contents,
     ):
@@ -38,7 +40,6 @@ class SDocDocument:  # pylint: disable=too-many-instance-attributes
             view if view is not None else DocumentView.create_default(self)
         )
         self.grammar: Optional[DocumentGrammar] = grammar
-        self.bibliography: Optional[DocumentBibliography] = bibliography
         self.free_texts: List[FreeText] = free_texts
         self.section_contents = section_contents
 
@@ -49,17 +50,45 @@ class SDocDocument:  # pylint: disable=too-many-instance-attributes
         self.ng_needs_generation = False
         self.ng_uses_old_refs_field: bool = False
         self.ng_at_least_one_relations_field: bool = False
+        self.ng_has_requirements = False
 
         self.meta: Optional[DocumentMeta] = None
 
         self.reserved_mid: MID = MID(mid) if mid is not None else MID.create()
         self.mid_permanent: bool = mid is not None
-        self.document_is_included: bool = False
         self.included_documents: List["SDocDocument"] = []
+        self.context = SDocDocumentContext()
 
         self.ng_including_document_reference: Optional = None
+        self.ng_including_document_from_file: Optional = None
+
+    @property
+    def uid(self) -> Optional[str]:
+        return self.config.uid
+
+    @property
+    def is_section(self):
+        return True
+
+    @property
+    def is_root_included_document(self):
+        return self.document_is_included()
+
+    @property
+    def is_requirement(self):
+        return False
+
+    @property
+    def is_composite_requirement(self):
+        return False
 
-    def document_is_included(self):
+    def get_node_type_string(self) -> Optional[str]:
+        return None
+
+    def get_type_string(self) -> str:
+        return "document" if not self.document_is_included() else "section"
+
+    def document_is_included(self) -> bool:
         return self.ng_including_document_reference.get_document() is not None
 
     def get_included_document(self):
@@ -88,13 +117,13 @@ class SDocDocument:  # pylint: disable=too-many-instance-attributes
 
     def has_any_requirements(self) -> bool:
         from strictdoc.backend.sdoc.models.document_from_file import (
-            FragmentFromFile,
+            DocumentFromFile,
         )
 
         task_list = list(self.section_contents)
         while len(task_list) > 0:
             section_or_requirement = task_list.pop(0)
-            if isinstance(section_or_requirement, FragmentFromFile):
+            if isinstance(section_or_requirement, DocumentFromFile):
                 if section_or_requirement.has_any_requirements():
                     return True
                 continue
@@ -107,14 +136,14 @@ class SDocDocument:  # pylint: disable=too-many-instance-attributes
     def get_title(self):
         return self.title
 
-    @staticmethod
-    def get_type_string() -> str:
-        return "document"
-
     @property
     def ng_resolved_custom_level(self):
         return None
 
+    @property
+    def requirement_prefix(self) -> str:
+        return self.get_requirement_prefix()
+
     def get_requirement_prefix(self) -> str:
         return self.config.get_requirement_prefix()
 

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/sdoc/models/document_from_file.py

@@ -1,12 +1,11 @@
 from typing import List, Optional
 
 from strictdoc.backend.sdoc.document_reference import DocumentReference
-from strictdoc.backend.sdoc.models.section import SDocSection
 from strictdoc.helpers.auto_described import auto_described
 
 
 @auto_described
-class FragmentFromFile:
+class DocumentFromFile:
     def __init__(
         self,
         parent,
@@ -15,13 +14,13 @@ class FragmentFromFile:
         self.parent = parent
         self.file = file
 
-        self.ng_level = None
         self.ng_has_requirements = False
         self.ng_document_reference: Optional[DocumentReference] = None
         self.ng_included_document_reference: Optional[DocumentReference] = None
+        self.ng_resolved_custom_level = None
+        self.ng_whitelisted = True
         self.resolved_full_path_to_document_file = None
         self.resolved_document: Optional = None
-        self.top_section: Optional = None
 
     @property
     def document(self):
@@ -31,7 +30,7 @@ class FragmentFromFile:
         task_list = list(self.section_contents)
         while len(task_list) > 0:
             section_or_requirement = task_list.pop(0)
-            if isinstance(section_or_requirement, FragmentFromFile):
+            if isinstance(section_or_requirement, DocumentFromFile):
                 if section_or_requirement.has_any_requirements():
                     return True
             if section_or_requirement.is_requirement:
@@ -42,26 +41,23 @@ class FragmentFromFile:
 
     @property
     def section_contents(self) -> List:
-        return [self.top_section]
+        return [self.resolved_document]
 
-    def configure_with_resolved_document(self, document):
-        assert document is not None
-        self.resolved_document = document
-
-        top_section = SDocSection(
-            self,
-            mid=None,
-            uid=None,
-            custom_level=None,
-            title=self.resolved_document.title,
-            requirement_prefix=self.resolved_document.get_requirement_prefix(),
-            free_texts=self.resolved_document.free_texts,
-            section_contents=self.resolved_document.section_contents,
-            root_section=True,
-        )
-        top_section.ng_level = self.ng_level
+    def configure_with_resolved_document(self, resolved_document):
         assert self.ng_included_document_reference is None
         assert self.ng_document_reference is not None
-        top_section.ng_document_reference = self.ng_document_reference
-        top_section.ng_including_document_reference = self.ng_document_reference
-        self.top_section = top_section
+
+        assert resolved_document is not None
+        self.resolved_document = resolved_document
+
+        including_document = self.parent
+        assert (
+            including_document.__class__.__name__ == "SDocDocument"
+        ), including_document
+
+        resolved_document.ng_including_document_from_file = self
+
+        resolved_document.ng_including_document_reference.set_document(
+            including_document
+        )
+        including_document.included_documents.append(resolved_document)

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/sdoc/models/document_grammar.py

@@ -7,7 +7,6 @@ from strictdoc.backend.sdoc.models.type_system import (
     GrammarElementField,
     GrammarElementFieldReference,
     GrammarElementFieldString,
-    GrammarElementRelationBibtex,
     GrammarElementRelationChild,
     GrammarElementRelationFile,
     GrammarElementRelationParent,
@@ -26,7 +25,6 @@ def create_default_relations(
         GrammarElementRelationParent,
         GrammarElementRelationChild,
         GrammarElementRelationFile,
-        GrammarElementRelationBibtex,
     ]
 ]:
     return [
@@ -59,7 +57,6 @@ class GrammarElement:
                 GrammarElementRelationParent,
                 GrammarElementRelationChild,
                 GrammarElementRelationFile,
-                GrammarElementRelationBibtex,
             ]
         ] = (
             relations

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/sdoc/models/node.py

@@ -223,6 +223,10 @@ class SDocNode(SDocObject):
     def get_title(self):
         return self.reserved_title
 
+    @property
+    def is_root_included_document(self):
+        return False
+
     @property
     def is_root(self) -> bool:
         return self.document.config.root is True
@@ -504,7 +508,7 @@ class SDocNode(SDocObject):
 
     def get_requirement_prefix(self) -> str:
         parent: Union[SDocSection, SDocDocument] = assert_cast(
-            self.parent, (SDocSection, SDocDocument, CompositeRequirement)
+            self.parent, (SDocSection, SDocDocument, SDocCompositeNode)
         )
         return parent.get_requirement_prefix()
 
@@ -655,7 +659,7 @@ class SDocNode(SDocObject):
 
 
 @auto_described
-class CompositeRequirement(SDocNode):
+class SDocCompositeNode(SDocNode):
     def __init__(self, parent, **fields):
         super().__init__(parent, **fields)
         self.ng_document_reference: Optional[DocumentReference] = None

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/sdoc/models/object_factory.py

@@ -15,7 +15,6 @@ class SDocObjectFactory:
             config=None,
             view=None,
             grammar=None,
-            bibliography=None,
             free_texts=[],
             section_contents=[],
         )
@@ -196,5 +195,4 @@ class SDocObjectFactory:
             comments=None,
         )
 
-        requirement.ng_level = level
         return requirement

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/sdoc/models/reference.py

@@ -1,7 +1,6 @@
 from typing import Optional
 
 from strictdoc.backend.sdoc.models.type_system import (
-    BibEntry,
     FileEntry,
     ReferenceType,
 )
@@ -61,12 +60,3 @@ class ChildReqReference(Reference):
             role if role is not None and len(role) > 0 else None
         )
         self.mid = MID.create()
-
-
-@auto_described
-class BibReference(Reference):
-    def __init__(self, parent, bib_format: Optional[str], bib_value: str):
-        super().__init__(ReferenceType.BIB_REF, parent)
-        self.bib_entry = BibEntry(self, bib_format, bib_value)
-        # TODO Add bib_entry into Parent-Root Document.Bibliography
-        self.mid = MID.create()

{strictdoc-0.0.52 → strictdoc-0.0.54a1}/strictdoc/backend/sdoc/models/section.py

@@ -70,6 +70,10 @@ class SDocSection(SDocObject):  # pylint: disable=too-many-instance-attributes
     def get_node_type_string(self) -> Optional[str]:
         return None
 
+    @property
+    def is_root_included_document(self):
+        return False
+
     def get_title(self):
         return self.title