Merge pull request #149 from glentakahashi/glen/allow-immutables

Allow JsonSubTypes to be interfaces/abstract classes

Author: vojtechhabarta

typescript-generator-core/pom.xml

@@ -50,6 +50,12 @@
             <version>4.11</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.immutables</groupId>
+            <artifactId>value</artifactId>
+            <version>2.5.3</version>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>com.google.code.findbugs</groupId>
             <artifactId>annotations</artifactId>

typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/Jackson2Parser.java

@@ -113,7 +113,7 @@ private BeanModel parseBean(SourceType<Class<?>> sourceClass) {
             // this is parent
             discriminantProperty = getDiscriminantPropertyName(jsonTypeInfo);
             discriminantLiteral = null;
-        } else if (!sourceClass.type.isInterface() && !Modifier.isAbstract(sourceClass.type.getModifiers()) && isSupported(parentJsonTypeInfo = getAnnotationRecursive(sourceClass.type, JsonTypeInfo.class))) {
+        } else if (isSupported(parentJsonTypeInfo = getAnnotationRecursive(sourceClass.type, JsonTypeInfo.class))) {
             // this is child class
             discriminantProperty = getDiscriminantPropertyName(parentJsonTypeInfo);
             discriminantLiteral = getTypeName(sourceClass.type);
@@ -186,8 +186,11 @@ public boolean test(JsonSubTypes types) {
                 return jsonSubType.name();
             }
         }
-        // use simplified class name
-        return cls.getName().substring(cls.getName().lastIndexOf(".") + 1);
+        // use simplified class name if it's not an interface or abstract
+        if(!cls.isInterface() && !Modifier.isAbstract(cls.getModifiers())) {
+            return cls.getName().substring(cls.getName().lastIndexOf(".") + 1);
+        }
+        return null;
     }
 
     private static JsonSubTypes.Type getJsonSubTypeForClass(JsonSubTypes types, Class<?> cls) {

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

@@ -0,0 +1,14 @@
+package cz.habarta.typescript.generator;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import org.immutables.value.Value;
+
+@Value.Immutable
+@JsonSerialize(as = ImmutableCircle.class)
+@JsonDeserialize(as = ImmutableCircle.class)
+public interface Circle extends Shape {
+    double radius();
+
+    final class Builder extends ImmutableCircle.Builder {}
+}

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

@@ -0,0 +1,41 @@
+
+package cz.habarta.typescript.generator;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+public class ImmutablesTest {
+
+    @Test
+    public void testImmutables() {
+        final Settings settings = TestUtils.settings();
+        final String output = new TypeScriptGenerator(settings).generateTypeScript(Input.from(Shape.class));
+        final String expected = (
+                "\n" +
+                "interface Shape {\n" +
+                "    kind: 'square' | 'rectangle' | 'circle';\n" +
+                "}\n" +
+                "\n" +
+                "interface Square extends Shape {\n" +
+                "    kind: 'square';\n" +
+                "    size: number;\n" +
+                "}\n" +
+                "\n" +
+                "interface Rectangle extends Shape {\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" +
+                "type ShapeUnion = Square | Rectangle | Circle;\n" +
+                ""
+                ).replace('\'', '"');
+        Assert.assertEquals(expected, output);
+    }
+
+}

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

@@ -0,0 +1,19 @@
+package cz.habarta.typescript.generator;
+
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import org.immutables.value.Value;
+
+@Value.Immutable
+@JsonSerialize(as = ImmutableRectangle.class)
+@JsonDeserialize(as = ImmutableRectangle.class)
+public abstract class Rectangle implements Shape {
+    public abstract double width();
+    public abstract double height();
+
+    public static Rectangle.Builder builder() {
+        return new Rectangle.Builder();
+    }
+
+    public static final class Builder extends ImmutableRectangle.Builder {}
+}

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

@@ -0,0 +1,13 @@
+package cz.habarta.typescript.generator;
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+
+@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "kind")
+@JsonSubTypes({
+        @JsonSubTypes.Type(value = Square.class, name = "square"),
+        @JsonSubTypes.Type(value = Rectangle.class, name = "rectangle"),
+        @JsonSubTypes.Type(value = Circle.class, name = "circle"),
+})
+public interface Shape {
+}

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

@@ -0,0 +1,5 @@
+package cz.habarta.typescript.generator;
+
+public class Square implements Shape {
+    public double size;
+}

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

@@ -132,6 +132,7 @@ public void testTaggedUnionsWithInterfaces() {
                 "}\n" +
                 "\n" +
                 "interface IQuadrilateral2 extends IShape2 {\n" +
+                "    kind: 'square' | 'rectangle';\n" +
                 "}\n" +
                 "\n" +
                 "type IShape2Union = CSquare2 | CRectangle2 | CCircle2;\n" +