Remove and refactor Context.init that was only used in tests.

Author: allevato

Sources/SwiftFormatCore/Context.swift

@@ -60,23 +60,6 @@ public class Context {
     )
   }
 
-  /// Creates a new Context with the provided configuration, diagnostic engine, and source text.
-  public init(
-    configuration: Configuration,
-    diagnosticEngine: DiagnosticEngine?,
-    fileURL: URL,
-    sourceText: String
-  ) {
-    self.configuration = configuration
-    self.diagnosticEngine = diagnosticEngine
-    self.fileURL = fileURL
-    self.importsXCTest = false
-    self.didSetImportsXCTest = false
-    self.sourceLocationConverter = SourceLocationConverter(file: fileURL.path, source: sourceText)
-    let syntax = try! SyntaxParser.parse(source: sourceText)
-    self.ruleMask = RuleMask(syntaxNode: syntax, sourceLocationConverter: sourceLocationConverter)
-  }
-
   /// Given a rule's name and the node it is examining, determine if the rule is disabled at this
   /// location or not.
   public func isRuleDisabled(_ ruleName: String, node: Syntax) -> Bool {

Tests/SwiftFormatPrettyPrintTests/PrettyPrintTestCase.swift

@@ -17,37 +17,40 @@ public class PrettyPrintTestCase: XCTestCase {
   ) {
     configuration.lineLength = linelength
 
-    let context = Context(
-      configuration: configuration,
-      diagnosticEngine: nil,
-      fileURL: URL(fileURLWithPath: "/tmp/file.swift"),
-      sourceText: input)
-
     // Assert that the input, when formatted, is what we expected.
-    if let formatted = prettyPrintedSource(input, context: context) {
+    if let formatted = prettyPrintedSource(input, configuration: configuration) {
       XCTAssertEqual(
         expected, formatted,
         "Pretty-printed result was not what was expected",
         file: file, line: line)
 
       // Idempotency check: Running the formatter multiple times should not change the outcome.
       // Assert that running the formatter again on the previous result keeps it the same.
-      if let reformatted = prettyPrintedSource(formatted, context: context) {
+      if let reformatted = prettyPrintedSource(formatted, configuration: configuration) {
         XCTAssertEqual(
           formatted, reformatted, "Pretty printer is not idempotent", file: file, line: line)
       }
     }
   }
 
   /// Returns the given source code reformatted with the pretty printer.
-  private func prettyPrintedSource(_ original: String, context: Context) -> String? {
+  private func prettyPrintedSource(_ source: String, configuration: Configuration) -> String?
+  {
+    let sourceFileSyntax: SourceFileSyntax
     do {
-      let syntax = try SyntaxParser.parse(source: original)
-      let printer = PrettyPrinter(context: context, node: syntax, printTokenStream: false)
-      return printer.prettyPrint()
+      sourceFileSyntax = try SyntaxParser.parse(source: source)
     } catch {
       XCTFail("Parsing failed with error: \(error)")
       return nil
     }
+
+    let context = Context(
+      configuration: configuration,
+      diagnosticEngine: nil,
+      fileURL: URL(fileURLWithPath: "/tmp/file.swift"),
+      sourceFileSyntax: sourceFileSyntax)
+
+    let printer = PrettyPrinter(context: context, node: sourceFileSyntax, printTokenStream: false)
+    return printer.prettyPrint()
   }
 }

Tests/SwiftFormatRulesTests/DiagnosingTestCase.swift

@@ -37,13 +37,13 @@ public class DiagnosingTestCase: XCTestCase {
     }
   }
 
-  /// Creates and returns a new `Context` from the given source text.
-  private func makeContext(sourceText: String) -> Context {
+  /// Creates and returns a new `Context` from the given syntax tree.
+  private func makeContext(sourceFileSyntax: SourceFileSyntax) -> Context {
     let context = Context(
       configuration: Configuration(),
       diagnosticEngine: DiagnosticEngine(),
       fileURL: URL(fileURLWithPath: "/tmp/test.swift"),
-      sourceText: sourceText)
+      sourceFileSyntax: sourceFileSyntax)
     consumer = DiagnosticTrackingConsumer()
     context.diagnosticEngine?.addConsumer(consumer)
     return context
@@ -62,19 +62,22 @@ public class DiagnosingTestCase: XCTestCase {
     file: StaticString = #file,
     line: UInt = #line
   ) {
-    context = makeContext(sourceText: input)
+    let sourceFileSyntax: SourceFileSyntax
+    do {
+      sourceFileSyntax = try SyntaxParser.parse(source: input)
+    } catch {
+      XCTFail("\(error)", file: file, line: line)
+      return
+    }
+
+    self.context = makeContext(sourceFileSyntax: sourceFileSyntax)
 
     // If we're linting, then indicate that we want to fail for unasserted diagnostics when the test
     // is torn down.
     shouldCheckForUnassertedDiagnostics = true
 
-    do {
-      let syntax = try SyntaxParser.parse(source: input)
-      var linter = type.init(context: context!)
-      syntax.walk(&linter)
-    } catch {
-      XCTFail("\(error)", file: file, line: line)
-    }
+    var linter = type.init(context: context!)
+    sourceFileSyntax.walk(&linter)
   }
 
   /// Asserts that the result of applying a formatter to the provided input code yields the output.
@@ -97,17 +100,20 @@ public class DiagnosingTestCase: XCTestCase {
     line: UInt = #line,
     checkForUnassertedDiagnostics: Bool = false
   ) {
-    context = makeContext(sourceText: input)
-
+    let sourceFileSyntax: SourceFileSyntax
     do {
-      shouldCheckForUnassertedDiagnostics = checkForUnassertedDiagnostics
-      let syntax = try SyntaxParser.parse(source: input)
-      let formatter = formatType.init(context: context!)
-      let result = formatter.visit(syntax)
-      XCTAssertDiff(result: result.description, expected: expected, file: file, line: line)
+      sourceFileSyntax = try SyntaxParser.parse(source: input)
     } catch {
       XCTFail("\(error)", file: file, line: line)
+      return
     }
+
+    context = makeContext(sourceFileSyntax: sourceFileSyntax)
+
+    shouldCheckForUnassertedDiagnostics = checkForUnassertedDiagnostics
+    let formatter = formatType.init(context: context!)
+    let result = formatter.visit(sourceFileSyntax)
+    XCTAssertDiff(result: result.description, expected: expected, file: file, line: line)
   }
 
   /// Asserts that the two expressions have the same value, and provides a detailed

Tests/SwiftFormatWhitespaceLinterTests/WhitespaceTestCase.swift

@@ -50,11 +50,19 @@ public class WhitespaceTestCase: XCTestCase {
     expected: String,
     linelength: Int? = nil
   ) {
+    let sourceFileSyntax: SourceFileSyntax
+    do {
+      sourceFileSyntax = try SyntaxParser.parse(source: input)
+    } catch {
+      XCTFail("Parsing failed with error: \(error)")
+      return
+    }
+
     context = Context(
       configuration: Configuration(),
       diagnosticEngine: DiagnosticEngine(),
       fileURL: URL(fileURLWithPath: "/tmp/test.swift"),
-      sourceText: input
+      sourceFileSyntax: sourceFileSyntax
     )
     if let linelength = linelength {
       context?.configuration.lineLength = linelength