Merge pull request #79 from Adyen/remove-assertion-failure

goergisn · web-flow · commit c668b2b5adfb · 2025-01-10T20:28:49.000+01:00
Fixed recursiveDescription formatting
diff --git a/ReferencePackages/UpdatedPackage/Sources/ReferencePackage/ReferencePackage.swift b/ReferencePackages/UpdatedPackage/Sources/ReferencePackage/ReferencePackage.swift
@@ -195,9 +195,9 @@ extension CustomEnum: SimpleProtocol {
     }
 }
 
-extension CustomEnum.NestedStructInExtension {
+extension CustomEnum.NestedStructInExtension: CustomStringConvertible {
 
-    var description: String {
+    public var description: String {
         return string
     }
 }
diff --git a/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceAnalyzer/SwiftInterfaceChangeConsolidator.swift b/Sources/PublicModules/PADSwiftInterfaceDiff/SwiftInterfaceAnalyzer/SwiftInterfaceChangeConsolidator.swift
@@ -52,7 +52,7 @@ struct SwiftInterfaceChangeConsolidator: SwiftInterfaceChangeConsolidating {
             let listOfChanges = listOfChanges(between: change, and: match)
 
             if listOfChanges.isEmpty {
-                assertionFailure("We should not end up here - investigate how this happened")
+                print("⚠ We should not end up here - investigate how this happened")
                 break
             }
 
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,16 +123,12 @@ 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))}")
         }
 
-        if indentation == 0 {
-            recursiveDescription.append("\n")
-        }
-
         return recursiveDescription
     }
     
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/ReferencePackageTests.swift b/Tests/IntegrationTests/ReferencePackageTests.swift
@@ -67,10 +67,10 @@ class ReferencePackageTests: XCTestCase {
 
         let expectedLines = sanitizeOutput(expectedOutput).components(separatedBy: "\n")
         let markdownOutputLines = sanitizeOutput(markdownOutput).components(separatedBy: "\n")
-
+        
         for i in 0..<expectedLines.count {
             if expectedLines[i] != markdownOutputLines[i] {
-                XCTAssertEqual(expectedLines[i], markdownOutputLines[i])
+                XCTAssertEqual(expectedLines[i], markdownOutputLines[i], "Issue in line \(i)")
                 return
             }
         }
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,32 +6,28 @@ _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)
   public typealias RawValue = Swift.String
   public var rawValue: Swift.String { get }
 }
-
 ```
 ```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
 public protocol SimpleProtocol
-
 ```
 #### 🔀 Modified
 ```javascript
@@ -108,33 +104,26 @@ Changes:
 extension Swift.Array {
   public subscript(safe index: Swift.Int) -> Element? { get }
 }
-
 ```
 ### `CustomClass`
 #### ❇️ Added
 ```javascript
 final public let a: Swift.Int { get }
-
 ```
 ```javascript
 final public let b: Swift.Int { get }
-
 ```
 ```javascript
 final public let c: Swift.Int { get }
-
 ```
 ```javascript
 final public let d: Swift.Double { get }
-
 ```
 ```javascript
 public subscript(index: Swift.Int) -> T? { get set }
-
 ```
 ```javascript
 public var lazyVar: Swift.String { get set }
-
 ```
 #### 🔀 Modified
 ```javascript
@@ -181,40 +170,33 @@ Changes:
 #### ❇️ Added
 ```javascript
 case a
-
 ```
 ```javascript
 case b
-
 ```
 ```javascript
 case c
-
 ```
 ```javascript
 case caseWithNamedString(title: T)
-
 ```
 ```javascript
 case d
-
 ```
 ```javascript
 case e(ReferencePackage.CustomEnum<T>.NestedStructInExtension)
-
 ```
 ```javascript
 extension ReferencePackage.CustomEnum where T == Swift.String {
   public var titleOfCaseWithNamedString: Swift.String? { get }
 }
-
 ```
 ```javascript
-public struct NestedStructInExtension {
-  public let string: Swift.String { get }
+public struct NestedStructInExtension: Swift.CustomStringConvertible {
   public init(string: Swift.String = "Hello")
+  public let string: Swift.String { get }
+  public var description: Swift.String { get }
 }
-
 ```
 #### 🔀 Modified
 ```javascript
@@ -259,19 +241,15 @@ case caseWithString(Swift.String)
 #### ❇️ Added
 ```javascript
 associatedtype AnotherAssociatedType: Swift.Strideable
-
 ```
 ```javascript
 associatedtype AnotherAssociatedType: Swift.Strideable
-
 ```
 ```javascript
 associatedtype CustomAssociatedType: Swift.Equatable
-
 ```
 ```javascript
 associatedtype CustomAssociatedType: Swift.Equatable
-
 ```
 #### 🔀 Modified
 ```javascript
@@ -324,23 +302,18 @@ public struct NestedStruct {
   @available(swift 5.9)
   public let nestedVar: Swift.String { get }
 }
-
 ```
 ```javascript
 public typealias AnotherAssociatedType = Swift.Double
-
 ```
 ```javascript
 public typealias CustomAssociatedType = Swift.Int
-
 ```
 ```javascript
 public typealias Iterator = [ReferencePackage.CustomStruct<T>.AnotherAssociatedType]
-
 ```
 ```javascript
 public typealias ParentType = Swift.Double
-
 ```
 #### 🔀 Modified
 ```javascript
@@ -386,17 +359,14 @@ Changes:
 ```javascript
 @_spi(SystemProgrammingInterface)
 public typealias AnotherAssociatedType = T
-
 ```
 ```javascript
 @_spi(SystemProgrammingInterface)
 public typealias Iterator = [Swift.Double]
-
 ```
 ```javascript
 @_spi(SystemProgrammingInterface)
 public typealias ParentType = Swift.Double
-
 ```
 #### 🔀 Modified
 ```javascript
diff --git a/Tests/IntegrationTests/Resources/expected-reference-changes-swift-interface-public.md b/Tests/IntegrationTests/Resources/expected-reference-changes-swift-interface-public.md

Original file line number	Diff line number	Diff line change
`@@ -195,9 +195,9 @@ extension CustomEnum: SimpleProtocol {`
`195`	`195`	`}`
`196`	`196`	`}`
`197`	`197`
`198`		`-extension CustomEnum.NestedStructInExtension {`
	`198`	`+extension CustomEnum.NestedStructInExtension: CustomStringConvertible {`
`199`	`199`
`200`		`- var description: String {`
	`200`	`+ public var description: String {`
`201`	`201`	`return string`
`202`	`202`	`}`
`203`	`203`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ struct SwiftInterfaceChangeConsolidator: SwiftInterfaceChangeConsolidating {`
`52`	`52`	`let listOfChanges = listOfChanges(between: change, and: match)`
`53`	`53`
`54`	`54`	`if listOfChanges.isEmpty {`
`55`		`- assertionFailure("We should not end up here - investigate how this happened")`
	`55`	`+ print("⚠ We should not end up here - investigate how this happened")`
`56`	`56`	`break`
`57`	`57`	`}`
`58`	`58`
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,16 +123,12 @@ 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))}")`
`130`	`130`	`}`
`131`	`131`
`132`		`- if indentation == 0 {`
`133`		`- recursiveDescription.append("\n")`
`134`		`- }`
`135`		`-`
`136`	`132`	`return recursiveDescription`
`137`	`133`	`}`
`138`	`134`