Support properties with type number (#27)

* Removed `model.mustache` * Add support for type `number` * Add descriptions to Example Record with `number` fields
Chrimle · Sep 8, 2024 · dcc8fb8 · dcc8fb8
1 parent 3741892
commit dcc8fb8
Show file tree

Hide file tree

Showing 19 changed files with 202 additions and 74 deletions.
diff --git a/README.md b/README.md
@@ -98,25 +98,25 @@ properties may be ignored, or may cause problems.
 > The following properties are referring to the schema definitions, prefixed
 > by `components.schemas.{schema}`.
 
-| Property                                     | Description                                      |       Value       | Value Description                                                                                                        |
-|----------------------------------------------|--------------------------------------------------|:-----------------:|--------------------------------------------------------------------------------------------------------------------------|
-| `{schema}`                                   | Name of the generated Java class.                |         *         |                                                                                                                          |
-| `{schema}.type`                              | Type of the generated Java class.                |     `object`      | Generates a Record class.                                                                                                |
-|                                              |                                                  |      `enum`       | Generates an Enum class.                                                                                                 |
-| `{schema}.description`                       | JavaDoc description of the generated Java class. |         *         |                                                                                                                          |
-| `{schema}.deprecated`                        | Marks the generated Java class as Deprecated.    |      `true`       | Annotates the class with `@Deprecated` and adds `@deprecated` to the JavaDoc description.                                |
-|                                              |                                                  | `false` (default) | Does nothing.                                                                                                            |
-| `{schema}.properties`                        | Fields of the generated Record class.            |         *         |                                                                                                                          |
-| `{schema}.properties.{property}`             | Name of the field.                               |         *         | Added as a `@param` in the JavaDoc.                                                                                      |
-| `{schema}.properties.{property}.description` | Description of the field.                        |         *         | Description of the `@param` in the JavaDoc.                                                                              |
-| `{schema}.properties.{property}.$ref`        | Type of the field is another Java class.         |         *         |                                                                                                                          |
-| `{schema}.properties.{property}.type`        | Type of the field.                               |      `array`      | Generates the field as `List<{items.type}>`.                                                                             |
-|                                              |                                                  |     `boolean`     | Generates the field as `Boolean`.                                                                                        |
-|                                              |                                                  |      `enum`       | **Not supported yet** - See [Issue #5](https://github.com/Chrimle/openapi-to-java-records-mustache-templates/issues/5)   |
-|                                              |                                                  |     `integer`     | Generates the field as `Integer`.                                                                                        |
-|                                              |                                                  |     `number`      | **Not supported yet** - See [Issue #15](https://github.com/Chrimle/openapi-to-java-records-mustache-templates/issues/15) |
-|                                              |                                                  |     `object`      | **Not supported yet** - See [Issue #4](https://github.com/Chrimle/openapi-to-java-records-mustache-templates/issues/4)   |
-|                                              |                                                  |     `string`      | Generates the field as `String`.                                                                                         |
+| Property                                     | Description                                      |       Value       | Value Description                                                                                                      |
+|----------------------------------------------|--------------------------------------------------|:-----------------:|------------------------------------------------------------------------------------------------------------------------|
+| `{schema}`                                   | Name of the generated Java class.                |         *         |                                                                                                                        |
+| `{schema}.type`                              | Type of the generated Java class.                |     `object`      | Generates a Record class.                                                                                              |
+|                                              |                                                  |      `enum`       | Generates an Enum class.                                                                                               |
+| `{schema}.description`                       | JavaDoc description of the generated Java class. |         *         |                                                                                                                        |
+| `{schema}.deprecated`                        | Marks the generated Java class as Deprecated.    |      `true`       | Annotates the class with `@Deprecated` and adds `@deprecated` to the JavaDoc description.                              |
+|                                              |                                                  | `false` (default) | Does nothing.                                                                                                          |
+| `{schema}.properties`                        | Fields of the generated Record class.            |         *         |                                                                                                                        |
+| `{schema}.properties.{property}`             | Name of the field.                               |         *         | Added as a `@param` in the JavaDoc.                                                                                    |
+| `{schema}.properties.{property}.description` | Description of the field.                        |         *         | Description of the `@param` in the JavaDoc.                                                                            |
+| `{schema}.properties.{property}.$ref`        | Type of the field is another Java class.         |         *         |                                                                                                                        |
+| `{schema}.properties.{property}.type`        | Type of the field.                               |      `array`      | Generates the field as `List<{items.type}>`.                                                                           |
+|                                              |                                                  |     `boolean`     | Generates the field as `Boolean`.                                                                                      |
+|                                              |                                                  |      `enum`       | **Not supported yet** - See [Issue #5](https://github.com/Chrimle/openapi-to-java-records-mustache-templates/issues/5) |
+|                                              |                                                  |     `integer`     | Generates the field as `Integer`.                                                                                      |
+|                                              |                                                  |     `number`      | Generates the field as `BigDecimal`.                                                                                   |
+|                                              |                                                  |     `object`      | **Not supported yet** - See [Issue #4](https://github.com/Chrimle/openapi-to-java-records-mustache-templates/issues/4) |
+|                                              |                                                  |     `string`      | Generates the field as `String`.                                                                                       |
 
 ### Useful Resources
 

diff --git a/pom.xml b/pom.xml
@@ -21,6 +21,7 @@
         <maven.compiler.source>17</maven.compiler.source>
         <maven.compiler.target>17</maven.compiler.target>
         <junit-jupiter-api.version>5.10.3</junit-jupiter-api.version>
+        <gson.version>2.10.1</gson.version>
     </properties>
 
 
@@ -31,6 +32,11 @@
             <version>${junit-jupiter-api.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.google.code.gson</groupId>
+            <artifactId>gson</artifactId>
+            <version>${gson.version}</version>
+        </dependency>
     </dependencies>
 
 

diff --git a/src/main/resources/api.yaml b/src/main/resources/api.yaml
@@ -92,17 +92,19 @@ components:
           description: yet another Array field
           items:
             type: boolean
-    ###### NOT SUPPORTED YET ######
-    #ExampleRecordWithNumberFields:
-    #  type: object
-    #  properties:
-    #    field1:
-    #      type: number
-    #    field2:
-    #      type: number
-    #    field3:
-    #      type: number
-    ###############################
+    ExampleRecordWithNumberFields:
+      type: object
+      description: Example of a Record with Number fields
+      properties:
+        field1:
+          type: number
+          description: a Number field
+        field2:
+          type: number
+          description: another Number field
+        field3:
+          type: number
+          description: yet another Number field
     ExampleRecordWithExampleRecordFields:
       type: object
       description: Example of a Record with Record fields

diff --git a/src/main/resources/templates/deprecation.mustache b/src/main/resources/templates/deprecation.mustache
@@ -0,0 +1,3 @@
+{{#isDeprecated}}
+
+@Deprecated{{/isDeprecated}}
diff --git a/src/main/resources/templates/model.mustache b/src/main/resources/templates/model.mustache
diff --git a/src/main/resources/templates/enum.mustache → ...in/resources/templates/modelEnum.mustache b/src/main/resources/templates/enum.mustache → ...in/resources/templates/modelEnum.mustache
@@ -1,3 +1,4 @@
+{{>javadoc}}{{>deprecation}}
 public enum {{classname}} {
     {{#allowableValues}}{{#enumVars}}{{{name}}}{{^-last}},
     {{/-last}}{{#-last}};{{/-last}}{{/enumVars}}{{/allowableValues}}

diff --git a/src/main/resources/templates/pojo.mustache b/src/main/resources/templates/pojo.mustache
@@ -1,3 +1,6 @@
-{{>javadoc}}{{#isDeprecated}}
-@Deprecated{{/isDeprecated}}
-{{^isEnum}}{{>record}}{{/isEnum}}{{#isEnum}}{{>enum}}{{/isEnum}}
+{{>javadoc}}{{>deprecation}}
+public record {{classname}}(
+    {{#vars}}{{{datatypeWithEnum}}} {{name}}{{^-last}},
+    {{/-last}}{{/vars}}) {
+
+}
diff --git a/src/test/java/com/chrimle/example/TestExampleRecordWithNumberFields.java b/src/test/java/com/chrimle/example/TestExampleRecordWithNumberFields.java
@@ -0,0 +1,32 @@
+package com.chrimle.example;
+
+import com.chrimle.example.utils.AssertionUtils;
+import java.math.BigDecimal;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+
+@DisplayName("Testing Record with Number fields")
+public class TestExampleRecordWithNumberFields {
+
+  private final Class<?> classUnderTest = ExampleRecordWithNumberFields.class;
+
+  @Test
+  @DisplayName("Testing class generated is a Record")
+  public void testClassGeneratedIsRecord() {
+    AssertionUtils.assertIsRecord(classUnderTest);
+  }
+
+  @Test
+  @DisplayName("Testing generated Record is not annotated as @Deprecated")
+  public void testRecordIsNotAnnotatedAsDeprecated() {
+    AssertionUtils.assertClassIsNotAnnotatedAsDeprecated(classUnderTest);
+  }
+
+  @Test
+  @DisplayName("Testing generated Record has expected number of fields of expected types")
+  public void testRecordHasNumberOfFieldsOfType() {
+    AssertionUtils.assertRecordHasNumberOfFieldsOfType(
+        classUnderTest, 3, BigDecimal.class);
+  }
+
+}
diff --git a/...enerated-sources/openapi/src/gen/java/main/com/chrimle/example/DeprecatedExampleEnum.java b/...enerated-sources/openapi/src/gen/java/main/com/chrimle/example/DeprecatedExampleEnum.java
@@ -14,9 +14,11 @@
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
  *
  */
+
 package com.chrimle.example;
 
-import java.util.List;
+import java.util.Objects;
+import com.google.gson.annotations.SerializedName;
 
 /**
  * Example of a deprecated Enum

diff --git a/...erated-sources/openapi/src/gen/java/main/com/chrimle/example/DeprecatedExampleRecord.java b/...erated-sources/openapi/src/gen/java/main/com/chrimle/example/DeprecatedExampleRecord.java
@@ -14,9 +14,17 @@
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
  *
  */
+
 package com.chrimle.example;
 
-import java.util.List;
+import java.util.Objects;
+import com.google.gson.TypeAdapter;
+import com.google.gson.annotations.JsonAdapter;
+import com.google.gson.annotations.SerializedName;
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonWriter;
+import java.io.IOException;
+import java.util.Arrays;
 
 /**
  * Example of a deprecated Record

diff --git a/target/generated-sources/openapi/src/gen/java/main/com/chrimle/example/ExampleEnum.java b/target/generated-sources/openapi/src/gen/java/main/com/chrimle/example/ExampleEnum.java
@@ -14,9 +14,11 @@
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
  *
  */
+
 package com.chrimle.example;
 
-import java.util.List;
+import java.util.Objects;
+import com.google.gson.annotations.SerializedName;
 
 /**
  * Example of an Enum

diff --git a/target/generated-sources/openapi/src/gen/java/main/com/chrimle/example/ExampleRecord.java b/target/generated-sources/openapi/src/gen/java/main/com/chrimle/example/ExampleRecord.java
@@ -14,9 +14,17 @@
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
  *
  */
+
 package com.chrimle.example;
 
-import java.util.List;
+import java.util.Objects;
+import com.google.gson.TypeAdapter;
+import com.google.gson.annotations.JsonAdapter;
+import com.google.gson.annotations.SerializedName;
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonWriter;
+import java.io.IOException;
+import java.util.Arrays;
 
 /**
  * Example of a Record

diff --git a/...d-sources/openapi/src/gen/java/main/com/chrimle/example/ExampleRecordWithArrayFields.java b/...d-sources/openapi/src/gen/java/main/com/chrimle/example/ExampleRecordWithArrayFields.java
@@ -14,8 +14,18 @@
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
  *
  */
+
 package com.chrimle.example;
 
+import java.util.Objects;
+import com.google.gson.TypeAdapter;
+import com.google.gson.annotations.JsonAdapter;
+import com.google.gson.annotations.SerializedName;
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonWriter;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
 
 /**

diff --git a/...sources/openapi/src/gen/java/main/com/chrimle/example/ExampleRecordWithBooleanFields.java b/...sources/openapi/src/gen/java/main/com/chrimle/example/ExampleRecordWithBooleanFields.java
@@ -14,9 +14,17 @@
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
  *
  */
+
 package com.chrimle.example;
 
-import java.util.List;
+import java.util.Objects;
+import com.google.gson.TypeAdapter;
+import com.google.gson.annotations.JsonAdapter;
+import com.google.gson.annotations.SerializedName;
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonWriter;
+import java.io.IOException;
+import java.util.Arrays;
 
 /**
  * Example of a Record with Boolean fields

diff --git a/...ces/openapi/src/gen/java/main/com/chrimle/example/ExampleRecordWithExampleEnumFields.java b/...ces/openapi/src/gen/java/main/com/chrimle/example/ExampleRecordWithExampleEnumFields.java
@@ -14,9 +14,18 @@
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
  *
  */
+
 package com.chrimle.example;
 
-import java.util.List;
+import java.util.Objects;
+import com.chrimle.example.ExampleEnum;
+import com.google.gson.TypeAdapter;
+import com.google.gson.annotations.JsonAdapter;
+import com.google.gson.annotations.SerializedName;
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonWriter;
+import java.io.IOException;
+import java.util.Arrays;
 
 /**
  * Example of a Record with Enum fields

diff --git a/...s/openapi/src/gen/java/main/com/chrimle/example/ExampleRecordWithExampleRecordFields.java b/...s/openapi/src/gen/java/main/com/chrimle/example/ExampleRecordWithExampleRecordFields.java
@@ -14,9 +14,18 @@
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
  *
  */
+
 package com.chrimle.example;
 
-import java.util.List;
+import java.util.Objects;
+import com.chrimle.example.ExampleRecord;
+import com.google.gson.TypeAdapter;
+import com.google.gson.annotations.JsonAdapter;
+import com.google.gson.annotations.SerializedName;
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonWriter;
+import java.io.IOException;
+import java.util.Arrays;
 
 /**
  * Example of a Record with Record fields

diff --git a/...sources/openapi/src/gen/java/main/com/chrimle/example/ExampleRecordWithIntegerFields.java b/...sources/openapi/src/gen/java/main/com/chrimle/example/ExampleRecordWithIntegerFields.java
@@ -14,9 +14,17 @@
  * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
  *
  */
+
 package com.chrimle.example;
 
-import java.util.List;
+import java.util.Objects;
+import com.google.gson.TypeAdapter;
+import com.google.gson.annotations.JsonAdapter;
+import com.google.gson.annotations.SerializedName;
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonWriter;
+import java.io.IOException;
+import java.util.Arrays;
 
 /**
  * Example of a Record with Integer fields

diff --git a/...-sources/openapi/src/gen/java/main/com/chrimle/example/ExampleRecordWithNumberFields.java b/...-sources/openapi/src/gen/java/main/com/chrimle/example/ExampleRecordWithNumberFields.java
@@ -0,0 +1,41 @@
+/*
+ * Example OpenAPI Spec.
+ * An example OpenAPI-spec to generate example Java records.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ * This class was generated using custom mustache templates from
+ * openapi-to-java-records-mustache-templates. For further information,
+ * questions, requesting features or reporting issues, please visit:
+ * https://github.com/Chrimle/openapi-to-java-records-mustache-templates.
+ *
+ */
+
+package com.chrimle.example;
+
+import java.util.Objects;
+import com.google.gson.TypeAdapter;
+import com.google.gson.annotations.JsonAdapter;
+import com.google.gson.annotations.SerializedName;
+import com.google.gson.stream.JsonReader;
+import com.google.gson.stream.JsonWriter;
+import java.io.IOException;
+import java.math.BigDecimal;
+import java.util.Arrays;
+
+/**
+ * Example of a Record with Number fields
+ * @param field1 a Number field
+ * @param field2 another Number field
+ * @param field3 yet another Number field
+ */
+public record ExampleRecordWithNumberFields(
+    BigDecimal field1,
+    BigDecimal field2,
+    BigDecimal field3) {
+
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		{{#isDeprecated}}

		@Deprecated{{/isDeprecated}}