Merge pull request #150 from glentakahashi/glen/sort-discriminant-types

Add option to sort discriminant types

Author: vojtechhabarta

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/Settings.java

@@ -56,6 +56,7 @@ public class Settings {
     public boolean restOptionsTypeIsGeneric;
     public TypeProcessor customTypeProcessor = null;
     public boolean sortDeclarations = false;
+    public boolean sortDiscriminantTypes = false;
     public boolean sortTypeDeclarations = false;
     public boolean noFileComment = false;
     public List<File> javadocXmlFiles = null;

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/TsType.java

@@ -166,16 +166,26 @@ public String format(Settings settings) {
     public static class UnionType extends TsType {
 
         public final List<TsType> types;
+        public final boolean sort;
 
         public UnionType(List<? extends TsType> types) {
+            this(types, false);
+        }
+
+        public UnionType(List<? extends TsType> types, boolean sort) {
             this.types = new ArrayList<TsType>(new LinkedHashSet<TsType>(types));
+            this.sort = sort;
         }
 
         @Override
         public String format(Settings settings) {
-            return types.isEmpty()
+            List<String> formattedTypes = format(this.types, settings);
+            if (this.sort) {
+                Collections.sort(formattedTypes);
+            }
+            return formattedTypes.isEmpty()
                     ? "never"
-                    : Utils.join(format(types, settings), " | ");
+                    : Utils.join(formattedTypes, " | ");
         }
 
     }

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/compiler/ModelCompiler.java

@@ -150,7 +150,7 @@ private <T> TsBeanModel processBean(SymbolTable symbolTable, Model model, Map<Ty
             }
             final TsType discriminantType = literals.isEmpty()
                     ? TsType.String
-                    : new TsType.UnionType(literals);
+                    : new TsType.UnionType(literals, settings.sortDiscriminantTypes);
             properties.add(0, new TsPropertyModel(bean.getDiscriminantProperty(), discriminantType, settings.declarePropertiesAsReadOnly, null));
         }
 

typescript-generator-core/src/test/java/cz/habarta/typescript/generator/SortedDiscriminantTypesTest.java

@@ -0,0 +1,81 @@
+
+package cz.habarta.typescript.generator;
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import org.junit.Assert;
+import org.junit.Test;
+
+import java.util.List;
+
+
+public class SortedDiscriminantTypesTest {
+
+    @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "kind")
+    @JsonSubTypes({
+        @JsonSubTypes.Type(Square.class),
+        @JsonSubTypes.Type(Rectangle.class),
+        @JsonSubTypes.Type(Circle.class),
+    })
+    private interface Shape {
+    }
+
+    private interface Quadrilateral extends Shape {
+    }
+
+    @JsonTypeName("square")
+    private static class Square implements Quadrilateral {
+        public double size;
+    }
+
+    @JsonTypeName("rectangle")
+    private static class Rectangle implements Quadrilateral {
+        public double width;
+        public double height;
+    }
+
+    @JsonTypeName("circle")
+    private static class Circle implements Shape {
+        public double radius;
+    }
+
+    @Test
+    public void testSortedDiscriminantTypes() {
+        final Settings settings = TestUtils.settings();
+        settings.sortDiscriminantTypes = true;
+        final String output = new TypeScriptGenerator(settings).generateTypeScript(Input.from(Shape.class));
+        System.out.println(output);
+        final String expected = (
+                "\n" +
+                "interface Shape {\n" +
+                "    kind: 'circle' | 'rectangle' | 'square';\n" +
+                "}\n" +
+                "\n" +
+                "interface Square extends Quadrilateral {\n" +
+                "    kind: 'square';\n" +
+                "    size: number;\n" +
+                "}\n" +
+                "\n" +
+                "interface Rectangle extends Quadrilateral {\n" +
+                "    kind: 'rectangle';\n" +
+                "    width: number;\n" +
+                "    height: number;\n" +
+                "}\n" +
+                "\n" +
+                "interface Circle extends Shape {\n" +
+                "    kind: 'circle';\n" +
+                "    radius: number;\n" +
+                "}\n" +
+                "\n" +
+                "interface Quadrilateral extends Shape {\n" +
+                "    kind: 'rectangle' | 'square';\n" +
+                "}\n" +
+                "\n" +
+                "type ShapeUnion = Square | Rectangle | Circle;\n" +
+                ""
+                ).replace('\'', '"');
+        Assert.assertEquals(expected, output);
+    }
+
+}

typescript-generator-gradle-plugin/src/main/java/cz/habarta/typescript/generator/gradle/GenerateTask.java

@@ -51,6 +51,7 @@ public class GenerateTask extends DefaultTask {
     public String restOptionsType;
     public String customTypeProcessor;
     public boolean sortDeclarations;
+    public boolean sortDiscriminantTypes;
     public boolean sortTypeDeclarations;
     public boolean noFileComment;
     public List<File> javadocXmlFiles;
@@ -123,6 +124,7 @@ public void generate() throws Exception {
         settings.setRestOptionsType(restOptionsType);
         settings.loadCustomTypeProcessor(classLoader, customTypeProcessor);
         settings.sortDeclarations = sortDeclarations;
+        settings.sortDiscriminantTypes = sortDiscriminantTypes;
         settings.sortTypeDeclarations = sortTypeDeclarations;
         settings.noFileComment = noFileComment;
         settings.javadocXmlFiles = javadocXmlFiles;

typescript-generator-maven-plugin/src/main/java/cz/habarta/typescript/generator/maven/GenerateMojo.java

@@ -317,6 +317,12 @@ public class GenerateMojo extends AbstractMojo {
     @Parameter
     private boolean sortDeclarations;
 
+    /**
+     * If true discriminant types will be sorted alphabetically.
+     */
+    @Parameter
+    private boolean sortDiscriminantTypes;
+
     /**
      * If true TypeScript type declarations (interfaces) will be sorted alphabetically.
      */
@@ -462,6 +468,7 @@ public void execute() {
             settings.setRestOptionsType(restOptionsType);
             settings.loadCustomTypeProcessor(classLoader, customTypeProcessor);
             settings.sortDeclarations = sortDeclarations;
+            settings.sortDiscriminantTypes = sortDiscriminantTypes;
             settings.sortTypeDeclarations = sortTypeDeclarations;
             settings.noFileComment = noFileComment;
             settings.javadocXmlFiles = javadocXmlFiles;