Checkpoint

Author: Steve Ramage

buildSrc/src/main/groovy/GenerateDataFromManPages.groovy

@@ -315,9 +315,9 @@ class GenerateDataFromManPages extends DefaultTask {
 
     String filename = file.getName()
 
-    def builder = dbf.newDocumentBuilder()
+    Document document = buildDocumentProcessingIncludes(file)
 
-    def records = builder.parse(file).documentElement
+    def records = document.documentElement
 
     /*
       We technically should be looking for variablelist element with class 'unit-directives' however some sections in
@@ -434,8 +434,18 @@ class GenerateDataFromManPages extends DefaultTask {
    * @return
    */
   private generateDocumentationHtmlFromManPages(String fileType, File sourceFile) {
-    DocumentBuilder builder = dbf.newDocumentBuilder()
 
+
+    Document document = buildDocumentProcessingIncludes(sourceFile)
+    Transformer transformer = getXsltTransformer()
+
+    String xsltOutput = transformDocument(document, transformer)
+
+    segmentParametersIntoFiles(fileType, sourceFile.getName(), xsltOutput)
+  }
+
+  private Document buildDocumentProcessingIncludes(File sourceFile) {
+    DocumentBuilder builder = dbf.newDocumentBuilder()
     String xmlContent = sourceFile.text
 
 
@@ -455,11 +465,7 @@ class GenerateDataFromManPages extends DefaultTask {
     outputFile.text = xmlContent  // Save to file
 
     Document document = builder.parse(outputFile)
-    Transformer transformer = getXsltTransformer()
-
-    String xsltOutput = transformDocument(document, transformer)
-
-    segmentParametersIntoFiles(fileType, sourceFile.getName(), xsltOutput)
+    document
   }
 
   private String processXIncludesWithRegex(String xmlContent, File baseDir) {
@@ -484,57 +490,65 @@ class GenerateDataFromManPages extends DefaultTask {
     }
   }
 
-  private static final Map<String, String> cache = new ConcurrentHashMap<>()
+  // 🔥 Static cache for storing extracted XML elements
+  private static final Map<String, Map<String, String>> fileCache = new ConcurrentHashMap<>()
 
-  private static String extractElementById(File xmlFile, String elementId) {
-    String cacheKey = xmlFile.getAbsolutePath() + "::" + elementId
+  static String extractElementById(File xmlFile, String elementId) {
+    // ✅ Check if the entire file has already been cached
+    String filePath = xmlFile.getAbsolutePath()
+    if (!fileCache.containsKey(filePath)) {
+      // 🚀 Populate the cache for this file
+      cacheAllElements(xmlFile)
+    }
 
-    // ✅ Check cache before processing
-    if (cache.containsKey(cacheKey)) {
-      return cache.get(cacheKey)
+    // ✅ Retrieve element from cache
+    Map<String, String> cachedElements = fileCache.get(filePath)
+    if (cachedElements.containsKey(elementId)) {
+      return cachedElements.get(elementId)
+    } else {
+      println "⚠️ WARNING: Element with id='$elementId' not found in ${xmlFile.name}"
+      return null
     }
+  }
 
+  private static void cacheAllElements(File xmlFile) {
     try {
-      println("Processing $cacheKey")
-
       DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance()
       factory.setNamespaceAware(true) // Needed for XML ID lookup
       DocumentBuilder builder = factory.newDocumentBuilder()
 
       Document document = builder.parse(new InputSource(xmlFile.newReader()))
       document.getDocumentElement().normalize()
 
-      // Find element with matching id
-      Node targetNode = findElementById(document, elementId)
-      if (targetNode == null) {
-        println "⚠️ WARNING: Element with id='$elementId' not found in ${xmlFile.name}"
-        return null
+      // ✅ Create a new cache for this file
+      Map<String, String> elementCache = new ConcurrentHashMap<>()
+
+      // 🚀 Find all elements with an `id` attribute and store them in cache
+      NodeList elements = document.getElementsByTagName("*")
+      for (int i = 0; i < elements.length; i++) {
+        Element element = elements.item(i)
+        if (element.hasAttribute("id")) {
+          String elementId = element.getAttribute("id")
+          String extractedXml = nodeToString(element)
+
+          String wrappedXml = "<!--xi:include='${xmlFile.name}' xpointer='${elementId}'-->" +
+                              extractedXml +
+                              "<!-- /xi:include='${xmlFile.name}' xpointer='${elementId}' -->"
+
+          elementCache.put(elementId, wrappedXml)
+        }
       }
 
-      // ✅ Convert the found node back to an XML string
-      String extractedXml = nodeToString(targetNode)
-      String value = "<!--xi:include='$xmlFile.name' xpointer='$elementId'-->" + extractedXml + "<!-- /xi:include='$xmlFile.name' xpointer='$elementId' -->"
-      cache.put(cacheKey, value)
+      // ✅ Store parsed elements in the file cache
+      fileCache.put(xmlFile.getAbsolutePath(), elementCache)
 
-      return value
+      println "✅ Cached ${elementCache.size()} elements from ${xmlFile.name}"
 
     } catch (Exception e) {
-      println "❌ ERROR: Failed to extract element by id='$elementId' from ${xmlFile.name}: ${e.message}"
-      cache.put(cacheKey, null)
+      println "❌ ERROR: Failed to parse ${xmlFile.name}: ${e.message}"
     }
   }
 
-  private static Node findElementById(Document document, String elementId) {
-    def elements = document.getElementsByTagName("*") // Get all elements
-    for (int i = 0; i < elements.length; i++) {
-      Element element = elements.item(i)
-      if (element.hasAttribute("id") && element.getAttribute("id") == elementId) {
-        return element
-      }
-    }
-    return null
-  }
-
   private static String nodeToString(Node node) {
     try {
       TransformerFactory transformerFactory = TransformerFactory.newInstance()
@@ -548,6 +562,7 @@ class GenerateDataFromManPages extends DefaultTask {
       return ""
     }
   }
+
   /**
    * Transforms the supplied document with the supplied transformer
    * @param document - XML Document to transform

src/test/kotlin/net/sjrx/intellij/plugins/systemdunitfiles/semanticdata/SemanticDataDocumentationCompletionTest.kt

@@ -4,7 +4,7 @@ import net.sjrx.intellij.plugins.systemdunitfiles.AbstractUnitFileTest
 import java.util.*
 
 class SemanticDataDocumentationCompletionTest : AbstractUnitFileTest() {
-  fun testAllOptions() {
+  fun testAllOptionsHaveDocumentation() {
     val sdr = SemanticDataRepository.instance
     val doc: MutableSet<String> = TreeSet()