Merge pull request #951 from jeffgbutler/new-plugin-method

Add ability to provide a fine grained filter for tables in a context

Author: jeffgbutler

core/mybatis-generator-core/src/main/java/org/mybatis/generator/api/CompositePlugin.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.
@@ -1264,4 +1264,15 @@ public boolean clientUpdateByPrimaryKeyMethodGenerated(KotlinFunction kotlinFunc
 
         return true;
     }
+
+    @Override
+    public boolean shouldGenerate(IntrospectedTable introspectedTable) {
+        for (Plugin plugin : plugins) {
+            if (!plugin.shouldGenerate(introspectedTable)) {
+                return false;
+            }
+        }
+
+        return true;
+    }
 }

core/mybatis-generator-core/src/main/java/org/mybatis/generator/api/Plugin.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.
@@ -2034,4 +2034,14 @@ default boolean clientUpdateByPrimaryKeyMethodGenerated(KotlinFunction kotlinFun
             IntrospectedTable introspectedTable) {
         return true;
     }
+
+    /**
+     * If false, the table will be skipped in code generation.
+     *
+     * @param introspectedTable the current table
+     * @return true if code should be generated for this table, else false
+     */
+    default boolean shouldGenerate(IntrospectedTable introspectedTable) {
+        return true;
+    }
 }

core/mybatis-generator-core/src/main/java/org/mybatis/generator/config/Context.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.
@@ -459,6 +459,11 @@ public void generateFiles(ProgressCallback callback,
 
         for (IntrospectedTable introspectedTable : introspectedTables) {
             callback.checkCancel();
+
+            if (!pluginAggregator.shouldGenerate(introspectedTable)) {
+                continue;
+            }
+
             generatedJavaFiles.addAll(introspectedTable
                     .getGeneratedJavaFiles());
             generatedXmlFiles.addAll(introspectedTable

core/mybatis-generator-core/src/main/java/org/mybatis/generator/plugins/IgnoreViewsPlugin.java

@@ -0,0 +1,36 @@
+/*
+ *    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.
+ *    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.mybatis.generator.plugins;
+
+import org.mybatis.generator.api.IntrospectedTable;
+import org.mybatis.generator.api.PluginAdapter;
+
+import java.util.List;
+
+/**
+ * This plugin will cause any table of type "VIEW" in a context to be ignored.
+ */
+public class IgnoreViewsPlugin extends PluginAdapter {
+    @Override
+    public boolean validate(List<String> warnings) {
+        return true;
+    }
+
+    @Override
+    public boolean shouldGenerate(IntrospectedTable introspectedTable) {
+        return !"VIEW".equalsIgnoreCase(introspectedTable.getTableType()); //$NON-NLS-1$
+    }
+}

core/mybatis-generator-core/src/site/xhtml/reference/plugins.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.
@@ -119,6 +119,11 @@ The plugin will create the additional Methods:
 <p>Using this plugin, you can configure the property values fluently with chained method calls. Example: <code>new MyDomain().withFoo("Test").withBar(4711);</code></p>
 
 
+<h2>org.mybatis.generator.plugins.IgnoreViewsPlugin</h2>
+<p>This plugin will filter out any table of type "VIEW" from a code generation run. This can be useful if you use
+    a wildcard to select many tables and views, but don't want to generate code for the views.
+</p>
+
 <h2>org.mybatis.generator.plugins.MapperAnnotationPlugin</h2>
 <p>This plugin has no impact and is not needed when the target runtime in use is based on MyBatis Dynamic SQL.</p>
 <p>This plugin adds the <code>@Mapper</code> annotation to generated mapper interfaces.  This

core/mybatis-generator-core/src/site/xhtml/whatsNew.xhtml

@@ -40,6 +40,9 @@
       Logging should now work as expected in Maven - Maven ships with the SLF4J simple logger in the classpath, so
       configuring logging in Maven will always use the SLF simple logger.
   </li>
+  <li>Added a new plugin method "shouldGenerate" that can be used to provide fine-grained filtering of tables in a
+      context. Also added a new "IgnoreViewsPlugin" that filters out table type VIEW
+  </li>
 </ul>
 
 

core/mybatis-generator-core/src/test/resources/scripts/generatorConfig.xml

@@ -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.
@@ -906,4 +906,17 @@
       <columnOverride column="class" property="dbClass" />
     </table>
   </context>
+
+  <context id="nothing-generated" targetRuntime="MyBatis3Simple">
+    <plugin type="org.mybatis.generator.plugins.IgnoreViewsPlugin" />
+
+    <jdbcConnection driverClass="org.hsqldb.jdbcDriver" connectionURL="${database.url}" userId="sa" />
+
+    <javaModelGenerator targetPackage="mbg.test.mb3.generated.simpleannotated.nothing" targetProject="MAVEN"/>
+
+    <javaClientGenerator type="ANNOTATEDMAPPER" targetPackage="mbg.test.mb3.generated.simpleannotated.nothing"  targetProject="MAVEN"/>
+
+    <table tableName="NameView" />
+    <table tableName="PKFields" />
+  </context>
 </generatorConfiguration>

core/mybatis-generator-systests-mybatis3/pom.xml

@@ -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.
@@ -110,6 +110,10 @@
       <artifactId>hsqldb</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.assertj</groupId>
+      <artifactId>assertj-core</artifactId>
+    </dependency>
   </dependencies>
   <description>Tests for the MyBatis3 code generator.</description>
   <profiles>

core/mybatis-generator-systests-mybatis3/src/main/resources/generatorConfig.xml

@@ -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.
@@ -906,4 +906,17 @@
       <columnOverride column="class" property="dbClass" />
     </table>
   </context>
+
+  <context id="nothing-generated" targetRuntime="MyBatis3Simple">
+    <plugin type="org.mybatis.generator.plugins.IgnoreViewsPlugin" />
+
+    <jdbcConnection driverClass="org.hsqldb.jdbcDriver" connectionURL="${database.url}" userId="sa" />
+
+    <javaModelGenerator targetPackage="mbg.test.mb3.generated.simpleannotated.nothing" targetProject="MAVEN"/>
+
+    <javaClientGenerator type="ANNOTATEDMAPPER" targetPackage="mbg.test.mb3.generated.simpleannotated.nothing"  targetProject="MAVEN"/>
+
+    <table tableName="NameView" />
+    <table tableName="PKFields" />
+  </context>
 </generatorConfiguration>