Enable some skipping tests in IncrementalParsingTests.swift

Also make some naming improvements

Author: StevenWong12

Sources/_SwiftSyntaxTestSupport/IncrementalParseTestUtils.swift

@@ -19,13 +19,20 @@ import XCTest
 /// 1. Round-trip on the incrementally parsed syntax tree.
 /// 2. verify that incrementally parsing the edited source base on the original source produces the same syntax tree as reparsing the post-edit file from scratch.
 /// 3. verify the reused nodes fall into expectations.
+///
+/// - parameter reusedNodes: The element order should respect to the order of  `ReusedNodeSpec.source` in `source`.
+/// e.g. for `source` func foo() {}\n foo()
+///    The `reusedNodes` should be [
+///      ReusedNodeSpec("func foo() {}", kind: .codeBlockItem),
+///      ReusedNodeSpec("foo()", kind: .codeBlockItem)
+///    ]
 public func assertIncrementalParse(
   _ source: String,
   reusedNodes expectedReusedNodes: [ReusedNodeSpec] = [],
   file: StaticString = #file,
   line: UInt = #line
 ) {
-  let (concurrentEdits, originalSource, editedSource) = getEditsAndSources(source)
+  let (concurrentEdits, originalSource, editedSource) = extractEditsAndSources(from: source)
 
   let originalString = String(originalSource)
   let editedString = String(editedSource)
@@ -78,13 +85,22 @@ public func assertIncrementalParse(
     return
   }
 
+  var lastRangeUpperBound = originalString.startIndex
   for expectedReusedNode in expectedReusedNodes {
-    guard let range = getByteSourceRange(for: expectedReusedNode.source, in: originalString) else {
+    guard let range = byteSourceRange(for: expectedReusedNode.source, in: originalString[lastRangeUpperBound...]) else {
       XCTFail("Fail to find string in original source,", file: expectedReusedNode.file, line: expectedReusedNode.line)
       continue
     }
 
-    guard let reusedNode = reusedNodes.first(where: { $0.byteRangeAfterTrimmingTrivia == range }) else {
+    guard
+      let reusedNode = reusedNodes.first(where: {
+        $0.byteRangeAfterTrimmingTrivia
+          == ByteSourceRange(
+            offset: range.offset + originalString.distance(from: originalString.startIndex, to: lastRangeUpperBound),
+            length: range.length
+          )
+      })
+    else {
       XCTFail(
         """
         Fail to match the range of \(expectedReusedNode.source) in:
@@ -105,10 +121,12 @@ public func assertIncrementalParse(
       file: expectedReusedNode.file,
       line: expectedReusedNode.line
     )
+
+    lastRangeUpperBound = originalString.index(originalString.startIndex, offsetBy: range.endOffset)
   }
 }
 
-fileprivate func getByteSourceRange(for substring: String, in sourceString: String) -> ByteSourceRange? {
+fileprivate func byteSourceRange(for substring: String, in sourceString: Substring) -> ByteSourceRange? {
   if let range = sourceString.range(of: substring) {
     return ByteSourceRange(
       offset: sourceString.utf8.distance(from: sourceString.startIndex, to: range.lowerBound),
@@ -148,7 +166,7 @@ public struct ReusedNodeSpec {
 /// Contents between `⏩️` and `⏸️` are source text that before modification, contents
 /// betwwen `⏸️` and `⏪️` are source text that after modification
 /// i.e. `⏩️foo⏸️bar⏪️`, the original source is `foo` and the edited source is `bar`
-public func getEditsAndSources(_ source: String) -> (edits: ConcurrentEdits, orignialSource: Substring, editedSource: Substring) {
+public func extractEditsAndSources(from source: String) -> (edits: ConcurrentEdits, orignialSource: Substring, editedSource: Substring) {
   var editedSource = Substring()
   var originalSource = Substring()
   var concurrentEdits: [IncrementalEdit] = []

Tests/SwiftParserTest/IncrementalParsingTests.swift

@@ -161,7 +161,7 @@ public class IncrementalParsingTests: XCTestCase {
     )
   }
 
-  public func testMultiEditMapping() throws {
+  public func testMultiEditMapping() {
     assertIncrementalParse(
       """
       let one: Int;let two: Int; let three: Int; ⏩️⏸️                      ⏪️⏩️⏸️   ⏪️let found: Int;let five: Int;
@@ -197,8 +197,7 @@ public class IncrementalParsingTests: XCTestCase {
     )
   }
 
-  public func testWarpInClass() throws {
-    try XCTSkipIf(true, "Swift parser does not handle node reuse yet")
+  public func testWarpInClass() {
     assertIncrementalParse(
       """
       ⏩️⏸️class Foo {⏪️
@@ -213,26 +212,21 @@ public class IncrementalParsingTests: XCTestCase {
       reusedNodes: [
         ReusedNodeSpec(
           """
-          func foo1() {
-            print("Hello Foo!")
-          }
+          print("Hello Foo!")
           """,
-          kind: .functionDecl
+          kind: .codeBlockItem
         ),
         ReusedNodeSpec(
           """
-          func foo2() {
-            print("Hello again!")
-          }
+          print("Hello again")
           """,
-          kind: .functionDecl
+          kind: .codeBlockItem
         ),
       ]
     )
   }
 
-  public func testUnwarpClass() throws {
-    try XCTSkipIf(true, "Swift parser does not handle node reuse yet")
+  public func testUnwarpClass() {
     assertIncrementalParse(
       """
       ⏩️class Bar {⏸️⏪️
@@ -250,21 +244,27 @@ public class IncrementalParsingTests: XCTestCase {
       reusedNodes: [
         ReusedNodeSpec(
           """
-          func bar1() {
-            let pi = 3.1415
-            print("Pi is (approximately) \\(pi)")
-          }
+          let pi = 3.1415
           """,
-          kind: .functionDecl
+          kind: .codeBlockItem
         ),
         ReusedNodeSpec(
           """
-          func bar2() {
-            print("I can compute Pi as well:")
-            bar1()
-          }
+          print("Pi is (approximately) \\(pi)")
           """,
-          kind: .functionDecl
+          kind: .codeBlockItem
+        ),
+        ReusedNodeSpec(
+          """
+          print("I can compute Pi as well:")
+          """,
+          kind: .codeBlockItem
+        ),
+        ReusedNodeSpec(
+          """
+          bar1()
+          """,
+          kind: .codeBlockItem
         ),
       ]
     )

Tests/SwiftSyntaxTestSupportTest/IncrementalParseTestUtilsTest.swift

@@ -27,7 +27,7 @@ public class IncrementalParseUtilTest: XCTestCase {
       }
       """
 
-    let (concurrentEdits, originalSource, _) = getEditsAndSources(source)
+    let (concurrentEdits, originalSource, _) = extractEditsAndSources(from: source)
 
     XCTAssertEqual(
       concurrentEdits.edits,
@@ -57,7 +57,7 @@ public class IncrementalParseUtilTest: XCTestCase {
   public func testReplaceMultiByteCharWithShorter() {
     let source = "⏩️👨‍👩‍👧‍👦⏸️🎉⏪️"
 
-    let (concurrentEdits, originalSource, editedSource) = getEditsAndSources(source)
+    let (concurrentEdits, originalSource, editedSource) = extractEditsAndSources(from: source)
 
     XCTAssertEqual(String(originalSource), "👨‍👩‍👧‍👦")
     XCTAssertEqual(String(editedSource), "🎉")
@@ -72,7 +72,7 @@ public class IncrementalParseUtilTest: XCTestCase {
   public func testReplaceWithMultiByteChar() {
     let source = "⏩️a⏸️👨‍👩‍👧‍👦⏪️"
 
-    let (concurrentEdits, originalSource, editedSource) = getEditsAndSources(source)
+    let (concurrentEdits, originalSource, editedSource) = extractEditsAndSources(from: source)
 
     XCTAssertEqual(String(originalSource), "a")
     XCTAssertEqual(String(editedSource), "👨‍👩‍👧‍👦")