Add support for filtering tables out of a code generation run

Also add a plugin that will ignore table type VIEW

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".equals(introspectedTable.getTableType()); //$NON-NLS-1$
+    }
+}

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>

core/mybatis-generator-systests-mybatis3/src/test/java/mbg/test/mb3/simpleannotated/SimpleAnnotatedTest.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.
@@ -17,6 +17,7 @@
 
 import static mbg.test.common.util.TestUtilities.datesAreEqual;
 import static mbg.test.common.util.TestUtilities.timesAreEqual;
+import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 import static org.junit.jupiter.api.Assertions.*;
 
 import java.math.BigDecimal;
@@ -464,4 +465,18 @@ record = new Pkonly();
             sqlSession.close();
         }
     }
+
+    @Test
+    void testThatViewWasIgnored() throws ClassNotFoundException {
+        Class<?> goodClass = Class.forName("mbg.test.mb3.generated.simpleannotated.nothing.Pkfields");
+        assertNotNull(goodClass);
+
+        assertThatExceptionOfType(ClassNotFoundException.class).isThrownBy(() -> {
+            Class.forName("mbg.test.mb3.generated.simpleannotated.nothing.Nameview");
+        });
+
+        assertThatExceptionOfType(ClassNotFoundException.class).isThrownBy(() -> {
+            Class.forName("mbg.test.mb3.generated.simpleannotated.nothing.NameviewMapper");
+        });
+    }
 }