preserve method names in records as property names, even if they have is/get prefix

Author: angryziber

README.md

@@ -4,7 +4,7 @@ Generates TypeScript definitions (d.ts) for Java/Kotlin model classes using refl
 that can be used for client-side type checking of API calls and responses.
 
 All public getters are read by default, in a similar way to Jackson.
-Works with Java/Lombok/Kotlin data classes. Java records are not yet supported.
+Works with Java/Lombok/Kotlin data classes.
 
 ## Usage
 

src/main/java/jvm2dts/Converter.java

@@ -90,7 +90,7 @@ private String convertClass(Class<?> clazz) {
           .collect(toMap(RecordComponent::getName, RecordComponent::getAccessor)) :
         stream(clazz.getMethods())
           .filter(m -> !isStatic(m.getModifiers()) && m.getParameterCount() == 0 && isLikeGetter(m.getName()))
-          .collect(toMap(Method::getName, m -> m, (m1, m2) -> m1.getReturnType().isAssignableFrom(m2.getReturnType()) ? m2 : m1));
+          .collect(toMap(m -> toPropertyName(m.getName()), m -> m, (m1, m2) -> m1.getReturnType().isAssignableFrom(m2.getReturnType()) ? m2 : m1));
 
       var methodNamesInOrder = new ArrayList<>(methodAnnotations.keySet());
       methodNamesInOrder.retainAll(getters.keySet());
@@ -101,7 +101,7 @@ private String convertClass(Class<?> clazz) {
       methodNamesInOrder.addAll(superClassGetters);
 
       for (String name : methodNamesInOrder) {
-        processProperty(getters.get(name), output, methodAnnotations);
+        processProperty(name, getters.get(name), output, methodAnnotations);
       }
     } catch (Exception e) {
       logger.log(SEVERE, "Failed to convert " + clazz, e);
@@ -117,12 +117,9 @@ static boolean isLikeGetter(String methodName) {
     return (methodName.startsWith("get") || methodName.startsWith("is")) && !methodName.equals("getClass");
   }
 
-  private void processProperty(Method method, StringBuilder out, Map<String, List<String>> classAnnotations) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException {
+  private void processProperty(String propertyName, Method method, StringBuilder out, Map<String, List<String>> classAnnotations) throws IllegalAccessException, InvocationTargetException, NoSuchMethodException {
     var fieldBuffer = new StringBuilder();
 
-    var name = method.getName();
-    var propertyName = toPropertyName(name);
-
     if (propertyName == null) return;
     var dashPos = propertyName.indexOf('-');
     if (dashPos > 0) propertyName = propertyName.substring(0, dashPos);
@@ -143,7 +140,7 @@ else if (annotationName.equals("JsonProperty"))
     fieldBuffer.append(propertyName);
 
     if (!classAnnotations.isEmpty())
-      for (String annotation : classAnnotations.getOrDefault(name, emptyList()))
+      for (var annotation : classAnnotations.getOrDefault(method.getName(), emptyList()))
         if (annotation.contains("Nullable;"))
           fieldBuffer.append("?");
 
@@ -162,7 +159,7 @@ else if (annotationName.equals("JsonProperty"))
         typeBuffer.append(typeMapper.getTSType(isIterable ? type.getComponentType() : type));
       }
     } catch (Exception e) {
-      logger.log(SEVERE, "Failed to convert property type for `" + name + "` in `" + method.getDeclaringClass() + "`, defaulting to `any`", e);
+      logger.log(SEVERE, "Failed to convert property type for `" + propertyName + "` in `" + method.getDeclaringClass() + "`, defaulting to `any`", e);
       typeBuffer = new StringBuilder("any");
     }
     out.append(fieldBuffer);

src/main/java/jvm2dts/NameConverter.java

@@ -17,13 +17,14 @@ class ClassConverterTest {
   @Test
   void modelClass() {
     assertThat(converter.convert(Model.class)).isEqualTo("interface Model {" +
-      "name: string; " +
       "age: number; " +
-      "role: ModelRole; " +
-      "listOfLong: number[]; " +
-      "listOfList: string[][]; " +
       "details: ModelDetails; " +
-      "id: string;}");
+      "id: string; " +
+      "listOfList: string[][]; " +
+      "listOfLong: number[]; " +
+      "name: string; " +
+      "role: ModelRole;" +
+      "}");
 
     assertThat(converter.convert(Model.Details.class)).isEqualTo("interface ModelDetails {" +
       "stuff: string;}");
@@ -34,30 +35,31 @@ void primitiveTypes() {
     assertThat(converter.convert(Primitives.class)).isEqualTo("interface Primitives {" +
       "aByte: number; " +
       "aShort: number; " +
-      "int: number; " +
-      "long: number; " +
-      "float: number; " +
+      "boolean: boolean; " +
       "double: number; " +
-      "boolean: boolean;}");
+      "float: number; " +
+      "int: number; " +
+      "long: number;}");
   }
 
   @Test
   void wrapperTypes() {
     assertThat(converter.convert(WrapperTypes.class)).isEqualTo("interface WrapperTypes {" +
       "aByte: number; " +
       "aShort: number; " +
-      "integer: number; " +
-      "long: number; " +
       "boolean: boolean; " +
+      "double?: number; " +
       "float?: number; " +
-      "double?: number;}");
+      "integer: number; " +
+      "long: number;}");
   }
 
   @Test
   void jsonProperty() {
     assertThat(converter.convert(JsonPropertyObject.class)).isEqualTo("interface JsonPropertyObject {" +
-      "namedProperty: boolean; " +
-      "literalObject: any;}");
+      "literalObject: any; " +
+      "namedProperty: boolean;" +
+      "}");
   }
 
   @Test
@@ -70,6 +72,7 @@ void realClass() {
   @Test
   void record() {
     assertThat(converter.convert(Record.class)).isEqualTo("interface Record {" +
+      "isCool: boolean; " +
       "hello: string; " +
       "world: string;}");
   }
@@ -150,4 +153,4 @@ interface AnyId {
   Object getId();
 }
 
-record Record(String hello, String world) {}
+record Record(String hello, String world, boolean isCool) {}

src/test/java/jvm2dts/ClassConverterTest.java

@@ -13,17 +13,17 @@ public class ConverterTest {
   @Test
   void collections() {
     assertThat(converter.convert(Collections.class)).isEqualTo("interface Collections {" +
-      "roles: Role[]; " +
       "dates: string[]; " +
+      "extendedGeneric: SingleGeneric<T>; " +
+      "generic: MultiGeneric<T,U,V>; " +
+      "genericRecursiveList: SingleGeneric[]; " +
       "ids: string[]; " +
       "map: {[key: string]: number}; " +
       "mapInMap: {[key: string]: {[key: string]: number}}; " +
-      "extendedGeneric: SingleGeneric<T>; " +
+      "rawType: ArrayList; " +
+      "roles: Role[]; " +
       "superGeneric: SingleGeneric<T>; " +
-      "generic: MultiGeneric<T,U,V>; " +
-      "superGenericList: Role[]; " +
-      "genericRecursiveList: SingleGeneric[]; " +
-      "rawType: ArrayList;" +
+      "superGenericList: Role[];" +
       "}");
   }
 }