rename package from zio.http.html to zio.http.template to avoid ambig…

…uity (#2405) * rename package from zio.http.html to zio.http.template to avoid ambiguity * fix import
zio · Aug 29, 2023 · ac3e544 · ac3e544
1 parent 25bc720
commit ac3e544
Show file tree

Hide file tree

Showing 21 changed files with 39 additions and 39 deletions.
diff --git a/docs/dsl/response.md b/docs/dsl/response.md
@@ -47,7 +47,7 @@ Response.json("""{"greetings": "Hello World!"}""")
 
 `html` creates a response with data as html, content-type header set to text/html and status code 200
 ```scala mdoc
-import zio.http.html._
+import zio.http.template._
 
 Response.html(Html.fromString("html text"))
 ```

diff --git a/docs/dsl/html.md → docs/dsl/template.md b/docs/dsl/html.md → docs/dsl/template.md
@@ -1,9 +1,9 @@
 ---
-id: html
-title: Html
+id: template
+title: Template
 ---
 
-The package `zio.http.html._` contains lightweight helpers for generating statically typed, safe html similiar in spirit to `scalatags`. 
+The package `zio.http.template._` contains lightweight helpers for generating statically typed, safe html similiar in spirit to `scalatags`. 
 
 ## Html and DOM
 
@@ -13,7 +13,7 @@ One possible way is to create an instance of `Html` directly from a `String` val
 from the compiler:
 
 ```scala mdoc:silent
-import zio.http.html._
+import zio.http.template._
 
 val divHtml1: Html = Html.fromString("""<div class="container1 container2"><a href="http://zio.dev">ZIO Homepage</a></div>""")
 ```
@@ -24,7 +24,7 @@ In order to improve on type safety one could use `Html` with `Dom` constructor f
 code is much more verbose:
 
 ```scala mdoc:silent
-import zio.http.html._
+import zio.http.template._
 
 val divHtml2: Html = Html.fromDomElement(
   Dom.element(
@@ -48,7 +48,7 @@ elements like `div` or `a` but also html attributes like `hrefAttr` or `styleAtt
 are suffixed `attr` to easily distinguish those from html elements: 
 
 ```scala mdoc:silent
-import zio.http.html._
+import zio.http.template._
 
 val divHtml3: Html = div(
   classAttr := "container1" :: "container2" :: Nil,
@@ -68,7 +68,7 @@ of `a(hrefAttr := "http://zio.dev", "ZIO Homepage")` one can use `a(hrefAttr("ht
 One can compose values of `Html` sequentially using the operator `++` to produce a larger `Html`: 
 
 ```scala mdoc:silent
-import zio.http.html._
+import zio.http.template._
 
 val fullHtml: Html = divHtml1 ++ divHtml2 ++ divHtml3
 ```

diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -30,7 +30,7 @@ const sidebars = {
                 "dsl/socket/websocketframe"
               ]
             },
-            "dsl/html"
+            "dsl/template"
           ]
         },
         {

diff --git a/zio-http-example/src/main/scala/example/HtmlTemplating.scala b/zio-http-example/src/main/scala/example/HtmlTemplating.scala
@@ -6,7 +6,7 @@ import zio.http._
 
 object HtmlTemplating extends ZIOAppDefault {
   // Importing everything from `zio.html`
-  import zio.http.html._
+  import zio.http.template._
 
   def app: HttpApp[Any] = {
     // Html response takes in a `Html` instance.

diff --git a/zio-http-example/src/main/scala/example/StaticServer.scala b/zio-http-example/src/main/scala/example/StaticServer.scala
@@ -4,7 +4,7 @@ import zio.ZIOAppDefault
 
 import zio.http._
 import zio.http.codec.PathCodec.trailing
-import zio.http.html._
+import zio.http.template._
 
 object StaticServer extends ZIOAppDefault {
 

diff --git a/zio-http/src/main/scala/zio/http/Handler.scala b/zio-http/src/main/scala/zio/http/Handler.scala
@@ -17,7 +17,7 @@
 package zio.http
 
 import zio._
-import zio.http.html.{Html, Template}
+import zio.http.template.{Html, Template}
 import zio.http.Header.HeaderType
 import zio.http.internal.HeaderModifier
 import zio.stream.ZStream

diff --git a/zio-http/src/main/scala/zio/http/HandlerAspect.scala b/zio-http/src/main/scala/zio/http/HandlerAspect.scala
@@ -22,7 +22,7 @@ import java.nio.charset._
 import zio._
 import zio.metrics._
 
-import zio.http.html._
+import zio.http.template._
 
 /**
  * A [[zio.http.HandlerAspect]] is a kind of [[zio.http.ProtocolStack]] that is

diff --git a/zio-http/src/main/scala/zio/http/Response.scala b/zio-http/src/main/scala/zio/http/Response.scala
@@ -25,8 +25,8 @@ import zio.{Cause, Task, Trace, ZIO}
 
 import zio.stream.ZStream
 
-import zio.http.html.Html
 import zio.http.internal.HeaderOps
+import zio.http.template.Html
 
 final case class Response(
   status: Status = Status.Ok,

diff --git a/zio-http/src/main/scala/zio/http/codec/Doc.scala b/zio-http/src/main/scala/zio/http/codec/Doc.scala
@@ -18,7 +18,7 @@ package zio.http.codec
 
 import zio.stacktracer.TracingImplicits.disableAutoTrace
 
-import zio.http.html
+import zio.http.template
 
 /**
  * A `Doc` models documentation for an endpoint or input.
@@ -117,8 +117,8 @@ sealed trait Doc { self =>
     writer.toString()
   }
 
-  def toHtml: html.Html = {
-    import html._
+  def toHtml: template.Html = {
+    import template._
 
     self match {
       case Doc.Empty                      =>
@@ -347,8 +347,8 @@ object Doc {
         case Span.Sequence(left, right) => left.size + right.size
       }
 
-    def toHtml: html.Html = {
-      import html._
+    def toHtml: template.Html = {
+      import template._
 
       self match {
         case Span.Text(value)           => value

diff --git a/...main/scala/zio/http/html/Attributes.scala → .../scala/zio/http/template/Attributes.scala b/...main/scala/zio/http/html/Attributes.scala → .../scala/zio/http/template/Attributes.scala
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package zio.http.html
+package zio.http.template
 
-import zio.http.html.Attributes.PartialAttribute
+import zio.http.template.Attributes.PartialAttribute
 
 trait Attributes {
   final def acceptAttr: PartialAttribute[String] = PartialAttribute("accept")

diff --git a/...tp/src/main/scala/zio/http/html/Dom.scala → ...rc/main/scala/zio/http/template/Dom.scala b/...tp/src/main/scala/zio/http/html/Dom.scala → ...rc/main/scala/zio/http/template/Dom.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package zio.http.html
+package zio.http.template
 
 /**
  * Light weight DOM implementation that can be rendered as a html string.
@@ -32,7 +32,7 @@ sealed trait Dom { self =>
   def encode(spaces: Int): CharSequence =
     encode(EncodingState.Indentation(0, spaces))
 
-  private[html] def encode(state: EncodingState): CharSequence = self match {
+  private[template] def encode(state: EncodingState): CharSequence = self match {
     case Dom.Element(name, children) =>
       val attributes = children.collect { case self: Dom.Attribute => self.encode }
 

diff --git a/...c/main/scala/zio/http/html/Elements.scala → ...in/scala/zio/http/template/Elements.scala b/...c/main/scala/zio/http/html/Elements.scala → ...in/scala/zio/http/template/Elements.scala
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package zio.http.html
+package zio.http.template
 
-import zio.http.html.Element.PartialElement
+import zio.http.template.Element.PartialElement
 
 trait Elements {
   final def a: PartialElement = PartialElement("a")

diff --git a/...n/scala/zio/http/html/EncodingState.scala → ...ala/zio/http/template/EncodingState.scala b/...n/scala/zio/http/html/EncodingState.scala → ...ala/zio/http/template/EncodingState.scala
@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package zio.http.html
+package zio.http.template
 
-private[html] sealed trait EncodingState {
+private[template] sealed trait EncodingState {
   def nextElemSeparator: String
   def inner: EncodingState
 }

diff --git a/...p/src/main/scala/zio/http/html/Html.scala → ...c/main/scala/zio/http/template/Html.scala b/...p/src/main/scala/zio/http/html/Html.scala → ...c/main/scala/zio/http/template/Html.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package zio.http.html
+package zio.http.template
 
 import scala.language.implicitConversions
 
@@ -28,7 +28,7 @@ sealed trait Html { self =>
   def encode(spaces: Int): CharSequence =
     encode(EncodingState.Indentation(0, spaces))
 
-  private[html] def encode(state: EncodingState): CharSequence = {
+  private[template] def encode(state: EncodingState): CharSequence = {
     self match {
       case Html.Empty                        => ""
       case Html.Single(element)              => element.encode(state)

diff --git a/...cala/zio/http/html/IsAttributeValue.scala → .../zio/http/template/IsAttributeValue.scala b/...cala/zio/http/html/IsAttributeValue.scala → .../zio/http/template/IsAttributeValue.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package zio.http.html
+package zio.http.template
 
 import scala.language.implicitConversions
 

diff --git a/...c/main/scala/zio/http/html/Template.scala → ...in/scala/zio/http/template/Template.scala b/...c/main/scala/zio/http/html/Template.scala → ...in/scala/zio/http/template/Template.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package zio.http.html
+package zio.http.template
 
 /**
  * A ZIO Http styled general purpose templates

diff --git a/...rc/main/scala/zio/http/html/package.scala → ...ain/scala/zio/http/template/package.scala b/...rc/main/scala/zio/http/html/package.scala → ...ain/scala/zio/http/template/package.scala
@@ -16,4 +16,4 @@
 
 package zio.http
 
-package object html extends Attributes with Elements {}
+package object template extends Attributes with Elements {}
diff --git a/zio-http/src/test/scala/zio/http/ServerSpec.scala b/zio-http/src/test/scala/zio/http/ServerSpec.scala
@@ -26,8 +26,8 @@ import zio.test._
 
 import zio.stream.{ZPipeline, ZStream}
 
-import zio.http.html.{body, div, id}
 import zio.http.internal.{DynamicServer, HttpGen, HttpRunnableSpec}
+import zio.http.template.{body, div, id}
 
 object ServerSpec extends HttpRunnableSpec {
 
@@ -367,7 +367,7 @@ object ServerSpec extends HttpRunnableSpec {
       test("body") {
         val res =
           Handler
-            .html(zio.http.html.html(body(div(id := "foo", "bar"))))
+            .html(zio.http.template.html(body(div(id := "foo", "bar"))))
             .sandbox
             .toHttpApp
             .deploy
@@ -377,7 +377,7 @@ object ServerSpec extends HttpRunnableSpec {
         assertZIO(res)(equalTo("""<!DOCTYPE html><html><body><div id="foo">bar</div></body></html>"""))
       },
       test("content-type") {
-        val app = Handler.html(zio.http.html.html(body(div(id := "foo", "bar")))).sandbox.toHttpApp
+        val app = Handler.html(zio.http.template.html(body(div(id := "foo", "bar")))).sandbox.toHttpApp
         val res = app.deploy.header(Header.ContentType).run()
         assertZIO(res)(isSome(equalTo(Header.ContentType(MediaType.text.html))))
       },

diff --git a/...rc/test/scala/zio/http/html/DomSpec.scala → ...est/scala/zio/http/template/DomSpec.scala b/...rc/test/scala/zio/http/html/DomSpec.scala → ...est/scala/zio/http/template/DomSpec.scala
@@ -14,12 +14,12 @@
  * limitations under the License.
  */
 
-package zio.http.html
+package zio.http.template
 
 import zio.test.{assertTrue, check, checkAll}
 
 import zio.http.ZIOHttpSpec
-import zio.http.html.HtmlGen.{tagGen, voidTagGen}
+import zio.http.template.HtmlGen.{tagGen, voidTagGen}
 
 object DomSpec extends ZIOHttpSpec {
   def spec = suite("DomSpec")(

diff --git a/...rc/test/scala/zio/http/html/HtmlGen.scala → ...est/scala/zio/http/template/HtmlGen.scala b/...rc/test/scala/zio/http/html/HtmlGen.scala → ...est/scala/zio/http/template/HtmlGen.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package zio.http.html
+package zio.http.template
 
 import zio.test.Gen
 

diff --git a/...c/test/scala/zio/http/html/HtmlSpec.scala → ...st/scala/zio/http/template/HtmlSpec.scala b/...c/test/scala/zio/http/html/HtmlSpec.scala → ...st/scala/zio/http/template/HtmlSpec.scala
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package zio.http.html
+package zio.http.template
 
 import zio.test.Assertion.equalTo
 import zio.test._