Class exclude patterns

vojtechhabarta · vojtechhabarta · commit a38a6f4deb02 · 2016-10-02T22:47:15.000+02:00
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/ExcludingTypeProcessor.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/ExcludingTypeProcessor.java
@@ -1,25 +1,23 @@
 
 package cz.habarta.typescript.generator;
 
+import cz.habarta.typescript.generator.util.Predicate;
 import cz.habarta.typescript.generator.util.Utils;
 import java.lang.reflect.Type;
-import java.util.*;
 
 
 public class ExcludingTypeProcessor implements TypeProcessor {
 
-    private final Set<String> excludedClassNames = new LinkedHashSet<>();
+    private final Predicate<String> excludeFilter;
 
-    public ExcludingTypeProcessor(List<String> excludedClassNames) {
-        if (excludedClassNames != null) {
-            this.excludedClassNames.addAll(excludedClassNames);
-        }
+    public ExcludingTypeProcessor(Predicate<String> excludeFilter) {
+        this.excludeFilter = excludeFilter;
     }
 
     @Override
     public Result processType(Type javaType, Context context) {
         final Class<?> rawClass = Utils.getRawClassOrNull(javaType);
-        if (rawClass != null && excludedClassNames.contains(rawClass.getName())) {
+        if (rawClass != null && excludeFilter.test(rawClass.getName())) {
             return new Result(TsType.Any);
         }
         return null;
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/Input.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/Input.java
@@ -2,6 +2,7 @@
 package cz.habarta.typescript.generator;
 
 import cz.habarta.typescript.generator.parser.*;
+import cz.habarta.typescript.generator.util.Predicate;
 import io.github.lukehutch.fastclasspathscanner.FastClasspathScanner;
 import java.lang.reflect.*;
 import java.util.*;
@@ -58,12 +59,12 @@ private static Input fromClassNamePatterns(List<String> classNamePatterns) {
         return fromClassNames(classNames);
     }
 
-    private static Input fromJaxrsApplication(String jaxrsApplicationClassName, List<String> excludedClassNames) {
-        final List<SourceType<Type>> sourceTypes = new JaxrsApplicationScanner().scanJaxrsApplication(jaxrsApplicationClassName, excludedClassNames);
+    private static Input fromJaxrsApplication(String jaxrsApplicationClassName, Predicate<String> isClassNameExcluded) {
+        final List<SourceType<Type>> sourceTypes = new JaxrsApplicationScanner().scanJaxrsApplication(jaxrsApplicationClassName, isClassNameExcluded);
         return new Input(sourceTypes);
     }
 
-    public static Input fromClassNamesAndJaxrsApplication(List<String> classNames, List<String> classNamePatterns, String jaxrsApplicationClassName, boolean automaticJaxrsApplication, List<String> excludedClassNames, ClassLoader classLoader) {
+    public static Input fromClassNamesAndJaxrsApplication(List<String> classNames, List<String> classNamePatterns, String jaxrsApplicationClassName, boolean automaticJaxrsApplication, Predicate<String> isClassNameExcluded, ClassLoader classLoader) {
         final ClassLoader originalContextClassLoader = Thread.currentThread().getContextClassLoader();
         try {
             Thread.currentThread().setContextClassLoader(classLoader);
@@ -75,10 +76,10 @@ public static Input fromClassNamesAndJaxrsApplication(List<String> classNames, L
                 types.addAll(fromClassNamePatterns(classNamePatterns).getSourceTypes());
             }
             if (jaxrsApplicationClassName != null) {
-                types.addAll(fromJaxrsApplication(jaxrsApplicationClassName, excludedClassNames).getSourceTypes());
+                types.addAll(fromJaxrsApplication(jaxrsApplicationClassName, isClassNameExcluded).getSourceTypes());
             }
             if (automaticJaxrsApplication) {
-                types.addAll(fromJaxrsApplication(null, excludedClassNames).getSourceTypes());
+                types.addAll(fromJaxrsApplication(null, isClassNameExcluded).getSourceTypes());
             }
             if (types.isEmpty()) {
                 final String errorMessage = "No input classes found.";
@@ -92,22 +93,33 @@ public static Input fromClassNamesAndJaxrsApplication(List<String> classNames, L
     }
 
     static List<String> filterClassNames(List<String> classNames, List<String> globs) {
-        final List<Pattern> regexps = new ArrayList<>();
-        for (String glob : globs) {
-            regexps.add(globToRegexp(glob));
-        }
+        final List<Pattern> regexps = globsToRegexps(globs);
         final List<String> result = new ArrayList<>();
         for (String className : classNames) {
-            for (Pattern regexp : regexps) {
-                if (regexp.matcher(className).matches()) {
-                    result.add(className);
-                    break;
-                }
+            if (classNameMatches(className, regexps)) {
+                result.add(className);
             }
         }
         return result;
     }
 
+    static boolean classNameMatches(String className, List<Pattern> regexps) {
+        for (Pattern regexp : regexps) {
+            if (regexp.matcher(className).matches()) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    static List<Pattern> globsToRegexps(List<String> globs) {
+        final List<Pattern> regexps = new ArrayList<>();
+        for (String glob : globs) {
+            regexps.add(globToRegexp(glob));
+        }
+        return regexps;
+    }
+
     /**
      * Creates regexp for glob pattern.
      * Replaces "*" with "[^.\$]*" and "**" with ".*".
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/JaxrsApplicationScanner.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/JaxrsApplicationScanner.java
@@ -2,6 +2,7 @@
 package cz.habarta.typescript.generator;
 
 import cz.habarta.typescript.generator.parser.*;
+import cz.habarta.typescript.generator.util.Predicate;
 import cz.habarta.typescript.generator.util.Utils;
 import io.github.lukehutch.fastclasspathscanner.FastClasspathScanner;
 import java.lang.annotation.*;
@@ -13,16 +14,17 @@
 
 public class JaxrsApplicationScanner {
 
-    private Set<String> excludes;
+    private Predicate<String> isClassNameExcluded;
+    private Set<String> defaultExcludes;
     private Queue<Class<?>> resourceQueue;
     private List<SourceType<Type>> discoveredTypes;
 
-    public List<SourceType<Type>> scanJaxrsApplication(String jaxrsApplicationClassName, List<String> excludedClassNames) {
+    public List<SourceType<Type>> scanJaxrsApplication(String jaxrsApplicationClassName, Predicate<String> isClassNameExcluded) {
         try {
             final List<Class<?>> resourceClasses = jaxrsApplicationClassName != null
                     ? scanJaxrsApplicationForJaxrsResources(jaxrsApplicationClassName)
                     : scanClasspathForJaxrsResources();
-            return scanJaxrsApplication(resourceClasses, excludedClassNames);
+            return scanJaxrsApplication(resourceClasses, isClassNameExcluded);
         } catch (ReflectiveOperationException e) {
             final String url = "https://github.com/vojtechhabarta/typescript-generator/wiki/JAX-RS-Application";
             final String message = "Cannot load JAX-RS application. For more information see " + url + ".";
@@ -51,14 +53,11 @@ private static List<Class<?>> scanClasspathForJaxrsResources() throws Reflective
         return classes;
     }
 
-    List<SourceType<Type>> scanJaxrsApplication(List<Class<?>> resourceClasses, List<String> excludedClassNames) {
+    List<SourceType<Type>> scanJaxrsApplication(List<Class<?>> resourceClasses, Predicate<String> isClassNameExcluded) {
         resourceQueue = new LinkedList<>();
         discoveredTypes = new ArrayList<>();
-        excludes = new LinkedHashSet<>();
-        excludes.addAll(getDefaultExcludedClassNames());
-        if (excludedClassNames != null) {
-            excludes.addAll(excludedClassNames);
-        }
+        this.isClassNameExcluded = isClassNameExcluded;
+        this.defaultExcludes = new LinkedHashSet<>(getDefaultExcludedClassNames());
         final LinkedHashSet<Class<?>> scannedResources = new LinkedHashSet<>();
         Collections.sort(resourceClasses, new Comparator<Class<?>>() {
             @Override
@@ -128,7 +127,10 @@ private void foundType(Type type, Class<?> usedInClass, String usedInMember) {
 
     private boolean isExcluded(Type type) {
         final Class<?> cls = Utils.getRawClassOrNull(type);
-        if (cls != null && excludes.contains(cls.getName())) {
+        if (cls != null && isClassNameExcluded != null && isClassNameExcluded.test(cls.getName())) {
+            return true;
+        }
+        if (cls != null && defaultExcludes.contains(cls.getName())) {
             return true;
         }
         for (Class<?> standardEntityClass : getStandardEntityClasses()) {
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/Settings.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/Settings.java
@@ -2,9 +2,11 @@
 package cz.habarta.typescript.generator;
 
 import cz.habarta.typescript.generator.emitter.EmitterExtension;
+import cz.habarta.typescript.generator.util.Predicate;
 import java.io.File;
 import java.lang.annotation.Annotation;
 import java.util.*;
+import java.util.regex.Pattern;
 
 
 /**
@@ -21,7 +23,7 @@ public class Settings {
     public String module = null;
     public String namespace = null;
     public JsonLibrary jsonLibrary = null;
-    public List<String> excludedClassNames = null;
+    private Predicate<String> excludeFilter = null;
     public boolean declarePropertiesAsOptional = false;
     public String removeTypeNamePrefix = null;
     public String removeTypeNameSuffix = null;
@@ -118,6 +120,28 @@ public void validateFileName(File outputFile) {
         }
     }
 
+    public Predicate<String> getExcludeFilter() {
+        if (excludeFilter == null) {
+            setExcludeFilter(null, null);
+        }
+        return excludeFilter;
+    }
+
+    public void setExcludeFilter(List<String> excludedClasses, List<String> excludedClassPatterns) {
+        this.excludeFilter = createExcludeFilter(excludedClasses, excludedClassPatterns);
+    }
+
+    public static Predicate<String> createExcludeFilter(List<String> excludedClasses, List<String> excludedClassPatterns) {
+        final Set<String> names = new LinkedHashSet<>(excludedClasses != null ? excludedClasses : Collections.<String>emptyList());
+        final List<Pattern> patterns = Input.globsToRegexps(excludedClassPatterns != null ? excludedClassPatterns : Collections.<String>emptyList());
+        return new Predicate<String>() {
+            @Override
+            public boolean test(String className) {
+                return names.contains(className) || Input.classNameMatches(className, patterns);
+            }
+        };
+    }
+
     public boolean areDefaultStringEnumsOverriddenByExtension() {
         for (EmitterExtension extension : extensions) {
             if (extension.getFeatures().overridesStringEnums) {
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/TypeScriptGenerator.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/TypeScriptGenerator.java
@@ -54,7 +54,7 @@ private void generateTypeScript(Input input, Output output, boolean forceExportK
     public TypeProcessor getTypeProcessor() {
         if (typeProcessor == null) {
             final List<TypeProcessor> processors = new ArrayList<>();
-            processors.add(new ExcludingTypeProcessor(settings.excludedClassNames));
+            processors.add(new ExcludingTypeProcessor(settings.getExcludeFilter()));
             if (settings.customTypeProcessor != null) {
                 processors.add(settings.customTypeProcessor);
             }
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/Jackson2Parser.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/Jackson2Parser.java
@@ -126,7 +126,7 @@ private boolean isParentProperty(String property, Class<?> cls) {
         }
         parents.addAll(Arrays.asList(cls.getInterfaces()));
         for (Class<?> parent : parents) {
-            if (settings.excludedClassNames == null || !settings.excludedClassNames.contains(parent.getName())) {
+            if (!settings.getExcludeFilter().test(parent.getName())) {
                 final BeanHelper beanHelper = getBeanHelper(parent);
                 if (beanHelper != null) {
                     for (BeanPropertyWriter beanPropertyWriter : beanHelper.getProperties()) {
diff --git a/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/GenericsTest.java b/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/GenericsTest.java
@@ -94,7 +94,7 @@ public void testImplements() {
         final Settings settings = TestUtils.settings();
         settings.customTypeProcessor = new GenericsTypeProcessor();
         settings.sortDeclarations = true;
-        settings.excludedClassNames = Arrays.asList(Comparable.class.getName());
+        settings.setExcludeFilter(Arrays.asList(Comparable.class.getName()), null);
 
         final StringWriter stringWriter = new StringWriter();
         new TypeScriptGenerator(settings).generateEmbeddableTypeScript(Input.from(IA.class), Output.to(stringWriter), true, 0);
diff --git a/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/JaxrsApplicationScannerTest.java b/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/JaxrsApplicationScannerTest.java
@@ -3,6 +3,7 @@
 
 import com.fasterxml.jackson.core.type.*;
 import cz.habarta.typescript.generator.parser.*;
+import cz.habarta.typescript.generator.util.Predicate;
 import java.io.*;
 import java.lang.reflect.*;
 import java.util.*;
@@ -71,16 +72,20 @@ private void testWithParsing(String applicationClass) {
 
     @Test
     public void testExcludedResource() {
-        final List<SourceType<Type>> sourceTypes = new JaxrsApplicationScanner().scanJaxrsApplication(TestApplication.class.getName(), Arrays.asList(TestResource1.class.getName()));
+        final Predicate<String> excludeFilter = Settings.createExcludeFilter(Arrays.asList(
+                TestResource1.class.getName()
+        ), null);
+        final List<SourceType<Type>> sourceTypes = new JaxrsApplicationScanner().scanJaxrsApplication(TestApplication.class.getName(), excludeFilter);
         Assert.assertEquals(0, sourceTypes.size());
     }
 
     @Test
     public void testExcludedType() {
-        final List<SourceType<Type>> sourceTypes = new JaxrsApplicationScanner().scanJaxrsApplication(TestApplication.class.getName(), Arrays.asList(
+        final Predicate<String> excludeFilter = Settings.createExcludeFilter(Arrays.asList(
                 A.class.getName(),
                 J.class.getName()
-        ));
+        ), null);
+        final List<SourceType<Type>> sourceTypes = new JaxrsApplicationScanner().scanJaxrsApplication(TestApplication.class.getName(), excludeFilter);
         Assert.assertTrue(!getTypes(sourceTypes).contains(A.class));
         Assert.assertTrue(getTypes(sourceTypes).contains(J[].class));
     }
diff --git a/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/ModelCompilerTest.java b/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/ModelCompilerTest.java
@@ -29,10 +29,18 @@ public void testExclusion() throws Exception {
         Assert.assertEquals("{ [index: string]: any }[]", TestUtils.compileType(settings, javaType).toString());
     }
 
+    @Test
+    public void testExclusionPattern() throws Exception {
+        final Settings settings = TestUtils.settings();
+        settings.setExcludeFilter(null, Arrays.asList("**Direction"));
+        final Type javaType = A.class.getField("directions").getGenericType();
+        Assert.assertEquals("{ [index: string]: any }[]", TestUtils.compileType(settings, javaType).toString());
+    }
+
     private static Settings getTestSettings(String... excludedClassNames) {
         final Settings settings = TestUtils.settings();
         settings.mapDate = DateMapping.asString;
-        settings.excludedClassNames = Arrays.asList(excludedClassNames);
+        settings.setExcludeFilter(Arrays.asList(excludedClassNames), null);
         return settings;
     }
 
diff --git a/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/ModelParserTest.java b/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/ModelParserTest.java
@@ -61,9 +61,9 @@ public void testExcludedInputInList() {
 
     private Model parseModel(Type type, String... excludedClassNames) {
         final Settings settings = new Settings();
-        settings.excludedClassNames = Arrays.asList(excludedClassNames);
+        settings.setExcludeFilter(Arrays.asList(excludedClassNames), null);
         final ModelParser parser = new Jackson2Parser(settings, new TypeProcessor.Chain(
-                new ExcludingTypeProcessor(settings.excludedClassNames),
+                new ExcludingTypeProcessor(settings.getExcludeFilter()),
                 new DefaultTypeProcessor()
         ));
         final Model model = parser.parseModel(type);
diff --git a/typescript-generator-gradle-plugin/src/main/java/cz/habarta/typescript/generator/gradle/GenerateTask.java b/typescript-generator-gradle-plugin/src/main/java/cz/habarta/typescript/generator/gradle/GenerateTask.java
@@ -22,6 +22,7 @@ public class GenerateTask extends DefaultTask {
     public String classesFromJaxrsApplication;
     public boolean classesFromAutomaticJaxrsApplication;
     public List<String> excludeClasses;
+    public List<String> excludeClassPatterns;
     public List<String> includePropertyAnnotations;
     public JsonLibrary jsonLibrary;
     public boolean declarePropertiesAsOptional;
@@ -76,7 +77,7 @@ public void generate() throws Exception {
         settings.outputKind = outputKind;
         settings.module = module;
         settings.namespace = namespace;
-        settings.excludedClassNames = excludeClasses;
+        settings.setExcludeFilter(excludeClasses, excludeClassPatterns);
         settings.jsonLibrary = jsonLibrary;
         settings.declarePropertiesAsOptional = declarePropertiesAsOptional;
         settings.removeTypeNamePrefix = removeTypeNamePrefix;
@@ -103,7 +104,7 @@ public void generate() throws Exception {
 
         // TypeScriptGenerator
         new TypeScriptGenerator(settings).generateTypeScript(
-                Input.fromClassNamesAndJaxrsApplication(classes, classPatterns, classesFromJaxrsApplication, classesFromAutomaticJaxrsApplication, excludeClasses, classLoader),
+                Input.fromClassNamesAndJaxrsApplication(classes, classPatterns, classesFromJaxrsApplication, classesFromAutomaticJaxrsApplication, settings.getExcludeFilter(), classLoader),
                 Output.to(getProject().file(outputFile))
         );
     }
diff --git a/typescript-generator-maven-plugin/src/main/java/cz/habarta/typescript/generator/maven/GenerateMojo.java b/typescript-generator-maven-plugin/src/main/java/cz/habarta/typescript/generator/maven/GenerateMojo.java
@@ -63,7 +63,7 @@ public class GenerateMojo extends AbstractMojo {
     private List<String> classes;
 
     /**
-     * JSON classes to process specified using glob pattern
+     * JSON classes to process specified using glob patterns
      * so it is possible to specify package or class name suffix.
      * Glob patterns support two wildcards:
      * Single "*" wildcard matches any character except for "." and "$".
@@ -94,6 +94,12 @@ public class GenerateMojo extends AbstractMojo {
     @Parameter
     private List<String> excludeClasses;
 
+    /**
+     * Excluded classes specified using glob patterns.
+     */
+    @Parameter
+    private List<String> excludeClassPatterns;
+
     /**
      * If this list is not empty then TypeScript will only be generated for
      * methods with one of the annotations defined in this list
@@ -286,7 +292,7 @@ public void execute() {
             settings.outputKind = outputKind;
             settings.module = module;
             settings.namespace = namespace;
-            settings.excludedClassNames = excludeClasses;
+            settings.setExcludeFilter(excludeClasses, excludeClassPatterns);
             settings.jsonLibrary = jsonLibrary;
             settings.declarePropertiesAsOptional = declarePropertiesAsOptional;
             settings.removeTypeNamePrefix = removeTypeNamePrefix;
@@ -313,7 +319,7 @@ public void execute() {
 
             // TypeScriptGenerator
             new TypeScriptGenerator(settings).generateTypeScript(
-                    Input.fromClassNamesAndJaxrsApplication(classes, classPatterns, classesFromJaxrsApplication, classesFromAutomaticJaxrsApplication, excludeClasses, classLoader),
+                    Input.fromClassNamesAndJaxrsApplication(classes, classPatterns, classesFromJaxrsApplication, classesFromAutomaticJaxrsApplication, settings.getExcludeFilter(), classLoader),
                     Output.to(outputFile)
             );
 

Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ private void generateTypeScript(Input input, Output output, boolean forceExportK`
`54`	`54`	`public TypeProcessor getTypeProcessor() {`
`55`	`55`	`if (typeProcessor == null) {`
`56`	`56`	`final List<TypeProcessor> processors = new ArrayList<>();`
`57`		`- processors.add(new ExcludingTypeProcessor(settings.excludedClassNames));`
	`57`	`+ processors.add(new ExcludingTypeProcessor(settings.getExcludeFilter()));`
`58`	`58`	`if (settings.customTypeProcessor != null) {`
`59`	`59`	`processors.add(settings.customTypeProcessor);`
`60`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ private boolean isParentProperty(String property, Class<?> cls) {`
`126`	`126`	`}`
`127`	`127`	`parents.addAll(Arrays.asList(cls.getInterfaces()));`
`128`	`128`	`for (Class<?> parent : parents) {`
`129`		`- if (settings.excludedClassNames == null \|\| !settings.excludedClassNames.contains(parent.getName())) {`
	`129`	`+ if (!settings.getExcludeFilter().test(parent.getName())) {`
`130`	`130`	`final BeanHelper beanHelper = getBeanHelper(parent);`
`131`	`131`	`if (beanHelper != null) {`
`132`	`132`	`for (BeanPropertyWriter beanPropertyWriter : beanHelper.getProperties()) {`