Rename certain Effect APIs (pointfreeco#92)

* Rename certain Effect APIs * Move deprecations * Fix
johankool · May 13, 2020 · 0807f9a · 0807f9a
1 parent 940207c
commit 0807f9a
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 10 deletions.
diff --git a/...s/SwiftUICaseStudies/04-HigherOrderReducers-ResuableOfflineDownloads/DownloadClient.swift b/...s/SwiftUICaseStudies/04-HigherOrderReducers-ResuableOfflineDownloads/DownloadClient.swift
@@ -24,7 +24,7 @@ extension DownloadClient {
       }
     },
     download: { id, url in
-      Effect.async { subscriber in
+      .run { subscriber in
         let task = URLSession.shared.dataTask(with: url) { data, _, error in
           switch (data, error) {
           case let (.some(data), _):
@@ -54,7 +54,8 @@ extension DownloadClient {
           dependencies[id] = nil
         }
       }
-    })
+    }
+  )
 }
 
 private struct Dependencies {

diff --git a/Examples/MotionManager/MotionManager/MotionClient/Live.swift b/Examples/MotionManager/MotionManager/MotionClient/Live.swift
@@ -5,7 +5,7 @@ import CoreMotion
 extension MotionClient {
   static let live = MotionClient(
     create: { id in
-      Effect.async { subscriber in
+      .run { subscriber in
         let manager = MotionManager(
           manager: CMMotionManager(),
           handler: { motion, error in

diff --git a/Examples/SpeechRecognition/SpeechRecognition/SpeechClient/Live.swift b/Examples/SpeechRecognition/SpeechRecognition/SpeechClient/Live.swift
@@ -17,7 +17,7 @@ extension SpeechClient {
       }
     },
     recognitionTask: { id, request in
-      Effect.async { subscriber in
+      Effect.run { subscriber in
         let cancellable = AnyCancellable {
           dependencies[id]?.cancel()
           dependencies[id] = nil

diff --git a/Sources/ComposableArchitecture/Effect.swift b/Sources/ComposableArchitecture/Effect.swift
@@ -140,7 +140,7 @@ public struct Effect<Output, Failure: Error>: Publisher {
   /// sending the current status immediately, and then if the current status is `notDetermined` it
   /// can request authorization, and once a status is received it can send that back to the effect:
   ///
-  ///     Effect.async { subscriber in
+  ///     Effect.run { subscriber in
   ///       subscriber.send(MPMediaLibrary.authorizationStatus())
   ///
   ///       guard MPMediaLibrary.authorizationStatus() == .notDetermined else {
@@ -161,7 +161,7 @@ public struct Effect<Output, Failure: Error>: Publisher {
   /// - Parameter work: A closure that accepts a `Subscriber` value and returns a cancellable. When
   ///   the `Effect` is completed, the cancellable will be used to clean up any resources created
   ///   when the effect was started.
-  public static func async(
+  public static func run(
     _ work: @escaping (Effect.Subscriber<Output, Failure>) -> Cancellable
   ) -> Self {
     AnyPublisher.create(work).eraseToEffect()
@@ -243,7 +243,7 @@ extension Effect where Failure == Swift.Error {
   ///
   /// For example, to load a user from some JSON on the disk, one can wrap that work in an effect:
   ///
-  ///     Effect<User, Error>.sync {
+  ///     Effect<User, Error>.catching {
   ///       let fileUrl = URL(
   ///         fileURLWithPath: NSSearchPathForDirectoriesInDomains(
   ///           .documentDirectory, .userDomainMask, true
@@ -257,7 +257,7 @@ extension Effect where Failure == Swift.Error {
   ///
   /// - Parameter work: A closure encapsulating some work to execute in the real world.
   /// - Returns: An effect.
-  public static func sync(_ work: @escaping () throws -> Output) -> Self {
+  public static func catching(_ work: @escaping () throws -> Output) -> Self {
     .future { $0(Result { try work() }) }
   }
 }

diff --git a/Sources/ComposableArchitecture/Internal/Deprecations.swift b/Sources/ComposableArchitecture/Internal/Deprecations.swift
@@ -0,0 +1,19 @@
+import Combine
+
+// NB: Deprecated after 0.1.3:
+
+extension Effect {
+  @available(*, deprecated, renamed: "run")
+  public static func async(
+    _ work: @escaping (Effect.Subscriber<Output, Failure>) -> Cancellable
+  ) -> Self {
+    self.run(work)
+  }
+}
+
+extension Effect where Failure == Swift.Error {
+  @available(*, deprecated, renamed: "catching")
+  public static func sync(_ work: @escaping () throws -> Output) -> Self {
+    self.catching(work)
+  }
+}
diff --git a/Tests/ComposableArchitectureTests/EffectTests.swift b/Tests/ComposableArchitectureTests/EffectTests.swift
@@ -93,7 +93,7 @@ final class EffectTests: XCTestCase {
   }
 
   func testEffectSubscriberInitializer() {
-    let effect = Effect<Int, Never>.async { subscriber in
+    let effect = Effect<Int, Never>.run { subscriber in
       subscriber.send(1)
       subscriber.send(2)
       self.scheduler.schedule(after: self.scheduler.now.advanced(by: .seconds(1))) {
@@ -130,7 +130,7 @@ final class EffectTests: XCTestCase {
   func testEffectSubscriberInitializer_WithCancellation() {
     struct CancelId: Hashable {}
 
-    let effect = Effect<Int, Never>.async { subscriber in
+    let effect = Effect<Int, Never>.run { subscriber in
       subscriber.send(1)
       self.scheduler.schedule(after: self.scheduler.now.advanced(by: .seconds(1))) {
         subscriber.send(2)