Initial light refactoring to remove some duplicated code

jeffgbutler · jeffgbutler · commit 186ecbd6bcb5 · 2023-01-12T16:19:01.000-05:00
diff --git a/core/mybatis-generator-core/src/main/java/org/mybatis/generator/api/ProgressCallback.java b/core/mybatis-generator-core/src/main/java/org/mybatis/generator/api/ProgressCallback.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright 2006-2022 the original author or authors.
+ *    Copyright 2006-2023 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.
@@ -65,7 +65,7 @@ default void generationStarted(int totalTasks) {}
     /**
      * Called to note the start of the file saving phase, and to note the
      * maximum number of startTask messages that will be sent for the file
-     * saving phase phase.
+     * saving phase.
      *
      * @param totalTasks
      *            the maximum number of times startTask will be called for the
@@ -87,8 +87,8 @@ default void startTask(String taskName) {}
     default void done() {}
 
     /**
-     * The method is called periodically during a long running method.
-     * If the the implementation throws <code>InterruptedException</code> then
+     * The method is called periodically during a long-running method.
+     * If the implementation throws <code>InterruptedException</code> then
      * the method will be canceled. Any files that have already been saved will
      * remain on the file system.
      *
diff --git a/core/mybatis-generator-core/src/main/java/org/mybatis/generator/api/ShellRunner.java b/core/mybatis-generator-core/src/main/java/org/mybatis/generator/api/ShellRunner.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright 2006-2022 the original author or authors.
+ *    Copyright 2006-2023 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.
@@ -22,17 +22,16 @@
 import java.sql.SQLException;
 import java.util.ArrayList;
 import java.util.HashMap;
-import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
-import java.util.StringTokenizer;
 
 import org.mybatis.generator.config.Configuration;
 import org.mybatis.generator.config.xml.ConfigurationParser;
 import org.mybatis.generator.exception.InvalidConfigurationException;
 import org.mybatis.generator.exception.XMLParserException;
 import org.mybatis.generator.internal.DefaultShellCallback;
+import org.mybatis.generator.internal.util.StringUtility;
 import org.mybatis.generator.logging.LogFactory;
 
 /**
@@ -79,42 +78,22 @@ public static void main(String[] args) {
             return;
         }
 
-        Set<String> fullyqualifiedTables = new HashSet<>();
-        if (arguments.containsKey(TABLES)) {
-            StringTokenizer st = new StringTokenizer(arguments.get(TABLES), ","); //$NON-NLS-1$
-            while (st.hasMoreTokens()) {
-                String s = st.nextToken().trim();
-                if (s.length() > 0) {
-                    fullyqualifiedTables.add(s);
-                }
-            }
-        }
+        Set<String> fullyQualifiedTables = StringUtility.tokenize(arguments.get(TABLES));
 
-        Set<String> contexts = new HashSet<>();
-        if (arguments.containsKey(CONTEXT_IDS)) {
-            StringTokenizer st = new StringTokenizer(
-                    arguments.get(CONTEXT_IDS), ","); //$NON-NLS-1$
-            while (st.hasMoreTokens()) {
-                String s = st.nextToken().trim();
-                if (s.length() > 0) {
-                    contexts.add(s);
-                }
-            }
-        }
+        Set<String> contexts = StringUtility.tokenize(arguments.get(CONTEXT_IDS));
 
         try {
             ConfigurationParser cp = new ConfigurationParser(warnings);
             Configuration config = cp.parseConfiguration(configurationFile);
 
-            DefaultShellCallback shellCallback = new DefaultShellCallback(
-                    arguments.containsKey(OVERWRITE));
+            DefaultShellCallback shellCallback = new DefaultShellCallback(arguments.containsKey(OVERWRITE));
 
             MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, shellCallback, warnings);
 
             ProgressCallback progressCallback = arguments.containsKey(VERBOSE) ? new VerboseProgressCallback()
                     : null;
 
-            myBatisGenerator.generate(progressCallback, contexts, fullyqualifiedTables);
+            myBatisGenerator.generate(progressCallback, contexts, fullyQualifiedTables);
 
         } catch (XMLParserException e) {
             writeLine(getString("Progress.3")); //$NON-NLS-1$
diff --git a/core/mybatis-generator-core/src/main/java/org/mybatis/generator/internal/DefaultShellCallback.java b/core/mybatis-generator-core/src/main/java/org/mybatis/generator/internal/DefaultShellCallback.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright 2006-2022 the original author or authors.
+ *    Copyright 2006-2023 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.
@@ -33,17 +33,15 @@ public DefaultShellCallback(boolean overwrite) {
     }
 
     @Override
-    public File getDirectory(String targetProject, String targetPackage)
-            throws ShellException {
-        // targetProject is interpreted as a directory that must exist
+    public File getDirectory(String targetProject, String targetPackage) throws ShellException {
+        // targetProject is interpreted as a directory that must already exist
         //
-        // targetPackage is interpreted as a sub directory, but in package
-        // format (with dots instead of slashes). The sub directory will be
-        // created
-        // if it does not already exist
+        // targetPackage is interpreted as a subdirectory, but in package
+        // format (with dots instead of slashes). The subdirectory will be
+        // created if it does not already exist
 
-        File project = new File(targetProject);
-        if (!project.isDirectory()) {
+        File targetProjectDirectory = new File(targetProject);
+        if (!targetProjectDirectory.isDirectory()) {
             throw new ShellException(getString("Warning.9", //$NON-NLS-1$
                     targetProject));
         }
@@ -55,7 +53,7 @@ public File getDirectory(String targetProject, String targetPackage)
             sb.append(File.separatorChar);
         }
 
-        File directory = new File(project, sb.toString());
+        File directory = new File(targetProjectDirectory, sb.toString());
         if (!directory.isDirectory()) {
             boolean rc = directory.mkdirs();
             if (!rc) {
diff --git a/core/mybatis-generator-core/src/main/java/org/mybatis/generator/internal/util/StringUtility.java b/core/mybatis-generator-core/src/main/java/org/mybatis/generator/internal/util/StringUtility.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright 2006-2022 the original author or authors.
+ *    Copyright 2006-2023 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.
@@ -15,6 +15,8 @@
  */
 package org.mybatis.generator.internal.util;
 
+import java.util.HashSet;
+import java.util.Set;
 import java.util.StringTokenizer;
 
 public class StringUtility {
@@ -100,4 +102,26 @@ public static boolean stringContainsSQLWildcard(String s) {
 
         return s.indexOf('%') != -1 || s.indexOf('_') != -1;
     }
+
+    /**
+     * Given an input string, tokenize on the commas and trim all token.
+     * Returns an empty set if the input string is null.
+     *
+     * @param in strong to tokenize.
+     * @return Set of tokens
+     */
+    public static Set<String> tokenize(String in) {
+        Set<String> answer = new HashSet<>();
+        if (StringUtility.stringHasValue(in)) {
+            StringTokenizer st = new StringTokenizer(in, ","); //$NON-NLS-1$
+            while (st.hasMoreTokens()) {
+                String s = st.nextToken().trim();
+                if (s.length() > 0) {
+                    answer.add(s);
+                }
+            }
+        }
+        return answer;
+    }
+
 }
diff --git a/core/mybatis-generator-core/src/site/xhtml/whatsNew.xhtml b/core/mybatis-generator-core/src/site/xhtml/whatsNew.xhtml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
 
-       Copyright 2006-2022 the original author or authors.
+       Copyright 2006-2023 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.
diff --git a/core/mybatis-generator-maven-plugin/src/main/java/org/mybatis/generator/maven/MavenShellCallback.java b/core/mybatis-generator-maven-plugin/src/main/java/org/mybatis/generator/maven/MavenShellCallback.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright 2006-2022 the original author or authors.
+ *    Copyright 2006-2023 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.
@@ -16,65 +16,43 @@
 package org.mybatis.generator.maven;
 
 import java.io.File;
-import java.util.StringTokenizer;
 
 import org.mybatis.generator.exception.ShellException;
 import org.mybatis.generator.internal.DefaultShellCallback;
-import org.mybatis.generator.internal.util.messages.Messages;
+
+import static org.mybatis.generator.internal.util.messages.Messages.getString;
 
 /**
  * Shell callback that calculates the Maven output directory.
  *
  * @author Jeff Butler
  */
 public class MavenShellCallback extends DefaultShellCallback {
-    private MyBatisGeneratorMojo mybatisGeneratorMojo;
+    private final MyBatisGeneratorMojo mybatisGeneratorMojo;
 
     public MavenShellCallback(MyBatisGeneratorMojo mybatisGeneratorMojo, boolean overwrite) {
         super(overwrite);
         this.mybatisGeneratorMojo = mybatisGeneratorMojo;
     }
 
     @Override
-    public File getDirectory(String targetProject, String targetPackage)
-            throws ShellException {
-        if (!"MAVEN".equals(targetProject)) {
-            return super.getDirectory(targetProject, targetPackage);
-        }
-
-        // targetProject is the output directory from the MyBatis generator
-        // Mojo. It will be created if necessary
-        //
-        // targetPackage is interpreted as a sub directory, but in package
-        // format (with dots instead of slashes).  The sub directory will be created
-        // if it does not already exist
-
-        File project = mybatisGeneratorMojo.getOutputDirectory();
-        if (!project.exists()) {
-            project.mkdirs();
-        }
-
-        if (!project.isDirectory()) {
-            throw new ShellException(Messages.getString("Warning.9", //$NON-NLS-1$
-                    project.getAbsolutePath()));
-        }
-
-        StringBuilder sb = new StringBuilder();
-        StringTokenizer st = new StringTokenizer(targetPackage, "."); //$NON-NLS-1$
-        while (st.hasMoreTokens()) {
-            sb.append(st.nextToken());
-            sb.append(File.separatorChar);
-        }
-
-        File directory = new File(project, sb.toString());
-        if (!directory.isDirectory()) {
-            boolean rc = directory.mkdirs();
-            if (!rc) {
-                throw new ShellException(Messages.getString("Warning.10", //$NON-NLS-1$
-                        directory.getAbsolutePath()));
+    public File getDirectory(String targetProject, String targetPackage) throws ShellException {
+        if ("MAVEN".equals(targetProject)) {
+            // targetProject is the output directory from the MyBatis generator
+            // Mojo. It will be created if necessary
+
+            File project = mybatisGeneratorMojo.getOutputDirectory();
+            if (!project.exists()) {
+                boolean rc = project.mkdirs();
+                if (!rc) {
+                    throw new ShellException(getString("Warning.10", //$NON-NLS-1$
+                            project.getAbsolutePath()));
+                }
             }
-        }
 
-        return directory;
+            return super.getDirectory(project.getAbsolutePath(), targetPackage);
+        } else {
+            return super.getDirectory(targetProject, targetPackage);
+        }
     }
 }
diff --git a/core/mybatis-generator-maven-plugin/src/main/java/org/mybatis/generator/maven/MyBatisGeneratorMojo.java b/core/mybatis-generator-maven-plugin/src/main/java/org/mybatis/generator/maven/MyBatisGeneratorMojo.java
@@ -1,5 +1,5 @@
 /*
- *    Copyright 2006-2022 the original author or authors.
+ *    Copyright 2006-2023 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.
@@ -22,7 +22,6 @@
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
-import java.util.StringTokenizer;
 
 import org.apache.maven.artifact.DependencyResolutionRequiredException;
 import org.apache.maven.model.Resource;
@@ -44,6 +43,8 @@
 import org.mybatis.generator.internal.util.StringUtility;
 import org.mybatis.generator.internal.util.messages.Messages;
 import org.mybatis.generator.logging.LogFactory;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Goal which generates MyBatis artifacts.
@@ -181,69 +182,38 @@ public void execute() throws MojoExecutionException {
         ObjectFactory.addExternalClassLoader(cl);
 
         if (configurationFile == null) {
-            throw new MojoExecutionException(
-                    Messages.getString("RuntimeError.0")); //$NON-NLS-1$
+            throw new MojoExecutionException(Messages.getString("RuntimeError.0")); //$NON-NLS-1$
         }
 
-        List<String> warnings = new ArrayList<>();
-
         if (!configurationFile.exists()) {
-            throw new MojoExecutionException(Messages.getString(
-                    "RuntimeError.1", configurationFile.toString())); //$NON-NLS-1$
+            throw new MojoExecutionException(Messages.getString("RuntimeError.1", configurationFile.toString())); //$NON-NLS-1$
         }
 
         runScriptIfNecessary();
 
-        Set<String> fullyqualifiedTables = new HashSet<>();
-        if (StringUtility.stringHasValue(tableNames)) {
-            StringTokenizer st = new StringTokenizer(tableNames, ","); //$NON-NLS-1$
-            while (st.hasMoreTokens()) {
-                String s = st.nextToken().trim();
-                if (s.length() > 0) {
-                    fullyqualifiedTables.add(s);
-                }
-            }
-        }
+        Set<String> fullyQualifiedTables = StringUtility.tokenize(tableNames);
 
-        Set<String> contextsToRun = new HashSet<>();
-        if (StringUtility.stringHasValue(contexts)) {
-            StringTokenizer st = new StringTokenizer(contexts, ","); //$NON-NLS-1$
-            while (st.hasMoreTokens()) {
-                String s = st.nextToken().trim();
-                if (s.length() > 0) {
-                    contextsToRun.add(s);
-                }
-            }
-        }
+        Set<String> contextsToRun = StringUtility.tokenize(contexts);
+
+        List<String> warnings = new ArrayList<>();
 
         try {
-            ConfigurationParser cp = new ConfigurationParser(
-                    project.getProperties(), warnings);
+            ConfigurationParser cp = new ConfigurationParser(project.getProperties(), warnings);
             Configuration config = cp.parseConfiguration(configurationFile);
 
             ShellCallback callback = new MavenShellCallback(this, overwrite);
 
-            MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,
-                    callback, warnings);
+            MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
 
-            myBatisGenerator.generate(new MavenProgressCallback(getLog(),
-                    verbose), contextsToRun, fullyqualifiedTables);
+            myBatisGenerator.generate(new MavenProgressCallback(getLog(), verbose), contextsToRun, fullyQualifiedTables);
 
-        } catch (XMLParserException e) {
+        } catch (XMLParserException | InvalidConfigurationException e) {
             for (String error : e.getErrors()) {
                 getLog().error(error);
             }
 
             throw new MojoExecutionException(e.getMessage());
-        } catch (SQLException e) {
-            throw new MojoExecutionException(e.getMessage());
-        } catch (IOException e) {
-            throw new MojoExecutionException(e.getMessage());
-        } catch (InvalidConfigurationException e) {
-            for (String error : e.getErrors()) {
-                getLog().error(error);
-            }
-
+        } catch (SQLException | IOException e) {
             throw new MojoExecutionException(e.getMessage());
         } catch (InterruptedException e) {
             // ignore (will never happen with the DefaultShellCallback)
@@ -253,8 +223,7 @@ public void execute() throws MojoExecutionException {
             getLog().warn(error);
         }
 
-        if (project != null && outputDirectory != null
-                && outputDirectory.exists()) {
+        if (project != null && outputDirectory != null && outputDirectory.exists()) {
             project.addCompileSourceRoot(outputDirectory.getAbsolutePath());
 
             Resource resource = new Resource();
diff --git a/core/mybatis-generator-maven-plugin/src/main/java/org/mybatis/generator/maven/SqlScriptRunner.java b/core/mybatis-generator-maven-plugin/src/main/java/org/mybatis/generator/maven/SqlScriptRunner.java
diff --git a/core/mybatis-generator-systests-domtests/src/main/java/mbg/domtest/GenerateTestSourceFiles.java b/core/mybatis-generator-systests-domtests/src/main/java/mbg/domtest/GenerateTestSourceFiles.java
