🐛 fix: incorrect relationship label when protocol is not scanned first (fix #49)

fix #49

Author: MarcoEidinger

Sources/SwiftPlantUMLFramework/Internal/SyntaxStructure+Extensions.swift

@@ -0,0 +1,30 @@
+import Foundation
+
+extension Array where Element == SyntaxStructure {
+    /// order: protocols first, then non-extensions (i.e protocols, structs, classes, enums). Extensions last/
+    /// This ensures that linking is correct
+    /// see https://github.com/MarcoEidinger/SwiftPlantUML/issues/47
+    /// as well as relationship label
+    /// see https://github.com/MarcoEidinger/SwiftPlantUML/issues/49
+    func orderedByProtocolsFirstExtensionsLast() -> [SyntaxStructure] {
+        return sorted(by: { $0.kind ?? .struct < $1.kind ?? .struct })
+    }
+}
+
+extension ElementKind: Comparable {
+    private var sortOrder: Int {
+        switch self {
+        case .protocol:
+            return 0
+        case .extension:
+            return 2
+        default:
+            return 1
+        }
+    }
+
+    static func < (lhs: ElementKind, rhs: ElementKind) -> Bool {
+        lhs.sortOrder < rhs.sortOrder
+    }
+}
+

Sources/SwiftPlantUMLFramework/PlantUMLScript.swift

@@ -45,7 +45,7 @@ public struct PlantUMLScript {
 
         var replacingText = "\n"
 
-        let orderedItems = items.orderedByExtensionsLast()
+        let orderedItems = items.orderedByProtocolsFirstExtensionsLast()
         for (index, element) in orderedItems.enumerated() {
             if let text = processStructureItem(item: element, index: index) {
                 replacingText.appendAsNewLine(text)
@@ -96,22 +96,3 @@ 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

@@ -128,12 +128,14 @@ final class SyntaxStructureTests: XCTestCase {
         let ext1 = SyntaxStructure(kind: .extension, name: "Ext1")
         let p1 = SyntaxStructure(kind: .protocol, name: "Protocol1")
         let c1 = SyntaxStructure(kind: .class, name: "Class1")
+        let s1 = SyntaxStructure(kind: .struct, name: "Struct1")
         let ext2 = SyntaxStructure(kind: .extension, name: "Ext2")
         let c2 = SyntaxStructure(kind: .class, name: "Class2")
+        let s2 = SyntaxStructure(kind: .struct, name: "Struct2")
 
-        let unordered = [ext1, p1, c1, ext2, c2]
-        let ordered = unordered.orderedByExtensionsLast()
-        XCTAssertEqual(ordered, [p1, c1, c2, ext1, ext2])
+        let unordered = [ext1, c1, p1, s1, ext2, c2, s2]
+        let ordered = unordered.orderedByProtocolsFirstExtensionsLast()
+        XCTAssertEqual(ordered, [p1, c1, s1, c2, s2, ext1, ext2])
     }
 
     func getTestFile() throws -> URL {