-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Render build matrix in the docs (#163)
- Loading branch information
Showing
3 changed files
with
192 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
105 changes: 105 additions & 0 deletions
105
modules/docs/src/main/scala/weaver/MatrixRendering.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| package weaver.docs | ||
|
|
||
| sealed trait CatsEffect | ||
| case object CE2 extends CatsEffect | ||
| case object CE3 extends CatsEffect | ||
|
|
||
| case class Artifact( | ||
| name: String, | ||
| jvm: Boolean, | ||
| js: Boolean, | ||
| scalaVersion: String, | ||
| catsEffect: CatsEffect, | ||
| version: String | ||
| ) | ||
|
|
||
| case class Cell( | ||
| jvm: Boolean, | ||
| js: Boolean, | ||
| version: String | ||
| ) | ||
|
|
||
| case class Row( | ||
| name: String, | ||
| ce2: Option[Cell], | ||
| ce3: Option[Cell] | ||
| ) | ||
|
|
||
| case class Table( | ||
| name: String, | ||
| rows: Vector[Row] | ||
| ) { | ||
| def _row(l: Seq[String], header: Boolean = false): String = { | ||
| val base = l.mkString("|", "|", "|") | ||
|
|
||
| if (header) base + "\n" + _row(l.map(_ => "---"), false) | ||
| else base + "\n" | ||
| } | ||
|
|
||
| def _cell(c: Option[Cell]): String = { | ||
| c match { | ||
| case Some(c) => | ||
| if (c.jvm && c.js) { | ||
| s"✅ `${c.version}`" | ||
| } else "❌" // TODO: do we always assume platform-complete artifacts? | ||
| case None => "❌" | ||
| } | ||
| } | ||
|
|
||
| def render(catsEffect3Version: String) = { | ||
| val sb = new StringBuilder | ||
| sb.append(_row(Seq(name, "Cats Effect 2", s"Cats Effect $catsEffect3Version"), header = true)) | ||
|
|
||
| rows.map { case Row(name, ce2, ce3) => | ||
| sb.append(_row(Seq(name, _cell(ce2), _cell(ce3)))) | ||
| } | ||
| sb.result() | ||
| } | ||
| } | ||
|
|
||
| object Table { | ||
| def row_name(artif: String) = artif match { | ||
| case "cats" => "Cats-Effect" | ||
| case "zio" => "ZIO" | ||
| case "monix" => "Monix" | ||
| case "monix-bio" => "Monix BIO" | ||
| case "scalacheck" => "ScalaCheck" | ||
| case "specs2" => "Specs2 matchers" | ||
| case _ => throw new RuntimeException("Not another effect type!") | ||
| } | ||
|
|
||
| def artifactsToCell(artifacts: List[Artifact]): Option[Cell] = { | ||
| artifacts.map(_.version).distinct.headOption.map { version => | ||
| val hasJVM = artifacts.exists(_.jvm) | ||
| val hasJS = artifacts.exists(_.js) | ||
|
|
||
| Cell( | ||
| jvm = hasJVM, | ||
| js = hasJS, | ||
| version = version | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| def create(name: String, artifacts: List[Artifact]): Table = { | ||
|
|
||
| val grouped = artifacts.groupBy(_.name) | ||
|
|
||
| val rows = grouped.map { | ||
| case (name, artifacts) => | ||
| val rowName = row_name(name) | ||
|
|
||
| val ce2Artifacts = artifacts.filter(_.catsEffect == CE2) | ||
| val ce3Artifacts = artifacts.filter(_.catsEffect == CE3) | ||
|
|
||
| Row(rowName, | ||
| artifactsToCell(ce2Artifacts), | ||
| artifactsToCell(ce3Artifacts)) | ||
| } | ||
|
|
||
| Table( | ||
| name, | ||
| rows.toVector.sortBy(_.name) | ||
| ) | ||
| } | ||
| } |