Merge branch 'release/4.6.0'

chrimaeon · Jun 18, 2022 · 2e57bbf · 2e57bbf
2 parents f381fd2 + fa98c11
commit 2e57bbf
Show file tree

Hide file tree

Showing 12 changed files with 190 additions and 21 deletions.
diff --git a/.github/workflows/create_release.yml b/.github/workflows/create_release.yml
@@ -27,6 +27,7 @@ jobs:
         with:
           slack_token: ${{ secrets.SLACK_TOKEN }}
           channel: ${{ secrets.SLACK_CHANNEL }}
+          publish: true
           text: "${{ github.ref_name }} on ${{ github.repository }} released! :raised_hands:"
           blocks: |
             [

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -7,6 +7,7 @@ on:
       - develop
       - 'release/**'
       - 'hotfix/**'
+  pull_request:
 
 jobs:
   build-and-test:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,12 +13,12 @@
 
 ### Security
 
-## [4.5.0]
+## [4.6.0]
 ### Added
-- Better support for Android Variants
+- Dark Mode for HTML report
 
 ### Changed
-- Internal handling of the license mappings
+- Sort libraries by name or maven coordinated on HTML report
 
 ### Deprecated
 
@@ -28,6 +28,13 @@
 
 ### Security
 
+## [4.5.0]
+### Added
+- Better support for Android Variants
+
+### Changed
+- Internal handling of the license mappings
+
 ## [4.4.0]
 ### Added
 - [SPDX License Identifier](https://spdx.org/licenses/) for various reports

diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ This Gradle plugin provides tasks to generate a file with the licenses used from
 
 ```kotlin
 plugins {
-    id("com.cmgapps.licenses") version "4.5.0"
+    id("com.cmgapps.licenses") version "4.6.0"
 }
 ```
 </details>
@@ -28,7 +28,7 @@ plugins {
 
 ```groovy
 plugins {
-    id 'com.cmgapps.licenses' version '4.5.0'
+    id 'com.cmgapps.licenses' version '4.6.0'
 }
 ```
 </details>
@@ -46,7 +46,7 @@ buildscript {
         }
     }
     dependencies {
-        classpath("com.cmgapps:gradle-licenses-plugin:4.5.0")
+        classpath("com.cmgapps:gradle-licenses-plugin:4.6.0")
     }
 }
 
@@ -65,7 +65,7 @@ buildscript {
         }
     }
     dependencies {
-        classpath 'com.cmgapps:gradle-licenses-plugin:4.5.0'
+        classpath 'com.cmgapps:gradle-licenses-plugin:4.6.0'
     }
 }
 
@@ -130,6 +130,17 @@ The plugin can output different formats.
             } 
         }
         ```
+
+    * On the default CSS style Dark Mode for supported browsers is also enabled by default. It adds a `<meta name="color-scheme" content="dark light">` and a custom css theme.      
+
+      It can be disabled via
+      ```kotlin
+      licenses {
+          reports {
+              html.useDarkMode.set(false)
+          }
+      }
+      ```
 * `JSON`
   generates a JSON file
 * `XML`

diff --git a/pom.properties b/pom.properties
@@ -4,7 +4,7 @@
 # SPDX-License-Identifier: Apache-2.0
 #
 group=com.cmgapps
-versionName=4.5.0
+versionName=4.6.0
 pomName=Gradle Licenses Plugin
 pomArtifactId=gradle-licenses-plugin
 pomDescription=Gradle plugin that provides a task to generate a license report for the dependencies used in your project Java/Kotlin project.

diff --git a/src/functionalTest/kotlin/com/cmgapps/license/LicensePluginJavaMultiProjectShould.kt b/src/functionalTest/kotlin/com/cmgapps/license/LicensePluginJavaMultiProjectShould.kt
@@ -101,7 +101,12 @@ class LicensePluginJavaMultiProjectShould {
                     "<html lang=\"en\">" +
                     "<head>" +
                     "<meta charset=\"UTF-8\">" +
-                    "<style>body{font-family:sans-serif;background-color:#eee}pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}</style>" +
+                    "<meta name=\"color-scheme\" content=\"dark light\">" +
+                    "<style>" +
+                    "body{font-family:sans-serif;background-color:#eee}" +
+                    "pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}" +
+                    "@media(prefers-color-scheme: dark){body{background-color: #303030}pre,.license {background-color: #242424}}" +
+                    "</style>" +
                     "<title>Open source licenses</title>" +
                     "</head>" +
                     "<body>" +
@@ -156,7 +161,12 @@ class LicensePluginJavaMultiProjectShould {
                     "<html lang=\"en\">" +
                     "<head>" +
                     "<meta charset=\"UTF-8\">" +
-                    "<style>body{font-family:sans-serif;background-color:#eee}pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}</style>" +
+                    "<meta name=\"color-scheme\" content=\"dark light\">" +
+                    "<style>" +
+                    "body{font-family:sans-serif;background-color:#eee}" +
+                    "pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}" +
+                    "@media(prefers-color-scheme: dark){body{background-color: #303030}pre,.license {background-color: #242424}}" +
+                    "</style>" +
                     "<title>Open source licenses</title>" +
                     "</head>" +
                     "<body>" +
@@ -214,7 +224,12 @@ class LicensePluginJavaMultiProjectShould {
                     "<html lang=\"en\">" +
                     "<head>" +
                     "<meta charset=\"UTF-8\">" +
-                    "<style>body{font-family:sans-serif;background-color:#eee}pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}</style>" +
+                    "<meta name=\"color-scheme\" content=\"dark light\">" +
+                    "<style>" +
+                    "body{font-family:sans-serif;background-color:#eee}" +
+                    "pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}" +
+                    "@media(prefers-color-scheme: dark){body{background-color: #303030}pre,.license {background-color: #242424}}" +
+                    "</style>" +
                     "<title>Open source licenses</title>" +
                     "</head>" +
                     "<body>" +

diff --git a/src/functionalTest/kotlin/com/cmgapps/license/LicensePluginJavaShould.kt b/src/functionalTest/kotlin/com/cmgapps/license/LicensePluginJavaShould.kt
@@ -102,7 +102,12 @@ class LicensePluginJavaShould {
                     "<html lang=\"en\">" +
                     "<head>" +
                     "<meta charset=\"UTF-8\">" +
-                    "<style>body{font-family:sans-serif;background-color:#eee}pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}</style>" +
+                    "<meta name=\"color-scheme\" content=\"dark light\">" +
+                    "<style>" +
+                    "body{font-family:sans-serif;background-color:#eee}" +
+                    "pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}" +
+                    "@media(prefers-color-scheme: dark){body{background-color: #303030}pre,.license {background-color: #242424}}" +
+                    "</style>" +
                     "<title>Open source licenses</title>" +
                     "</head>" +
                     "<body>" +
@@ -139,7 +144,12 @@ class LicensePluginJavaShould {
                     "<html lang=\"en\">" +
                     "<head>" +
                     "<meta charset=\"UTF-8\">" +
-                    "<style>body{font-family:sans-serif;background-color:#eee}pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}</style>" +
+                    "<meta name=\"color-scheme\" content=\"dark light\">" +
+                    "<style>" +
+                    "body{font-family:sans-serif;background-color:#eee}" +
+                    "pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}" +
+                    "@media(prefers-color-scheme: dark){body{background-color: #303030}pre,.license {background-color: #242424}}" +
+                    "</style>" +
                     "<title>Open source licenses</title>" +
                     "</head>" +
                     "<body>" +
@@ -183,7 +193,12 @@ class LicensePluginJavaShould {
                     "<html lang=\"en\">" +
                     "<head>" +
                     "<meta charset=\"UTF-8\">" +
-                    "<style>body{font-family:sans-serif;background-color:#eee}pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}</style>" +
+                    "<meta name=\"color-scheme\" content=\"dark light\">" +
+                    "<style>" +
+                    "body{font-family:sans-serif;background-color:#eee}" +
+                    "pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}" +
+                    "@media(prefers-color-scheme: dark){body{background-color: #303030}pre,.license {background-color: #242424}}" +
+                    "</style>" +
                     "<title>Open source licenses</title>" +
                     "</head>" +
                     "<body>" +
@@ -217,6 +232,57 @@ class LicensePluginJavaShould {
 
         val result = gradleRunner.build()
 
+        assertThat(
+            result.output,
+            matchesPattern(Pattern.compile(".*Wrote HTML report to .*$reportFolder/licenses.html.*", Pattern.DOTALL))
+        )
+        assertThat(
+            File("$reportFolder/licenses.html").readText().trim(),
+            `is`(
+                "<!DOCTYPE html>" +
+                    "<html lang=\"en\">" +
+                    "<head>" +
+                    "<meta charset=\"UTF-8\">" +
+                    "<meta name=\"color-scheme\" content=\"dark light\">" +
+                    "<style>" +
+                    "body{font-family:sans-serif;background-color:#eee}" +
+                    "pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}" +
+                    "@media(prefers-color-scheme: dark){body{background-color: #303030}pre,.license {background-color: #242424}}" +
+                    "</style>" +
+                    "<title>Open source licenses</title>" +
+                    "</head>" +
+                    "<body>" +
+                    "<h3>Notice for packages:</h3>" +
+                    "<ul>" +
+                    "<li>group:noname</li>" +
+                    "</ul>" +
+                    "<div class=\"license\">" +
+                    "<p>Some license</p>" +
+                    "<a href=\"http://website.tld/\">http://website.tld/</a>" +
+                    "</div>" +
+                    "</body>" +
+                    "</html>"
+            )
+        )
+    }
+
+    @Test
+    fun `generate Html report with no dark theme`() {
+        buildFile + """
+            licenses {
+                reports {
+                    html.enabled = true
+                    html.useDarkMode.set(false)
+                }
+            }
+            
+            dependencies {
+              implementation 'group:noname:1.0.0'
+            }
+        """.trimIndent()
+
+        val result = gradleRunner.build()
+
         assertThat(
             result.output,
             matchesPattern(Pattern.compile(".*Wrote HTML report to .*$reportFolder/licenses.html.*", Pattern.DOTALL))
@@ -284,6 +350,7 @@ class LicensePluginJavaShould {
                 reports {
                     html.enabled = true
                     html.stylesheet("body{}")
+                    html.useDarkMode.set(false)
                 }
             }
 

diff --git a/src/main/kotlin/com/cmgapps/license/LicensesTask.kt b/src/main/kotlin/com/cmgapps/license/LicensesTask.kt
@@ -263,6 +263,7 @@ abstract class LicensesTask : DefaultTask() {
                     ReportType.HTML -> HtmlReport(
                         libraries,
                         reports.html._stylesheet.orNull,
+                        reports.html.useDarkMode.get(),
                         logger
                     )
                     ReportType.JSON -> JsonReport(libraries)

diff --git a/src/main/kotlin/com/cmgapps/license/reporter/HtmlReport.kt b/src/main/kotlin/com/cmgapps/license/reporter/HtmlReport.kt
@@ -17,12 +17,15 @@ import org.gradle.api.resources.TextResource
 internal class HtmlReport(
     libraries: List<Library>,
     private val css: TextResource?,
+    private val useDarkMode: Boolean,
     private val logger: Logger
 ) : Report(libraries) {
 
     companion object {
         private const val DEFAULT_PRE_CSS = "pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}"
         private const val DEFAULT_BODY_CSS = "body{font-family:sans-serif;background-color:#eee}"
+        private const val NIGHT_MODE_CSS =
+            "@media(prefers-color-scheme: dark){body{background-color: #303030}pre,.license {background-color: #242424}}"
         private const val DEFAULT_CSS = "$DEFAULT_BODY_CSS$DEFAULT_PRE_CSS"
         private const val OPEN_SOURCE_LIBRARIES = "Open source licenses"
 
@@ -33,8 +36,11 @@ internal class HtmlReport(
         return html {
             head {
                 meta(mapOf("charset" to "UTF-8"))
+                if (useDarkMode) {
+                    meta(mapOf("name" to "color-scheme", "content" to "dark light"))
+                }
                 style {
-                    +(css?.asString() ?: DEFAULT_CSS)
+                    +(css?.asString() ?: (DEFAULT_CSS + if (useDarkMode) NIGHT_MODE_CSS else ""))
                 }
                 title {
                     +OPEN_SOURCE_LIBRARIES
@@ -48,11 +54,12 @@ internal class HtmlReport(
 
                 libraries.toLicensesMap().forEach { (license, libraries) ->
                     ul {
-                        libraries.asSequence().sortedBy { it.name }.forEach { library ->
-                            li {
-                                +(library.name ?: library.mavenCoordinates.identifierWithoutVersion)
+                        libraries.asSequence().sortedBy { it.name ?: it.mavenCoordinates.identifierWithoutVersion }
+                            .forEach { library ->
+                                li {
+                                    +(library.name ?: library.mavenCoordinates.identifierWithoutVersion)
+                                }
                             }
-                        }
                     }
 
                     when (license.id) {

diff --git a/src/main/kotlin/com/cmgapps/license/reporter/Report.kt b/src/main/kotlin/com/cmgapps/license/reporter/Report.kt
@@ -72,7 +72,7 @@ open class LicensesReport(internal val type: ReportType, task: Task, internal va
 
 class CustomizableHtmlReport(type: ReportType, task: Task, project: Project) : LicensesReport(type, task, project) {
 
-    internal var _stylesheet: Property<TextResource?> = task.project.objects.property(TextResource::class.java)
+    internal val _stylesheet: Property<TextResource?> = task.project.objects.property(TextResource::class.java)
 
     @Input
     fun stylesheet(css: String) {
@@ -84,6 +84,9 @@ class CustomizableHtmlReport(type: ReportType, task: Task, project: Project) : L
         _stylesheet.set(project.resources.text.fromFile(css))
     }
 
+    @Input
+    val useDarkMode: Property<Boolean> = task.project.objects.property(Boolean::class.java).convention(true)
+
     override fun configure(
         config: (Action<in LicensesReport>)?,
         configHtml: (Action<in CustomizableHtmlReport>)?,

diff --git a/src/test/kotlin/com/cmgapps/license/LicensesTaskShould.kt b/src/test/kotlin/com/cmgapps/license/LicensesTaskShould.kt
@@ -48,6 +48,7 @@ class LicensesTaskShould {
         val task = project.tasks.create("licensesReport", LicensesTask::class.java) { task ->
             task.reports {
                 it.html.enabled = true
+                it.html.useDarkMode.set(false)
             }
         }
 
@@ -85,6 +86,7 @@ class LicensesTaskShould {
             task.reports {
                 it.html.enabled = true
                 it.html.stylesheet("body{}")
+                it.html.useDarkMode.set(false)
             }
         }
 
@@ -297,7 +299,12 @@ class LicensesTaskShould {
                     "<html lang=\"en\">" +
                     "<head>" +
                     "<meta charset=\"UTF-8\">" +
-                    "<style>body{font-family:sans-serif;background-color:#eee}pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}</style>" +
+                    "<meta name=\"color-scheme\" content=\"dark light\">" +
+                    "<style>" +
+                    "body{font-family:sans-serif;background-color:#eee}" +
+                    "pre,.license{background-color:#ddd;padding:1em}pre{white-space:pre-wrap}" +
+                    "@media(prefers-color-scheme: dark){body{background-color: #303030}pre,.license {background-color: #242424}}" +
+                    "</style>" +
                     "<title>Open source licenses</title>" +
                     "</head>" +
                     "<body>" +