🐛 fix: incorrect inheritance/extensions when parent class is not scanned first (fix #47)

fix #47

Author: MarcoEidinger

Sources/SwiftPlantUMLFramework/Internal/PlantUMLContext.swift

@@ -3,6 +3,9 @@ import Foundation
 class PlantUMLContext {
     private(set) var configuration: Configuration
 
+    // lookup the unique name (generated by SwiftPlantUML) for a given element
+    var uniqueNameForElement: [SyntaxStructure: String] = [:]
+
     var uniqElementNames: [String] = []
     var uniqElementAndTypes: [String: String] = [:]
     // var style: [String: String] = [:]
@@ -102,6 +105,7 @@ class PlantUMLContext {
                 uniqElementAndTypes[linkTypeKey] = linkTypeGeneric
             }
         }
+        uniqueNameForElement[item] = newName
         return newName
     }
 }

Sources/SwiftPlantUMLFramework/Internal/SyntaxStructure.swift

@@ -229,3 +229,5 @@ extension ElementKind: UnknownCaseRepresentable {
     /// `unknownCase` (abnormal situation)
     static let unknownCase: ElementKind = .other
 }
+
+extension SyntaxStructure: Hashable {}

Sources/SwiftPlantUMLFramework/PlantUMLScript.swift

@@ -45,7 +45,8 @@ public struct PlantUMLScript {
 
         var replacingText = "\n"
 
-        for (index, element) in items.enumerated() {
+        let orderedItems = items.orderedByExtensionsLast()
+        for (index, element) in orderedItems.enumerated() {
             if let text = processStructureItem(item: element, index: index) {
                 replacingText.appendAsNewLine(text)
             }
@@ -95,3 +96,22 @@ public struct PlantUMLScript {
         return item.plantuml(context: context) ?? nil
     }
 }
+
+extension Array where Element == SyntaxStructure {
+    /// order: non-extensions (i.e protocols, structs, classes, enums) first. Extensions last
+    /// this ensures that linking is correct
+    /// see https://github.com/MarcoEidinger/SwiftPlantUML/issues/47
+    func orderedByExtensionsLast() -> [SyntaxStructure] {
+        var ordered: [SyntaxStructure] = []
+        var nonExtInsertPoint = 0
+        forEach {
+            if $0.kind == .extension {
+                ordered.append($0)
+            } else {
+                ordered.insert($0, at: nonExtInsertPoint)
+                nonExtInsertPoint += 1
+            }
+        }
+        return ordered
+    }
+}

Tests/SwiftPlantUMLFrameworkTests/SyntaxStructureTests.swift

@@ -124,6 +124,18 @@ final class SyntaxStructureTests: XCTestCase {
         XCTAssertTrue(plantUMLElement!.contains("~hasBasket : Bool"))
     }
 
+    func testOrderedByExtensionsLast() {
+        let ext1 = SyntaxStructure(kind: .extension, name: "Ext1")
+        let p1 = SyntaxStructure(kind: .protocol, name: "Protocol1")
+        let c1 = SyntaxStructure(kind: .class, name: "Class1")
+        let ext2 = SyntaxStructure(kind: .extension, name: "Ext2")
+        let c2 = SyntaxStructure(kind: .class, name: "Class2")
+
+        let unordered = [ext1, p1, c1, ext2, c2]
+        let ordered = unordered.orderedByExtensionsLast()
+        XCTAssertEqual(ordered, [p1, c1, c2, ext1, ext2])
+    }
+
     func getTestFile() throws -> URL {
         // https://stackoverflow.com/questions/47177036/use-resources-in-unit-tests-with-swift-package-manager
         let path = Bundle.module.path(forResource: "demo", ofType: "txt", inDirectory: "TestData") ?? "nonesense"

Tests/SwiftPlantUMLFrameworkTests/TestData/basics.txt

@@ -81,12 +81,6 @@ extension aPublicStruct: aProtocol {
     }
 }
 
-struct anInternalStruct {
-    var anInternalInstanceVar: Double
-    private var aPrivateInstanceVar: Int
-    private var aPublicInstanceVarTypeInference = "aString"
-}
-
 extension anInternalStruct {
     var anExtensionComputedInstanceVar: String {
         "aString"
@@ -99,6 +93,12 @@ fileprivate extension anInternalStruct {
     }
 }
 
+struct anInternalStruct {
+    var anInternalInstanceVar: Double
+    private var aPrivateInstanceVar: Int
+    private var aPublicInstanceVarTypeInference = "aString"
+}
+
 /// ignore comments :)
 public enum AnEnum {
 

Tests/SwiftPlantUMLFrameworkTests/TestData/basicsAsPlantUML.txt

@@ -45,6 +45,19 @@ class "aPublicStruct" as aPublicStruct << (S, SkyBlue) struct >> {
   +aPublicInstanceMethod(param1:param2:)
   +{static} aStaticPublicInstanceMethod(param1:param2:)
 }
+class "anInternalStruct" as anInternalStruct << (S, SkyBlue) struct >> {
+  ~anInternalInstanceVar : Double
+  -aPrivateInstanceVar : Int
+  -aPublicInstanceVarTypeInference
+}
+class "AnEnum" as AnEnum << (E, LightSteelBlue) enum >> {
+  +simpleCase
+  +caseWithRaw(_:)
+  +caseWithRaw(_:_:)
+  ~anInternalInstanceMethod()
+  ~{static} aStaticInternalMethod()
+  ~anInternalComputedVar : AnEnum
+}
 class "aPublicStruct" as aPublicStruct0 << (X, Orchid) extension >> {
   +anExtensionComputedInstanceVar : String
   +anExtensionInstanceMethod(param1:param2:)
@@ -53,27 +66,14 @@ class "aPublicStruct" as aPublicStruct1 << (X, Orchid) extension >> {
   ~aProtocolInstanceVar : String
   ~aProtocolInstanceMethod(param1:param2:)
 }
-class "anInternalStruct" as anInternalStruct << (S, SkyBlue) struct >> {
-  ~anInternalInstanceVar : Double
-  -aPrivateInstanceVar : Int
-  -aPublicInstanceVarTypeInference
-}
 class "anInternalStruct" as anInternalStruct2 << (X, Orchid) extension >> {
   ~anExtensionComputedInstanceVar : String
 }
 class "anInternalStruct" as anInternalStruct3 << (X, Orchid) extension >> {
   -anFileprivateExtensionComputedInstanceVar : String
 }
-class "AnEnum" as AnEnum << (E, LightSteelBlue) enum >> {
-  +simpleCase
-  +caseWithRaw(_:)
-  +caseWithRaw(_:_:)
-  ~anInternalInstanceMethod()
-  ~{static} aStaticInternalMethod()
-  ~anInternalComputedVar : AnEnum
-}
 aClass <|-- anInternalSubClass : inherits
-aPrivateGenericClass <|-- aPrivateGenericSubClass  : inherits
+aPrivateGenericClass <|-- aPrivateGenericSubClass : inherits
 aProtocol <|.. aPublicStruct : confirms to
 aPublicStruct <.. aPublicStruct0 : ext
 aPublicStruct <.. aPublicStruct1 : ext