Streamline Gradle build scripts: using the Spring Dependency Management Plugin to manage dependencies and versions

Closes gh-21

Author: rainboyan

build.gradle

@@ -1,10 +1,12 @@
 buildscript {
     repositories {
+        // mavenLocal()
         mavenCentral()
         gradlePluginPortal()
     }
     dependencies {
         classpath "org.graceframework:grace-gradle-plugin:$graceVersion"
+        // classpath "org.graceframework.plugins:asset-pipeline-gradle:$assetPipelineVersion"
         classpath 'org.asciidoctor:asciidoctor-gradle-jvm:4.0.3'
         classpath "com.github.erdi:webdriver-binaries-gradle-plugin:$webdriverBinariesVersion"
         classpath "org.graceframework.plugins:views-gradle:6.3.0-M1"
@@ -18,7 +20,6 @@ group = "org.graceframework"
 version = project.projectVersion
 
 ext {
-    hibernatePluginVersion = project.hibernatePluginVersion
     isCiBuild = project.hasProperty("isCiBuild") || System.getenv().get("CI") as Boolean
     isBuildSnapshot = project.version.endsWith("-SNAPSHOT")
     isReleaseVersion = !isBuildSnapshot
@@ -30,7 +31,6 @@ ext {
 ext."signing.keyId" = System.getenv("SIGNING_KEY") ?: project.hasProperty("signing.keyId") ? project.getProperty('signing.keyId') : null
 ext."signing.password" = System.getenv("SIGNING_PASSPHRASE") ?: project.hasProperty("signing.password") ? project.getProperty('signing.password') : null
 ext."signing.secretKeyRingFile" = project.hasProperty("signing.secretKeyRingFile") ? project.getProperty('signing.secretKeyRingFile') : null
-ext['junit-jupiter.version'] = junitJupiterVersion
 
 apply plugin: 'maven-publish'
 apply plugin: "io.github.gradle-nexus.publish-plugin"
@@ -67,21 +67,17 @@ subprojects { project ->
         }
     }
 
-    ext['h2.version'] = h2Version
-    ext['gorm.version'] = datastoreVersion
-    ext['gorm.hibernate5.version'] = hibernatePluginVersion
-    ext['junit-jupiter.version'] = junitJupiterVersion
-    ext['spock.version'] = spockVersion
-    ext['mongodb.version'] = mongodbDriverVersion
-
     if (project.name.startsWith("examples")) {
+        group = "examples"
 
         apply plugin: 'groovy'
 
-        if(project.name.contains('grace')) {
-
+        if (project.name.contains('grace')) {
             apply plugin:"org.graceframework.grace-web"
             apply plugin:"org.graceframework.grace-gsp"
+            // Execution failed for task ':examples-grace-hibernate5-mongodb:assetCompile'.
+            // > java.util.concurrent.ExecutionException: java.lang.NoSuchMethodError: 'void groovy.lang.IntRange.<init>(boolean, boolean, int, int)'
+            // apply plugin: "org.graceframework.asset-pipeline"
         }
 
         boolean usesGeb = project.name.contains('grace-hibernate5-mongodb') || project.name.contains('grace-mongodb') || project.name.contains('grace-mongodb-database-per-tenant')|| project.name.contains('grace-rxmongodb')
@@ -90,18 +86,33 @@ subprojects { project ->
             apply plugin:"com.github.erdi.webdriver-binaries"
         }
 
-        if (project.name == "examples-test-data-service") {
+        if (project.name == "examples-grace-test-data-service") {
             apply plugin:"org.graceframework.grace-web"
             apply plugin:"org.graceframework.plugins.views-json"
         }
 
+        if (project.name == "examples-springboot-mongodb") {
+            apply plugin: 'org.springframework.boot'
+            apply plugin: 'io.spring.dependency-management'
+
+            dependencyManagement {
+                imports {
+                    mavenBom "org.graceframework:grace-bom:$graceVersion"
+                }
+                applyMavenExclusions false
+                generatedPomCustomization {
+                    enabled = false
+                }
+            }
+        }
+
         dependencies {
-            testImplementation "org.hibernate:hibernate-validator:$hibernateValidatorVersion"
-            testImplementation "org.apache.groovy:groovy-test-junit5:$groovyVersion"
-            testImplementation "org.spockframework:spock-core:$spockVersion", { transitive = false }
-            testImplementation "org.junit.jupiter:junit-jupiter-api:$junitJupiterVersion"
-            testImplementation "org.junit.platform:junit-platform-runner:1.10.2"
-            testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitJupiterVersion"
+            testImplementation "org.hibernate.validator:hibernate-validator"
+            testImplementation "org.apache.groovy:groovy-test-junit5"
+            testImplementation "org.spockframework:spock-core", { transitive = false }
+            testImplementation "org.junit.jupiter:junit-jupiter-api"
+            testImplementation "org.junit.platform:junit-platform-runner"
+            testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine"
         }
 
         tasks.withType(Test) {
@@ -120,11 +131,6 @@ subprojects { project ->
     }
 
     boolean isPluginProject = project.name.startsWith("grace") && project.name.endsWith("-plugin")
-    boolean isGracePluginProject = project.name.endsWith("-plugin")
-
-    ext {
-        projectInfo = new PublishingConvention(project)
-    }
 
     apply plugin: 'groovy'
 
@@ -133,11 +139,22 @@ subprojects { project ->
         version = rootProject.version
 
         apply plugin: "org.graceframework.grace-plugin"
-    } else {
+    }
+    else {
         group = "org.graceframework"
         version = rootProject.version
 
-        apply plugin: "groovy"
+        apply plugin: "io.spring.dependency-management"
+
+        dependencyManagement {
+            imports {
+                mavenBom "org.graceframework:grace-bom:$graceVersion"
+            }
+            applyMavenExclusions false
+            generatedPomCustomization {
+                enabled = false
+            }
+        }
     }
 
     if (project.name == 'docs') {
@@ -156,43 +173,50 @@ subprojects { project ->
         withSourcesJar()
     }
 
-    configurations {
-        all {
-            resolutionStrategy {
-                force "org.apache.groovy:groovy:$groovyVersion"
-                force "org.apache.groovy:groovy-dateutil:$groovyVersion"
-                force "org.apache.groovy:groovy-xml:$groovyVersion"
-                force "org.apache.groovy:groovy-templates:$groovyVersion"
-            }
-        }
-    }
-
     dependencies {
-        api "org.apache.groovy:groovy:$groovyVersion"
-        api "org.apache.groovy:groovy-templates:$groovyVersion"
+        api "org.apache.groovy:groovy"
+        api "org.apache.groovy:groovy-templates"
 
-        testImplementation "org.apache.groovy:groovy-json:$groovyVersion"
-        testImplementation "org.apache.groovy:groovy-templates:$groovyVersion"
-        testImplementation "org.apache.groovy:groovy-test-junit5:$groovyVersion", {
+        testImplementation "org.apache.groovy:groovy-json"
+        testImplementation "org.apache.groovy:groovy-templates"
+        testImplementation "org.apache.groovy:groovy-test-junit5", {
             exclude group: "org.junit.platform", module: "junit-platform-launcher"
             exclude group: "org.junit.jupiter", module: "junit-jupiter-engine"
         }
-        testImplementation "org.spockframework:spock-core:$spockVersion", {
+        testImplementation "org.spockframework:spock-core", {
             exclude group: "org.junit.platform", module: "junit-platform-engine"
         }
-        testImplementation "org.junit.jupiter:junit-jupiter-api:$junitJupiterVersion"
-        testImplementation "org.junit.platform:junit-platform-runner:$junitPlatformVersion"
-        testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitJupiterVersion"
+        testImplementation "org.junit.jupiter:junit-jupiter-api"
+        testImplementation "org.junit.platform:junit-platform-runner"
+        testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine"
     }
 
     publishing {
         publications {
             maven(MavenPublication) {
+                def projectArtifactId = project.name
+                def projectName = project.name.split('-')*.capitalize().join(' ')
+                if (project.name == 'grace-plugin') {
+                    projectArtifactId = 'mongodb'
+                    projectName = 'Grace MongoDb Plugin'
+                }
+
+                artifactId projectArtifactId
+                from components.java
+
+                versionMapping {
+                    usage('java-api') {
+                        fromResolutionOf('runtimeClasspath')
+                    }
+                    usage('java-runtime') {
+                        fromResolutionResult()
+                    }
+                }
 
                 pom {
-                    name = projectInfo.projectName
-                    description = projectInfo.projectDescription
-                    url = projectInfo.projectURL
+                    name = projectName                
+                    description = "Grace Data : $projectName"
+                    url = 'https://github.com/graceframework/grace-data-mongodb'
 
                     licenses {
                         license {
@@ -203,7 +227,7 @@ subprojects { project ->
                     }
 
                     scm {
-                        url = 'scm:git@github.com:graceframework/grace-data-mongodb.git'
+                        url = 'https://github.com/graceframework/grace-data-mongodb'
                         connection = 'scm:[email protected]:graceframework/grace-data-mongodb.git'
                         developerConnection = 'scm:[email protected]:graceframework/grace-data-mongodb.git'
                     }
@@ -217,11 +241,8 @@ subprojects { project ->
                     }
                 }
 
-                artifactId projectInfo.projectArtifactId
-                from components.java
-
                 afterEvaluate {
-                    if (isGracePluginProject) {
+                    if (isPluginProject) {
                         artifact source:"${sourceSets.main.groovy.classesDirectory.get()}/META-INF/grails-plugin.xml",
                                 classifier:"plugin",
                                 extension:'xml'
@@ -248,24 +269,3 @@ subprojects { project ->
         shouldRunAfter(tasks.withType(Sign))
     }
 }
-
-class PublishingConvention {
-    Project project
-
-    String projectArtifactId
-    String projectName = 'Grace Data MongoDB'
-    String projectDescription = 'Provides a GORM Object Mapping implementations for the MongodB Document Database'
-    String projectURL = 'https://github.com/graceframework/grace-data-mongodb'
-    String projectIssueTrackerUrl = 'https://github.com/graceframework/grace-data-mongodb/issues'
-    String projectVcsUrl = 'https://github.com/graceframework/grace-data-mongodb'
-
-    PublishingConvention(Project project) {
-        this.project = project
-
-        def name = project.name
-        if (name.startsWith('grace') && name.endsWith('-plugin')) {
-            name = 'mongodb'
-        }
-        projectArtifactId = name
-    }
-}

examples/grace-hibernate5-mongodb/build.gradle

@@ -1,5 +1,3 @@
-group = "examples"
-
 dependencies {
     implementation "org.springframework.boot:spring-boot-starter-logging"
     implementation "org.springframework.boot:spring-boot-autoconfigure"

examples/grace-mongodb-database-per-tenant/build.gradle

@@ -1,5 +1,3 @@
-group = "examples"
-
 dependencies {
     implementation "org.springframework.boot:spring-boot-starter-logging"
     implementation "org.springframework.boot:spring-boot-autoconfigure"

examples/grace-mongodb/build.gradle

@@ -1,5 +1,3 @@
-group = "examples"
-
 dependencies {
     implementation "org.springframework.boot:spring-boot-starter-logging"
     implementation "org.springframework.boot:spring-boot-autoconfigure"

examples/springboot-mongodb/build.gradle

@@ -1,12 +1,7 @@
-apply plugin: 'org.springframework.boot'
-apply plugin: 'io.spring.dependency-management'
-
-group = 'example'
-
 dependencies {
     implementation "org.springframework.boot:spring-boot-starter-web"
     implementation project(":grace-plugin")
 
     testImplementation"org.springframework.boot:spring-boot-starter-test"
-    testImplementation"org.spockframework:spock-core:$spockVersion"
+    testImplementation"org.spockframework:spock-core"
 }

grace-datastore-gorm-bson/build.gradle

@@ -1,4 +1,4 @@
 dependencies {
-    api "org.graceframework:grace-datastore-gorm:$datastoreVersion"
+    api "org.graceframework:grace-datastore-gorm"
     api "org.mongodb:bson:$mongodbDriverVersion"
 }

grace-datastore-gorm-mongodb/build.gradle

@@ -2,25 +2,25 @@ import org.gradle.api.tasks.testing.logging.TestExceptionFormat
 
 dependencies {
     api "org.mongodb:mongodb-driver-sync:$mongodbDriverVersion"
-    api "org.graceframework:grace-datastore-gorm-validation:$datastoreVersion"
-    api "org.graceframework:grace-datastore-gorm:$datastoreVersion"
+    api "org.graceframework:grace-datastore-gorm-validation"
+    api "org.graceframework:grace-datastore-gorm"
     api project(":grace-datastore-gorm-bson")
 
-    implementation "com.github.ben-manes.caffeine:caffeine:$caffeineVersion"
+    implementation "com.github.ben-manes.caffeine:caffeine"
 
-    compileOnly "org.graceframework:grace-datastore-gorm-support:$datastoreVersion"
-    compileOnly "jakarta.servlet:jakarta.servlet-api:$servletApiVersion"
+    compileOnly "org.graceframework:grace-datastore-gorm-support"
+    compileOnly "jakarta.servlet:jakarta.servlet-api"
 
     testImplementation "org.testcontainers:mongodb:1.19.8"
     testImplementation "org.graceframework:grace-datastore-gorm-tck:$datastoreVersion"
-    testImplementation "org.graceframework:grace-test-support:$graceVersion"
-    testImplementation "jakarta.validation:jakarta.validation-api:$jakartaValidationVersion"
-    testImplementation "org.hibernate.validator:hibernate-validator:$hibernateValidatorVersion"
-    testImplementation "org.graceframework:grace-datastore-gorm-support:$datastoreVersion", {
+    testImplementation "org.graceframework:grace-test-support:"
+    testImplementation "jakarta.validation:jakarta.validation-api"
+    testImplementation "org.hibernate.validator:hibernate-validator"
+    testImplementation "org.graceframework:grace-datastore-gorm-support", {
         exclude group: "org.graceframework", module:"grace-datastore-gorm-hibernate-core"
     }
     testRuntimeOnly "org.glassfish:jakarta.el:$jakartaElVersion"
-    testRuntimeOnly "org.springframework:spring-aop:$springVersion"
+    testRuntimeOnly "org.springframework:spring-aop"
 }
 
 

grace-plugin/build.gradle

@@ -2,17 +2,18 @@ dependencies {
     compileOnly "org.graceframework:grace-core"
     compileOnly "org.graceframework:grace-bootstrap"
     compileOnly "org.graceframework:grace-boot"
-    compileOnly "org.spockframework:spock-core:$spockVersion", {
+    compileOnly "org.spockframework:spock-core", {
         exclude group: "junit", module: "junit-dep"
         exclude group: 'org.codehaus.groovy', module: 'groovy-all'
         exclude group: 'org.hamcrest', module: 'hamcrest-core'
     }
 
-    api("org.springframework.boot:spring-boot-autoconfigure:$springBootVersion")
-    annotationProcessor("org.springframework.boot:spring-boot-autoconfigure-processor:$springBootVersion")
-    annotationProcessor("org.springframework.boot:spring-boot-configuration-processor:$springBootVersion")
-    api "org.graceframework:grace-datastore-gorm-support:$datastoreVersion"
-    api "org.graceframework:grace-datastore-web:$datastoreVersion"
     api project(":grace-datastore-gorm-mongodb-ext")
     api project(":grace-datastore-gorm-mongodb")
+    api "org.graceframework:grace-datastore-gorm-support"
+    api "org.graceframework:grace-datastore-web"
+
+    api("org.springframework.boot:spring-boot-autoconfigure")
+    annotationProcessor("org.springframework.boot:spring-boot-autoconfigure-processor")
+    annotationProcessor("org.springframework.boot:spring-boot-configuration-processor")
 }

gradle.properties

@@ -1,25 +1,15 @@
 projectVersion=2023.3.0-SNAPSHOT
 assetPipelineVersion=6.3.0-M1
-caffeineVersion=3.1.8
 datastoreVersion=2023.3.0-M1
 graceVersion=2023.3.0-M2
 groovyVersion=4.0.26
 jakartaElVersion=4.0.2
-jakartaValidationVersion=3.0.2
-h2Version=2.2.224
-hibernateCoreVersion=5.6.15.Final
-hibernatePluginVersion=2023.2.0
-hibernateValidatorVersion=8.0.2.Final
 jansiVersion=2.4.1
 javaParserCoreVersion=3.26.4
-junitJupiterVersion=5.10.5
-junitPlatformVersion=1.10.5
 mongodbDriverVersion=5.0.1
 seleniumVersion=4.2.2
-spockVersion=2.3-groovy-4.0
-springBootVersion=3.3.10
-springVersion=6.1.18
 webdriverBinariesVersion=3.2
+
 org.gradle.caching=true
 org.gradle.daemon=true
 org.gradle.parallel=false

settings.gradle

@@ -1,3 +1,5 @@
+rootProject.name = 'Grace.Data.MongoDB'
+
 // core
 include "grace-datastore-gorm-bson"
 include "grace-datastore-gorm-mongodb"