validate html (#406)

jaredsburrows · Jan 27, 2024 · 8ab4734 · 8ab4734
1 parent ccc85ad
commit 8ab4734
Show file tree

Hide file tree

Showing 8 changed files with 257 additions and 222 deletions.
diff --git a/build.gradle b/build.gradle
@@ -11,6 +11,7 @@ plugins {
   alias(libs.plugins.maven.publish) apply false
   alias(libs.plugins.plugin.publish) apply false
   alias(libs.plugins.versions)
+  alias(libs.plugins.license)
   id 'java-gradle-plugin'
   id 'java-library'
   id 'groovy'

diff --git a/gradle-license-plugin/src/main/kotlin/com/jaredsburrows/license/internal/ConsoleRenderer.kt b/gradle-license-plugin/src/main/kotlin/com/jaredsburrows/license/internal/ConsoleRenderer.kt
@@ -9,7 +9,7 @@ import java.net.URISyntaxException
 /**
  * Renders information in a format suitable for logging to the console.
  *
- * Taken from: https://github.com/gradle/gradle/blob/master/subprojects/logging/src/main/java/org/gradle/internal/logging/ConsoleRenderer.java
+ * Taken from: https://github.com/gradle/gradle/blob/f3828bbb3350292dcbea7f505464eb5d30cb9d44/platforms/core-runtime/logging/src/main/java/org/gradle/internal/logging/ConsoleRenderer.java
  */
 class ConsoleRenderer {
 
@@ -29,7 +29,7 @@ class ConsoleRenderer {
 /**
  * Wraps a checked exception. Carries no other context.
  *
- * Taken from: https://github.com/gradle/gradle/blob/master/subprojects/base-services/src/main/java/org/gradle/internal/UncheckedException.java
+ * Taken from: https://github.com/gradle/gradle/blob/f3828bbb3350292dcbea7f505464eb5d30cb9d44/platforms/core-runtime/base-services/src/main/java/org/gradle/internal/UncheckedException.java
  */
 private class UncheckedException : RuntimeException {
   constructor(cause: Throwable) : super(cause)

diff --git a/...le-license-plugin/src/main/kotlin/com/jaredsburrows/license/internal/report/HtmlReport.kt b/...le-license-plugin/src/main/kotlin/com/jaredsburrows/license/internal/report/HtmlReport.kt
@@ -1,28 +1,27 @@
 package com.jaredsburrows.license.internal.report
 
 import com.jaredsburrows.license.internal.LicenseHelper
-import kotlinx.html.A
 import kotlinx.html.Entities
-import kotlinx.html.FlowOrInteractiveOrPhrasingContent
 import kotlinx.html.HTML
 import kotlinx.html.HtmlTagMarker
 import kotlinx.html.TagConsumer
-import kotlinx.html.attributesMapOf
+import kotlinx.html.a
 import kotlinx.html.body
 import kotlinx.html.br
+import kotlinx.html.dd
 import kotlinx.html.dl
 import kotlinx.html.dt
 import kotlinx.html.h3
 import kotlinx.html.head
 import kotlinx.html.hr
+import kotlinx.html.id
 import kotlinx.html.li
 import kotlinx.html.pre
 import kotlinx.html.stream.appendHTML
 import kotlinx.html.style
 import kotlinx.html.title
 import kotlinx.html.ul
 import kotlinx.html.unsafe
-import kotlinx.html.visit
 import kotlinx.html.visitAndFinalize
 import org.apache.maven.model.License
 import org.apache.maven.model.Model
@@ -86,15 +85,16 @@ class HtmlReport(private val projects: List<Model>) : Report {
             h3 {
               +NOTICE_LIBRARIES
             }
-            ul {
-              projectsMap.entries.forEach { entry ->
+
+            projectsMap.entries.forEach { entry ->
+              var currentProject: Model? = null
+              var currentLicense: Int? = null
+
+              ul {
                 val sortedProjects = entry.value.sortedWith(
                   compareBy(String.CASE_INSENSITIVE_ORDER) { it.name },
                 )
 
-                var currentProject: Model? = null
-                var currentLicense: Int? = null
-
                 sortedProjects.forEach { project ->
                   currentProject = project
                   currentLicense = entry.key.hashCode()
@@ -114,64 +114,66 @@ class HtmlReport(private val projects: List<Model>) : Report {
                             +Entities.copy
                             +" $copyrightYear ${developer.id}"
                           }
+                          dd { }
                         }
                       } else {
                         dt {
                           +COPYRIGHT
                           +Entities.copy
                           +" $copyrightYear $DEFAULT_AUTHOR"
                         }
+                        dd { }
                       }
                     }
                   }
                 }
+              }
 
-                // This isn't correctly indented in the html source (but is otherwise correct).
-                // It appears to be a bug in the DSL implementation from what little I see on the web.
-                a(name = currentLicense.toString())
+              a {
+                id = currentLicense.toString()
+              }
 
-                // Display associated license text with libraries
-                val licenses = currentProject?.licenses
-                if (licenses.isNullOrEmpty()) {
-                  pre {
-                    +NO_LICENSE
-                  }
-                } else {
-                  licenses.forEach { license ->
-                    val key = getLicenseKey(license)
-                    if (key.isNotEmpty() && licenseMap.values.contains(key)) {
-                      // license from license map
+              // Display associated license text with libraries
+              val licenses = currentProject?.licenses
+              if (licenses.isNullOrEmpty()) {
+                pre {
+                  +NO_LICENSE
+                }
+              } else {
+                licenses.forEach { license ->
+                  val key = getLicenseKey(license)
+                  if (key.isNotEmpty() && licenseMap.values.contains(key)) {
+                    // license from license map
+                    pre {
+                      unsafe { +getLicenseText(key) }
+                    }
+                  } else {
+                    // if not found in the map, just display the info from the POM.xml
+                    val currentLicenseName = license.name.trim()
+                    val currentUrl = license.url.trim()
+
+                    if (currentLicenseName.isNotEmpty() && currentUrl.isNotEmpty()) {
+                      pre {
+                        unsafe { +"$currentLicenseName\n<a href=\"$currentUrl\">$currentUrl</a>" }
+                      }
+                    } else if (currentUrl.isNotEmpty()) {
                       pre {
-                        unsafe { +getLicenseText(key) }
+                        unsafe { +"<a href=\"$currentUrl\">$currentUrl</a>" }
+                      }
+                    } else if (currentLicenseName.isNotEmpty()) {
+                      pre {
+                        unsafe { +"$currentLicenseName\n" }
                       }
                     } else {
-                      // if not found in the map, just display the info from the POM.xml
-                      val currentLicenseName = license.name.trim()
-                      val currentUrl = license.url.trim()
-
-                      if (currentLicenseName.isNotEmpty() && currentUrl.isNotEmpty()) {
-                        pre {
-                          unsafe { +"$currentLicenseName\n<a href=\"$currentUrl\">$currentUrl</a>" }
-                        }
-                      } else if (currentUrl.isNotEmpty()) {
-                        pre {
-                          unsafe { +"<a href=\"$currentUrl\">$currentUrl</a>" }
-                        }
-                      } else if (currentLicenseName.isNotEmpty()) {
-                        pre {
-                          unsafe { +"$currentLicenseName\n" }
-                        }
-                      } else {
-                        pre {
-                          +NO_LICENSE
-                        }
+                      pre {
+                        +NO_LICENSE
                       }
                     }
-                    br
                   }
+                  br
                 }
-                hr {}
               }
+              hr {}
             }
           }
         }
@@ -224,32 +226,11 @@ class HtmlReport(private val projects: List<Model>) : Report {
     namespace,
   ).visitAndFinalize(this, block)
 
-  @HtmlTagMarker
-  private fun FlowOrInteractiveOrPhrasingContent.a(
-    href: String? = null,
-    target: String? = null,
-    classes: String? = null,
-    name: String? = null,
-    block: A.() -> Unit = {},
-  ): Unit = A(
-    attributesMapOf(
-      "href",
-      href,
-      "target",
-      target,
-      "class",
-      classes,
-      "name",
-      name,
-    ),
-    consumer,
-  ).visit(block)
-
   private companion object {
     private const val EXTENSION = "html"
     private const val NAME = "HTML"
     const val DOCTYPE = "<!DOCTYPE html>"
-    const val META = "<meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\" />"
+    const val META = "<meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\">"
     const val CSS_STYLE =
       "body { font-family: sans-serif } pre { background-color: #eeeeee; padding: 1em; white-space: pre-wrap; word-break: break-word; display: inline-block }"
     const val OPEN_SOURCE_LIBRARIES = "Open source licenses"