Adjust debug descriptions: remove final newline (#143)

nuomi1 · web-flow · commit 7c01bdd45f5a · 2024-11-05T10:21:27.000-07:00
Remove last terminator in customized `debugDescription`.
diff --git a/Sources/DebugDescriptions.swift b/Sources/DebugDescriptions.swift
@@ -36,6 +36,12 @@ private func buildString<Target: TextOutputStream>(
     print("\(String(repeating: " ", count: indent))\(text)", to: &output)
 }
 
+private func adjustLastTerminator(_ output: inout String) {
+    if output.last == "\n" {
+        output.removeLast()
+    }
+}
+
 // swiftlint:disable:next cyclomatic_complexity
 private func debugDescriptionBuilder<Target: TextOutputStream>(
     elements: [(Element, Int)],
@@ -168,6 +174,7 @@ func collectionDebugDescription(_ collection: CollectionViewModel) -> String {
         ],
         to: &output
     )
+    adjustLastTerminator(&output)
     return output
 }
 
@@ -187,6 +194,7 @@ func sectionDebugDescription(_ section: SectionViewModel) -> String {
         ],
         to: &output
     )
+    adjustLastTerminator(&output)
     return output
 }
 
@@ -201,6 +209,7 @@ func driverOptionsDebugDescription(_ options: CollectionViewDriverOptions) -> St
         ],
         to: &output
     )
+    adjustLastTerminator(&output)
     return output
 }
 
@@ -225,5 +234,6 @@ func driverDebugDescription(
         ],
         to: &output
     )
+    adjustLastTerminator(&output)
     return output
 }
diff --git a/Tests/TestCollectionViewDriverOptions.swift b/Tests/TestCollectionViewDriverOptions.swift
@@ -32,7 +32,6 @@ final class TestCollectionViewDriverOptions: XCTestCase {
               diffOnBackgroundQueue: false
               reloadDataOnReplacingViewModel: false
             }
-
             """
         )
 
@@ -47,7 +46,6 @@ final class TestCollectionViewDriverOptions: XCTestCase {
               diffOnBackgroundQueue: true
               reloadDataOnReplacingViewModel: true
             }
-
             """
         )
     }
diff --git a/Tests/TestDebugDescriptionCollection.swift b/Tests/TestDebugDescriptionCollection.swift
@@ -33,7 +33,6 @@ final class TestDebugDescriptionCollection: XCTestCase {
               registrations: none
               isEmpty: true
             }
-
             """
         )
     }
@@ -66,7 +65,6 @@ final class TestDebugDescriptionCollection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
 
@@ -96,7 +94,6 @@ final class TestDebugDescriptionCollection: XCTestCase {
                 - FakeCellNibViewModel (cell)
               isEmpty: false
             }
-
             """
         )
     }
@@ -131,7 +128,6 @@ final class TestDebugDescriptionCollection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
 
@@ -163,7 +159,6 @@ final class TestDebugDescriptionCollection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
 
@@ -197,7 +192,6 @@ final class TestDebugDescriptionCollection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
     }
@@ -239,7 +233,6 @@ final class TestDebugDescriptionCollection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
     }
@@ -282,7 +275,6 @@ final class TestDebugDescriptionCollection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
 
@@ -322,7 +314,6 @@ final class TestDebugDescriptionCollection: XCTestCase {
                 - FakeCellNibViewModel (cell)
               isEmpty: false
             }
-
             """
         )
 
@@ -364,7 +355,6 @@ final class TestDebugDescriptionCollection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
     }
@@ -409,7 +399,6 @@ final class TestDebugDescriptionCollection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
 
@@ -453,7 +442,6 @@ final class TestDebugDescriptionCollection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
 
@@ -505,7 +493,6 @@ final class TestDebugDescriptionCollection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
     }
diff --git a/Tests/TestDebugDescriptionDriver.swift b/Tests/TestDebugDescriptionDriver.swift
@@ -68,7 +68,6 @@ final class TestDebugDescriptionDriver: XCTestCase {
               flowLayoutDelegate: nil
               view: \(viewPattern)
             \\}
-
             """
 
         XCTAssertTrue(driver.debugDescription.regexMatches(pattern: expected))
@@ -124,7 +123,6 @@ final class TestDebugDescriptionDriver: XCTestCase {
               flowLayoutDelegate: nil
               view: \(viewPattern)
             \\}
-
             """
 
         XCTAssertTrue(driver.debugDescription.regexMatches(pattern: expected))
@@ -173,7 +171,6 @@ final class TestDebugDescriptionDriver: XCTestCase {
               flowLayoutDelegate: <ReactiveCollectionsKitTests\\.FakeFlowLayoutDelegate: \(Self.addressPattern)>
               view: \(viewPattern)
             \\}
-
             """
 
         XCTAssertTrue(driver.debugDescription.regexMatches(pattern: expected))
diff --git a/Tests/TestDebugDescriptionSection.swift b/Tests/TestDebugDescriptionSection.swift
@@ -35,7 +35,6 @@ final class TestDebugDescriptionSection: XCTestCase {
               registrations: none
               isEmpty: true
             }
-
             """
         )
     }
@@ -60,7 +59,6 @@ final class TestDebugDescriptionSection: XCTestCase {
                 - FakeNumberCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
     }
@@ -88,7 +86,6 @@ final class TestDebugDescriptionSection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
 
@@ -113,7 +110,6 @@ final class TestDebugDescriptionSection: XCTestCase {
                 - FakeCellNibViewModel (cell)
               isEmpty: false
             }
-
             """
         )
     }
@@ -143,7 +139,6 @@ final class TestDebugDescriptionSection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
 
@@ -170,7 +165,6 @@ final class TestDebugDescriptionSection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
 
@@ -199,7 +193,6 @@ final class TestDebugDescriptionSection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
 
@@ -233,7 +226,6 @@ final class TestDebugDescriptionSection: XCTestCase {
                 - FakeTextCellViewModel (cell)
               isEmpty: false
             }
-
             """
         )
     }

Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,12 @@ private func buildString<Target: TextOutputStream>(`
`36`	`36`	`print("\(String(repeating: " ", count: indent))\(text)", to: &output)`
`37`	`37`	`}`
`38`	`38`
	`39`	`+private func adjustLastTerminator(_ output: inout String) {`
	`40`	`+ if output.last == "\n" {`
	`41`	`+ output.removeLast()`
	`42`	`+ }`
	`43`	`+}`
	`44`	`+`
`39`	`45`	`// swiftlint:disable:next cyclomatic_complexity`
`40`	`46`	`private func debugDescriptionBuilder<Target: TextOutputStream>(`
`41`	`47`	`elements: [(Element, Int)],`
`@@ -168,6 +174,7 @@ func collectionDebugDescription(_ collection: CollectionViewModel) -> String {`
`168`	`174`	`],`
`169`	`175`	`to: &output`
`170`	`176`	`)`
	`177`	`+ adjustLastTerminator(&output)`
`171`	`178`	`return output`
`172`	`179`	`}`
`173`	`180`
`@@ -187,6 +194,7 @@ func sectionDebugDescription(_ section: SectionViewModel) -> String {`
`187`	`194`	`],`
`188`	`195`	`to: &output`
`189`	`196`	`)`
	`197`	`+ adjustLastTerminator(&output)`
`190`	`198`	`return output`
`191`	`199`	`}`
`192`	`200`
`@@ -201,6 +209,7 @@ func driverOptionsDebugDescription(_ options: CollectionViewDriverOptions) -> St`
`201`	`209`	`],`
`202`	`210`	`to: &output`
`203`	`211`	`)`
	`212`	`+ adjustLastTerminator(&output)`
`204`	`213`	`return output`
`205`	`214`	`}`
`206`	`215`
`@@ -225,5 +234,6 @@ func driverDebugDescription(`
`225`	`234`	`],`
`226`	`235`	`to: &output`
`227`	`236`	`)`
	`237`	`+ adjustLastTerminator(&output)`
`228`	`238`	`return output`
`229`	`239`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,6 @@ final class TestCollectionViewDriverOptions: XCTestCase {`
`32`	`32`	`diffOnBackgroundQueue: false`
`33`	`33`	`reloadDataOnReplacingViewModel: false`
`34`	`34`	`}`
`35`		`-`
`36`	`35`	`"""`
`37`	`36`	`)`
`38`	`37`
`@@ -47,7 +46,6 @@ final class TestCollectionViewDriverOptions: XCTestCase {`
`47`	`46`	`diffOnBackgroundQueue: true`
`48`	`47`	`reloadDataOnReplacingViewModel: true`
`49`	`48`	`}`
`50`		`-`
`51`	`49`	`"""`
`52`	`50`	`)`
`53`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,6 @@ final class TestDebugDescriptionCollection: XCTestCase {`
`33`	`33`	`registrations: none`
`34`	`34`	`isEmpty: true`
`35`	`35`	`}`
`36`		`-`
`37`	`36`	`"""`
`38`	`37`	`)`
`39`	`38`	`}`
`@@ -66,7 +65,6 @@ final class TestDebugDescriptionCollection: XCTestCase {`
`66`	`65`	`- FakeTextCellViewModel (cell)`
`67`	`66`	`isEmpty: false`
`68`	`67`	`}`
`69`		`-`
`70`	`68`	`"""`
`71`	`69`	`)`
`72`	`70`
`@@ -96,7 +94,6 @@ final class TestDebugDescriptionCollection: XCTestCase {`
`96`	`94`	`- FakeCellNibViewModel (cell)`
`97`	`95`	`isEmpty: false`
`98`	`96`	`}`
`99`		`-`
`100`	`97`	`"""`
`101`	`98`	`)`
`102`	`99`	`}`
`@@ -131,7 +128,6 @@ final class TestDebugDescriptionCollection: XCTestCase {`
`131`	`128`	`- FakeTextCellViewModel (cell)`
`132`	`129`	`isEmpty: false`
`133`	`130`	`}`
`134`		`-`
`135`	`131`	`"""`
`136`	`132`	`)`
`137`	`133`
`@@ -163,7 +159,6 @@ final class TestDebugDescriptionCollection: XCTestCase {`
`163`	`159`	`- FakeTextCellViewModel (cell)`
`164`	`160`	`isEmpty: false`
`165`	`161`	`}`
`166`		`-`
`167`	`162`	`"""`
`168`	`163`	`)`
`169`	`164`
`@@ -197,7 +192,6 @@ final class TestDebugDescriptionCollection: XCTestCase {`
`197`	`192`	`- FakeTextCellViewModel (cell)`
`198`	`193`	`isEmpty: false`
`199`	`194`	`}`
`200`		`-`
`201`	`195`	`"""`
`202`	`196`	`)`
`203`	`197`	`}`
`@@ -239,7 +233,6 @@ final class TestDebugDescriptionCollection: XCTestCase {`
`239`	`233`	`- FakeTextCellViewModel (cell)`
`240`	`234`	`isEmpty: false`
`241`	`235`	`}`
`242`		`-`
`243`	`236`	`"""`
`244`	`237`	`)`
`245`	`238`	`}`
`@@ -282,7 +275,6 @@ final class TestDebugDescriptionCollection: XCTestCase {`
`282`	`275`	`- FakeTextCellViewModel (cell)`
`283`	`276`	`isEmpty: false`
`284`	`277`	`}`
`285`		`-`
`286`	`278`	`"""`
`287`	`279`	`)`
`288`	`280`
`@@ -322,7 +314,6 @@ final class TestDebugDescriptionCollection: XCTestCase {`
`322`	`314`	`- FakeCellNibViewModel (cell)`
`323`	`315`	`isEmpty: false`
`324`	`316`	`}`
`325`		`-`
`326`	`317`	`"""`
`327`	`318`	`)`
`328`	`319`
`@@ -364,7 +355,6 @@ final class TestDebugDescriptionCollection: XCTestCase {`
`364`	`355`	`- FakeTextCellViewModel (cell)`
`365`	`356`	`isEmpty: false`
`366`	`357`	`}`
`367`		`-`
`368`	`358`	`"""`
`369`	`359`	`)`
`370`	`360`	`}`
`@@ -409,7 +399,6 @@ final class TestDebugDescriptionCollection: XCTestCase {`
`409`	`399`	`- FakeTextCellViewModel (cell)`
`410`	`400`	`isEmpty: false`
`411`	`401`	`}`
`412`		`-`
`413`	`402`	`"""`
`414`	`403`	`)`
`415`	`404`
`@@ -453,7 +442,6 @@ final class TestDebugDescriptionCollection: XCTestCase {`
`453`	`442`	`- FakeTextCellViewModel (cell)`
`454`	`443`	`isEmpty: false`
`455`	`444`	`}`
`456`		`-`
`457`	`445`	`"""`
`458`	`446`	`)`
`459`	`447`
`@@ -505,7 +493,6 @@ final class TestDebugDescriptionCollection: XCTestCase {`
`505`	`493`	`- FakeTextCellViewModel (cell)`
`506`	`494`	`isEmpty: false`
`507`	`495`	`}`
`508`		`-`
`509`	`496`	`"""`
`510`	`497`	`)`
`511`	`498`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,6 @@ final class TestDebugDescriptionSection: XCTestCase {`
`35`	`35`	`registrations: none`
`36`	`36`	`isEmpty: true`
`37`	`37`	`}`
`38`		`-`
`39`	`38`	`"""`
`40`	`39`	`)`
`41`	`40`	`}`
`@@ -60,7 +59,6 @@ final class TestDebugDescriptionSection: XCTestCase {`
`60`	`59`	`- FakeNumberCellViewModel (cell)`
`61`	`60`	`isEmpty: false`
`62`	`61`	`}`
`63`		`-`
`64`	`62`	`"""`
`65`	`63`	`)`
`66`	`64`	`}`
`@@ -88,7 +86,6 @@ final class TestDebugDescriptionSection: XCTestCase {`
`88`	`86`	`- FakeTextCellViewModel (cell)`
`89`	`87`	`isEmpty: false`
`90`	`88`	`}`
`91`		`-`
`92`	`89`	`"""`
`93`	`90`	`)`
`94`	`91`
`@@ -113,7 +110,6 @@ final class TestDebugDescriptionSection: XCTestCase {`
`113`	`110`	`- FakeCellNibViewModel (cell)`
`114`	`111`	`isEmpty: false`
`115`	`112`	`}`
`116`		`-`
`117`	`113`	`"""`
`118`	`114`	`)`
`119`	`115`	`}`
`@@ -143,7 +139,6 @@ final class TestDebugDescriptionSection: XCTestCase {`
`143`	`139`	`- FakeTextCellViewModel (cell)`
`144`	`140`	`isEmpty: false`
`145`	`141`	`}`
`146`		`-`
`147`	`142`	`"""`
`148`	`143`	`)`
`149`	`144`
`@@ -170,7 +165,6 @@ final class TestDebugDescriptionSection: XCTestCase {`
`170`	`165`	`- FakeTextCellViewModel (cell)`
`171`	`166`	`isEmpty: false`
`172`	`167`	`}`
`173`		`-`
`174`	`168`	`"""`
`175`	`169`	`)`
`176`	`170`
`@@ -199,7 +193,6 @@ final class TestDebugDescriptionSection: XCTestCase {`
`199`	`193`	`- FakeTextCellViewModel (cell)`
`200`	`194`	`isEmpty: false`
`201`	`195`	`}`
`202`		`-`
`203`	`196`	`"""`
`204`	`197`	`)`
`205`	`198`
`@@ -233,7 +226,6 @@ final class TestDebugDescriptionSection: XCTestCase {`
`233`	`226`	`- FakeTextCellViewModel (cell)`
`234`	`227`	`isEmpty: false`
`235`	`228`	`}`
`236`		`-`
`237`	`229`	`"""`
`238`	`230`	`)`
`239`	`231`	`}`