experimental enum inlining (closes #52), improved TsType formating

vojtechhabarta · vojtechhabarta · commit 0252e92c71e0 · 2016-04-20T10:22:56.000+02:00
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/GenericsTypeProcessor.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/GenericsTypeProcessor.java
@@ -60,8 +60,8 @@ public GenericReferenceType(Symbol symbol, List<TsType> typeArguments) {
         }
 
         @Override
-        public String toString() {
-            return symbol + "<" + Utils.join(typeArguments, ", ") + ">";
+        public String format(Settings settings) {
+            return symbol + "<" + Utils.join(format(typeArguments, settings), ", ") + ">";
         }
     }
     
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
@@ -35,6 +35,7 @@ public class Settings {
     public List<File> javadocXmlFiles = null;
     public List<EmitterExtension> extensions = new ArrayList<>();
     public List<Class<? extends Annotation>> optionalAnnotations = new ArrayList<>();
+    public boolean experimentalInlineEnums = false;
 
 
     public void loadCustomTypeProcessor(ClassLoader classLoader, String customTypeProcessor) {
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/TsType.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/TsType.java
@@ -32,8 +32,20 @@ public TsType.OptionalType optional() {
         return new TsType.OptionalType(this);
     }
 
+    public abstract String format(Settings settings);
+
+    protected static List<String> format(List<TsType> types, Settings settings) {
+        final List<String> formatted = new ArrayList<>();
+        for (TsType type : types) {
+            formatted.add(type.format(settings));
+        }
+        return formatted;
+    }
+
     @Override
-    public abstract String toString();
+    public String toString() {
+        return format(new Settings());
+    }
 
     public static class BasicType extends TsType {
 
@@ -44,7 +56,7 @@ public BasicType(String name) {
         }
 
         @Override
-        public String toString() {
+        public String format(Settings settings) {
             return name;
         }
     }
@@ -61,7 +73,7 @@ public ReferenceType(Symbol symbol) {
         }
 
         @Override
-        public String toString() {
+        public String format(Settings settings) {
             return symbol.toString();
         }
 
@@ -82,8 +94,8 @@ public BasicArrayType(TsType elementType) {
         }
 
         @Override
-        public String toString() {
-            return elementType + "[]";
+        public String format(Settings settings) {
+            return elementType.format(settings) + "[]";
         }
 
     }
@@ -99,8 +111,8 @@ public IndexedArrayType(TsType indexType, TsType elementType) {
         }
 
         @Override
-        public String toString() {
-            return "{ [index: " + indexType + "]: " + elementType + " }";
+        public String format(Settings settings) {
+            return "{ [index: " + indexType.format(settings) + "]: " + elementType.format(settings) + " }";
         }
 
     }
@@ -114,8 +126,8 @@ public UnionType(List<? extends TsType> types) {
         }
 
         @Override
-        public String toString() {
-            return Utils.join(types, " | ");
+        public String format(Settings settings) {
+            return Utils.join(format(types, settings), " | ");
         }
 
     }
@@ -124,13 +136,13 @@ public static class StringLiteralType extends TsType {
 
         public final String literal;
 
-        public StringLiteralType(java.lang.String literal) {
+        public StringLiteralType(String literal) {
             this.literal = literal;
         }
 
         @Override
-        public String toString() {
-            return "\"" + literal + "\"";
+        public String format(Settings settings) {
+            return settings.quotes + literal + settings.quotes;
         }
 
     }
@@ -144,8 +156,8 @@ public OptionalType(TsType type) {
         }
 
         @Override
-        public String toString() {
-            return type.toString();
+        public String format(Settings settings) {
+            return type.format(settings);
         }
 
     }
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
@@ -43,6 +43,9 @@ public TsModel javaToTypeScript(Model model) {
         TsModel tsModel = processModel(symbolTable, model);
         tsModel = transformDates(symbolTable, tsModel);
         tsModel = transformEnums(tsModel);
+        if (settings.experimentalInlineEnums) {
+            tsModel = inlineEnums(tsModel, symbolTable);
+        }
         symbolTable.resolveSymbolNames(settings);
         return tsModel;
     }
@@ -150,6 +153,31 @@ private TsModel transformEnums(TsModel tsModel) {
         return tsModel.setTypeAliases(new ArrayList<>(typeAliases));
     }
 
+    private TsModel inlineEnums(final TsModel tsModel, final SymbolTable symbolTable) {
+        final Set<TsAliasModel> inlinedAliases = new LinkedHashSet<>();
+        final TsModel newTsModel = transformBeanPropertyTypes(tsModel, new TsType.Transformer() {
+            @Override
+            public TsType transform(TsType tsType) {
+                if (tsType instanceof TsType.EnumReferenceType) {
+                    final TsType.ReferenceType reference = (TsType.ReferenceType) tsType;
+                    final Class<?> cls = symbolTable.getSymbolClass(reference.symbol);
+                    if (cls != null) {
+                        for (TsAliasModel alias : tsModel.getTypeAliases()) {
+                            if (alias.getOrigin() == cls) {
+                                inlinedAliases.add(alias);
+                                return alias.getDefinition();
+                            }
+                        }
+                    }
+                }
+                return tsType;
+            }
+        });
+        final ArrayList<TsAliasModel> aliases = new ArrayList<>(tsModel.getTypeAliases());
+        aliases.removeAll(inlinedAliases);
+        return newTsModel.setTypeAliases(aliases);
+    }
+
     private static TsModel transformBeanPropertyTypes(TsModel tsModel, TsType.Transformer transformer) {
         final List<TsBeanModel> newBeans = new ArrayList<>();
         for (TsBeanModel bean : tsModel.getBeans()) {
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/compiler/SymbolTable.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/compiler/SymbolTable.java
@@ -22,6 +22,15 @@ public Symbol getSymbol(Class<?> cls) {
         return symbols.get(cls);
     }
 
+    public Class<?> getSymbolClass(Symbol symbol) {
+        for (Map.Entry<Class<?>, Symbol> entry : symbols.entrySet()) {
+            if (entry.getValue() == symbol) {
+                return entry.getKey();
+            }
+        }
+        return null;
+    }
+
     public Symbol getSyntheticSymbol(String name) {
         if (!syntheticSymbols.containsKey(name)) {
             syntheticSymbols.put(name, new Symbol(name));
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/emitter/Emitter.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/emitter/Emitter.java
@@ -117,7 +117,7 @@ private void emitProperty(TsPropertyModel property) {
         emitComments(property.getComments());
         final TsType tsType = property.getTsType();
         final String questionMark = settings.declarePropertiesAsOptional || (tsType instanceof TsType.OptionalType) ? "?" : "";
-        writeIndentedLine(toPropertyName(property.getName()) + questionMark + ": " + tsType + ";");
+        writeIndentedLine(toPropertyName(property.getName()) + questionMark + ": " + tsType.format(settings) + ";");
     }
 
     private String toPropertyName(String name) {
@@ -150,7 +150,7 @@ private void emitTypeAliases(TsModel model, boolean exportKeyword) {
         for (TsAliasModel alias : aliases) {
             writeNewLine();
             emitComments(alias.getComments());
-            writeIndentedLine(exportKeyword, "type " + alias.getName() + " = " + alias.getDefinition() + ";");
+            writeIndentedLine(exportKeyword, "type " + alias.getName() + " = " + alias.getDefinition().format(settings) + ";");
         }
     }
 
diff --git a/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/EnumTest.java b/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/EnumTest.java
@@ -11,28 +11,42 @@ public class EnumTest {
     public void test() {
         final Settings settings = TestUtils.settings();
         final String actual = new TypeScriptGenerator(settings).generateTypeScript(Input.from(AClass.class));
-        final String expected =
+        final String expected = (
                 "\n" +
                 "interface AClass {\n" +
                 "    direction: Direction;\n" +
                 "}\n" +
                 "\n" +
                 "type Direction = 'North' | 'East' | 'South' | 'West';\n"
-                .replace("'", "\"");
+                ).replace("'", "\"");
         assertEquals(expected, actual);
     }
 
     @Test
     public void testSingleEnum() {
         final Settings settings = TestUtils.settings();
         final String actual = new TypeScriptGenerator(settings).generateTypeScript(Input.from(Direction.class));
-        final String expected =
+        final String expected = (
                 "\n" +
                 "type Direction = 'North' | 'East' | 'South' | 'West';\n"
-                .replace("'", "\"");
+                ).replace("'", "\"");
         assertEquals(expected, actual);
     }
 
+    @Test
+    public void inlineEnumTest() {
+        final Settings settings = TestUtils.settings();
+        settings.quotes = "'";
+        settings.experimentalInlineEnums = true;
+        final String output = new TypeScriptGenerator(settings).generateTypeScript(Input.from(AClass.class));
+        final String expected =
+                "\n" +
+                "interface AClass {\n" +
+                "    direction: 'North' | 'East' | 'South' | 'West';\n" +
+                "}\n";
+        assertEquals(expected, output);
+    }
+
     private static class AClass {
         public Direction direction;
     }
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
@@ -35,7 +35,7 @@ public class GenerateTask extends DefaultTask {
     public List<File> javadocXmlFiles;
     public List<String> extensions;
     public List<String> optionalAnnotations;
-
+    public boolean experimentalInlineEnums;
 
     @TaskAction
     public void generate() throws Exception {
@@ -83,6 +83,7 @@ public void generate() throws Exception {
         settings.javadocXmlFiles = javadocXmlFiles;
         settings.loadExtensions(classLoader, extensions);
         settings.loadOptionalAnnotations(classLoader, optionalAnnotations);
+        settings.experimentalInlineEnums = experimentalInlineEnums;
         settings.validateFileName(new File(outputFile));
 
         // TypeScriptGenerator
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
@@ -192,6 +192,13 @@ public class GenerateMojo extends AbstractMojo {
     @Parameter
     private List<String> optionalAnnotations;
 
+    /**
+     * Defines enum type on places where the enum is used (inline).
+     * (Without this flag enum type is created once as type alias and is referenced from places where the enum is used.)
+     */
+    @Parameter
+    private boolean experimentalInlineEnums;
+
     @Parameter(defaultValue = "${project}", readonly = true, required = true)
     private MavenProject project;
 
@@ -230,6 +237,7 @@ public void execute() {
             settings.javadocXmlFiles = javadocXmlFiles;
             settings.loadExtensions(classLoader, extensions);
             settings.loadOptionalAnnotations(classLoader, optionalAnnotations);
+            settings.experimentalInlineEnums = experimentalInlineEnums;
             settings.validateFileName(outputFile);
 
             // TypeScriptGenerator

Original file line number	Diff line number	Diff line change
`@@ -60,8 +60,8 @@ public GenericReferenceType(Symbol symbol, List<TsType> typeArguments) {`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`@Override`
`63`		`- public String toString() {`
`64`		`- return symbol + "<" + Utils.join(typeArguments, ", ") + ">";`
	`63`	`+ public String format(Settings settings) {`
	`64`	`+ return symbol + "<" + Utils.join(format(typeArguments, settings), ", ") + ">";`
`65`	`65`	`}`
`66`	`66`	`}`
`67`	`67`
Original file line number	Diff line number	Diff line change
`@@ -32,8 +32,20 @@ public TsType.OptionalType optional() {`
`32`	`32`	`return new TsType.OptionalType(this);`
`33`	`33`	`}`
`34`	`34`
	`35`	`+ public abstract String format(Settings settings);`
	`36`	`+`
	`37`	`+ protected static List<String> format(List<TsType> types, Settings settings) {`
	`38`	`+ final List<String> formatted = new ArrayList<>();`
	`39`	`+ for (TsType type : types) {`
	`40`	`+ formatted.add(type.format(settings));`
	`41`	`+ }`
	`42`	`+ return formatted;`
	`43`	`+ }`
	`44`	`+`
`35`	`45`	`@Override`
`36`		`- public abstract String toString();`
	`46`	`+ public String toString() {`
	`47`	`+ return format(new Settings());`
	`48`	`+ }`
`37`	`49`
`38`	`50`	`public static class BasicType extends TsType {`
`39`	`51`
`@@ -44,7 +56,7 @@ public BasicType(String name) {`
`44`	`56`	`}`
`45`	`57`
`46`	`58`	`@Override`
`47`		`- public String toString() {`
	`59`	`+ public String format(Settings settings) {`
`48`	`60`	`return name;`
`49`	`61`	`}`
`50`	`62`	`}`
`@@ -61,7 +73,7 @@ public ReferenceType(Symbol symbol) {`
`61`	`73`	`}`
`62`	`74`
`63`	`75`	`@Override`
`64`		`- public String toString() {`
	`76`	`+ public String format(Settings settings) {`
`65`	`77`	`return symbol.toString();`
`66`	`78`	`}`
`67`	`79`
`@@ -82,8 +94,8 @@ public BasicArrayType(TsType elementType) {`
`82`	`94`	`}`
`83`	`95`
`84`	`96`	`@Override`
`85`		`- public String toString() {`
`86`		`- return elementType + "[]";`
	`97`	`+ public String format(Settings settings) {`
	`98`	`+ return elementType.format(settings) + "[]";`
`87`	`99`	`}`
`88`	`100`
`89`	`101`	`}`
`@@ -99,8 +111,8 @@ public IndexedArrayType(TsType indexType, TsType elementType) {`
`99`	`111`	`}`
`100`	`112`
`101`	`113`	`@Override`
`102`		`- public String toString() {`
`103`		`- return "{ [index: " + indexType + "]: " + elementType + " }";`
	`114`	`+ public String format(Settings settings) {`
	`115`	`+ return "{ [index: " + indexType.format(settings) + "]: " + elementType.format(settings) + " }";`
`104`	`116`	`}`
`105`	`117`
`106`	`118`	`}`
`@@ -114,8 +126,8 @@ public UnionType(List<? extends TsType> types) {`
`114`	`126`	`}`
`115`	`127`
`116`	`128`	`@Override`
`117`		`- public String toString() {`
`118`		`- return Utils.join(types, " \| ");`
	`129`	`+ public String format(Settings settings) {`
	`130`	`+ return Utils.join(format(types, settings), " \| ");`
`119`	`131`	`}`
`120`	`132`
`121`	`133`	`}`
`@@ -124,13 +136,13 @@ public static class StringLiteralType extends TsType {`
`124`	`136`
`125`	`137`	`public final String literal;`
`126`	`138`
`127`		`- public StringLiteralType(java.lang.String literal) {`
	`139`	`+ public StringLiteralType(String literal) {`
`128`	`140`	`this.literal = literal;`
`129`	`141`	`}`
`130`	`142`
`131`	`143`	`@Override`
`132`		`- public String toString() {`
`133`		`- return "\"" + literal + "\"";`
	`144`	`+ public String format(Settings settings) {`
	`145`	`+ return settings.quotes + literal + settings.quotes;`
`134`	`146`	`}`
`135`	`147`
`136`	`148`	`}`
`@@ -144,8 +156,8 @@ public OptionalType(TsType type) {`
`144`	`156`	`}`
`145`	`157`
`146`	`158`	`@Override`
`147`		`- public String toString() {`
`148`		`- return type.toString();`
	`159`	`+ public String format(Settings settings) {`
	`160`	`+ return type.format(settings);`
`149`	`161`	`}`
`150`	`162`
`151`	`163`	`}`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ private void emitProperty(TsPropertyModel property) {`
`117`	`117`	`emitComments(property.getComments());`
`118`	`118`	`final TsType tsType = property.getTsType();`
`119`	`119`	`final String questionMark = settings.declarePropertiesAsOptional \|\| (tsType instanceof TsType.OptionalType) ? "?" : "";`
`120`		`- writeIndentedLine(toPropertyName(property.getName()) + questionMark + ": " + tsType + ";");`
	`120`	`+ writeIndentedLine(toPropertyName(property.getName()) + questionMark + ": " + tsType.format(settings) + ";");`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	`private String toPropertyName(String name) {`
`@@ -150,7 +150,7 @@ private void emitTypeAliases(TsModel model, boolean exportKeyword) {`
`150`	`150`	`for (TsAliasModel alias : aliases) {`
`151`	`151`	`writeNewLine();`
`152`	`152`	`emitComments(alias.getComments());`
`153`		`- writeIndentedLine(exportKeyword, "type " + alias.getName() + " = " + alias.getDefinition() + ";");`
	`153`	`+ writeIndentedLine(exportKeyword, "type " + alias.getName() + " = " + alias.getDefinition().format(settings) + ";");`
`154`	`154`	`}`
`155`	`155`	`}`
`156`	`156`