Changeset a5f3cc1 in rtems-central for rtemsqual/glossary.py

Timestamp:

May 6, 2020, 8:31:57 AM (10 months ago)

Author:

Sebastian Huber <sebastian.huber@…>

Branches:

master

Children:

833470c

Parents:

fa46b668

git-author:

Sebastian Huber <sebastian.huber@…> (05/06/20 08:31:57)

git-committer:

Sebastian Huber <sebastian.huber@…> (05/28/20 08:37:29)

Message:

spec: Use item mapper for glossary terms

File:

• rtemsqual/glossary.py (modified) (4 diffs)

rtemsqual/glossary.py

@@ -27 +27 @@
 import glob
 import re
-from typing import Dict
+from typing import Any, Dict, Optional
 
-from rtemsqual.content import MacroToSphinx, SphinxContent
-from rtemsqual.items import Item, ItemCache
+from rtemsqual.content import SphinxContent, SphinxMapper
+from rtemsqual.items import Item, ItemCache, ItemMapper
 
 ItemMap = Dict[str, Item]
@@ -55 +55 @@
     with content.indent():
         content.append(":sorted:")
-    macro_to_sphinx = MacroToSphinx()
-    macro_to_sphinx.set_terms(terms)
     for item in sorted(terms.values(),
                        key=lambda x: x["glossary-term"].lower()):
-        text = macro_to_sphinx.substitute(item["text"].strip())
         content.register_license_and_copyrights_of_item(item)
         with content.indent():
+            text = SphinxMapper(item).substitute(item["text"])
             content.add_definition_item(item["glossary-term"], text)
     content.add_licence_and_copyrights()
@@ -83 +81 @@
 
 
-def _resolve_glossary_term(document_terms: ItemMap, project_terms: ItemMap,
-                           term: Item) -> None:
-    for match in re.findall(r"@@|@([a-z]+){([^}]+)}", term["text"]):
-        if match[1] and match[1] not in document_terms:
-            new_term = project_terms[match[1]]
-            document_terms[match[1]] = new_term
-            _resolve_glossary_term(document_terms, project_terms, new_term)
+class _GlossaryMapper(ItemMapper):
+    def __init__(self, item: Item, document_terms: ItemMap):
+        super().__init__(item)
+        self._document_terms = document_terms
+
+    def get_value(self, item: Item, _path: str, _value: Any, key: str,
+                  _index: Optional[int]) -> Any:
+        """ Recursively adds glossary terms to the document terms. """
+        if key == "glossary-term":
+            if item.uid not in self._document_terms:
+                self._document_terms[item.uid] = item
+                _GlossaryMapper(item,
+                                self._document_terms).substitute(item["text"])
+        # The value of this substitute is unused.
+        return ""
 
 
-def _resolve_glossary_terms(document_terms: ItemMap,
-                            project_terms: ItemMap) -> None:
+def _resolve_glossary_terms(document_terms: ItemMap) -> None:
     for term in list(document_terms.values()):
-        _resolve_glossary_term(document_terms, project_terms, term)
+        _GlossaryMapper(term, document_terms).substitute(term["text"])
 
 
@@ -107 +112 @@
     for path in config["rest-source-paths"]:
         _find_glossary_terms(path, document_terms, project_terms)
-    _resolve_glossary_terms(document_terms, project_terms)
+    _resolve_glossary_terms(document_terms)
     content = _generate_glossary_content(document_terms)
     content.write(config["target"])