Merge pull request #25 from natsukagami/transform-values-with

Rename source.map => transformValuesWith and add warning
lampepfl · Dec 10, 2023 · 793cf70 · 793cf70
2 parents 8f32c1b + b244be6
commit 793cf70
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 8 deletions.
diff --git a/shared/src/main/scala/async/Async.scala b/shared/src/main/scala/async/Async.scala
@@ -153,8 +153,11 @@ object Async:
     end values
 
   extension [T](src: Source[T])
-    /** Pass on data transformed by `f` */
-    def map[U](f: T => U) =
+    /** Create a new source that requires the original source to run the given transformation function on every value
+      * received. Note that [[f]] is **always** run on the computation that produces the values from the original
+      * source, so this is very likely to run **sequentially** and be a performance bottleneck.
+      */
+    def transformValuesWith[U](f: T => U) =
       new Source[U]:
         selfSrc =>
         def transform(k: Listener[U]) =
@@ -267,5 +270,5 @@ object Async:
     * continuation.
     */
   def either[T1, T2](src1: Source[T1], src2: Source[T2]): Source[Either[T1, T2]] =
-    race(src1.map(Left(_)), src2.map(Right(_)))
+    race(src1.transformValuesWith(Left(_)), src2.transformValuesWith(Right(_)))
 end Async
diff --git a/shared/src/test/scala/ChannelBehavior.scala b/shared/src/test/scala/ChannelBehavior.scala
@@ -254,7 +254,7 @@ class ChannelBehavior extends munit.FunSuite {
       }
       val race = Async.race(
         (0 until 100).map(i =>
-          Async.race((10 * i until 10 * i + 10).map(idx => channels(idx).readSource.map(_.right.get))*)
+          Async.race((10 * i until 10 * i + 10).map(idx => channels(idx).readSource.transformValuesWith(_.right.get))*)
         )*
       )
       var sum = 0

diff --git a/shared/src/test/scala/SourceBehavior.scala b/shared/src/test/scala/SourceBehavior.scala
@@ -127,12 +127,12 @@ class SourceBehavior extends munit.FunSuite {
       assertEquals(bRan, true)
   }
 
-  test("map") {
+  test("transform values with") {
     Async.blocking:
       val f: Future[Int] = Future { 10 }
-      assertEquals(f.map({ case Success(i) => i + 1 }).awaitResult, 11)
+      assertEquals(f.transformValuesWith({ case Success(i) => i + 1 }).awaitResult, 11)
       val g: Future[Int] = Future.now(Failure(AssertionError(1123)))
-      assertEquals(g.map({ case Failure(_) => 17 }).awaitResult, 17)
+      assertEquals(g.transformValuesWith({ case Failure(_) => 17 }).awaitResult, 17)
   }
 
   test("all listeners in chain fire") {
@@ -143,7 +143,7 @@ class SourceBehavior extends munit.FunSuite {
         sleep(50)
         10
       }
-      val g = f.map(identity)
+      val g = f.transformValuesWith(identity)
       f.onComplete(Listener.acceptingListener { (_, _) => aRan.complete(Success(())) })
       g.onComplete(Listener.acceptingListener { (_, _) => bRan.complete(Success(())) })
       assertEquals(aRan.future.poll(), None)