fix(core): Property's type should be nullable (#117)

Author: nandorholozsnyak

spring-configuration-property-documenter-core/src/main/java/org/rodnansol/core/generator/template/data/Property.java

@@ -22,7 +22,7 @@ public class Property {
     /**
      * Type of the property, most likely to be a Java class.
      */
-    @NonNull
+    @Nullable
     private final String type;
     /**
      * Property's key.
@@ -47,7 +47,7 @@ public class Property {
 
     public Property(String fqName, String type) {
         this.fqName = Objects.requireNonNull(fqName, "fqName is NULL");
-        this.type = Objects.requireNonNull(type, "type is NULL");
+        this.type = type;
     }
 
     public Property(String fqName, String type, String key, String description, String defaultValue, PropertyDeprecation propertyDeprecation) {
@@ -96,7 +96,7 @@ public void setDefaultValue(@Nullable String defaultValue) {
         this.defaultValue = defaultValue;
     }
 
-    @NonNull
+    @Nullable
     public String getType() {
         return type;
     }

spring-configuration-property-documenter-core/src/main/resources/templates/partials/adoc/content.adoc.hbs

@@ -16,7 +16,9 @@ ifdef::property-group-discrete-heading[]
 === {{groupName}}
 endif::[]
 {{#is_included "class" ~}}
+{{#if type ~}}
 *{{i18n "template.class"}}:* `{{type}}`
+{{/if ~}}
 {{/is_included ~}}
 
 {{> templates/partials/adoc/content-table-header.adoc}}
@@ -25,7 +27,7 @@ endif::[]
 |{{key}}
 {{/is_included ~}}
 {{#is_included "type" ~}}
-|{{type}}
+|{{#if type}}{{type}}{{/if}}
 {{/is_included ~}}
 {{#is_included "description" ~}}
 |{{description}}

spring-configuration-property-documenter-core/src/main/resources/templates/partials/html/compact-content.html.hbs

@@ -4,7 +4,7 @@
         <td>{{fqName}}</td>
         {{/is_included ~}}
         {{#is_included "type" ~}}
-        <td>{{type}}</td>
+    <td>{{#if type}}{{type}}{{/if}}</td>
         {{/is_included ~}}
         {{#is_included "description" ~}}
         <td>{{description}}</td>

spring-configuration-property-documenter-core/src/main/resources/templates/partials/html/content.html.hbs

@@ -6,7 +6,7 @@
     {{#each propertyGroups ~}}
     <h2 id="{{#if moduleName}}{{moduleName}}-{{/if}}{{groupName}}">{{groupName}}</h2>
     {{#is_included "class" ~}}
-        <b>{{i18n "template.class"}}:</b> <code>{{type}}</code>
+    {{#if type}}<b>{{i18n "template.class"}}:</b> <code>{{type}}</code>{{/if}}
     {{/is_included ~}}
     <table class="table">
         {{> templates/partials/html/content-table-header.html}}
@@ -17,7 +17,7 @@
                 <td>{{key}}</td>
                 {{/is_included ~}}
                 {{#is_included "type" ~}}
-                <td>{{type}}</td>
+                <td>{{#if type}}{{type}}{{/if}}</td>
                 {{/is_included ~}}
                 {{#is_included "description" ~}}
                 <td>{{description}}</td>

spring-configuration-property-documenter-core/src/main/resources/templates/partials/md/content.md.hbs

@@ -8,10 +8,12 @@
 {{#each propertyGroups~}}
 ### {{groupName}}
 {{#is_included "class" ~}}
+{{#if type~}}
 **{{i18n "template.class"}}:** `{{type}}`
+{{/if~}}
 {{/is_included}}
 {{> templates/partials/md/content-table-header.md}}
 {{#each properties ~}}
-| {{#is_included "key"}}{{key}}|{{/is_included}} {{#is_included "type"}}{{type}}|{{/is_included}} {{#is_included "description"}}{{description}}|{{/is_included}} {{#is_included "defaultValue"}}{{defaultValue}}|{{/is_included}} {{#is_included "deprecation"}}{{propertyDeprecation}}|{{/is_included}} {{#is_included "envFormat"}}`{{as_env fqName}}`|{{/is_included}}
+| {{#is_included "key"}}{{key}}|{{/is_included}} {{#is_included "type"}}{{#if type~}}{{type}}{{/if}}|{{/is_included}} {{#is_included "description"}}{{description}}|{{/is_included}} {{#is_included "defaultValue"}}{{defaultValue}}|{{/is_included}} {{#is_included "deprecation"}}{{propertyDeprecation}}|{{/is_included}} {{#is_included "envFormat"}}`{{as_env fqName}}`|{{/is_included}}
 {{/each ~}}
 {{/each}}

spring-configuration-property-documenter-core/src/main/resources/templates/partials/xml/content.xml.hbs

@@ -4,11 +4,11 @@
             <propertyGroups>{{#each propertyGroups}}
                     <propertyGroup>
                         <groupName>{{groupName}}</groupName>
-                        <type>{{type}}</type>
+                        {{#if type}}<type>{{type}}</type>{{/if}}
                         <properties>{{#each properties}}
                             <property>
                                 <key>{{key}}</key>
-                                <type>{{type}}</type>
+                                {{#if type}}<type>{{type}}</type>{{/if}}
                                 <description>{{description}}</description>
                                 <defaultValue>{{defaultValue}}</defaultValue>
                                 <propertyDeprecation>{{propertyDeprecation}}</propertyDeprecation>

spring-configuration-property-documenter-core/src/test/java/org/rodnansol/core/generator/reader/MetadataReaderTest.java

@@ -323,6 +323,26 @@ void readPropertiesAsPropertyGroupList_whenProperyParentIsNotHavingName() throws
             assertThat(propertyGroups)
                 .containsAll(expectedYourProperties1);
         }
+
+        @Test
+        @Issue("#115")
+        @DisplayName("Should parse property with null type and not fail")
+        void shouldParsePropertyWithNullType() throws Exception {
+            // Given
+            String file = TEST_RESOURCES_DIRECTORY + "regression/spring-configuration-metadata-property-without-type.json";
+
+            // When
+            List<PropertyGroup> propertyGroups = underTest.readPropertiesAsPropertyGroupList(new FileInputStream(file));
+
+            // Then
+            PropertyGroup testGroup = new PropertyGroup("test.group", "com.example.springpropertysources.MyProperties", "com.example.springpropertysources.MyProperties");
+            testGroup.addProperty(new Property("test.group.with.type", "java.lang.String", "with.type", "Property with type field", null, null));
+            testGroup.addProperty(new Property("test.group.without.type", null, "without.type", "Property without type field", null, null));
+
+            List<PropertyGroup> expectedGroups = List.of(PropertyGroup.createUnknownGroup(), testGroup);
+            assertThat(propertyGroups)
+                .containsAll(expectedGroups);
+        }
     }
 
     static class ReadPropertiesAsPropertyGroupListTestCase {

spring-configuration-property-documenter-core/src/test/resources/regression/spring-configuration-metadata-property-without-type.json

@@ -0,0 +1,22 @@
+{
+  "groups": [
+    {
+      "name": "test.group",
+      "type": "com.example.springpropertysources.MyProperties",
+      "sourceType": "com.example.springpropertysources.MyProperties"
+    }
+  ],
+  "properties": [
+    {
+      "name": "test.group.without.type",
+      "description": "Property without type field",
+      "sourceType": "com.example.springpropertysources.MyProperties"
+    },
+    {
+      "name": "test.group.with.type",
+      "type": "java.lang.String",
+      "description": "Property with type field",
+      "sourceType": "com.example.springpropertysources.MyProperties"
+    }
+  ]
+}