Integrate grails-gsp

Author: jdaugherty

.sdkmanrc

@@ -1,2 +1,3 @@
 # Enable auto-env through the sdkman_auto_env config - https://sdkman.io/usage#env
 java=17.0.12-librca
+gradle=8.13

README.md

@@ -1,15 +1,18 @@
-# Grails Views
+# grails-views repo
 
 [![Maven Central](https://img.shields.io/maven-central/v/org.grails/views-core.svg?label=Maven%20Central)](https://central.sonatype.com/artifact/org.grails/views-core)
 [![Java CI](https://github.com/grails/grails-views/actions/workflows/gradle.yml/badge.svg?event=push)](https://github.com/grails/grails-views/actions/workflows/gradle.yml)
 
-Additional View Technologies for Grails.
+This project contains view related technologies for the [Grails framework](https://grails.org).
 
-Initial implementation includes JSON views powered by Groovy's JsonBuilder.\
-However, this project provides the basis for implementing other view types.
+## Grails Server Pages (GSP)
+See [Grails Server Pages (GSP)](/gsp) for more information.
 
-View [the latest documentation](https://views.grails.org/latest/views/guide/index.html) for details. 
+## Additional Grails View Technologies
+See [grails-views](/views) for more information.
 
-# Fields
+## Fields Plugin
+See [fields](/fields) for more information.
 
-View [the latest documentation](https://views.grails.org/latest/fields/guide/index.html) for details. 
+## Scaffolding 
+See [scaffolding](/scaffolding) for more information.

build.gradle

@@ -11,6 +11,10 @@ buildscript {
     }
 }
 
+ext {
+    isCI = System.getenv('CI') != null
+}
+
 String customGroovyVersion = findProperty('groovyVersion') ?: System.getenv('GROOVY_VERSION')
 if (customGroovyVersion) {
     logger.warn("Using custom Groovy version: $customGroovyVersion")
@@ -70,7 +74,16 @@ def publishedProjects = [
         'views-json-testing-support',
         'views-markup',
         'scaffolding',
-        'fields-plugin'
+        'fields-plugin',
+        'grails-gsp',
+        'grails-plugin-gsp',
+        'grails-plugin-sitemesh3',
+        'grails-taglib',
+        'grails-web-gsp',
+        'grails-web-gsp-taglib',
+        'grails-web-jsp',
+        'grails-web-taglib',
+        'grails-web-testing-support'
 ]
 subprojects {
     if (name in publishedProjects) {

buildSrc/build.gradle

@@ -29,7 +29,7 @@ dependencies {
         exclude group: 'org.grails.plugins', module: 'views-gradle'
         exclude group: 'org.grails.plugins', module: 'views-json'
     }
-    implementation "org.asciidoctor:asciidoctor-gradle-jvm:${gradleProperties.asciidoctorVersion}"
     implementation "org.grails:grails-gradle-plugin"
     implementation "org.grails.plugins:views-gradle"
+    implementation "org.grails:grails-docs"
 }

grails-gsp/docs/src/main/docs/resources/style/layout.html etc/layout/style/layout.html

@@ -1,9 +1,14 @@
-# Grails Fields plugin
+# Grails Fields Plugin
 
 The grails fields plugin simplifies working with forms in Grails by offering convenient and customizable ways to manage
 field rendering, validation, and interactions. It provides an easy-to-use API that reduces the boilerplate code for
 generating form fields, allowing developers to focus on building their applications rather than managing repetitive UI
 logic.
 
-## Documentation 
-For further information please see the full [Grails fields plugin documentation](https://grails.github.io/grails-views/latest/fields/guide).
+## Documentation
+
+* Latest Guide - https://views.grails.org/latest/fields/guide
+* Latest API - https://views.grails.org/latest/fields/api
+
+* Snapshot Guide - https://views.grails.org/snapshot/fields/guide
+* Snapshot API - https://views.grails.org/snapshot/fields/api

fields/plugin/README.md fields/README.md

@@ -1,8 +1,7 @@
-plugins {
-    id 'groovy' // For groovydoc task
-}
-
 ext {
+    guideTitle = 'Grails Fields Plugin'
+    guideSubtitle = 'Grails Fields Plugin - customize the rendering of input fields for Grails artifacts'
+
     apiDocsProjects = [
             'fields': [
                     docTitle   : 'Grails Fields Plugin - ' + projectVersion,
@@ -26,11 +25,8 @@ ext {
             revnumber           : projectVersion,
             setanchors          : true,
             'source-highlighter': 'prettify',
-            toc                 : 'left',
-            toc2                : '',
-            toclevels           : '2',
             'version'           : projectVersion,
-            'sourcedir'         : rootProject.layout.projectDirectory.dir('fields/src/main/groovy')
+            'sourcedir'         : rootProject.layout.projectDirectory.dir('fields/src/main/groovy').asFile.toString()
     ]
 }
 

fields/docs/build.gradle

@@ -13,12 +13,15 @@ ext {
     pomTitle = 'Grails Fields Plugin'
     pomDescription = 'Customizable form-field rendering based on overrideable GSP template'
     pomDevelopers = [robfletcher: 'Rob Fletcher', graemerocher: "Graeme Rocher", sdelamo: "Sergio del Amo", sbglasius: 'Søren Berg Glasius']
+    mavenSnapshotPublishUrl = 'https://repo.grails.org/grails/plugins3-snapshots-local'
 }
 
 dependencies {
-    implementation platform("org.grails:grails-bom:${grailsVersion}")
+    implementation platform("org.grails:grails-bom:${grailsVersion}"), {
+        exclude group: 'org.grails.plugins', module: 'gsp'
+    }
 
-    compileOnly "org.grails.plugins:gsp"
+    implementation project(':grails-plugin-gsp')
     compileOnly "org.grails:grails-plugin-controllers"
     compileOnly "org.springframework.boot:spring-boot-autoconfigure"
     compileOnly "org.springframework.boot:spring-boot-starter-actuator"
@@ -40,4 +43,4 @@ dependencies {
 
 apply from: rootProject.layout.projectDirectory.file('gradle/java-config.gradle')
 apply from: rootProject.layout.projectDirectory.file('gradle/test-config.gradle')
-apply from: rootProject.layout.projectDirectory.file('gradle/publishing.gradle')
+apply from: rootProject.layout.projectDirectory.file('gradle/publish-config.gradle')

fields/plugin/build.gradle

@@ -1,11 +1,15 @@
 projectVersion=7.0.0-SNAPSHOT
-
+githubBranch = 7.0.x
 javaVersion=17
 
-# when updating grails version, be sure to update the functional-tests-plugin as well
+# when updating grails version, be sure to update the views/gradle-plugin as well
 grailsVersion=7.0.0-M3
-asciidoctorVersion=4.0.3
 joddWotVersion=3.3.8
+commonsTextVersion=1.13.0
+elApiVersion=6.0.1
+jspApiVersion=4.0.0
+sitemeshVersion=3.2.2
+javassistVersion=3.30.2-GA
 
 micronautVersion=4.6.5
 

gradle.properties

@@ -1,13 +1,11 @@
-import org.asciidoctor.gradle.jvm.AsciidoctorTask
-
-apply plugin: 'org.asciidoctor.jvm.convert'
-
-configurations.register('documentation')
+apply plugin: 'groovy'
+apply plugin: 'org.grails.grails-doc'
 
 dependencies {
-    add('documentation', platform("org.grails:grails-bom:$grailsVersion"))
-    add('documentation', 'com.github.javaparser:javaparser-core')
-    add('documentation', 'org.apache.groovy:groovy-groovydoc')
+    implementation platform("org.grails:grails-bom:$grailsVersion")
+    implementation 'org.apache.groovy:groovy'
+    implementation 'org.apache.groovy:groovy-groovydoc'
+    implementation 'com.github.javaparser:javaparser-core'
 }
 
 tasks.register('pluginName') {
@@ -18,12 +16,18 @@ tasks.withType(Groovydoc).configureEach {
     def firstDocTitle
     def firstWindowTitle
     def sources = []
+    def projectClasspath = [configurations.compileClasspath]
     rootProject.subprojects
             .findAll { it.name in (project.findProperty('apiDocsProjects') ?: []) }
             .each {
                 firstDocTitle = firstDocTitle ?: (project.findProperty('apiDocsProjects') as Map)[it.name]['docTitle']
                 firstWindowTitle = firstWindowTitle ?: (project.findProperty('apiDocsProjects') as Map)[it.name]['windowTitle']
                 sources += it.files('src/main/groovy')
+                if(it.file('src/ast/groovy').exists()) {
+                    sources += it.files('src/ast/groovy')
+                }
+                //TODO: FIXME: compileClasspath isn't detected
+                //projectClasspath += it.configurations.compileClasspath
             }
     docTitle = firstDocTitle
     windowTitle = firstWindowTitle
@@ -33,26 +37,86 @@ tasks.withType(Groovydoc).configureEach {
     processScripts = false
     includeMainForScripts = false
     includeAuthor = false
-    classpath = configurations.documentation
-    groovyClasspath += configurations.documentation
+    classpath = files(projectClasspath)
+    groovyClasspath += files(projectClasspath)
+}
+
+tasks.register('resolveGroovyVersion') {
+    group = 'documentation'
+    description = 'Resolve Groovy Version from the BOM'
+    ext.resolved = configurations.compileClasspath
+            .resolvedConfiguration
+            .resolvedArtifacts
+            .find {
+                it.moduleVersion.id.group == 'org.apache.groovy' &&
+                        it.moduleVersion.id.name.contains('groovy')
+            }.moduleVersion.id.version
+    logger.lifecycle('Resolved Groovy version for Guide links: {}', resolved)
+}
+
+// TODO: PublishGuide should eventually ensure the build directory exists
+tasks.register('docsBuild') {
+    doFirst {
+        project.layout.buildDirectory.get().asFile.mkdirs()
+    }
+    // Do not cache this task since the directory must exist if publishGuide is going to run
+    outputs.upToDateWhen { false }
 }
 
-tasks.named('asciidoctor', AsciidoctorTask) {
-    sourceDir layout.projectDirectory.file('src/docs')
-    sources { include 'index.adoc' }
-    outputDir = layout.buildDirectory.file('docs')
-    attributes findProperty('asciidoctorAttributes') as Map ?: [:]
-    baseDirFollowsSourceDir()
-    jvm {
-        jvmArgs '--add-opens', 'java.base/sun.nio.ch=ALL-UNNAMED', '--add-opens', 'java.base/java.io=ALL-UNNAMED'
+tasks.register('publishGuide', grails.doc.gradle.PublishGuide) {
+    group = 'documentation'
+    description = 'Generate Guide'
+    dependsOn('docsBuild', 'resolveGroovyVersion')
+
+    targetDir = project.layout.buildDirectory.dir('docs').get().asFile
+    outputs.dir(targetDir) // ensure gradle understands what this task generates
+
+    String relativeProjectPath = rootProject.projectDir.toPath().relativize(project.projectDir.toPath()).toString()
+    logger.lifecycle("${project.name} Relative project path: {}", relativeProjectPath)
+    sourceRepo = "https://github.com/grails/grails-views/edit/${githubBranch}/${relativeProjectPath}/src/docs"
+    sourceDir = project.layout.projectDirectory.dir('src/docs').getAsFile()
+    inputs.dir(sourceDir) // ensure gradle understands what this task creates from
+    propertiesFiles = [rootProject.layout.projectDirectory.file('gradle.properties').asFile]
+    asciidoc = true
+    resourcesDir = rootProject.layout.projectDirectory.dir('etc/layout').asFile
+    properties = ([
+                          'safe'          : 'UNSAFE', // Make sure any asciidoc security is disabled
+                          'version'       : projectVersion,
+                          'title'         : project.findProperty('guideTitle'),
+                          'subtitle'      : project.findProperty('guideSubtitle'),
+                          // TODO: The javaee documentation has not been updated to jakarta
+                          'javaee'        : 'https://docs.oracle.com/javaee/7/api/',
+                          'jakartaee'     : 'https://jakarta.ee/specifications/platform/10/apidocs/',
+                          'javase'        : 'https://docs.oracle.com/en/java/javase/17/docs/api/index.html',
+                          'groovyapi'     : "https://docs.groovy-lang.org/${resolveGroovyVersion.resolved}/html/gapi/",
+                          'groovyjdk'     : "https://docs.groovy-lang.org/${resolveGroovyVersion.resolved}/html/groovy-jdk/",
+                          'grailsapi'     : "https://docs.grails.org/$grailsVersion/api/",
+                          'grailsdocs'    : "https://docs.grails.org/$grailsVersion/",
+                          'gormapi'       : 'https://gorm.grails.org/latest/api/',
+                          'springapi'     : 'https://docs.spring.io/spring/docs/current/javadoc-api/',
+                          'commandLineRef': "https://docs.grails.org/$grailsVersion/ref/Command%20Line",
+                          'controllersRef': "https://docs.grails.org/$grailsVersion/ref/Controllers"
+                  ] + project.findProperty('asciidoctorAttributes') as Map<String, String>) as Properties
+
+    doLast {
+        File destination = project.layout.buildDirectory.file('docs/guide/index.html').get().asFile
+        destination.delete()
+        project.layout.buildDirectory.file('docs/guide/single.html').get().asFile.renameTo(destination)
+        project.layout.buildDirectory.file('docs/index.html').get().asFile.text = '''
+        <html lang="en">
+            <head>
+                <title>Redirecting...</title>
+                <meta http-equiv="refresh" content="0; url=guide/index.html" />
+            </head>
+            <body></body>
+        </html>
+        '''.stripIndent(8)
     }
-    inputs.dir(sourceDir)
-    outputs.dir(outputDir)
 }
 
 tasks.register('guideDocs', Copy) {
     group = 'documentation'
-    dependsOn 'asciidoctor'
+    dependsOn 'publishGuide'
     def sourceDir = layout.projectDirectory.dir('src/docs')
     def targetDir = layout.buildDirectory.dir('docs')
     outputs.dir(targetDir)

gradle/docs-config.gradle

@@ -1,4 +1,18 @@
 tasks.withType(Test).configureEach {
     useJUnitPlatform()
-    testLogging { events 'passed', 'skipped', 'failed', 'standardOut', 'standardError' }
+    testLogging {
+        events 'passed', 'skipped', 'failed', 'standardOut', 'standardError'
+        showStandardStreams = true
+        exceptionFormat = 'full'
+    }
+    if (isCI) {
+        maxParallelForks = findProperty('testMaxParallelFork') ?: 2
+        forkEvery = findProperty('testForkEvery') ?: 0
+    } else {
+        maxParallelForks = findProperty('testMaxParallelFork') ?: 4
+        forkEvery = findProperty('testForkEvery') ?: 0
+    }
+    if (findProperty('testJvmArgs')) {
+        jvmArgs = findProperty('testJvmArgs')
+    }
 }

gradle/publishing.gradle gradle/publish-config.gradle

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.10-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME