sorting children + inheritance for description

goergisn · goergisn · commit 7e3d8eef0f11 · 2025-01-10T14:35:17.000+01:00
diff --git a/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Actor.swift b/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Actor.swift
@@ -83,7 +83,7 @@ private extension SwiftInterfaceActor {
         description.append("actor", with: modifiers.isEmpty ? "" : " ")
         description.append(name, with: " ")
         description.append(genericParameterDescription, with: "")
-        description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }
+        description.append(inheritance?.sorted().joined(separator: ", "), with: "") { ": \($0)" }
         description.append(genericWhereClauseDescription, with: " ")
         return description
     }
diff --git a/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+AssociatedType.swift b/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+AssociatedType.swift
@@ -79,7 +79,7 @@ private extension SwiftInterfaceAssociatedType {
         if modifiers.isEmpty && !attributes.isEmpty { description.append("\n") }
         description.append("associatedtype", with: modifiers.isEmpty ? "" : " ")
         description.append(name, with: " ")
-        description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }
+        description.append(inheritance?.sorted().joined(separator: ", "), with: "") { ": \($0)" }
         description.append(initializerValue, with: " ") { "= \($0)" }
         description.append(genericWhereClauseDescription, with: " ")
         return description
diff --git a/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Class.swift b/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Class.swift
@@ -83,7 +83,7 @@ private extension SwiftInterfaceClass {
         description.append("class", with: modifiers.isEmpty ? "" : " ")
         description.append(name, with: " ")
         description.append(genericParameterDescription, with: "")
-        description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }
+        description.append(inheritance?.sorted().joined(separator: ", "), with: "") { ": \($0)" }
         description.append(genericWhereClauseDescription, with: " ")
         return description
     }
diff --git a/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Enum.swift b/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Enum.swift
@@ -81,7 +81,7 @@ private extension SwiftInterfaceEnum {
         description.append("enum", with: modifiers.isEmpty ? "" : " ")
         description.append(name, with: " ")
         description.append(genericParameterDescription, with: "")
-        description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }
+        description.append(inheritance?.sorted().joined(separator: ", "), with: "") { ": \($0)" }
         description.append(genericWhereClauseDescription, with: " ")
         return description
     }
diff --git a/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Extension.swift b/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Extension.swift
@@ -77,7 +77,7 @@ private extension SwiftInterfaceExtension {
         if modifiers.isEmpty && !attributes.isEmpty { description.append("\n") }
         description.append("extension", with: modifiers.isEmpty ? "" : " ")
         description.append(extendedType, with: " ")
-        description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }
+        description.append(inheritance?.sorted().joined(separator: ", "), with: "") { ": \($0)" }
         description.append(genericWhereClauseDescription, with: " ")
         return description
     }
diff --git a/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Protocol.swift b/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Protocol.swift
@@ -81,7 +81,7 @@ private extension SwiftInterfaceProtocol {
         description.append("protocol", with: modifiers.isEmpty ? "" : " ")
         description.append(name, with: " ")
         description.append(primaryAssociatedTypes.map { "<\($0.joined(separator: ", "))>" }, with: "")
-        description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }
+        description.append(inheritance?.sorted().joined(separator: ", "), with: "") { ": \($0)" }
         description.append(genericWhereClauseDescription, with: " ")
         return description
     }
diff --git a/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Struct.swift b/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement+Declaration/SwiftInterfaceElement+Struct.swift
@@ -81,7 +81,7 @@ private extension SwiftInterfaceStruct {
         description.append("struct", with: modifiers.isEmpty ? "" : " ")
         description.append(name, with: " ")
         description.append(genericParameterDescription, with: "")
-        description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }
+        description.append(inheritance?.sorted().joined(separator: ", "), with: "") { ": \($0)" }
         description.append(genericWhereClauseDescription, with: " ")
         return description
     }
diff --git a/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement/SwiftInterfaceElement.swift b/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceElement/SwiftInterfaceElement.swift
@@ -123,7 +123,7 @@ extension SwiftInterfaceElement {
         var recursiveDescription = "\(indentedDescription(indentation: indentation))"
         if !self.children.isEmpty {
             recursiveDescription.append(" {")
-            for child in self.children {
+            for child in self.children.sorted(by: { $0.description < $1.description }) {
                 recursiveDescription.append("\n\(child.recursiveDescription(indentation: indentation + 1))")
             }
             recursiveDescription.append("\n\(String(repeating: spacer, count: indentation))}")
diff --git a/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceParser+Root.swift b/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceParser/SwiftInterfaceParser+Root.swift
@@ -34,9 +34,8 @@ extension SwiftInterfaceParser {
 
         init(moduleName: String, elements: [any SwiftInterfaceElement]) {
             self.moduleName = moduleName
-            self.children = elements
 
-            self.children = Self.mergeExtensions(for: self.children, moduleName: moduleName)
+            self.children = Self.mergeExtensions(for: elements, moduleName: moduleName)
             self.children.forEach { $0.setupParentRelationships(parent: self) }
         }
 
diff --git a/Tests/IntegrationTests/Resources/expected-reference-changes-swift-interface-private.md b/Tests/IntegrationTests/Resources/expected-reference-changes-swift-interface-private.md
@@ -6,7 +6,7 @@ _Comparing `new_private` to `old_private`_
 ## `ReferencePackage`
 #### ❇️ Added
 ```javascript
-public enum RawValueEnum: Swift.String, Swift.Equatable, Swift.Hashable, Swift.RawRepresentable {
+public enum RawValueEnum: Swift.Equatable, Swift.Hashable, Swift.RawRepresentable, Swift.String {
   case one
   case two
   public init?(rawValue: Swift.String)
@@ -16,14 +16,14 @@ public enum RawValueEnum: Swift.String, Swift.Equatable, Swift.Hashable, Swift.R
 ```
 ```javascript
 public protocol ParentProtocol {
-  associatedtype ParentType: Swift.Equatable where Self.ParentType == Self.Iterator.Element
   associatedtype Iterator: Swift.Collection
+  associatedtype ParentType: Swift.Equatable where Self.ParentType == Self.Iterator.Element
 }
 ```
 ```javascript
 public protocol ParentProtocol<ParentType> {
-  associatedtype ParentType: Swift.Equatable where Self.ParentType == Self.Iterator.Element
   associatedtype Iterator: Swift.Collection
+  associatedtype ParentType: Swift.Equatable where Self.ParentType == Self.Iterator.Element
 }
 ```
 ```javascript
@@ -193,8 +193,8 @@ extension ReferencePackage.CustomEnum where T == Swift.String {
 ```
 ```javascript
 public struct NestedStructInExtension {
-  public let string: Swift.String { get }
   public init(string: Swift.String = "Hello")
+  public let string: Swift.String { get }
 }
 ```
 #### 🔀 Modified
diff --git a/Tests/IntegrationTests/Resources/expected-reference-changes-swift-interface-public.md b/Tests/IntegrationTests/Resources/expected-reference-changes-swift-interface-public.md
@@ -6,7 +6,7 @@ _Comparing `new_public` to `old_public`_
 ## `ReferencePackage`
 #### ❇️ Added
 ```javascript
-public enum RawValueEnum: Swift.String, Swift.Equatable, Swift.Hashable, Swift.RawRepresentable {
+public enum RawValueEnum: Swift.Equatable, Swift.Hashable, Swift.RawRepresentable, Swift.String {
   case one
   case two
   public init?(rawValue: Swift.String)
@@ -16,14 +16,14 @@ public enum RawValueEnum: Swift.String, Swift.Equatable, Swift.Hashable, Swift.R
 ```
 ```javascript
 public protocol ParentProtocol {
-  associatedtype ParentType: Swift.Equatable where Self.ParentType == Self.Iterator.Element
   associatedtype Iterator: Swift.Collection
+  associatedtype ParentType: Swift.Equatable where Self.ParentType == Self.Iterator.Element
 }
 ```
 ```javascript
 public protocol ParentProtocol<ParentType> {
-  associatedtype ParentType: Swift.Equatable where Self.ParentType == Self.Iterator.Element
   associatedtype Iterator: Swift.Collection
+  associatedtype ParentType: Swift.Equatable where Self.ParentType == Self.Iterator.Element
 }
 ```
 ```javascript
@@ -178,8 +178,8 @@ extension ReferencePackage.CustomEnum where T == Swift.String {
 ```
 ```javascript
 public struct NestedStructInExtension {
-  public let string: Swift.String { get }
   public init(string: Swift.String = "Hello")
+  public let string: Swift.String { get }
 }
 ```
 #### 🔀 Modified

Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ private extension SwiftInterfaceActor {`
`83`	`83`	`description.append("actor", with: modifiers.isEmpty ? "" : " ")`
`84`	`84`	`description.append(name, with: " ")`
`85`	`85`	`description.append(genericParameterDescription, with: "")`
`86`		`- description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }`
	`86`	`+ description.append(inheritance?.sorted().joined(separator: ", "), with: "") { ": \($0)" }`
`87`	`87`	`description.append(genericWhereClauseDescription, with: " ")`
`88`	`88`	`return description`
`89`	`89`	`}`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ private extension SwiftInterfaceEnum {`
`81`	`81`	`description.append("enum", with: modifiers.isEmpty ? "" : " ")`
`82`	`82`	`description.append(name, with: " ")`
`83`	`83`	`description.append(genericParameterDescription, with: "")`
`84`		`- description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }`
	`84`	`+ description.append(inheritance?.sorted().joined(separator: ", "), with: "") { ": \($0)" }`
`85`	`85`	`description.append(genericWhereClauseDescription, with: " ")`
`86`	`86`	`return description`
`87`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ private extension SwiftInterfaceExtension {`
`77`	`77`	`if modifiers.isEmpty && !attributes.isEmpty { description.append("\n") }`
`78`	`78`	`description.append("extension", with: modifiers.isEmpty ? "" : " ")`
`79`	`79`	`description.append(extendedType, with: " ")`
`80`		`- description.append(inheritance?.joined(separator: ", "), with: "") { ": \($0)" }`
	`80`	`+ description.append(inheritance?.sorted().joined(separator: ", "), with: "") { ": \($0)" }`
`81`	`81`	`description.append(genericWhereClauseDescription, with: " ")`
`82`	`82`	`return description`
`83`	`83`	`}`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ extension SwiftInterfaceElement {`
`123`	`123`	`var recursiveDescription = "\(indentedDescription(indentation: indentation))"`
`124`	`124`	`if !self.children.isEmpty {`
`125`	`125`	`recursiveDescription.append(" {")`
`126`		`- for child in self.children {`
	`126`	`+ for child in self.children.sorted(by: { $0.description < $1.description }) {`
`127`	`127`	`recursiveDescription.append("\n\(child.recursiveDescription(indentation: indentation + 1))")`
`128`	`128`	`}`
`129`	`129`	`recursiveDescription.append("\n\(String(repeating: spacer, count: indentation))}")`
Original file line number	Diff line number	Diff line change
`@@ -34,9 +34,8 @@ extension SwiftInterfaceParser {`
`34`	`34`
`35`	`35`	`init(moduleName: String, elements: [any SwiftInterfaceElement]) {`
`36`	`36`	`self.moduleName = moduleName`
`37`		`- self.children = elements`
`38`	`37`
`39`		`- self.children = Self.mergeExtensions(for: self.children, moduleName: moduleName)`
	`38`	`+ self.children = Self.mergeExtensions(for: elements, moduleName: moduleName)`
`40`	`39`	`self.children.forEach { $0.setupParentRelationships(parent: self) }`
`41`	`40`	`}`
`42`	`41`