Move Gradle classes to gradle package

aim42 · Sep 18, 2024 · 5374aa3 · 5374aa3
1 parent 9307f2e
commit 5374aa3
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 15 deletions.
diff --git a/htmlSanityCheck-gradle-plugin/build.gradle b/htmlSanityCheck-gradle-plugin/build.gradle
@@ -30,7 +30,7 @@ gradlePlugin {
     plugins {
         htmlSanityCheck {
             id = 'org.aim42.htmlSanityCheck'
-            implementationClass = 'org.aim42.htmlsanitycheck.HtmlSanityCheckPlugin'
+            implementationClass = 'org.aim42.htmlsanitycheck.gradle.HtmlSanityCheckPlugin'
             displayName = 'Gradle HtmlSanityCheck Plugin'
             description = project.description
             tags = ["checks", "quality", "documentation", "html", "asciidoctor", "test"]

diff --git a/...lsanitycheck/HtmlSanityCheckPlugin.groovy → ...check/gradle/HtmlSanityCheckPlugin.groovy b/...lsanitycheck/HtmlSanityCheckPlugin.groovy → ...check/gradle/HtmlSanityCheckPlugin.groovy
@@ -1,6 +1,6 @@
 // see end-of-file for license information
 
-package org.aim42.htmlsanitycheck
+package org.aim42.htmlsanitycheck.gradle
 
 import org.gradle.api.Plugin
 import org.gradle.api.Project
@@ -13,7 +13,7 @@ class HtmlSanityCheckPlugin implements Plugin<Project> {
 
     void apply(Project project) {
 
-        project.task( HTML_SANITY_CHECK,
+        project.tasks.register( HTML_SANITY_CHECK,
                 type: HtmlSanityCheckTask,
                 description: "performs semantic checks on html files",
                 group: LifecycleBasePlugin.VERIFICATION_GROUP)

diff --git a/...tmlsanitycheck/HtmlSanityCheckTask.groovy → ...tycheck/gradle/HtmlSanityCheckTask.groovy b/...tmlsanitycheck/HtmlSanityCheckTask.groovy → ...tycheck/gradle/HtmlSanityCheckTask.groovy
@@ -1,5 +1,7 @@
-package org.aim42.htmlsanitycheck
+package org.aim42.htmlsanitycheck.gradle
 
+import org.aim42.htmlsanitycheck.AllChecksRunner
+import org.aim42.htmlsanitycheck.Configuration
 import org.aim42.htmlsanitycheck.check.AllCheckers
 import org.gradle.api.DefaultTask
 import org.gradle.api.GradleException

diff --git a/...anitycheck/HtmlSanityCheckBaseSpec.groovy → ...eck/gradle/HtmlSanityCheckBaseSpec.groovy b/...anitycheck/HtmlSanityCheckBaseSpec.groovy → ...eck/gradle/HtmlSanityCheckBaseSpec.groovy
@@ -1,4 +1,4 @@
-package org.aim42.htmlsanitycheck
+package org.aim42.htmlsanitycheck.gradle
 
 import org.junit.Rule
 import org.junit.rules.TemporaryFolder

diff --git a/...itycheck/HtmlSanityCheckPluginSpec.groovy → ...k/gradle/HtmlSanityCheckPluginSpec.groovy b/...itycheck/HtmlSanityCheckPluginSpec.groovy → ...k/gradle/HtmlSanityCheckPluginSpec.groovy
@@ -1,4 +1,5 @@
-package org.aim42.htmlsanitycheck
+package org.aim42.htmlsanitycheck.gradle
+
 
 import org.gradle.api.Project
 import org.gradle.language.base.plugins.LifecycleBasePlugin

diff --git a/.../HtmlSanityCheckTaskFunctionalSpec.groovy → .../HtmlSanityCheckTaskFunctionalSpec.groovy b/.../HtmlSanityCheckTaskFunctionalSpec.groovy → .../HtmlSanityCheckTaskFunctionalSpec.groovy
@@ -1,4 +1,4 @@
-package org.aim42.htmlsanitycheck
+package org.aim42.htmlsanitycheck.gradle
 
 
 import org.gradle.testkit.runner.GradleRunner

diff --git a/...anitycheck/HtmlSanityCheckTaskSpec.groovy → ...eck/gradle/HtmlSanityCheckTaskSpec.groovy b/...anitycheck/HtmlSanityCheckTaskSpec.groovy → ...eck/gradle/HtmlSanityCheckTaskSpec.groovy
@@ -1,5 +1,6 @@
-package org.aim42.htmlsanitycheck
+package org.aim42.htmlsanitycheck.gradle
 
+import org.aim42.htmlsanitycheck.MisconfigurationException
 import org.gradle.api.GradleException
 import org.gradle.api.Project
 import org.gradle.testfixtures.ProjectBuilder

diff --git a/src/docs/arc42/chapters/chap-08-gradle-plugin.adoc b/src/docs/arc42/chapters/chap-08-gradle-plugin.adoc
@@ -13,7 +13,7 @@ we implement a lean wrapper as described in the Gradle user guide.
 
 [source, groovy]
 ----
-include::{gradle-plugin-source-path}/htmlsanitycheck/HtmlSanityCheckPlugin.groovy[tag=gradle-plugin-implementation]
+include::{gradle-plugin-source-path}/htmlsanitycheck/gradle/HtmlSanityCheckPlugin.groovy[tag=gradle-plugin-implementation]
 ----
 
 ==== Directory Structure and Required Files

diff --git a/src/docs/development/development-intro.adoc b/src/docs/development/development-intro.adoc
@@ -52,9 +52,10 @@ TBD
    |  |  |  |  |-org
    |  |  |  |  |  |-aim42
    |  |  |  |  |  |  |-htmlsanitycheck
-   |  |  |  |  |  |  |  | ...
-   |  |  |  |  |  |  |  |-HtmlSanityCheckPlugin.groovy // <1>
-   |  |  |  |  |  |  |  |-HtmlSanityCheckTask.groovy
+   |  |  |  |  |  |  |  |-gradle
+   |  |  |  |  |  |  |  |  | ...
+   |  |  |  |  |  |  |  |  |-HtmlSanityCheckPlugin.groovy // <1>
+   |  |  |  |  |  |  |  |  |-HtmlSanityCheckTask.groovy
    |  |  |  |  |-resources
    |  |  |  |  |  |-META-INF                          // <2>
    |  |  |  |  |  |  |-gradle-plugins
@@ -63,15 +64,16 @@ TBD
    |  |  |  |  |-org
    |  |  |  |  |  |-aim42
    |  |  |  |  |  |  |-htmlsanitycheck
-   |  |  |  |  |  |  |  | ...
-   |  |  |  |  |  |  |  |-HtmlSanityCheckPluginTest
+   |  |  |  |  |  |  |  |-gradle
+   |  |  |  |  |  |  |  |  | ...
+   |  |  |  |  |  |  |  |  |-HtmlSanityCheckPluginSpec
    |
 ----
 <1> the actual plugin code, a xyzPlugin and xyzTask groovy files
 <2> Gradle expects plugin properties in META-INF
 <3> Property file containing the name of the actual implementation class:
 
- implementation-class=org.aim42.htmlsanitycheck.HtmlSanityCheckPlugin
+ implementation-class=org.aim42.htmlsanitycheck.gradle.HtmlSanityCheckPlugin
 
 ==== Notes for IntelliJ Users
 If you work with IntelliJ, you should configure your run- and test configurations