added mima plugin, updated depemdencies

Author: rssh

build.sbt

@@ -2,15 +2,15 @@
 val dottyVersion = "3.0.1"
 //val dottyVersion = dottyLatestNightlyBuild.get
 
-ThisBuild/version := "2.0.7-SNAPSHOT"
+ThisBuild/version := "2.1.0"
 ThisBuild/versionScheme := Some("semver-spec")
 
 val sharedSettings = Seq(
     organization := "com.github.rssh",
     scalaVersion := dottyVersion,
     name := "scala-gopher",
     resolvers += "Local Ivy Repository" at "file://"+Path.userHome.absolutePath+"/.ivy2/local",
-    libraryDependencies += "com.github.rssh" %%% "dotty-cps-async" % "0.9.3-SNAPSHOT",
+    libraryDependencies += "com.github.rssh" %%% "dotty-cps-async" % "0.9.3",
     libraryDependencies += "org.scalameta" %%% "munit" % "0.7.27" % Test,
 )
 
@@ -42,6 +42,7 @@ lazy val gopher = crossProject(JSPlatform, JVMPlatform)
          s"-javaagent:${System.getProperty("user.home")}/.ivy2/local/com.github.rssh/trackedfuture_3/0.5.0/jars/trackedfuture_3-assembly.jar"
         )
         */
+        mimaPreviousArtifacts := Set( "com.github.rssh" %% "scala-gopher" % "2.0.6")
     ).jsSettings(
         libraryDependencies += ("org.scala-js" %%% "scalajs-java-logging" % "1.0.0").cross(CrossVersion.for3Use2_13),
         // TODO: switch to ModuleES ?

project/plugins.sbt

@@ -3,4 +3,4 @@ addSbtPlugin("com.typesafe.sbt" % "sbt-site" % "1.4.1")
 addSbtPlugin("com.typesafe.sbt" % "sbt-ghpages" % "0.6.3")
 addSbtPlugin("org.portable-scala" % "sbt-scalajs-crossproject"      % "1.0.0")
 addSbtPlugin("org.scala-js" % "sbt-scalajs"      % "1.7.0")
-
+addSbtPlugin("com.typesafe" % "sbt-mima-plugin" % "1.0.0")

shared/src/main/scala/gopher/Channel.scala

@@ -47,6 +47,9 @@ object Channel:
   case class FRead[F[_],A](a:A, ch: F[A])
   case class Write[F[_],A](a: A, ch: WriteChannel[F,A])
 
+  import cps.stream._ 
+
+
 
 end Channel
 

shared/src/main/scala/gopher/ReadChannel.scala

@@ -12,13 +12,17 @@ import scala.concurrent.duration.Duration
 import java.util.logging.{Level => LogLevel}
 
 /**
- * ReadChannel:  Interface providing reading API.  
+ * ReadChannel:  Interface providing asynchronous reading API.  
  * 
  **/
 trait ReadChannel[F[_], A]:
 
    thisReadChannel =>
 
+   /**
+    * Special type which is used in select statement.
+    *@see [gopher.Select]
+    **/   
    type read = A
 
    def gopherApi: Gopher[F]
@@ -45,7 +49,8 @@ trait ReadChannel[F[_], A]:
 
    /**
     * blocked read: if currently not element available - wait for one.
-    * Can be used only inside async block
+    * Can be used only inside async block.
+    * If stream is closed and no values to read left in the stream - throws StreamClosedException
     **/   
    transparent inline def read(): A = await(aread())(using rAsyncMonad)
 
@@ -74,9 +79,18 @@ trait ReadChannel[F[_], A]:
          b.result()
       }
 
+   /**
+   * take first `n` elements.
+   * should be called inside async block. 
+   **/   
    transparent inline def take(n: Int): IndexedSeq[A] =
       await(atake(n))(using rAsyncMonad)
 
+   /**
+    * read value and return future with
+    * - Some(value)  if value is available to read
+    * - None if stream is closed.
+    **/   
    def aOptRead(): F[Option[A]] =
        asyncMonad.adoptCallbackStyle( f =>
                    addReader(SimpleReader{ x => x match
@@ -86,6 +100,13 @@ trait ReadChannel[F[_], A]:
                                          })
        )
 
+   /**
+    * read value and return 
+    * - Some(value)  if value is available to read
+    * - None if stream is closed.
+    *
+    * should be called inside async block.
+    **/   
    transparent inline def optRead(): Option[A] = await(aOptRead())(using rAsyncMonad)
 
    def foreach_async(f: A=>F[Unit]): F[Unit] =
@@ -112,6 +133,7 @@ trait ReadChannel[F[_], A]:
    transparent inline def foreach(inline f: A=>Unit): Unit = 
       await(aforeach(f))(using rAsyncMonad)
 
+
    def map[B](f: A=>B): ReadChannel[F,B] =
       new MappedReadChannel(this, f)
 

shared/src/main/scala/gopher/WriteChannel.scala

@@ -7,6 +7,7 @@ import scala.annotation.targetName
 import scala.concurrent.duration.FiniteDuration
 import scala.util.Try
 
+
 trait WriteChannel[F[_], A]:
 
    type write = A

shared/src/test/scala/gopher/stream/BasicGeneratorSuite.scala

@@ -66,13 +66,9 @@ class BasicGeneratorSuite extends FunSuite {
         }  }
      }
 
-     
-     
-
+    
   }
 
-
-  /*
   test("exception should break loop in gopher generator") {
     val channel = asyncStream[ReadChannel[Future, Int]] { out =>
       for(i <- 1 to N) {
@@ -89,7 +85,8 @@ class BasicGeneratorSuite extends FunSuite {
 
     res.failed.map(ex => assert(ex.getMessage()=="bye"))
 
-  }*/
+  }
+
 
 
 }