Rename Clock to MonotonicClock

voidcontext · Mar 21, 2020 · b87c4e0 · b87c4e0
1 parent 9c7aa14
commit b87c4e0
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/examples/src/main/scala/vdx/fetchfile/examples/Main.scala b/examples/src/main/scala/vdx/fetchfile/examples/Main.scala
@@ -1,6 +1,6 @@
 package vdx.fetchfile.examples
 
-import cats.effect.{Clock => _, _}
+import cats.effect._
 import cats.syntax.functor._
 import vdx.fetchfile._
 
@@ -10,7 +10,7 @@ import java.io.{File, FileOutputStream}
 object Main extends IOApp {
   def run(args: List[String]): IO[ExitCode] = {
 
-    implicit val clock: Clock = Clock.system
+    implicit val clock: MonotonicClock = MonotonicClock.system
 
     val outFile = new File("/tmp/100MB.bin")
 

diff --git a/.../src/main/scala/vdx/fetchfile/Clock.scala → .../scala/vdx/fetchfile/MonotonicClock.scala b/.../src/main/scala/vdx/fetchfile/Clock.scala → .../scala/vdx/fetchfile/MonotonicClock.scala
@@ -5,15 +5,15 @@ package vdx.fetchfile
  * In case of cats.effect.Clock[F], the evaluation of IO makes the stream slightly slower.
  * To avoid this performance impact, but still keep the progress tracker testable we introduce our own clock interface.
  */
-trait Clock {
+trait MonotonicClock {
   def nanoTime(): Long
 }
 
-object Clock {
+object MonotonicClock {
   /**
    * Simple clock implementation based on System.nanoTime()
    */
-  def system(): Clock = new Clock {
+  def system(): MonotonicClock = new MonotonicClock {
     def nanoTime(): Long = System.nanoTime()
   }
 }

diff --git a/fetch-file/src/main/scala/vdx/fetchfile/Progress.scala b/fetch-file/src/main/scala/vdx/fetchfile/Progress.scala
@@ -9,7 +9,7 @@ import java.util.Locale
 object Progress {
   def noop[F[_]]: Int => Pipe[F, Byte, Unit] = _ => _.map(_ => ())
 
-  def consoleProgress[F[_]: Sync](implicit clock: Clock): Int => Pipe[F, Byte, Unit] =
+  def consoleProgress[F[_]: Sync](implicit clock: MonotonicClock): Int => Pipe[F, Byte, Unit] =
     custom[F] { (downloadedBytes, contentLength, elapsedTime, downloadSpeed) =>
       println(
         s"\u001b[1A\u001b[100D\u001b[0KDownloaded ${bytesToString(downloadedBytes)} of " +
@@ -22,7 +22,7 @@ object Progress {
   def custom[F[_]: Sync](
     f: (Long, Int, Long, Long) => Unit,
     chunkLimit: Option[Int] = None
-  )(implicit clock: Clock): Int => Pipe[F, Byte, Unit] =
+  )(implicit clock: MonotonicClock): Int => Pipe[F, Byte, Unit] =
     contentLength => { s =>
       Stream.eval(Sync[F].delay(clock.nanoTime()))
         .flatMap { startTime =>

diff --git a/fetch-file/src/test/scala/vdx/fetchfile/ProgressSpec.scala b/fetch-file/src/test/scala/vdx/fetchfile/ProgressSpec.scala
@@ -20,7 +20,7 @@ class ProgressSpec extends AnyFlatSpec with Checkers {
 
         implicit val cs: ContextShift[IO] = IO.contextShift(ExecutionContext.global)
         var elapsedTime: Long = 0
-        implicit val clock: Clock = new Clock {
+        implicit val clock: MonotonicClock = new MonotonicClock {
           def nanoTime(): Long = {
             elapsedTime += 1000000
             elapsedTime