Merge branch 'master' of https://github.com/vojtechhabarta/typescript-generator

vojtechhabarta · vojtechhabarta · commit d86c1a9494b2 · 2018-08-31T13:11:08.000+02:00
diff --git a/README.md b/README.md
@@ -201,5 +201,5 @@ Contributing
 ### Code formatting
 
 - use 4 spaces for indentation in Java files
-- sort java imports alphabetically, you can use wildcards
+- sort java imports alphabetically (including static imports), you can use wildcards
 - please do not reformat whole files in IDE
diff --git a/checkstyle.xml b/checkstyle.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+    "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
+    "http://checkstyle.sourceforge.net/dtds/configuration_1_3.dtd">
+
+<module name="Checker">
+    <property name="charset" value="UTF-8"/>
+    <property name="fileExtensions" value="java"/>
+
+    <module name="FileTabCharacter"/>
+
+    <module name="TreeWalker">
+
+        <module name="ImportOrder">
+            <property name="option" value="inflow"/>
+            <property name="sortStaticImportsAlphabetically" value="true"/>
+        </module>
+
+    </module>
+</module>
diff --git a/pom.xml b/pom.xml
@@ -98,6 +98,15 @@
                 <artifactId>maven-javadoc-plugin</artifactId>
                 <version>3.0.0</version>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <version>3.0.0</version>
+                <configuration>
+                    <includeTestSourceDirectory>true</includeTestSourceDirectory>
+                    <configLocation>../checkstyle.xml</configLocation>
+                </configuration>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-site-plugin</artifactId>
diff --git a/typescript-generator-core/pom.xml b/typescript-generator-core/pom.xml
@@ -173,6 +173,22 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>check</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                        <configuration>
+                            <excludes>cz/habarta/typescript/generator/xmldoclet/*.java</excludes>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/TypeProcessor.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/TypeProcessor.java
@@ -1,8 +1,8 @@
 
 package cz.habarta.typescript.generator;
 
-import cz.habarta.typescript.generator.compiler.SymbolTable;
 import cz.habarta.typescript.generator.compiler.Symbol;
+import cz.habarta.typescript.generator.compiler.SymbolTable;
 import java.lang.reflect.Type;
 import java.util.*;
 
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/compiler/ModelCompiler.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/compiler/ModelCompiler.java
@@ -42,13 +42,15 @@ public ModelCompiler(Settings settings, TypeProcessor typeProcessor) {
     }
 
     public enum TransformationPhase {
+        BeforeTsModel,
         BeforeEnums,
         BeforeSymbolResolution,
     }
 
     public TsModel javaToTypeScript(Model model) {
         final SymbolTable symbolTable = new SymbolTable(settings);
         final List<Extension.TransformerDefinition> extensionTransformers = getExtensionTransformers();
+        model = applyExtensionModelTransformers(symbolTable, model, extensionTransformers);
         TsModel tsModel = processModel(symbolTable, model);
         tsModel = removeInheritedProperties(symbolTable, tsModel);
         tsModel = addImplementedProperties(symbolTable, tsModel);
@@ -112,6 +114,15 @@ private List<Extension.TransformerDefinition> getExtensionTransformers() {
         return transformers;
     }
 
+    private static Model applyExtensionModelTransformers(SymbolTable symbolTable, Model model, List<Extension.TransformerDefinition> transformerDefinitions) {
+        for (Extension.TransformerDefinition definition : transformerDefinitions) {
+            if (definition.phase == TransformationPhase.BeforeTsModel) {
+                model = definition.transformer.transformModel(symbolTable, model);
+            }
+        }
+        return model;
+    }
+
     private static TsModel applyExtensionTransformers(SymbolTable symbolTable, TsModel model, TransformationPhase phase, List<Extension.TransformerDefinition> transformerDefinitions) {
         for (Extension.TransformerDefinition definition : transformerDefinitions) {
             if (definition.phase == phase) {
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/compiler/ModelTransformer.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/compiler/ModelTransformer.java
@@ -2,10 +2,15 @@
 package cz.habarta.typescript.generator.compiler;
 
 import cz.habarta.typescript.generator.emitter.TsModel;
+import cz.habarta.typescript.generator.parser.Model;
 
 
 public interface ModelTransformer {
 
     public TsModel transformModel(SymbolTable symbolTable, TsModel model);
 
+    default Model transformModel(SymbolTable symbolTable, Model model) {
+        return model;
+    }
+
 }
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/ext/EnumConstantsExtension.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/ext/EnumConstantsExtension.java
@@ -1,6 +1,7 @@
 
 package cz.habarta.typescript.generator.ext;
 
+import cz.habarta.typescript.generator.DeprecationText;
 import cz.habarta.typescript.generator.Settings;
 import cz.habarta.typescript.generator.compiler.EnumMemberModel;
 import cz.habarta.typescript.generator.emitter.EmitterExtension;
@@ -9,7 +10,6 @@
 import cz.habarta.typescript.generator.emitter.TsModel;
 import java.util.Collections;
 import java.util.List;
-import cz.habarta.typescript.generator.DeprecationText;
 
 
 @DeprecationText("Consider using configuration parameter 'mapEnum' with value 'asEnum'")
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/ext/NonConstEnumsExtension.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/ext/NonConstEnumsExtension.java
@@ -1,6 +1,7 @@
 
 package cz.habarta.typescript.generator.ext;
 
+import cz.habarta.typescript.generator.DeprecationText;
 import cz.habarta.typescript.generator.Settings;
 import cz.habarta.typescript.generator.compiler.EnumMemberModel;
 import cz.habarta.typescript.generator.emitter.EmitterExtension;
@@ -9,7 +10,6 @@
 import cz.habarta.typescript.generator.emitter.TsModel;
 import java.util.Collections;
 import java.util.List;
-import cz.habarta.typescript.generator.DeprecationText;
 
 
 @DeprecationText("Consider using parameter 'mapEnum' with value 'asEnum' and parameter 'nonConstEnums' with 'true'")
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/EnumModel.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/EnumModel.java
@@ -1,8 +1,8 @@
 
 package cz.habarta.typescript.generator.parser;
 
-import cz.habarta.typescript.generator.compiler.EnumMemberModel;
 import cz.habarta.typescript.generator.compiler.EnumKind;
+import cz.habarta.typescript.generator.compiler.EnumMemberModel;
 import java.util.*;
 
 
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/ModelParser.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/ModelParser.java
@@ -1,12 +1,11 @@
 
 package cz.habarta.typescript.generator.parser;
 
-import cz.habarta.typescript.generator.compiler.EnumMemberModel;
+import cz.habarta.typescript.generator.*;
 import cz.habarta.typescript.generator.compiler.EnumKind;
+import cz.habarta.typescript.generator.compiler.EnumMemberModel;
 import cz.habarta.typescript.generator.compiler.SymbolTable;
-import cz.habarta.typescript.generator.*;
 import java.lang.annotation.Annotation;
-import java.lang.reflect.AnnotatedElement;
 import java.lang.reflect.Field;
 import java.lang.reflect.Member;
 import java.lang.reflect.Method;
diff --git a/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/ExtensionTest.java b/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/ExtensionTest.java
@@ -0,0 +1,69 @@
+package cz.habarta.typescript.generator;
+
+import cz.habarta.typescript.generator.compiler.ModelCompiler;
+import cz.habarta.typescript.generator.compiler.ModelCompiler.TransformationPhase;
+import cz.habarta.typescript.generator.compiler.ModelTransformer;
+import cz.habarta.typescript.generator.compiler.SymbolTable;
+import cz.habarta.typescript.generator.emitter.EmitterExtensionFeatures;
+import cz.habarta.typescript.generator.emitter.TsModel;
+import cz.habarta.typescript.generator.parser.BeanModel;
+import cz.habarta.typescript.generator.parser.Jackson2Parser;
+import cz.habarta.typescript.generator.parser.Model;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+import org.hamcrest.CoreMatchers;
+import org.junit.Assert;
+import org.junit.Test;
+
+public class ExtensionTest {
+
+    @Test
+    public void testBeforeTsExtension() throws Exception {
+        final Settings settings = TestUtils.settings();
+
+        settings.extensions.add(new Extension() {
+
+            @Override
+            public EmitterExtensionFeatures getFeatures() {
+                return new EmitterExtensionFeatures();
+            }
+
+            @Override
+            public List<TransformerDefinition> getTransformers() {
+                return Collections.singletonList(new TransformerDefinition(TransformationPhase.BeforeTsModel, new ModelTransformer() {
+
+                    @Override
+                    public TsModel transformModel(SymbolTable symbolTable, TsModel model) {
+                        return model;
+                    }
+
+                    @Override
+                    public Model transformModel(SymbolTable symbolTable, Model model) {
+                        List<BeanModel> beans = new ArrayList<>(model.getBeans());
+
+                        BeanModel implementationBean = model.getBean(Implementation.class);
+                        BeanModel beanWithComments = implementationBean.withComments(Collections.singletonList("My new comment"));
+
+                        beans.remove(implementationBean);
+                        beans.add(beanWithComments);
+
+                        return new Model(beans, model.getEnums(), model.getJaxrsApplication());
+                    }
+                }));
+            }
+        });
+
+        final Jackson2Parser jacksonParser = new Jackson2Parser(settings, new DefaultTypeProcessor());
+        final Model model = jacksonParser.parseModel(Implementation.class);
+        final ModelCompiler modelCompiler = new TypeScriptGenerator(settings).getModelCompiler();
+
+        final TsModel result = modelCompiler.javaToTypeScript(model);
+
+        Assert.assertEquals(1, result.getBean(Implementation.class).getComments().size());
+        Assert.assertThat(result.getBean(Implementation.class).getComments().get(0), CoreMatchers.containsString("My new comment"));
+    }
+
+    private static class Implementation { }
+
+}
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
@@ -4,8 +4,8 @@
 import com.fasterxml.jackson.annotation.JsonTypeInfo.As;
 import java.io.StringWriter;
 import java.util.*;
-import org.junit.Test;
 import static org.junit.Assert.assertEquals;
+import org.junit.Test;
 
 
 public class GenericsTest {
diff --git a/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/Jackson2ParserTest.java b/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/Jackson2ParserTest.java
@@ -1,10 +1,10 @@
 
 package cz.habarta.typescript.generator;
 
-import cz.habarta.typescript.generator.parser.*;
 import com.fasterxml.jackson.annotation.*;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import cz.habarta.typescript.generator.parser.*;
 import java.util.Optional;
 import javax.xml.bind.annotation.XmlElement;
 import org.junit.Assert;
diff --git a/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/SortedTypesTest.java b/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/SortedTypesTest.java
@@ -1,7 +1,7 @@
 package cz.habarta.typescript.generator;
 
-import static org.junit.Assert.*;
 import org.junit.*;
+import static org.junit.Assert.*;
 
 public class SortedTypesTest {
 
diff --git a/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/TsTypeTest.java b/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/TsTypeTest.java
@@ -3,9 +3,8 @@
 import static cz.habarta.typescript.generator.TsType.*;
 import cz.habarta.typescript.generator.compiler.Symbol;
 import java.util.Arrays;
-import static org.junit.Assert.*;
-
 import org.junit.*;
+import static org.junit.Assert.*;
 
 public class TsTypeTest {
 
diff --git a/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/ext/BeanPropertyPathExtensionTest.java b/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/ext/BeanPropertyPathExtensionTest.java
@@ -1,8 +1,8 @@
 package cz.habarta.typescript.generator.ext;
 
-import cz.habarta.typescript.generator.TypeProcessor;
 import cz.habarta.typescript.generator.DefaultTypeProcessor;
 import cz.habarta.typescript.generator.Settings;
+import cz.habarta.typescript.generator.TypeProcessor;
 import cz.habarta.typescript.generator.compiler.ModelCompiler;
 import cz.habarta.typescript.generator.emitter.EmitterExtension;
 import cz.habarta.typescript.generator.emitter.TsModel;
diff --git a/typescript-generator-gradle-plugin/pom.xml b/typescript-generator-gradle-plugin/pom.xml
@@ -53,6 +53,19 @@
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>check</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 
diff --git a/typescript-generator-maven-plugin/pom.xml b/typescript-generator-maven-plugin/pom.xml
@@ -56,6 +56,22 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>check</id>
+                        <phase>verify</phase>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                        <configuration>
+                            <excludes>cz/habarta/typescript/generator/maven/*.java</excludes>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 
