Merge pull request #9 from bilal-fazlani/unify-package-name

unify package name by removing .protocol package
bilal-fazlani · Jul 13, 2023 · 9e965ce · 9e965ce
2 parents 98dba3e + dc4a2ab
commit 9e965ce
Show file tree

Hide file tree

Showing 32 changed files with 25 additions and 44 deletions.
diff --git a/docs/api-reference/index.md b/docs/api-reference/index.md
@@ -7,11 +7,10 @@ hide:
 # API Reference
 
 !!! tip
-    All the functionality of zio-maelstrom is available via two import statements
+    All the functionality of zio-maelstrom is available via following import statement
 
     ```scala
     import com.bilalfazlani.zioMaelstrom.*
-    import com.bilalfazlani.zioMaelstrom.protocol.*
     ```
 
 ## Primitive Types

diff --git a/examples/broadcast/src/main/scala/com/example/Main.scala b/examples/broadcast/src/main/scala/com/example/Main.scala
@@ -4,7 +4,6 @@ package com.example.broadcast
 import zio.json.*
 import zio.*
 import com.bilalfazlani.zioMaelstrom.*
-import com.bilalfazlani.zioMaelstrom.protocol.*
 // }
 
 // input_messages {

diff --git a/examples/echo/src/main/scala/com/example/Calculator.scala b/examples/echo/src/main/scala/com/example/Calculator.scala
@@ -2,7 +2,6 @@ package com.example.calculator
 
 import zio.json.*
 import zio.*
-import com.bilalfazlani.zioMaelstrom.protocol.*
 import com.bilalfazlani.zioMaelstrom.*
 
 // format: off

diff --git a/examples/echo/src/main/scala/com/example/ErrorDocs.scala b/examples/echo/src/main/scala/com/example/ErrorDocs.scala
@@ -1,7 +1,6 @@
 package com.example
 
 import com.bilalfazlani.zioMaelstrom.*
-import com.bilalfazlani.zioMaelstrom.protocol.*
 import zio.json.*
 import zio.*
 

diff --git a/examples/echo/src/main/scala/com/example/FileInputDocs.scala b/examples/echo/src/main/scala/com/example/FileInputDocs.scala
@@ -2,7 +2,6 @@ package com.example
 
 import zio.*
 import com.bilalfazlani.zioMaelstrom.*
-import com.bilalfazlani.zioMaelstrom.protocol.*
 import zio.json.*
 
 object Main extends ZIOAppDefault {

diff --git a/examples/echo/src/main/scala/com/example/IODocs.scala b/examples/echo/src/main/scala/com/example/IODocs.scala
@@ -1,7 +1,6 @@
 package com.example
 
 import com.bilalfazlani.zioMaelstrom.*
-import com.bilalfazlani.zioMaelstrom.protocol.*
 import zio.json.JsonCodec
 import zio.*
 

diff --git a/examples/echo/src/main/scala/com/example/KvStoreDocs.scala b/examples/echo/src/main/scala/com/example/KvStoreDocs.scala
@@ -1,7 +1,6 @@
 package com.example.kvstore
 
 import com.bilalfazlani.zioMaelstrom.*
-import com.bilalfazlani.zioMaelstrom.protocol.*
 import zio.*
 
 object SeqKvExample {

diff --git a/examples/echo/src/main/scala/com/example/Main.scala b/examples/echo/src/main/scala/com/example/Main.scala
@@ -3,7 +3,6 @@ package com.example.echo
 //imports {
 import zio.json.{JsonEncoder, JsonDecoder}
 import zio.{ZIOAppDefault, ZIO}
-import com.bilalfazlani.zioMaelstrom.protocol.*
 import com.bilalfazlani.zioMaelstrom.*
 //}
 

diff --git a/examples/echo/src/main/scala/com/example/PingPong.scala b/examples/echo/src/main/scala/com/example/PingPong.scala
@@ -2,7 +2,6 @@ package com.example.pingpong
 
 import zio.json.*
 import zio.*
-import com.bilalfazlani.zioMaelstrom.protocol.*
 import com.bilalfazlani.zioMaelstrom.*
 
 case class Ping(msg_id: MessageId, `type`: String = "ping") extends Sendable, NeedsReply

diff --git a/examples/echo/src/main/scala/com/example/TsoDocs.scala b/examples/echo/src/main/scala/com/example/TsoDocs.scala
@@ -1,7 +1,6 @@
 package com.example.tso
 
 import com.bilalfazlani.zioMaelstrom.*
-import com.bilalfazlani.zioMaelstrom.protocol.*
 import zio.*
 
 object TsoExample {

diff --git a/examples/unique-ids/src/main/scala/com/example/Main.scala b/examples/unique-ids/src/main/scala/com/example/Main.scala
@@ -1,7 +1,6 @@
 package com.example.uniqueIds
 
 //imports {
-import com.bilalfazlani.zioMaelstrom.protocol.*
 import com.bilalfazlani.zioMaelstrom.*
 import zio.json.{JsonDecoder, JsonEncoder}
 import zio.{ZIOAppDefault, ZIO, Ref, ZLayer}

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/CallbackRegistry.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/CallbackRegistry.scala
@@ -1,7 +1,6 @@
 package com.bilalfazlani.zioMaelstrom
 
 import zio.*
-import protocol.*
 import zio.concurrent.ConcurrentMap
 
 private case class TimedPromise(promise: Promise[AskError, GenericMessage], startTime: Long) {

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/Context.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/Context.scala
@@ -1,7 +1,5 @@
 package com.bilalfazlani.zioMaelstrom
 
-import protocol.*
-
 case class Context(me: NodeId, others: Set[NodeId])
 
 object Context:

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/DSL.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/DSL.scala
@@ -1,7 +1,6 @@
 package com.bilalfazlani.zioMaelstrom
 
 import java.nio.file.Path
-import protocol.*
 import zio.json.*
 import zio.*
 

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/GenericMessage.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/GenericMessage.scala
@@ -1,5 +1,4 @@
 package com.bilalfazlani.zioMaelstrom
-package protocol
 
 import zio.json.ast.Json
 import zio.json.JsonDecoder
@@ -12,9 +11,13 @@ private[zioMaelstrom] case class GenericDetails(
 
 extension (parent: Json)
   private def getChildOptional[A: JsonDecoder](field: String): Either[String, Option[A]] =
-    parent.asObject.flatMap(_.get(field)).fold(Right(None))(json => JsonDecoder[A].fromJsonAST(json).map(Some(_)))
+    parent.asObject
+      .flatMap(_.get(field))
+      .fold(Right(None))(json => JsonDecoder[A].fromJsonAST(json).map(Some(_)))
   private def getChild[A: JsonDecoder](field: String): Either[String, A] =
-    parent.asObject.flatMap(_.get(field)).fold(Left(s"missing field '$field'"))(json => JsonDecoder[A].fromJsonAST(json))
+    parent.asObject
+      .flatMap(_.get(field))
+      .fold(Left(s"missing field '$field'"))(json => JsonDecoder[A].fromJsonAST(json))
 
 private[zioMaelstrom] object GenericDetails {
   val empty = GenericDetails(None, None, None)
@@ -60,12 +63,22 @@ private[zioMaelstrom] case class GenericMessage(
 private[zioMaelstrom] object GenericMessage {
   given JsonDecoder[GenericMessage] = JsonDecoder[Json].mapOrFail[GenericMessage](ast =>
     for {
-      obj     <- ast.asObject.toRight("message is not a json object")
-      src     <- obj.getChild[NodeId]("src")
-      dest    <- obj.getChild[NodeId]("dest")
-      body    <- obj.getChildOptional[Json]("body")
-      details <- body.fold(Right(GenericDetails.empty))(body => JsonDecoder[GenericDetails].fromJsonAST(body))
-    } yield GenericMessage(src, dest, details.messageType, details.messageId, details.inReplyTo, body, ast)
+      obj  <- ast.asObject.toRight("message is not a json object")
+      src  <- obj.getChild[NodeId]("src")
+      dest <- obj.getChild[NodeId]("dest")
+      body <- obj.getChildOptional[Json]("body")
+      details <- body.fold(Right(GenericDetails.empty))(body =>
+        JsonDecoder[GenericDetails].fromJsonAST(body)
+      )
+    } yield GenericMessage(
+      src,
+      dest,
+      details.messageType,
+      details.messageId,
+      details.inReplyTo,
+      body,
+      ast
+    )
   )
 }
 

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/Initializer.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/Initializer.scala
@@ -1,6 +1,5 @@
 package com.bilalfazlani.zioMaelstrom
 
-import protocol.*
 import zio.*
 import zio.stream.{ZStream, ZSink}
 import zio.json.JsonDecoder

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/InputChannel.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/InputChannel.scala
@@ -2,7 +2,6 @@ package com.bilalfazlani.zioMaelstrom
 
 import zio.{Scope, ZIO, ZLayer}
 import zio.json.JsonDecoder
-import protocol.*
 
 private[zioMaelstrom] trait InputChannel:
   def partitionInputs: ZIO[Scope, Nothing, Inputs]

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/MessageIdStore.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/MessageIdStore.scala
@@ -1,7 +1,6 @@
 package com.bilalfazlani.zioMaelstrom
 
 import zio.{ZIO, Ref, ZLayer}
-import protocol.MessageId
 
 trait MessageIdStore:
   def next: ZIO[Any, Nothing, MessageId]

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/MessageSender.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/MessageSender.scala
@@ -1,6 +1,5 @@
 package com.bilalfazlani.zioMaelstrom
 
-import protocol.*
 import zio.*
 import zio.json.{JsonEncoder, JsonDecoder}
 
@@ -54,8 +53,8 @@ private case class MessageSenderLive(
       to: NodeId,
       timeout: Duration
   ): IO[AskError, Res] = for {
-    _ <- send(body, to)
-    _ <- logger.debug(s"waiting for reply from ${to} for message id ${body.msg_id}...")
+    _              <- send(body, to)
+    _              <- logger.debug(s"waiting for reply from ${to} for message id ${body.msg_id}...")
     genericMessage <- ZIO.scoped(callbackRegistry.awaitCallback(body.msg_id, to, timeout))
     decoded <-
       if genericMessage.isError then {

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/OutputChannel.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/OutputChannel.scala
@@ -1,7 +1,6 @@
 package com.bilalfazlani.zioMaelstrom
 
 import zio.*
-import protocol.*
 import zio.json.{JsonEncoder, EncoderOps}
 
 private[zioMaelstrom] trait OutputChannel:

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/Protocol.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/Protocol.scala
@@ -1,5 +1,4 @@
 package com.bilalfazlani.zioMaelstrom
-package protocol
 
 import zio.json.*
 import scala.annotation.targetName

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/RequestHandler.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/RequestHandler.scala
@@ -1,6 +1,5 @@
 package com.bilalfazlani.zioMaelstrom
 
-import protocol.*
 import zio.*
 import zio.json.*
 

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/services/KvImpl.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/services/KvImpl.scala
@@ -2,7 +2,6 @@ package com.bilalfazlani.zioMaelstrom
 
 import zio.*
 import zio.json.*
-import protocol.*
 
 private[zioMaelstrom] trait KvService:
 

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/services/KvMessages.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/services/KvMessages.scala
@@ -2,7 +2,6 @@ package com.bilalfazlani.zioMaelstrom
 
 import zio.*
 import zio.json.*
-import protocol.*
 
 private[zioMaelstrom] case class KvRead[Key](key: Key, msg_id: MessageId, `type`: String = "read")
     extends NeedsReply,

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/services/LinKv.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/services/LinKv.scala
@@ -1,6 +1,5 @@
 package com.bilalfazlani.zioMaelstrom
 
-import protocol.*
 import zio.*
 import zio.json.*
 

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/services/LinTso.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/services/LinTso.scala
@@ -1,6 +1,5 @@
 package com.bilalfazlani.zioMaelstrom
 
-import protocol.*
 import zio.*
 import zio.json.*
 

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/services/LwwKv.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/services/LwwKv.scala
@@ -1,6 +1,5 @@
 package com.bilalfazlani.zioMaelstrom
 
-import protocol.*
 import zio.*
 import zio.json.*
 

diff --git a/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/services/SeqKv.scala b/zio-maelstrom/src/main/scala/com/bilal-fazlani/zio-maelstrom/services/SeqKv.scala
@@ -1,6 +1,5 @@
 package com.bilalfazlani.zioMaelstrom
 
-import protocol.*
 import zio.*
 import zio.json.*
 

diff --git a/zio-maelstrom/src/test/scala/com/bilal-fazlani/zio-maelstrom/RPCTest.scala b/zio-maelstrom/src/test/scala/com/bilal-fazlani/zio-maelstrom/RPCTest.scala
@@ -2,7 +2,6 @@ package com.bilalfazlani.zioMaelstrom
 
 import zio.test.*
 import zio.*
-import com.bilalfazlani.zioMaelstrom.protocol.*
 import zio.json.*
 import testkit.TestRuntime
 import testkit.TestRuntime.*

diff --git a/zio-maelstrom/src/test/scala/com/bilal-fazlani/zio-maelstrom/RequestHandlerTests.scala b/zio-maelstrom/src/test/scala/com/bilal-fazlani/zio-maelstrom/RequestHandlerTests.scala
@@ -5,7 +5,6 @@ import zio.*
 import zio.json.*
 import testkit.TestRuntime
 import testkit.TestRuntime.*
-import com.bilalfazlani.zioMaelstrom.protocol.*
 
 object RequestHandlerTest extends ZIOSpecDefault {
   def isCI        = sys.env.get("CI").contains("true")

diff --git a/zio-maelstrom/src/test/scala/com/bilal-fazlani/zio-maelstrom/testkit/KvFake.scala b/zio-maelstrom/src/test/scala/com/bilal-fazlani/zio-maelstrom/testkit/KvFake.scala
@@ -3,7 +3,6 @@ package testkit
 
 import zio.*
 import zio.json.*
-import protocol.*
 
 case class KvFake(ref: Ref.Synchronized[Map[Any, Any]], messageIdStore: MessageIdStore)
     extends KvService:

diff --git a/zio-maelstrom/src/test/scala/com/bilal-fazlani/zio-maelstrom/testkit/TestRuntime.scala b/zio-maelstrom/src/test/scala/com/bilal-fazlani/zio-maelstrom/testkit/TestRuntime.scala
@@ -2,7 +2,6 @@ package com.bilalfazlani.zioMaelstrom
 package testkit
 
 import zio.*
-import protocol.*
 import zio.json.{JsonEncoder, EncoderOps}
 
 type TestRuntime = MaelstromRuntime & Queue[Message[Sendable]] & Queue[String] & CallbackRegistry