Merge pull request #2027 from ahoppen/ahoppen/some-substructure

Change `substructure` parameter of `assertParse` to `some SyntaxProtocol`

Author: ahoppen

Sources/_SwiftSyntaxTestSupport/IncrementalParseTestUtils.swift

@@ -72,9 +72,9 @@ public func assertIncrementalParse(
   )
 
   // Substructure
-  let subtreeMatcher = SubtreeMatcher(Syntax(incrementallyParsedNewTree), markers: [:])
+  let subtreeMatcher = SubtreeMatcher(incrementallyParsedNewTree, markers: [:])
   do {
-    try subtreeMatcher.assertSameStructure(Syntax(newTree), includeTrivia: true, file: file, line: line)
+    try subtreeMatcher.assertSameStructure(newTree, includeTrivia: true, file: file, line: line)
   } catch {
     XCTFail("Matching for a subtree failed with error: \(error)", file: file, line: line)
   }

Sources/_SwiftSyntaxTestSupport/Syntax+Assertions.swift

@@ -88,15 +88,15 @@ public struct SubtreeMatcher {
     self.actualTree = try parse(text)
   }
 
-  public init(_ actualTree: Syntax, markers: [String: Int]) {
+  public init(_ actualTree: some SyntaxProtocol, markers: [String: Int]) {
     self.markers = markers.isEmpty ? ["DEFAULT": 0] : markers
-    self.actualTree = actualTree
+    self.actualTree = Syntax(actualTree)
   }
 
   /// Same as `Syntax.findFirstDifference(baseline:includeTrivia:)`, but
   /// matches against the first subtree from parsing `markedText` that is after
   /// `afterMarker` with the root matching the root type of `baseline`.
-  public func findFirstDifference(afterMarker: String? = nil, baseline: Syntax, includeTrivia: Bool = false) throws -> TreeDifference? {
+  public func findFirstDifference(afterMarker: String? = nil, baseline: some SyntaxProtocol, includeTrivia: Bool = false) throws -> TreeDifference? {
     let afterMarker = afterMarker ?? markers.first!.key
     guard let subtreeStart = markers[afterMarker] else {
       throw SubtreeError.invalidMarker(name: afterMarker)
@@ -113,7 +113,7 @@ public struct SubtreeMatcher {
   /// `init(markedText:)` has the same structure as `expected`.
   public func assertSameStructure(
     afterMarker: String? = nil,
-    _ expected: Syntax,
+    _ expected: some SyntaxProtocol,
     includeTrivia: Bool = false,
     additionalInfo: String? = nil,
     file: StaticString = #filePath,

Tests/SwiftOperatorsTest/OperatorTableTests.swift

@@ -90,9 +90,9 @@ extension OperatorTable {
     XCTAssertFalse(parenthesizedSyntax.containsExprSequence)
 
     // Make sure the two have the same structure.
-    let subtreeMatcher = SubtreeMatcher(Syntax(foldedSyntax), markers: [:])
+    let subtreeMatcher = SubtreeMatcher(foldedSyntax, markers: [:])
     do {
-      try subtreeMatcher.assertSameStructure(Syntax(parenthesizedSyntax))
+      try subtreeMatcher.assertSameStructure(parenthesizedSyntax)
     } catch {
       XCTFail("Matching for a subtree failed with error: \(error)")
     }

Tests/SwiftParserTest/Assertions.swift

@@ -531,7 +531,7 @@ public struct AssertParseOptions: OptionSet {
 /// parsing the resulting `String` as a ``SourceFileSyntax``.
 func assertParse(
   _ markedSource: String,
-  substructure expectedSubstructure: Syntax? = nil,
+  substructure expectedSubstructure: (some SyntaxProtocol)? = Optional<Syntax>.none,
   substructureAfterMarker: String = "START",
   diagnostics expectedDiagnostics: [DiagnosticSpec] = [],
   applyFixIts: [String]? = nil,
@@ -609,7 +609,7 @@ fileprivate func assertRoundTrip<S: SyntaxProtocol>(
 func assertParse<S: SyntaxProtocol>(
   _ markedSource: String,
   _ parse: (inout Parser) -> S,
-  substructure expectedSubstructure: Syntax? = nil,
+  substructure expectedSubstructure: (some SyntaxProtocol)? = Optional<Syntax>.none,
   substructureAfterMarker: String = "START",
   diagnostics expectedDiagnostics: [DiagnosticSpec] = [],
   applyFixIts: [String]? = nil,
@@ -648,11 +648,11 @@ func assertParse<S: SyntaxProtocol>(
 
   // Substructure
   if let expectedSubstructure {
-    let subtreeMatcher = SubtreeMatcher(Syntax(tree), markers: markerLocations)
+    let subtreeMatcher = SubtreeMatcher(tree, markers: markerLocations)
     do {
       try subtreeMatcher.assertSameStructure(
         afterMarker: substructureAfterMarker,
-        Syntax(expectedSubstructure),
+        expectedSubstructure,
         includeTrivia: options.contains(.substructureCheckTrivia),
         file: file,
         line: line
@@ -760,9 +760,9 @@ func assertBasicFormat<S: SyntaxProtocol>(
   let formattedReparsed = Syntax(parse(&formattedParser))
 
   do {
-    let subtreeMatcher = SubtreeMatcher(Syntax(formattedReparsed), markers: [:])
+    let subtreeMatcher = SubtreeMatcher(formattedReparsed, markers: [:])
     try subtreeMatcher.assertSameStructure(
-      Syntax(sourceTree),
+      sourceTree,
       includeTrivia: false,
       additionalInfo: """
         Removing trivia, formatting using BasicFormat and re-parsing did not produce the same syntax tree.

Tests/SwiftParserTest/AttributeTests.swift

@@ -149,7 +149,7 @@ final class AttributeTests: XCTestCase {
       @1️⃣rethrows
       protocol P { }
       """,
-      substructure: Syntax(TokenSyntax.identifier("rethrows")),
+      substructure: TokenSyntax.identifier("rethrows"),
       substructureAfterMarker: "1️⃣"
     )
   }
@@ -327,7 +327,7 @@ final class AttributeTests: XCTestCase {
       assertParse(
         "@_implements(1️⃣\(baseType), f())",
         AttributeSyntax.parse,
-        substructure: Syntax(TypeSyntax.parse(from: &parser)),
+        substructure: TypeSyntax.parse(from: &parser),
         substructureAfterMarker: "1️⃣",
         line: line
       )

Tests/SwiftParserTest/AvailabilityTests.swift

@@ -106,10 +106,8 @@ final class AvailabilityTests: XCTestCase {
       @available(OSX 10)
       func test() {}
       """,
-      substructure: Syntax(
-        VersionTupleSyntax(
-          major: .integerLiteral("10")
-        )
+      substructure: VersionTupleSyntax(
+        major: .integerLiteral("10")
       )
     )
 
@@ -118,11 +116,9 @@ final class AvailabilityTests: XCTestCase {
       @available(OSX 10.0)
       func test() {}
       """,
-      substructure: Syntax(
-        VersionTupleSyntax(
-          major: .integerLiteral("10"),
-          components: VersionComponentListSyntax([VersionComponentSyntax(number: .integerLiteral("0"))])
-        )
+      substructure: VersionTupleSyntax(
+        major: .integerLiteral("10"),
+        components: VersionComponentListSyntax([VersionComponentSyntax(number: .integerLiteral("0"))])
       )
     )
 
@@ -131,14 +127,12 @@ final class AvailabilityTests: XCTestCase {
       @available(OSX 10.0.1)
       func test() {}
       """,
-      substructure: Syntax(
-        VersionTupleSyntax(
-          major: .integerLiteral("10"),
-          components: VersionComponentListSyntax([
-            VersionComponentSyntax(number: .integerLiteral("0")),
-            VersionComponentSyntax(number: .integerLiteral("1")),
-          ])
-        )
+      substructure: VersionTupleSyntax(
+        major: .integerLiteral("10"),
+        components: VersionComponentListSyntax([
+          VersionComponentSyntax(number: .integerLiteral("0")),
+          VersionComponentSyntax(number: .integerLiteral("1")),
+        ])
       )
     )