fix(core): Replace special characters with a post processing step (#78)…

… (#84) * fix(core): Replace special characters with a post processing step (#78) - Markup language related special characters are being replaced - toString changes - Now some classes are havin NonNull and Nullable annotations - Tests passes again. * fix(core): XSD version is invalid in the templates (#83) - Using latest XSD version
rodnansol · Sep 9, 2023 · 02c0d0f · 02c0d0f
1 parent 02398e3
commit 02c0d0f
Show file tree

Hide file tree

Showing 41 changed files with 427 additions and 115 deletions.
diff --git a/...perty-documenter-core/src/it/resources/it/aggregated/expected-compact-mode.adoc b/...perty-documenter-core/src/it/resources/it/aggregated/expected-compact-mode.adoc
@@ -23,8 +23,8 @@ This is a test description
 |
 |myproduct.features.foobar.value
 |java.lang.String
-|String value
-|Hello world
+|String \| value
+|Hello \| world
 |
 |myproduct.features.foobar.enabled
 |java.lang.Boolean
@@ -38,7 +38,7 @@ This is a test description
 |
 |myproduct.features.foobar.value
 |java.lang.String
-|String value
-|Hello world
+|String \| value
+|Hello \| world
 |
 |===
diff --git a/...ration-property-documenter-core/src/it/resources/it/aggregated/expected-compact-mode.html b/...ration-property-documenter-core/src/it/resources/it/aggregated/expected-compact-mode.html
@@ -189,8 +189,8 @@ <h1 class="center center-text">IT</h1>
 <tr>
         <td>myproduct.features.foobar.value</td>
         <td>java.lang.String</td>
-        <td>String value</td>
-        <td>Hello world</td>
+        <td>String | value</td>
+        <td>Hello | world</td>
         <td></td>
         </tr>
 <tr>
@@ -210,8 +210,8 @@ <h1 class="center center-text">IT</h1>
 <tr>
         <td>myproduct.features.foobar.value</td>
         <td>java.lang.String</td>
-        <td>String value</td>
-        <td>Hello world</td>
+        <td>String | value</td>
+        <td>Hello | world</td>
         <td></td>
         </tr>
 </table>

diff --git a/...roperty-documenter-core/src/it/resources/it/aggregated/expected-compact-mode.md b/...roperty-documenter-core/src/it/resources/it/aggregated/expected-compact-mode.md
@@ -10,7 +10,7 @@ This is a test description
 |---|----|-----------|-------------|-----------|
 | myproduct.features.foobar.enabled| java.lang.Boolean| Enable the foobar feature| true| | 
 | myproduct.features.foobar.number| java.lang.Number| Number value| 12.99| | 
-| myproduct.features.foobar.value| java.lang.String| String value| Hello world| | 
+| myproduct.features.foobar.value| java.lang.String| String &amp;#124 value| Hello &amp;#124 world| | 
 | myproduct.features.foobar.enabled| java.lang.Boolean| Enable the foobar feature| true| | 
 | myproduct.features.foobar.number| java.lang.Number| Number value| 12.99| | 
-| myproduct.features.foobar.value| java.lang.String| String value| Hello world| | 
+| myproduct.features.foobar.value| java.lang.String| String &amp;#124 value| Hello &amp;#124 world| | 
diff --git a/...documenter-core/src/it/resources/it/aggregated/expected-with-env-variables.adoc b/...documenter-core/src/it/resources/it/aggregated/expected-with-env-variables.adoc
@@ -38,8 +38,8 @@ endif::[]
 
 |myproduct.features.foobar.value
 |java.lang.String
-|String value
-|Hello world
+|String \| value
+|Hello \| world
 |
 |`MYPRODUCT_FEATURES_FOOBAR_VALUE`
 
@@ -80,8 +80,8 @@ endif::[]
 
 |myproduct.features.foobar.value
 |java.lang.String
-|String value
-|Hello world
+|String \| value
+|Hello \| world
 |
 |`MYPRODUCT_FEATURES_FOOBAR_VALUE`
 

diff --git a/...-property-documenter-core/src/it/resources/it/aggregated/expected-with-env-variables.html b/...-property-documenter-core/src/it/resources/it/aggregated/expected-with-env-variables.html
@@ -194,8 +194,8 @@ <h2 id="Document 1-Unknown group">Unknown group</h2>
         <tr>
                 <td>myproduct.features.foobar.value</td>
                 <td>java.lang.String</td>
-                <td>String value</td>
-                <td>Hello world</td>
+                <td>String | value</td>
+                <td>Hello | world</td>
                 <td></td>
                 <td>MYPRODUCT_FEATURES_FOOBAR_VALUE</td>
                 </tr>
@@ -237,8 +237,8 @@ <h2 id="Document 2-Unknown group">Unknown group</h2>
         <tr>
                 <td>myproduct.features.foobar.value</td>
                 <td>java.lang.String</td>
-                <td>String value</td>
-                <td>Hello world</td>
+                <td>String | value</td>
+                <td>Hello | world</td>
                 <td></td>
                 <td>MYPRODUCT_FEATURES_FOOBAR_VALUE</td>
                 </tr>

diff --git a/...y-documenter-core/src/it/resources/it/aggregated/expected-with-env-variables.md b/...y-documenter-core/src/it/resources/it/aggregated/expected-with-env-variables.md
@@ -15,7 +15,7 @@ Document 1 description
 |---|----|-----------|-------------|-----------|----------------------|
 | myproduct.features.foobar.enabled| java.lang.Boolean| Enable the foobar feature| true| | `MYPRODUCT_FEATURES_FOOBAR_ENABLED`|
 | myproduct.features.foobar.number| java.lang.Number| Number value| 12.99| | `MYPRODUCT_FEATURES_FOOBAR_NUMBER`|
-| myproduct.features.foobar.value| java.lang.String| String value| Hello world| | `MYPRODUCT_FEATURES_FOOBAR_VALUE`|
+| myproduct.features.foobar.value| java.lang.String| String &amp;#124 value| Hello &amp;#124 world| | `MYPRODUCT_FEATURES_FOOBAR_VALUE`|
 
 ## Document 2
 Document 2 description
@@ -26,5 +26,5 @@ Document 2 description
 |---|----|-----------|-------------|-----------|----------------------|
 | myproduct.features.foobar.enabled| java.lang.Boolean| Enable the foobar feature| true| | `MYPRODUCT_FEATURES_FOOBAR_ENABLED`|
 | myproduct.features.foobar.number| java.lang.Number| Number value| 12.99| | `MYPRODUCT_FEATURES_FOOBAR_NUMBER`|
-| myproduct.features.foobar.value| java.lang.String| String value| Hello world| | `MYPRODUCT_FEATURES_FOOBAR_VALUE`|
+| myproduct.features.foobar.value| java.lang.String| String &amp;#124 value| Hello &amp;#124 world| | `MYPRODUCT_FEATURES_FOOBAR_VALUE`|
 
diff --git a/...n-property-documenter-core/src/it/resources/it/aggregated/expected-with-env-variables.xml b/...n-property-documenter-core/src/it/resources/it/aggregated/expected-with-env-variables.xml
@@ -52,8 +52,8 @@
                         <property>
                             <key>myproduct.features.foobar.value</key>
                             <type>java.lang.String</type>
-                            <description>String value</description>
-                            <defaultValue>Hello world</defaultValue>
+                            <description>String | value</description>
+                            <defaultValue>Hello | world</defaultValue>
                             <propertyDeprecation></propertyDeprecation>
                             <environmentVariable>MYPRODUCT_FEATURES_FOOBAR_VALUE</environmentVariable>
                         </property>
@@ -88,8 +88,8 @@
                         <property>
                             <key>myproduct.features.foobar.value</key>
                             <type>java.lang.String</type>
-                            <description>String value</description>
-                            <defaultValue>Hello world</defaultValue>
+                            <description>String | value</description>
+                            <defaultValue>Hello | world</defaultValue>
                             <propertyDeprecation></propertyDeprecation>
                             <environmentVariable>MYPRODUCT_FEATURES_FOOBAR_VALUE</environmentVariable>
                         </property>

diff --git a/...umenter-core/src/it/resources/it/aggregated/expected-without-env-variables.adoc b/...umenter-core/src/it/resources/it/aggregated/expected-without-env-variables.adoc
@@ -36,8 +36,8 @@ endif::[]
 
 |myproduct.features.foobar.value
 |java.lang.String
-|String value
-|Hello world
+|String \| value
+|Hello \| world
 |
 
 
@@ -75,8 +75,8 @@ endif::[]
 
 |myproduct.features.foobar.value
 |java.lang.String
-|String value
-|Hello world
+|String \| value
+|Hello \| world
 |
 
 

diff --git a/...operty-documenter-core/src/it/resources/it/aggregated/expected-without-env-variables.html b/...operty-documenter-core/src/it/resources/it/aggregated/expected-without-env-variables.html
@@ -192,8 +192,8 @@ <h2 id="Document 1-Unknown group">Unknown group</h2>
         <tr>
                 <td>myproduct.features.foobar.value</td>
                 <td>java.lang.String</td>
-                <td>String value</td>
-                <td>Hello world</td>
+                <td>String | value</td>
+                <td>Hello | world</td>
                 <td></td>
                 </tr>
         </tbody>
@@ -232,8 +232,8 @@ <h2 id="Document 2-Unknown group">Unknown group</h2>
         <tr>
                 <td>myproduct.features.foobar.value</td>
                 <td>java.lang.String</td>
-                <td>String value</td>
-                <td>Hello world</td>
+                <td>String | value</td>
+                <td>Hello | world</td>
                 <td></td>
                 </tr>
         </tbody>

diff --git a/...ocumenter-core/src/it/resources/it/aggregated/expected-without-env-variables.md b/...ocumenter-core/src/it/resources/it/aggregated/expected-without-env-variables.md
@@ -15,7 +15,7 @@ Document 1 description
 |---|----|-----------|-------------|-----------|
 | myproduct.features.foobar.enabled| java.lang.Boolean| Enable the foobar feature| true| | 
 | myproduct.features.foobar.number| java.lang.Number| Number value| 12.99| | 
-| myproduct.features.foobar.value| java.lang.String| String value| Hello world| | 
+| myproduct.features.foobar.value| java.lang.String| String &amp;#124 value| Hello &amp;#124 world| | 
 
 ## Document 2
 Document 2 description
@@ -26,5 +26,5 @@ Document 2 description
 |---|----|-----------|-------------|-----------|
 | myproduct.features.foobar.enabled| java.lang.Boolean| Enable the foobar feature| true| | 
 | myproduct.features.foobar.number| java.lang.Number| Number value| 12.99| | 
-| myproduct.features.foobar.value| java.lang.String| String value| Hello world| | 
+| myproduct.features.foobar.value| java.lang.String| String &amp;#124 value| Hello &amp;#124 world| | 
 
diff --git a/...roperty-documenter-core/src/it/resources/it/aggregated/expected-without-env-variables.xml b/...roperty-documenter-core/src/it/resources/it/aggregated/expected-without-env-variables.xml
@@ -52,8 +52,8 @@
                         <property>
                             <key>myproduct.features.foobar.value</key>
                             <type>java.lang.String</type>
-                            <description>String value</description>
-                            <defaultValue>Hello world</defaultValue>
+                            <description>String | value</description>
+                            <defaultValue>Hello | world</defaultValue>
                             <propertyDeprecation></propertyDeprecation>
 
                         </property>

diff --git a/...r-core/src/it/resources/it/aggregated/spring-configuration-metadata-empty-sourceType.json b/...r-core/src/it/resources/it/aggregated/spring-configuration-metadata-empty-sourceType.json
@@ -10,8 +10,8 @@
     {
       "name": "myproduct.features.foobar.value",
       "type": "java.lang.String",
-      "description": "String value",
-      "defaultValue": "Hello world"
+      "description": "String | value",
+      "defaultValue": "Hello | world"
     },
     {
       "name": "myproduct.features.foobar.number",

diff --git a/...-property-documenter-core/src/it/resources/it/single/expected-compact-mode.adoc b/...-property-documenter-core/src/it/resources/it/single/expected-compact-mode.adoc
@@ -24,8 +24,8 @@ This is a test description
 |
 |myproduct.features.foobar.value
 |java.lang.String
-|String value
-|Hello world
+|String \| value
+|Hello \| world
 |
 
 |===

diff --git a/...figuration-property-documenter-core/src/it/resources/it/single/expected-compact-mode.html b/...figuration-property-documenter-core/src/it/resources/it/single/expected-compact-mode.html
@@ -176,8 +176,8 @@ <h1 class="center center-text">IT</h1>
 <tr>
         <td>myproduct.features.foobar.value</td>
         <td>java.lang.String</td>
-        <td>String value</td>
-        <td>Hello world</td>
+        <td>String | value</td>
+        <td>Hello | world</td>
         <td></td>
         </tr>
 

diff --git a/...on-property-documenter-core/src/it/resources/it/single/expected-compact-mode.md b/...on-property-documenter-core/src/it/resources/it/single/expected-compact-mode.md
@@ -7,5 +7,5 @@ This is a test description
 |---|----|-----------|-------------|-----------|
 | myproduct.features.foobar.enabled| java.lang.Boolean| Enable the foobar feature| true| | 
 | myproduct.features.foobar.number| java.lang.Number| Number value| 12.99| | 
-| myproduct.features.foobar.value| java.lang.String| String value| Hello world| | 
+| myproduct.features.foobar.value| java.lang.String| String &amp;#124 value| Hello &amp;#124 world| | 
 
diff --git a/...rty-documenter-core/src/it/resources/it/single/expected-with-env-variables.adoc b/...rty-documenter-core/src/it/resources/it/single/expected-with-env-variables.adoc
@@ -36,8 +36,8 @@ endif::[]
 
 |myproduct.features.foobar.value
 |java.lang.String
-|String value
-|Hello world
+|String \| value
+|Hello \| world
 |
 |`MYPRODUCT_FEATURES_FOOBAR_VALUE`
 

diff --git a/...tion-property-documenter-core/src/it/resources/it/single/expected-with-env-variables.html b/...tion-property-documenter-core/src/it/resources/it/single/expected-with-env-variables.html
@@ -181,8 +181,8 @@ <h2 id="Unknown group">Unknown group</h2>
         <tr>
                 <td>myproduct.features.foobar.value</td>
                 <td>java.lang.String</td>
-                <td>String value</td>
-                <td>Hello world</td>
+                <td>String | value</td>
+                <td>Hello | world</td>
                 <td></td>
                 <td>MYPRODUCT_FEATURES_FOOBAR_VALUE</td>
                 </tr>

diff --git a/...perty-documenter-core/src/it/resources/it/single/expected-with-env-variables.md b/...perty-documenter-core/src/it/resources/it/single/expected-with-env-variables.md
@@ -10,7 +10,7 @@ This is a test description
 |---|----|-----------|-------------|-----------|----------------------|
 | myproduct.features.foobar.enabled| java.lang.Boolean| Enable the foobar feature| true| | `MYPRODUCT_FEATURES_FOOBAR_ENABLED`|
 | myproduct.features.foobar.number| java.lang.Number| Number value| 12.99| | `MYPRODUCT_FEATURES_FOOBAR_NUMBER`|
-| myproduct.features.foobar.value| java.lang.String| String value| Hello world| | `MYPRODUCT_FEATURES_FOOBAR_VALUE`|
+| myproduct.features.foobar.value| java.lang.String| String &amp;#124 value| Hello &amp;#124 world| | `MYPRODUCT_FEATURES_FOOBAR_VALUE`|
 
 
 
diff --git a/...ation-property-documenter-core/src/it/resources/it/single/expected-with-env-variables.xml b/...ation-property-documenter-core/src/it/resources/it/single/expected-with-env-variables.xml
@@ -1,6 +1,6 @@
 <configurationProperties  xmlns="https://github.com/rodnansol/spring-configuration-property-documenter"
                           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-                          xsi:schemaLocation="https://github.com/rodnansol/spring-configuration-property-documenter https://raw.githubusercontent.com/rodnansol/spring-configuration-property-documenter/master/public/schema-0.5.1.xsd">
+                          xsi:schemaLocation="https://github.com/rodnansol/spring-configuration-property-documenter https://raw.githubusercontent.com/rodnansol/spring-configuration-property-documenter/master/public/schema-0.5.0.xsd">
     <mainName>IT</mainName>
     <mainDescription>This is a test description</mainDescription>
     <tableOfContents>
@@ -42,8 +42,8 @@
                             <property>
                                 <key>myproduct.features.foobar.value</key>
                                 <type>java.lang.String</type>
-                                <description>String value</description>
-                                <defaultValue>Hello world</defaultValue>
+                                <description>String | value</description>
+                                <defaultValue>Hello | world</defaultValue>
                                 <propertyDeprecation></propertyDeprecation>
                                 <environmentVariable>MYPRODUCT_FEATURES_FOOBAR_VALUE</environmentVariable>
                             </property>

diff --git a/...-documenter-core/src/it/resources/it/single/expected-without-env-variables.adoc b/...-documenter-core/src/it/resources/it/single/expected-without-env-variables.adoc
@@ -34,8 +34,8 @@ endif::[]
 
 |myproduct.features.foobar.value
 |java.lang.String
-|String value
-|Hello world
+|String \| value
+|Hello \| world
 |
 
 

diff --git a/...n-property-documenter-core/src/it/resources/it/single/expected-without-env-variables.html b/...n-property-documenter-core/src/it/resources/it/single/expected-without-env-variables.html
@@ -179,8 +179,8 @@ <h2 id="Unknown group">Unknown group</h2>
         <tr>
                 <td>myproduct.features.foobar.value</td>
                 <td>java.lang.String</td>
-                <td>String value</td>
-                <td>Hello world</td>
+                <td>String | value</td>
+                <td>Hello | world</td>
                 <td></td>
                 </tr>
         </tbody>

diff --git a/...ty-documenter-core/src/it/resources/it/single/expected-without-env-variables.md b/...ty-documenter-core/src/it/resources/it/single/expected-without-env-variables.md
@@ -10,7 +10,7 @@ This is a test description
 |---|----|-----------|-------------|-----------|
 | myproduct.features.foobar.enabled| java.lang.Boolean| Enable the foobar feature| true| | 
 | myproduct.features.foobar.number| java.lang.Number| Number value| 12.99| | 
-| myproduct.features.foobar.value| java.lang.String| String value| Hello world| | 
+| myproduct.features.foobar.value| java.lang.String| String &amp;#124 value| Hello &amp;#124 world| | 
 
 
 
diff --git a/...on-property-documenter-core/src/it/resources/it/single/expected-without-env-variables.xml b/...on-property-documenter-core/src/it/resources/it/single/expected-without-env-variables.xml
@@ -1,6 +1,6 @@
 <configurationProperties  xmlns="https://github.com/rodnansol/spring-configuration-property-documenter"
                           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-                          xsi:schemaLocation="https://github.com/rodnansol/spring-configuration-property-documenter https://raw.githubusercontent.com/rodnansol/spring-configuration-property-documenter/master/public/schema-0.5.1.xsd">
+                          xsi:schemaLocation="https://github.com/rodnansol/spring-configuration-property-documenter https://raw.githubusercontent.com/rodnansol/spring-configuration-property-documenter/master/public/schema-0.5.0.xsd">
     <mainName>IT</mainName>
     <mainDescription></mainDescription>
     <tableOfContents>
@@ -42,8 +42,8 @@
                         <property>
                             <key>myproduct.features.foobar.value</key>
                             <type>java.lang.String</type>
-                            <description>String value</description>
-                            <defaultValue>Hello world</defaultValue>
+                            <description>String | value</description>
+                            <defaultValue>Hello | world</defaultValue>
                             <propertyDeprecation></propertyDeprecation>
 
                         </property>

diff --git a/...enter-core/src/it/resources/it/single/spring-configuration-metadata-empty-sourceType.json b/...enter-core/src/it/resources/it/single/spring-configuration-metadata-empty-sourceType.json
@@ -10,8 +10,8 @@
     {
       "name": "myproduct.features.foobar.value",
       "type": "java.lang.String",
-      "description": "String value",
-      "defaultValue": "Hello world"
+      "description": "String | value",
+      "defaultValue": "Hello | world"
     },
     {
       "name": "myproduct.features.foobar.number",