Code formatting with Checkstyle and Codenarc

Author: rainboyan

grace-plugin-database-migration/src/main/groovy/org/grails/plugins/databasemigration/DatabaseMigrationException.groovy

@@ -1,11 +1,11 @@
 /*
- * Copyright 2015 original authors
+ * Copyright 2015-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *      http://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -19,4 +19,5 @@ import groovy.transform.InheritConstructors
 
 @InheritConstructors
 class DatabaseMigrationException extends RuntimeException {
+
 }

grace-plugin-database-migration/src/main/groovy/org/grails/plugins/databasemigration/DatabaseMigrationGrailsPlugin.groovy

@@ -1,11 +1,11 @@
 /*
- * Copyright 2015 original authors
+ * Copyright 2015-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *      http://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -15,34 +15,25 @@
  */
 package org.grails.plugins.databasemigration
 
-import grails.plugins.Plugin
+import javax.sql.DataSource
+
 import liquibase.parser.ChangeLogParser
 import liquibase.parser.ChangeLogParserFactory
-import org.grails.plugins.databasemigration.liquibase.GormDatabase
-import org.grails.plugins.databasemigration.liquibase.GrailsLiquibase
-import org.grails.plugins.databasemigration.liquibase.GroovyChangeLogParser
 import org.springframework.context.ApplicationContext
 
-import javax.sql.DataSource
+import grails.plugins.Plugin
+import grails.util.GrailsUtil
+
+import org.grails.plugins.databasemigration.liquibase.GrailsLiquibase
+import org.grails.plugins.databasemigration.liquibase.GroovyChangeLogParser
 
 class DatabaseMigrationGrailsPlugin extends Plugin {
 
     static final String CONFIG_MAIN_PREFIX = 'grails.plugin.databasemigration'
 
-    def grailsVersion = "2023.0.0 > *"
-    def pluginExcludes = [
-            'testapp/**',
-            'databasemigration/**',
-            "grails-app/views/error.gsp"
-    ]
-
-    def title = "Grace Database Migration Plugin" // Headline display name of the plugin
-    def author = "Michael Yan"
-    def authorEmail = "rain@rainboyan.com"
-    def description = 'Grace Database Migration Plugin'
-    def documentation = "http://graceframework.org/plugin/database-migration"
-    def license = "APACHE"
-    def scm = [url: "https://github.com/graceframework/grace-database-migration"]
+    def version = GrailsUtil.getGrailsVersion()
+    def grailsVersion = '2023.0.0 > *'
+    def title = 'Grace Database Migration Plugin'
 
     @Override
     Closure doWithSpring() {
@@ -58,25 +49,28 @@ class DatabaseMigrationGrailsPlugin extends Plugin {
 
         dataSourceNames.each { String dataSourceName ->
             String configPrefix = isDefaultDataSource(dataSourceName) ? CONFIG_MAIN_PREFIX : "${CONFIG_MAIN_PREFIX}.${dataSourceName}"
-            def skipMainClasses = config.getProperty("${configPrefix}.skipUpdateOnStartMainClasses", List, ['grails.ui.command.GrailsApplicationContextCommandRunner'])
+            def skipMainClasses = config.getProperty("${configPrefix}.skipUpdateOnStartMainClasses", List,
+                    ['grails.ui.command.GrailsApplicationContextCommandRunner'])
             if (skipMainClasses.contains(mainClassName)) {
                 return
             }
 
-            if(!updateAllOnStart) {
+            if (!updateAllOnStart) {
                 def updateOnStart = config.getProperty("${configPrefix}.updateOnStart", Boolean, false)
                 if (!updateOnStart) {
                     return
                 }
-            } else {
+            }
+            else {
                 configPrefix = CONFIG_MAIN_PREFIX
             }
 
             new DatabaseMigrationTransactionManager(applicationContext, dataSourceName).withTransaction {
                 GrailsLiquibase gl = new GrailsLiquibase(applicationContext)
                 gl.dataSource = getDataSourceBean(applicationContext, dataSourceName)
                 gl.dropFirst = config.getProperty("${configPrefix}.dropOnStart", Boolean, false)
-                gl.changeLog = config.getProperty("${configPrefix}.updateOnStartFileName", String, isDefaultDataSource(dataSourceName) ? 'changelog.groovy' : "changelog-${dataSourceName}.groovy")
+                gl.changeLog = config.getProperty("${configPrefix}.updateOnStartFileName", String,
+                        isDefaultDataSource(dataSourceName) ? 'changelog.groovy' : "changelog-${dataSourceName}.groovy")
                 gl.contexts = config.getProperty("${configPrefix}.updateOnStartContexts", List, []).join(',')
                 gl.labels = config.getProperty("${configPrefix}.updateOnStartLabels", List, []).join(',')
                 gl.defaultSchema = config.getProperty("${configPrefix}.updateOnStartDefaultSchema", String)
@@ -88,12 +82,13 @@ class DatabaseMigrationGrailsPlugin extends Plugin {
         }
     }
 
-    private def getDataSourceBean(ApplicationContext applicationContext, String dataSourceName) {
+    private DataSource getDataSourceBean(ApplicationContext applicationContext, String dataSourceName) {
         applicationContext.getBean(getDataSourceName(dataSourceName), DataSource)
     }
 
     private void configureLiquibase() {
-        def groovyChangeLogParser = ChangeLogParserFactory.instance.parsers.find { ChangeLogParser changeLogParser -> changeLogParser instanceof GroovyChangeLogParser } as GroovyChangeLogParser
+        def groovyChangeLogParser = ChangeLogParserFactory.instance.parsers.find { ChangeLogParser changeLogParser ->
+            changeLogParser instanceof GroovyChangeLogParser } as GroovyChangeLogParser
         groovyChangeLogParser.applicationContext = applicationContext
         groovyChangeLogParser.config = config
     }
@@ -111,7 +106,9 @@ class DatabaseMigrationGrailsPlugin extends Plugin {
     }
 
     private String deduceApplicationMainClassName() {
-        new RuntimeException().stackTrace.find { StackTraceElement stackTraceElement -> 'main' == stackTraceElement.methodName }?.className
+        new RuntimeException().stackTrace.find { StackTraceElement stackTraceElement ->
+            'main' == stackTraceElement.methodName
+        }?.className
     }
 
     static String getDataSourceName(String dataSourceName) {
@@ -121,4 +118,5 @@ class DatabaseMigrationGrailsPlugin extends Plugin {
     static Boolean isDefaultDataSource(String dataSourceName) {
         !dataSourceName || 'dataSource' == dataSourceName
     }
+
 }

grace-plugin-database-migration/src/main/groovy/org/grails/plugins/databasemigration/DatabaseMigrationTransactionManager.groovy

@@ -1,12 +1,28 @@
+/*
+ * Copyright 2015-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.grails.plugins.databasemigration
 
-import grails.gorm.transactions.GrailsTransactionTemplate
 import org.springframework.context.ApplicationContext
 import org.springframework.transaction.PlatformTransactionManager
 import org.springframework.transaction.TransactionDefinition
 import org.springframework.transaction.support.DefaultTransactionDefinition
 import org.springframework.util.Assert
 
+import grails.gorm.transactions.GrailsTransactionTemplate
+
 /**
  * Created by Jim on 7/15/2016.
  */
@@ -25,12 +41,12 @@ class DatabaseMigrationTransactionManager {
      * @return The transactionManager bean for the current dataSource
      */
     PlatformTransactionManager getTransactionManager() {
-        String dataSource = this.dataSource ?: "dataSource"
-        String beanName = "transactionManager"
-        if (dataSource != "dataSource") {
+        String dataSource = this.dataSource ?: 'dataSource'
+        String beanName = 'transactionManager'
+        if (dataSource != 'dataSource') {
             beanName += "_${dataSource}"
         }
-        applicationContext.getBean(beanName, PlatformTransactionManager)
+        this.applicationContext.getBean(beanName, PlatformTransactionManager)
     }
 
     /**
@@ -92,15 +108,16 @@ class DatabaseMigrationTransactionManager {
         withTransaction(props, callable)
     }
 
-    void  withTransaction(Map transactionProperties, Closure callable) {
+    void withTransaction(Map transactionProperties, Closure callable) {
         def transactionDefinition = new DefaultTransactionDefinition()
         transactionProperties.each { k, v ->
-            if(v instanceof CharSequence && !(v instanceof String)) {
+            if (v instanceof CharSequence && !(v instanceof String)) {
                 v = v.toString()
             }
             try {
                 transactionDefinition[k as String] = v
-            } catch (MissingPropertyException mpe) {
+            }
+            catch (MissingPropertyException mpe) {
                 throw new IllegalArgumentException("[${k}] is not a valid transaction property.", mpe)
             }
         }
@@ -114,12 +131,13 @@ class DatabaseMigrationTransactionManager {
      * @return The result of the closure execution
      */
     void withTransaction(TransactionDefinition definition, Closure callable) {
-        Assert.notNull transactionManager, "No transactionManager bean configured"
+        Assert.notNull transactionManager, 'No transactionManager bean configured'
 
         if (!callable) {
             return
         }
 
         new GrailsTransactionTemplate(transactionManager, definition).execute(callable)
     }
+
 }

grace-plugin-database-migration/src/main/groovy/org/grails/plugins/databasemigration/EnvironmentAwareCodeGenConfig.groovy

@@ -1,11 +1,11 @@
 /*
- * Copyright 2015 original authors
+ * Copyright 2015-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *      http://www.apache.org/licenses/LICENSE-2.0
+ *      https://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
@@ -17,6 +17,7 @@ package org.grails.plugins.databasemigration
 
 import groovy.transform.CompileDynamic
 import groovy.transform.CompileStatic
+
 import org.grails.config.CodeGenConfig
 
 @CompileStatic
@@ -31,4 +32,5 @@ class EnvironmentAwareCodeGenConfig extends CodeGenConfig {
     private void mergeEnvironmentConfig(CodeGenConfig copyOf, String environment) {
         mergeMap(copyOf.environments?."$environment" ?: [:])
     }
+
 }

grace-plugin-database-migration/src/main/groovy/org/grails/plugins/databasemigration/NoopVisitor.groovy

@@ -1,3 +1,18 @@
+/*
+ * Copyright 2015-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.grails.plugins.databasemigration
 
 import liquibase.changelog.ChangeSet
@@ -18,7 +33,9 @@ class NoopVisitor implements ChangeSetVisitor {
     Direction getDirection() { Direction.FORWARD }
 
     @Override
-    void visit(ChangeSet changeSet, DatabaseChangeLog databaseChangeLog, Database database, Set<ChangeSetFilterResult> filterResults) throws LiquibaseException {
+    void visit(ChangeSet changeSet, DatabaseChangeLog databaseChangeLog, Database database,
+            Set<ChangeSetFilterResult> filterResults) throws LiquibaseException {
         changeSet.execute(databaseChangeLog, database)
     }
+
 }

grace-plugin-database-migration/src/main/groovy/org/grails/plugins/databasemigration/PluginConstants.groovy

@@ -1,7 +1,24 @@
+/*
+ * Copyright 2015-2025 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 package org.grails.plugins.databasemigration
 
 class PluginConstants {
-    static final String DATA_SOURCE_NAME_KEY = "dataSourceName"
+
+    static final String DATA_SOURCE_NAME_KEY = 'dataSourceName'
     static final String DEFAULT_DATASOURCE_NAME = 'dataSource'
     static final String DEFAULT_CHANGE_LOG_LOCATION = 'db/migrations'
+
 }