feat!: add plugin key to adapt links before they are added to the table

Author: giacomocavalieri

src/main/scala/dev/atedeg/EntityUtils.scala

@@ -32,8 +32,13 @@ object EntityParsing {
 
 object EntityConversion {
 
-  def entityToRow(namedEntity: (Option[String], Entity), baseDir: File, allEntities: Set[Entity]): Either[Error, Row] =
-    extractTermAndDefinition(baseDir / namedEntity._2.sanitizedLink, namedEntity._2, allEntities).map {
+  def entityToRow(
+      namedEntity: (Option[String], Entity),
+      baseDir: File,
+      allEntities: Set[Entity],
+      linkSolver: String => String,
+  ): Either[Error, Row] =
+    extractTermAndDefinition(baseDir / namedEntity._2.sanitizedLink, namedEntity._2, allEntities, linkSolver).map {
       case (term, definition) => Row.from(namedEntity._1.getOrElse(term), definition)
     }
 }

src/main/scala/dev/atedeg/HtmlParsing.scala

@@ -13,25 +13,40 @@ object HtmlParsing {
       file: File,
       entity: Entity,
       allEntities: Set[Entity],
+      linkSolver: String => String,
   ): Either[Error, (String, String)] = {
     val document = JsoupBrowser().parseFile(file.toJava)
     val docQuery = s"${entity.entityId.map("div#" + _ + " ").getOrElse("")}div.cover > div.doc"
-    extractTag(file, document, docQuery, allEntities).map((entity.name, _))
+    extractTag(file, document, docQuery, allEntities, linkSolver).map((entity.name, _))
   }
 
-  private def extractTag(file: File, doc: Browser#DocumentType, tag: String, all: Set[Entity]): Either[Error, String] =
-    doc.tryExtract(element(tag)).map(_.childNodes).toRight(ParseError(file, tag)).flatMap(toMarkdown(_, all))
+  private def extractTag(
+      file: File,
+      doc: Browser#DocumentType,
+      tag: String,
+      all: Set[Entity],
+      linkSolver: String => String,
+  ): Either[Error, String] =
+    doc
+      .tryExtract(element(tag))
+      .map(_.childNodes)
+      .toRight(ParseError(file, tag))
+      .flatMap(toMarkdown(_, all, linkSolver))
 
-  private def toMarkdown(elems: Iterable[Node], allEntities: Set[Entity]): Either[Error, String] = {
+  private def toMarkdown(
+      elems: Iterable[Node],
+      allEntities: Set[Entity],
+      linkSolver: String => String,
+  ): Either[Error, String] = {
     def isLink(elem: Element) = elem.tagName === "a"
-    def toMarkdownLink(elem: Element) = lookupLinkFor(extractName(elem)).map(l => s"[${elem.text}]($l)")
-    def lookupLinkFor(name: String) = allEntities.find(_.name === name).map("../" + _.link).toRight(MissingLink(name))
+    def toMarkdownLink(elem: Element) = lookupLinkFor(extractName(elem)).map(linkSolver).map(l => s"[${elem.text}]($l)")
+    def lookupLinkFor(name: String) = allEntities.find(_.name === name).map(_.link).toRight(MissingLink(name))
     def extractName(elem: Element) = elem.attr("href").replace(".html", "").split('$').last.split("/").last
     elems.foldLeft("".asRight[Error]) { (acc, elem) =>
       elem match {
         case TextNode(s) => acc.map(_ + s)
         case ElementNode(e) if isLink(e) => acc.flatMap(a => toMarkdownLink(e).map(a + _))
-        case ElementNode(e) => acc.flatMap(a => toMarkdown(e.childNodes, allEntities).map(a + _))
+        case ElementNode(e) => acc.flatMap(a => toMarkdown(e.childNodes, allEntities, linkSolver).map(a + _))
       }
     }
   }

src/main/scala/dev/atedeg/TableUtils.scala

@@ -15,9 +15,10 @@ object TableUtils {
       table: Table[(Option[String], Entity)],
       baseDir: File,
       allEntities: Set[Entity],
+      linkSolver: String => String,
   ): Either[Error, Table[Row]] =
     table.rows
-      .traverseError(entityToRow(_, baseDir, allEntities))
+      .traverseError(entityToRow(_, baseDir, allEntities, linkSolver))
       .map(Table(table.title, table.termName, table.definitionName, _))
 
   def serialize(table: Table[Row], targetDir: File): Try[Unit] = {

src/main/scala/dev/atedeg/Ubidoc.scala

@@ -15,12 +15,24 @@ import ConfigurationValidation._
 
 object Ubidoc {
 
-  def apply(lookupDir: JFile, targetDir: JFile, workingDir: JFile, logger: ManagedLogger): Unit =
-    Internals.ubiquitousScaladocTask(lookupDir.toScala, targetDir.toScala, workingDir.toScala, logger)
+  def apply(
+      lookupDir: JFile,
+      targetDir: JFile,
+      workingDir: JFile,
+      linkSolver: String => String,
+      logger: ManagedLogger,
+  ): Unit =
+    Internals.ubiquitousScaladocTask(lookupDir.toScala, targetDir.toScala, workingDir.toScala, linkSolver, logger)
 
   private object Internals {
 
-    def ubiquitousScaladocTask(lookupDir: File, targetDir: File, workingDir: File, logger: ManagedLogger): Unit = {
+    def ubiquitousScaladocTask(
+        lookupDir: File,
+        targetDir: File,
+        workingDir: File,
+        linkSolver: String => String,
+        logger: ManagedLogger,
+    ): Unit = {
       val result = for {
         config <- readConfiguration(workingDir)
         allEntities <- readAllEntities(lookupDir)
@@ -32,7 +44,7 @@ object Ubidoc {
           config.ignored,
           logger,
         )
-        tables <- tables.traverseError(entitiesToRows(_, lookupDir, allEntities))
+        tables <- tables.traverseError(entitiesToRows(_, lookupDir, allEntities, linkSolver))
       } yield tables.foreach(serialize(_, targetDir))
       result match {
         case Left(err) => throw UbidocException(err)

src/main/scala/dev/atedeg/UbiquitousScaladocKeys.scala

@@ -12,4 +12,9 @@ trait UbiquitousScaladocKeys {
 
   val targetDirectory: SettingKey[File] =
     settingKey[File]("The target directory where to put the generated Markdown tables")
+
+  val linkSolver: SettingKey[String => String] =
+    settingKey[String => String](
+      "A function to adapt the base link in case it needs to be changed to accomodate the site structure",
+    )
 }

src/main/scala/dev/atedeg/UbiquitousScaladocPlugin.scala

@@ -1,7 +1,7 @@
 package dev.atedeg
 
 import sbt.Keys.{ baseDirectory, streams }
-import sbt.{ AutoPlugin, Setting, Task }
+import sbt.{ AutoPlugin, Setting }
 
 @SuppressWarnings(Array("org.wartremover.warts.Any", "org.wartremover.warts.Nothing"))
 object UbiquitousScaladocPlugin extends AutoPlugin {
@@ -12,11 +12,13 @@ object UbiquitousScaladocPlugin extends AutoPlugin {
 
   import autoImport.*
 
-  override lazy val buildSettings: Seq[Setting[Task[Unit]]] = Seq(
+  override lazy val buildSettings: Seq[Setting[_]] = Seq(
+    ubidoc / linkSolver := ((s: String) => s),
     ubidoc := Ubidoc(
       (ubidoc / lookupDirectory).value,
       (ubidoc / targetDirectory).value,
       (ubidoc / baseDirectory).value,
+      (ubidoc / linkSolver).value,
       streams.value.log,
     ),
   )