Merge pull request #33 from contentstack/next

next : support of br tag and alignment styling

Author: ishaileshmishra

.idea/.gitignore

@@ -1,44 +1,65 @@
-
 # Changelog
 
 A brief description of what changes project contains
 
 ## Aug 8, 2023
-#### v1.2.3 
-- Attribute support added
 
+#### v1.2.4
+
+- Style Attribute support added
+- Issue fixes for missing center alignment
+- \n support added using br tag to support new lines
+
+## Aug 8, 2023
+
+#### v1.2.3
+
+- Attribute support added
 
 ## Jun 7un 26, 2023
-#### v1.2.2 
+
+#### v1.2.2
+
 - Added Support For Nested Assets
 - General Code Improvement
 
 ## Jun 26, 2023
-#### v1.2.1 
+
+#### v1.2.1
+
 - New Line Issues while rendering Json object To HTML
 
 ## Updated Jsoup vulnerable dependency
-#### v1.2.0 
+
+#### v1.2.0
+
 - Updated Jsoup vulnerable dependency
 - jsonToHTML function support added
 
-
 ## Fixed compile Issue
-#### v1.1.2 
+
+#### v1.1.2
+
 - Fixed compile Issue
 
 ## Transitive dependencies updated
-#### v1.1.1 
-- Updated transitive dependencies to pom.xml
 
+#### v1.1.1
+
+- Updated transitive dependencies to pom.xml
 
 ## JSON RTE Feature Support
-#### v1.1.0 
+
+#### v1.1.0
+
 - JSON RTE Feature Support
 
 ## Introducing Release Of Java Utils SDK
-#### v1.0.0 
+
+#### v1.0.0
+
 - Initial release for Utils SDK
+
 ## Support
 
 - For support, email [email protected] or join our Slack channel.

Changelog.md

@@ -2,14 +2,12 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
-
     <groupId>com.contentstack.sdk</groupId>
     <artifactId>utils</artifactId>
-    <version>1.2.3</version>
+    <version>1.2.4</version>
     <packaging>jar</packaging>
     <name>Contentstack-utils</name>
-    <description>Java Utils SDK for Contentstack Content Delivery API, Contentstack is a headless CMS
-    </description>
+    <description>Java Utils SDK for Contentstack Content Delivery API, Contentstack is a headless CMS</description>
     <url>https://www.***REMOVED***</url>
 
     <properties>
@@ -29,8 +27,8 @@
         <nexus-staging-maven-plugin.version>1.6.7</nexus-staging-maven-plugin.version>
         <maven-release-plugin.version>2.5.3</maven-release-plugin.version>
         <validation-version>2.0.1.Final</validation-version>
-        <json-version>20230227</json-version>
-        <spring-web-version>6.0.11</spring-web-version>
+        <json-version>20230618</json-version>
+        <spring-web-version>6.0.12</spring-web-version>
         <org.apache.commons-text>1.10.0</org.apache.commons-text>
     </properties>
 
@@ -173,6 +171,9 @@
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
                 <version>${maven-javadoc-plugin.version}</version>
+                <configuration>
+                    <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
+                </configuration>
                 <executions>
                     <execution>
                         <id>attach-javadocs</id>
@@ -223,6 +224,15 @@
                     <autoReleaseAfterClose>true</autoReleaseAfterClose>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>1.8</source>
+                    <target>1.8</target>
+<!--                    <executable>${JAVA_HOME}/bin/javac</executable>-->
+                </configuration>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-release-plugin</artifactId>

pom.xml

@@ -196,7 +196,7 @@ public static void jsonToHTML(@NotNull JSONObject entry, @NotNull String[] keyPa
      * @param jsonRTE       A JSONObject representing the JSON data to be converted to HTML.
      * @param renderOption  The `renderOption` parameter is an option that determines how the JSON content
      *                      should be rendered as HTML. It could be an enum or a class that defines different rendering options.
-     * @param embeddeditems The `embeddeditems` parameter is a `JSONObject` that contains embedded items.
+     * @param embeddeditems The `embedded-items` parameter is a `JSONObject` that contains embedded items.
      *                      It is used to find and retrieve embedded items based on their metadata.
      * @return The method is returning a String.
      */
@@ -219,7 +219,7 @@ public static String jsonToHTML(@NotNull JSONObject jsonRTE, Option renderOption
      * @param renderOption  The `renderOption` parameter is an option that determines how the JSON data
      *                      should be rendered as HTML. It could be an enum or a custom class that defines different rendering
      *                      options.
-     * @param embeddeditems The `embeddeditems` parameter is a `JSONObject` that contains embedded items.
+     * @param embeddeditems The `embedded-items` parameter is a `JSONObject` that contains embedded items.
      *                      It is used to find and retrieve embedded items based on the metadata provided.
      * @return The method is returning an Object.
      */

src/main/java/com/contentstack/utils/Utils.java

@@ -7,8 +7,7 @@
 import org.apache.commons.text.StringEscapeUtils;
 import org.json.JSONObject;
 
-import java.util.ArrayList;
-import java.util.Arrays;
+import java.util.*;
 
 
 public class DefaultOption implements Option {
@@ -55,6 +54,8 @@ public String renderOptions(JSONObject embeddedObject, Metadata metadata) {
      */
     @Override
     public String renderMark(MarkType markType, String text) {
+        // Replace "\n" with "<br/>" tags
+        text = renderHtmlWithLineBreaks(text);
         switch (markType) {
             case SUPERSCRIPT:
                 return "<sup>" + text + "</sup>";
@@ -94,8 +95,7 @@ private String escapeInjectHtml(JSONObject nodeObj, String nodeType) {
      *                   rendered.
      * @param callback   The `callback` parameter is an instance of the `NodeCallback` interface. It is
      *                   used to render the children of the current node. The `renderChildren` method of the `callback`
-     *                   is called with the `children` JSON array of the current node as the argument. The
-     *                   `renderChildren
+     *                   is called with the `children` JSON array of the current node as the argument. The `renderChildren
      * @return The method `renderNode` returns a string representation of an HTML element based on the
      * given `nodeType` and `nodeObject`.
      */
@@ -105,11 +105,12 @@ public String renderNode(String nodeType, JSONObject nodeObject, NodeCallback ca
         String strAttrs = strAttrs(nodeObject);
 
         String children = callback.renderChildren(nodeObject.optJSONArray("children"));
+
         switch (nodeType) {
             case "p":
                 return "<p" + strAttrs + ">" + children + "</p>";
             case "a":
-                return "<a" + strAttrs + "href=\"" + escapeInjectHtml(nodeObject, "href") + "\">" + children + "</a>";
+                return "<a" + strAttrs + " href=\"" + escapeInjectHtml(nodeObject, "href") + "\">" + children + "</a>";
             case "img":
                 String assetLink = getNodeStr(nodeObject, "asset-link");
                 if (!assetLink.isEmpty()) {
@@ -164,6 +165,28 @@ public String renderNode(String nodeType, JSONObject nodeObject, NodeCallback ca
     }
 
 
+    /**
+     * Returns the string replacing </n> is with the <br/> tags
+     *
+     * @param content the content
+     * @return string with br tags
+     * @apiNote the support for the br tags are included
+     * @since v1.3.0
+     */
+    private String renderHtmlWithLineBreaks(String content) {
+        // Replace "\n" with "<br/>" tags
+        String htmlContent = content.replaceAll("\\n", "<br />");
+
+        // Now, you can render the HTML content
+        // (You can use your rendering method here, e.g., send it to a WebView or display it in a GUI component)
+
+        // For demonstration purposes, let's just print it
+        System.out.println(htmlContent);
+
+        return htmlContent;
+    }
+
+
     /**
      * The function takes a JSONObject as input and returns a string containing the attributes and
      * their values, excluding certain keys.
@@ -178,12 +201,18 @@ String strAttrs(JSONObject nodeObject) {
             JSONObject attrsObject = nodeObject.optJSONObject("attrs");
             if (attrsObject != null && !attrsObject.isEmpty()) {
                 for (String key : attrsObject.keySet()) {
-                    Object objValue =  attrsObject.opt(key);
+                    Object objValue = attrsObject.opt(key);
                     String value = objValue.toString();
-                    String[] ignoreKeys = {"href", "asset-link", "src", "url"};
-                    ArrayList<String> ignoreKeysList = new ArrayList<>(Arrays.asList(ignoreKeys));
-                    if (!ignoreKeysList.contains(key)) {
-                        result.append(" ").append(key).append("=\"").append(value).append("\"");
+                    // If style is available, do styling calculations
+                    if (Objects.equals(key, "style")) {
+                        String resultStyle = stringifyStyles(attrsObject.optJSONObject("style"));
+                        result.append(" ").append(key).append("=\"").append(resultStyle).append("\"");
+                    } else {
+                        String[] ignoreKeys = {"href", "asset-link", "src", "url"};
+                        ArrayList<String> ignoreKeysList = new ArrayList<>(Arrays.asList(ignoreKeys));
+                        if (!ignoreKeysList.contains(key)) {
+                            result.append(" ").append(key).append("=\"").append(value).append("\"");
+                        }
                     }
                 }
             }
@@ -192,6 +221,30 @@ String strAttrs(JSONObject nodeObject) {
     }
 
 
+    private String stringifyStyles(JSONObject style) {
+        Map<String, String> styleMap = new HashMap<>();
+
+        // Convert JSONObject to a Map
+        Iterator<String> keys = style.keys();
+        while (keys.hasNext()) {
+            String key = keys.next();
+            String value = style.getString(key);
+            styleMap.put(key, value);
+        }
+
+        StringBuilder styleString = new StringBuilder();
+
+        for (Map.Entry<String, String> entry : styleMap.entrySet()) {
+            String property = entry.getKey();
+            String value = entry.getValue();
+
+            styleString.append(property).append(": ").append(value).append("; ");
+        }
+
+        return styleString.toString();
+    }
+
+
     /**
      * The function retrieves the value of a specified key from a JSONObject, and if it is empty or
      * null, it retrieves the value of the "url" key instead.

src/main/java/com/contentstack/utils/render/DefaultOption.java

@@ -10,9 +10,9 @@ public class RTEResult {
     public static String kH4Html = "<h4><strong><em><u><sub>MaNullam feugiat turpis quis elit interdum, vitae laoreet quam viverra</sub></u></em></strong></h4>";
     public static String kH5Html = "<h5>Mauris venenatis dui id massa sollicitudin, non bibendum nunc dictum.</h5>";
     public static String kH6Html = "<h6>Nunc porta diam vitae purus semper, ut consequat lorem vehicula.</h6>";
-    public static String kOrderListHtml = "<ol><li>Morbi in quam molestie, fermentum diam vitae, bibendum ipsum.</li><li>Pellentesque mattis lacus in quam aliquam congue</li><li>Integer feugiat leo dignissim, lobortis enim vitae, mollis lectus.</li><li>Sed in ante lacinia, molestie metus eu, fringilla sapien.</li></ol>";
+    public static String kOrderListHtml = "<ol><li redactor-attributes=\"{}\" style=\"text-align: justify; \">Morbi in quam molestie, fermentum diam vitae, bibendum ipsum.</li><li redactor-attributes=\"{}\" style=\"text-align: justify; \">Pellentesque mattis lacus in quam aliquam congue</li><li redactor-attributes=\"{}\" style=\"text-align: justify; \">Integer feugiat leo dignissim, lobortis enim vitae, mollis lectus.</li><li redactor-attributes=\"{}\" style=\"text-align: justify; \">Sed in ante lacinia, molestie metus eu, fringilla sapien.</li></ol>";
     public static String kIUnorderListHtml = "<ul><li>Sed quis metus sed mi hendrerit mollis vel et odio.</li><li>Integer vitae sem dignissim, elementum libero vel, fringilla massa.</li><li>Integer imperdiet arcu sit amet tortor faucibus aliquet.</li><li>Aenean scelerisque velit vitae dui vehicula, at congue massa sagittis.</li></ul>";
-    public static String kImgHtml = "<img src=\"https://images.***REMOVED***/v3/assets/UID_13/Donald.jog.png\" />";
+    public static String kImgHtml = "<img redactor-attributes=\"{\"asset_uid\":\"47f1aa5ae422cd1\"}\" width=\"33.69418132611637\" height=\"auto\" src=\"https://images.***REMOVED***/v3/assets/UID_13/Donald.jog.png\" />";
     public static String kTableHtml = "<table><thead><tr><th><p>Header 1</p></th><th><p>Header 2</p></th></tr></thead><tbody><tr><td><p>Body row 1 data 1</p></td><td><p>Body row 1 data 2</p></td></tr><tr><td><p>Body row 2 data 1</p></td><td><p>Body row 2 data 2</p></td></tr></tbody></table>";
     public static String kBlockquoteHtml = "<blockquote>Praesent eu ex sed nibh venenatis pretium.</blockquote>";
     public static String kCodeHtml = "<code>Code template.</code>";

src/test/java/com/contentstack/utils/RTEResult.java

@@ -1,7 +1,8 @@
-[{
+[
+  {
     "title": "New entry with figure tag",
     "rich_text_editor": [
-        "<p> Block embedded entry </p><p><figure type=\"entry\" class=\"embedded-entry block-entry\" data-sys-entry-uid=\"55f6d8cbd7e03a1f\" data-sys-content-type-uid=\"article\" style=\"display:block;\" sys-style-type=\"block\"><span>{{title}}</span></figure></p>"
+      "<p> Block embedded entry </p><p><figure type=\"entry\" class=\"embedded-entry block-entry\" data-sys-entry-uid=\"55f6d8cbd7e03a1f\" data-sys-content-type-uid=\"article\" style=\"display:block;\" sys-style-type=\"block\"><span>{{title}}</span></figure></p>"
     ],
     "tags": [],
     "locale": "en-us",
@@ -13,20 +14,25 @@
     "ACL": {},
     "_version": 1,
     "_in_progress": false,
-    "_embedded_entries": [{
+    "_embedded_entries": [
+      {
         "title": "Why are Indian rating agency heads being sent on 'leave'?",
         "multi_line": "If you have watched the film The Big Short, you might remember a scene in which Mark Baum, the fund manager, asks the lady at the ratings agency, “Why did you rate this?” And she says, otherwise they will go to another agency two blocks down the road.\n\nDid rating agencies in India fall for the same logic? Only time will tell.\n\nFor now, the heads of two Indian rating agencies, CARE Ltd and ICRA Ltd, have been sent on leave. On Wednesday evening, CARE Ratings Ltd announced to the stock exchanges that it has sent its managing director and CEO, Rajesh Mokashi on leave with immediate effect. It comes on the back of an anonymous complaint that was sent to the markets regulator, which was then forwarded to CARE, and the ratings firm is now examining the complaint.\n\nJust a fortnight ago, the same pattern followed when concerns were raised in an anonymous representation to the securities and exchange board of India (Sebi) regarding another agency, ICRA Ltd. The markets regulator had promptly sent it forward to ICRA which then sent its managing director, Naresh Takkar, on immediate leave, until further notice.\n\nThese are two incidents just this month, and more heads are expected to roll. Ratings agencies have come under the scanner since the debacle of shadow banking firm IL&FS Ltd. Three agencies that rated the company include India Ratings & Research, ICRA and CARE. The markets regulator in December last year had said it will investigate the matter.\n\nIn fact, one look at ICRA’s website shows that on August 6, 2018, the firm had given an A+ rating to IL&FS Financial Services Ltd’s (IFIN’s) commercial paper, worth Rs 4,000 crore. Interestingly, a closer look at the document showcases problems galore.",
-        "header_ref": [{
+        "header_ref": [
+          {
             "uid": "dd96bf9df1e109cd",
             "_content_type_uid": "header"
-        }],
+          }
+        ],
         "footer_ref": [
-            "a8d1c04adeca1cd1"
+          "a8d1c04adeca1cd1"
         ],
-        "reference": [{
+        "reference": [
+          {
             "uid": "35f57d9211b3d430",
             "_content_type_uid": "author"
-        }],
+          }
+        ],
         "tags": [],
         "locale": "en-us",
         "uid": "55f6d8cbd7e03a1f",
@@ -41,5 +47,7 @@
         "number": null,
         "url": "/why-are-indian-rating-agency-heads-being-sent-on-leave-",
         "_in_progress": false
-    }]
-}]
+      }
+    ]
+  }
+]