XCTUnimplemented -> unimplemented (#1530)

Author: stephencelis

ComposableArchitecture.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -61,7 +61,7 @@ private enum ScreenshotsKey: DependencyKey {
         .map { _ in }
     )
   }
-  static let testValue: @Sendable () async -> AsyncStream<Void> = XCTUnimplemented(
+  static let testValue: @Sendable () async -> AsyncStream<Void> = unimplemented(
     #"@Dependency(\.screenshots)"#, placeholder: .finished
   )
 }

Examples/CaseStudies/SwiftUICaseStudies/02-Effects-LongLiving.swift

@@ -326,10 +326,10 @@ extension WebSocketClient: DependencyKey {
   }
 
   static let testValue = Self(
-    open: XCTUnimplemented("\(Self.self).open", placeholder: AsyncStream.never),
-    receive: XCTUnimplemented("\(Self.self).receive"),
-    send: XCTUnimplemented("\(Self.self).send"),
-    sendPing: XCTUnimplemented("\(Self.self).sendPing")
+    open: unimplemented("\(Self.self).open", placeholder: AsyncStream.never),
+    receive: unimplemented("\(Self.self).receive"),
+    send: unimplemented("\(Self.self).send"),
+    sendPing: unimplemented("\(Self.self).sendPing")
   )
 }
 

Examples/CaseStudies/SwiftUICaseStudies/02-Effects-WebSocket.swift

@@ -47,6 +47,6 @@ extension DownloadClient: DependencyKey {
   )
 
   static let testValue = Self(
-    download: XCTUnimplemented("\(Self.self).download")
+    download: unimplemented("\(Self.self).download")
   )
 }

Examples/CaseStudies/SwiftUICaseStudies/04-HigherOrderReducers-ResuableOfflineDownloads/DownloadClient.swift

@@ -29,6 +29,6 @@ extension FactClient: DependencyKey {
   /// This is the "unimplemented" fact dependency that is useful to plug into tests that you want
   /// to prove do not need the dependency.
   static let testValue = Self(
-    fetch: XCTUnimplemented("\(Self.self).fetch")
+    fetch: unimplemented("\(Self.self).fetch")
   )
 }

Examples/CaseStudies/SwiftUICaseStudies/FactClient.swift

@@ -50,8 +50,8 @@ extension WeatherClient: TestDependencyKey {
   )
 
   static let testValue = Self(
-    forecast: XCTUnimplemented("\(Self.self).forecast"),
-    search: XCTUnimplemented("\(Self.self).search")
+    forecast: unimplemented("\(Self.self).forecast"),
+    search: unimplemented("\(Self.self).search")
   )
 }
 

Examples/Search/Search/WeatherClient.swift

@@ -67,11 +67,11 @@ extension SpeechClient: TestDependencyKey {
   }
 
   static let testValue = Self(
-    finishTask: XCTUnimplemented("\(Self.self).finishTask"),
-    requestAuthorization: XCTUnimplemented(
+    finishTask: unimplemented("\(Self.self).finishTask"),
+    requestAuthorization: unimplemented(
       "\(Self.self).requestAuthorization", placeholder: .notDetermined
     ),
-    startTask: XCTUnimplemented("\(Self.self).recognitionTask", placeholder: .never)
+    startTask: unimplemented("\(Self.self).recognitionTask", placeholder: .never)
   )
 }
 

Examples/SpeechRecognition/SpeechRecognition/SpeechClient/Client.swift

@@ -73,8 +73,8 @@ public struct AuthenticationClient: Sendable {
 
 extension AuthenticationClient: TestDependencyKey {
   public static var testValue = Self(
-    login: XCTUnimplemented("\(Self.self).login"),
-    twoFactor: XCTUnimplemented("\(Self.self).twoFactor")
+    login: unimplemented("\(Self.self).login"),
+    twoFactor: unimplemented("\(Self.self).twoFactor")
   )
 }
 

Examples/TicTacToe/tic-tac-toe/Sources/AuthenticationClient/AuthenticationClient.swift

@@ -15,7 +15,7 @@ extension AudioPlayerClient: TestDependencyKey {
   )
 
   static let testValue = Self(
-    play: XCTUnimplemented("\(Self.self).play")
+    play: unimplemented("\(Self.self).play")
   )
 }
 

Examples/VoiceMemos/VoiceMemos/AudioPlayerClient/AudioPlayerClient.swift

@@ -34,12 +34,12 @@ extension AudioRecorderClient: TestDependencyKey {
   }
 
   static let testValue = Self(
-    currentTime: XCTUnimplemented("\(Self.self).currentTime", placeholder: nil),
-    requestRecordPermission: XCTUnimplemented(
+    currentTime: unimplemented("\(Self.self).currentTime", placeholder: nil),
+    requestRecordPermission: unimplemented(
       "\(Self.self).requestRecordPermission", placeholder: false
     ),
-    startRecording: XCTUnimplemented("\(Self.self).startRecording", placeholder: false),
-    stopRecording: XCTUnimplemented("\(Self.self).stopRecording")
+    startRecording: unimplemented("\(Self.self).startRecording", placeholder: false),
+    stopRecording: unimplemented("\(Self.self).stopRecording")
   )
 }
 

Examples/VoiceMemos/VoiceMemos/AudioRecorderClient/AudioRecorderClient.swift

@@ -16,7 +16,7 @@ extension DependencyValues {
         UIApplication.shared.open(URL(string: UIApplication.openSettingsURLString)!)
       }
     }
-    static let testValue: @Sendable () async -> Void = XCTUnimplemented(
+    static let testValue: @Sendable () async -> Void = unimplemented(
       #"@Dependency(\.openSettings)"#
     )
   }
@@ -28,7 +28,7 @@ extension DependencyValues {
 
   private enum TemporaryDirectoryKey: DependencyKey {
     static let liveValue: @Sendable () -> URL = { URL(fileURLWithPath: NSTemporaryDirectory()) }
-    static let testValue: @Sendable () -> URL = XCTUnimplemented(
+    static let testValue: @Sendable () -> URL = unimplemented(
       #"@Dependency(\.temporaryDirectory)"#
     )
   }

Examples/VoiceMemos/VoiceMemos/Dependencies.swift

@@ -315,27 +315,20 @@ Unfortunately, `XCTFail` cannot be used in non-test targets, and so this instanc
 in the same file where your dependency is registered. To work around this you can use our
 [XCTestDynamicOverlay][xctest-dynamic-overlay-gh] library that dynamically invokes `XCTFail` and
 it is automatically accessible when using the Composable Architecture. It also comes with some
-helpers to ease the construction of these unimplemented values:
+helpers to ease the construction of these unimplemented values, which we can use when defining the
+`testValue` of your dependency:
 
 ```swift
 import XCTestDynamicOverlay
 
 extension APIClient {
-  static let unimplemented = Self(
-    fetchUser: XCTUnimplemented("APIClient.fetchUser")
-    fetchUsers: XCTUnimplemented("APIClient.fetchUsers")
+  static let testValue = Self(
+    fetchUser: unimplemented("APIClient.fetchUser")
+    fetchUsers: unimplemented("APIClient.fetchUsers")
   )
 }
 ```
 
-This is now the value that is most appropriate to use as the `testValue` of your dependency:
-
-```swift
-extension APIClient: TestDependencyKey {
-  static let testValue = APIClient.unimplemented
-}
-```
-
 The other requirement of `TestDependencyKey` is `previewValue`, and if this value is implemented
 it will be used whenever your feature is run in an Xcode preview. Previews are similar to tests in
 that you usually do not want to interact with the outside world, such as making network requests.

Sources/ComposableArchitecture/Documentation.docc/Articles/DependencyManagement.md

@@ -490,17 +490,17 @@ extension EffectPublisher {
   ///
   /// > Important: This Combine-based interface has been soft-deprecated in favor of Swift
   /// > concurrency. Prefer using async functions and `AsyncStream`s directly in your dependencies,
-  /// > and using `XCTUnimplemented` from the [XCTest Dynamic Overlay](gh-xctest-dynamic-overlay)
+  /// > and using `unimplemented` from the [XCTest Dynamic Overlay](gh-xctest-dynamic-overlay)
   /// > library to stub in a function that fails when invoked:
   /// >
   /// > ```swift
   /// > struct NumberFactClient {
   /// >   var fetch: (Int) async throws -> String
   /// > }
   /// >
-  /// > extension NumberFactClient {
-  /// >   static let unimplemented = Self(
-  /// >     fetch: XCTUnimplemented(
+  /// > extension NumberFactClient: TestDependencyKey {
+  /// >   static let testValue = Self(
+  /// >     fetch: unimplemented(
   /// >       "\(Self.self).fetch",
   /// >       placeholder: "Not an interesting number."
   /// >     )
@@ -590,16 +590,16 @@ extension EffectPublisher {
   ///   messages.
   /// - Returns: An effect that causes a test to fail if it runs.
   @available(
-    iOS, deprecated: 9999.0, message: "Call 'XCTUnimplemented' from your dependencies, instead."
+    iOS, deprecated: 9999.0, message: "Call 'unimplemented' from your dependencies, instead."
   )
   @available(
-    macOS, deprecated: 9999.0, message: "Call 'XCTUnimplemented' from your dependencies, instead."
+    macOS, deprecated: 9999.0, message: "Call 'unimplemented' from your dependencies, instead."
   )
   @available(
-    tvOS, deprecated: 9999.0, message: "Call 'XCTUnimplemented' from your dependencies, instead."
+    tvOS, deprecated: 9999.0, message: "Call 'unimplemented' from your dependencies, instead."
   )
   @available(
-    watchOS, deprecated: 9999.0, message: "Call 'XCTUnimplemented' from your dependencies, instead."
+    watchOS, deprecated: 9999.0, message: "Call 'unimplemented' from your dependencies, instead."
   )
   public static func unimplemented(_ prefix: String) -> Self {
     .fireAndForget {