Merge pull request #226 from mike-plummer/feat/expanded-enum-values

feat(expanded-enum-values): Expand @jsonvalue scenarios for enums

Author: vojtechhabarta

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

@@ -17,7 +17,7 @@
 import cz.habarta.typescript.generator.util.Predicate;
 import java.beans.BeanInfo;
 import java.beans.Introspector;
-import java.beans.PropertyDescriptor;
+import java.beans.MethodDescriptor;
 import java.lang.annotation.Annotation;
 import java.lang.reflect.AccessibleObject;
 import java.lang.reflect.Field;
@@ -26,6 +26,7 @@
 import java.lang.reflect.Modifier;
 import java.lang.reflect.Type;
 import java.util.*;
+import java.util.stream.Collectors;
 
 
 public class Jackson2Parser extends ModelParser {
@@ -295,24 +296,41 @@ private DeclarationModel parseEnumOrObjectEnum(SourceType<Class<?>> sourceClass)
 
             try {
                 Method valueMethod = null;
+                Field valueField = null;
+
+                Field[] allEnumFields = enumClass.getDeclaredFields();
+                List<Field> constants = Arrays.stream(allEnumFields).filter(Field::isEnumConstant).collect(Collectors.toList());
+
                 final BeanInfo beanInfo = Introspector.getBeanInfo(enumClass);
-                for (PropertyDescriptor propertyDescriptor : beanInfo.getPropertyDescriptors()) {
-                    final Method readMethod = propertyDescriptor.getReadMethod();
-                    if (readMethod.isAnnotationPresent(JsonValue.class)) {
-                        valueMethod = readMethod;
-                    }
+                valueMethod = Arrays.stream(beanInfo.getMethodDescriptors())
+                        .map(MethodDescriptor::getMethod)
+                        .filter(method -> method.isAnnotationPresent(JsonValue.class))
+                        .findAny().orElse(null);
+
+                if (valueMethod == null) {
+                    List<Field> instanceFields = Arrays.stream(allEnumFields).filter(field -> !field.isEnumConstant()).collect(Collectors.toList());
+                    valueField = instanceFields.stream()
+                            .filter(field -> field.isAnnotationPresent(JsonValue.class))
+                            .findAny().orElse(null);
                 }
 
                 int index = 0;
-                for (Field field : enumClass.getFields()) {
-                    if (field.isEnumConstant()) {
-                        if (isNumberBased) {
-                            final Number value = getNumberEnumValue(field, valueMethod, index++);
-                            enumMembers.add(new EnumMemberModel(field.getName(), value, null));
-                        } else {
-                            final String value = getStringEnumValue(field, valueMethod);
-                            enumMembers.add(new EnumMemberModel(field.getName(), value, null));
-                        }
+                for (Field constant : constants) {
+                    Object value;
+                    if (valueField != null) {
+                        value = getFieldJsonValue(constant, valueField);
+                    } else if (isNumberBased) {
+                        value = getNumberEnumValue(constant, valueMethod, index++);
+                    } else {
+                        value = getStringEnumValue(constant, valueMethod);
+                    }
+
+                    if (value instanceof String) {
+                        enumMembers.add(new EnumMemberModel(constant.getName(), (String) value, null));
+                    } else if (value instanceof Number) {
+                        enumMembers.add(new EnumMemberModel(constant.getName(), (Number) value, null));
+                    } else {
+                        System.out.println(String.format("'%s' enum as a @JsonValue that isn't a String or Number, ignoring", enumClass.getName()));
                     }
                 }
             } catch (Exception e) {
@@ -358,4 +376,10 @@ private Object invokeJsonValueMethod(Field field, Method valueMethod) throws Ref
         return valueObject;
     }
 
+    private Object getFieldJsonValue(Field field, Field jsonValueField) throws ReflectiveOperationException {
+        field.setAccessible(true);
+        final Object constant = field.get(null);
+        jsonValueField.setAccessible(true);
+        return jsonValueField.get(constant);
+    }
 }

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

@@ -175,4 +175,44 @@ public String getXname4() {
         }
     }
 
+    @Test
+    public void testStandardEnumValue() {
+        testEnumByType(TestEnums.StandardEnum.class, "A", "B", "C");
+    }
+
+    @Test
+    public void testStringPropertyEnumValue() {
+        testEnumByType(TestEnums.StringPropertyValuedEnum.class, "_A", "_B", "_C");
+    }
+
+    @Test
+    public void testNumberPropertyEnumValue() {
+        testEnumByType(TestEnums.NumberPropertyValuedEnum.class, 0, 1, 2);
+    }
+
+    @Test
+    public void testMethodEnumValue() {
+        testEnumByType(TestEnums.GeneralMethodValuedEnum.class, "_A", "_B", "_C");
+    }
+
+    @Test
+    public void testToStringEnumValue() {
+        testEnumByType(TestEnums.ToStringValuedEnum.class, "_A", "_B", "_C");
+    }
+
+    @Test
+    public void testJsonPropertyEnumValue() {
+        testEnumByType(TestEnums.JsonPropertyValuedEnum.class, "_A", "_B", "_C");
+    }
+
+    private void testEnumByType(Class<? extends Enum<?>> type, Object... expectedValues) {
+        final Jackson2Parser jacksonParser = getJackson2Parser();
+        final Model model = jacksonParser.parseModel(type);
+        Assert.assertEquals(1, model.getEnums().size());
+        final EnumModel enumModel = model.getEnums().get(0);
+        Assert.assertEquals(expectedValues.length, enumModel.getMembers().size());
+        for (int i = 0; i < expectedValues.length; i++) {
+            Assert.assertEquals(expectedValues[i], enumModel.getMembers().get(i).getEnumValue());
+        }
+    }
 }

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

@@ -0,0 +1,49 @@
+package cz.habarta.typescript.generator;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonValue;
+
+public class TestEnums {
+    public enum StandardEnum {
+        A, B, C
+    }
+
+    public enum GeneralMethodValuedEnum {
+        A, B, C;
+
+        @JsonValue
+        public String getValue() {
+            return "_" + name();
+        }
+    }
+
+    public enum ToStringValuedEnum {
+        A, B, C;
+
+        @JsonValue
+        @Override
+        public String toString() {
+            return "_" + name();
+        }
+    }
+
+    public enum StringPropertyValuedEnum {
+        A, B, C;
+
+        @JsonValue
+        private final String value = "_" + name();
+    }
+
+    public enum NumberPropertyValuedEnum {
+        A, B, C;
+
+        @JsonValue
+        private final Integer value = ordinal();
+    }
+
+    public enum JsonPropertyValuedEnum {
+        @JsonProperty("_A") A,
+        @JsonProperty("_B") B,
+        @JsonProperty("_C") C
+    }
+}