contentstack_utils 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a691f064b75fd39a515820f923d010c522db2424625e7bc6067d506f503032d
-  data.tar.gz: 2697a1861b0ff36a01067c818b978f0ed49c70c1e5873fb8d848370314da11d6
+  metadata.gz: 21932309e73056c667d82fb62ffcc391b31875bbab0862b3c62e6c5cd273f0e4
+  data.tar.gz: 2c62ff41a24c02a1737f192d51389449f9c7f4a3f157f6b3373367a74809b5c2
 SHA512:
-  metadata.gz: 30aab1ef4bb9db3b8e2ebd83bc43ca204c93a11c96b37c85d57dc74b289e08ec518bfa5da8d192c146fdc52567f9b37acb1199d1f0eaedfd7af323154a8e1cfb
-  data.tar.gz: 6033a07b7469e441135337014784746a87ef215d4e70aa92e730c13a8636ebae8e48dc989efee9c1d201100317388db9c942bcecade1c3c7eb296d1767a1591f
+  metadata.gz: 597777d333caef160d256e78b740ae5a2068ecbe8bac8b77183df32efc40d781101dcef0787b045ea816e1560ca46704b50e801746a2bce797134538f18fd723
+  data.tar.gz: cd94ed56bae23557502116fd4c1d1d3aca927cdc3d7af38708950cbc52fa8deb6051c529d41c579421e060c8694f57ef56a846a7fdd27a931267747ef0cf81e8

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [1.1.0](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.1.0) (2021-08-10)
+  - GQL Json rte to Html content support added
+
+## [1.0.2](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.0.2) (2021-07-16)
+  - JSON RTE support added
 ## [1.0.1](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.0.1) (2021-06-02)
   - Gemspec Dependency update
 

data/README.md

@@ -86,3 +86,12 @@ require  'contentstack'
 	Contentstack.render_content(@entry.rte_field_uid, ContentstackUtils::Model::Option.new(@entry))  
 end
 ```
+### GQL Json RTE to HTML
+To parse JSON RTE content from GQL response to HTML content use `ContentstackUtils::GQL.json_to_html` function as below:
+
+```ruby
+require  'contentstack_utils'  
+
+	result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+
+```

data/lib/contentstack_utils/model/options.rb

@@ -17,7 +17,7 @@ module ContentstackUtils
                 renderString = ''
                 case metadata.style_type
                 when 'block'
-                    renderString = "<div><p>#{embeddedObject['title'] || embeddedObject['uid']}</p><p>Content type: <span>#{embeddedObject['_content_type_uid']}</span></p></div>"
+                    renderString = "<div><p>#{embeddedObject['title'] || embeddedObject['uid']}</p><p>Content type: <span>#{embeddedObject['_content_type_uid'] || embeddedObject['system']['content_type_uid']}</span></p></div>"
                 when 'inline'
                     renderString = "<span>#{embeddedObject["title"] || embeddedObject["uid"]}</span>";
                 when 'link'

data/lib/contentstack_utils/utils.rb

@@ -17,38 +17,49 @@ module ContentstackUtils
     end
 
     def self.json_to_html(content, options)
+        reference = -> (metadata){
+            result = ""
+            if options.entry != nil
+                object = findObject(metadata, options.entry)
+                if object!= nil && object.length() > 0 
+                    result = options.render_option(object[0], metadata)
+                end
+            end
+            result
+         }
         if (content.instance_of? Array)
             result = []
             content.each do |n|
-                result.push(json_doc_to_html(n, options))
+                result.push(json_doc_to_html(n, options, reference) )
             end
             result
         elsif content.instance_of? Hash
-            json_doc_to_html(content, options)
+            json_doc_to_html(content, options, reference)
         end
     end
 
-    private_class_method def self.json_doc_to_html(node, options) 
+    def self.json_doc_to_html(node, options, callback)
         result = ""
         if node["children"] && node["children"].length() > 0
-            result = node_children_to_html(node["children"], options)
+            result = node_children_to_html(node["children"], options, callback)
         end
         result
     end
 
-    private_class_method def self.node_children_to_html(nodes, options) 
-        nodes.map {|node| node_to_html(node, options)}.join("")
+    private_class_method def self.node_children_to_html(nodes, options, callback) 
+        nodes.map {|node| node_to_html(node, options, callback)}.join("")
     end
 
-    private_class_method def self.node_to_html(node, options)
+    private_class_method def self.node_to_html(node, options, callback)
         html_result = ""
         if node["type"] == nil && node["text"] 
             html_result = text_to_htms(node, options)            
         elsif node["type"]
             if node["type"] == "reference"
-                html_result = reference_to_html(node, options)
+                metadata = Model::Metadata.new(node)
+                html_result = callback.call(metadata)
             else
-                inner_html = json_doc_to_html(node, options)
+                inner_html = json_doc_to_html(node, options, callback)
                 html_result =  options.render_node(node["type"], node, inner_html)
             end 
         end
@@ -81,18 +92,6 @@ module ContentstackUtils
         text
     end
 
-    private_class_method def self.reference_to_html(node, options) 
-        result = ""
-        if options.entry != nil
-            metadata = Model::Metadata.new(node)
-            object = findObject(metadata, options.entry)
-            if object!= nil && object.length() > 0 
-                result = options.render_option(object[0], metadata)
-            end
-        end
-        result
-    end
-
     private_class_method def self.render_string(string, options) 
         xml_doc = Nokogiri::HTML(appendFrame(string))
         result = xml_doc.xpath('//documentfragmentcontainer').inner_html
@@ -128,4 +127,37 @@ module ContentstackUtils
         end
         return nil
     end
+
+    module GQL
+        include ContentstackUtils
+        def self.json_to_html(content, options)
+            embeddedItems = []
+            if content.has_key? 'embedded_itemsConnection'
+                embeddedItems = content['embedded_itemsConnection']['edges'] || []
+            end            
+            reference = -> (metadata){
+                result = ""
+                if embeddedItems != nil
+                    object = embeddedItems.select { |embedObject| embedObject['node']["system"]["uid"] == metadata.item_uid }
+                    if object != nil && object.length() > 0 
+                        result = options.render_option(object[0]["node"], metadata)
+                    end
+                end
+                result
+            }         
+           
+            if content.has_key? 'json'
+                json = content['json']
+                if (json.instance_of? Array)
+                    result = []
+                    json.each do |n|
+                        result.push(ContentstackUtils.json_doc_to_html(n, options, reference))
+                    end
+                    result
+                elsif json.instance_of? Hash
+                    ContentstackUtils.json_doc_to_html(json, options, reference)
+                end
+            end
+        end
+    end
 end

data/lib/contentstack_utils/version.rb

@@ -1,3 +1,3 @@
 module ContentstackUtils
-    VERSION = "1.0.2"
+    VERSION = "1.1.0"
 end

data/spec/lib/utils_spec.rb

@@ -401,6 +401,240 @@ RSpec.describe ContentstackUtils do
             expect(result).to eq EntryReferenceInlineHtml
         end
 
+       
+    end
+    describe 'GQL #JsonToHtml' do
+        it 'Should return blank string for blank doc' do
+            entry = getGQLJSONRTE(BlankDocument)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq ""
+            expect(arrayResult).to eq [""]
+        end
+
+        it 'Should return mark text string for PlainTextJson doc' do
+            entry = getGQLJSONRTE(PlainTextJson)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq PlainTextHtml
+            expect(arrayResult).to eq [PlainTextHtml]
+        end
+
+        it 'Should return paragraph string for ParagraphJson doc' do
+            entry = getGQLJSONRTE(ParagraphJson)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq ParagraphHtml
+            expect(arrayResult).to eq [ParagraphHtml]
+        end
+
+        it 'Should return H1 string for H1Json doc' do
+            entry = getGQLJSONRTE(H1Json)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq H1Html
+            expect(arrayResult).to eq [H1Html]
+        end
+
+        it 'Should return H2 string for H1Json doc' do
+            entry = getGQLJSONRTE(H2Json)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq H2Html
+            expect(arrayResult).to eq [H2Html]
+        end
+
+        it 'Should return H3 string for H1Json doc' do
+            entry = getGQLJSONRTE(H3Json)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq H3Html
+            expect(arrayResult).to eq [H3Html]
+        end
+
+        it 'Should return H4 string for H1Json doc' do
+            entry = getGQLJSONRTE(H4Json)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq H4Html
+            expect(arrayResult).to eq [H4Html]
+        end
+
+        it 'Should return H5 string for H1Json doc' do
+            entry = getGQLJSONRTE(H5Json)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq H5Html
+            expect(arrayResult).to eq [H5Html]
+        end
+
+        it 'Should return H6 string for H1Json doc' do
+            entry = getGQLJSONRTE(H6Json)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq H6Html
+            expect(arrayResult).to eq [H6Html]
+        end
+
+        it 'Should return Order List string for OrderListJson doc' do
+            entry = getGQLJSONRTE(OrderListJson)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq OrderListHtml
+            expect(arrayResult).to eq [OrderListHtml]
+        end
+
+        it 'Should return Unorder List string for UnorderListJson doc' do
+            entry = getGQLJSONRTE(UnorderListJson)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq UnorderListHtml
+            expect(arrayResult).to eq [UnorderListHtml]
+        end
+
+        it 'Should return image string for ImgJson doc' do
+            entry = getGQLJSONRTE(ImgJson)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq ImgHtml
+            expect(arrayResult).to eq [ImgHtml]
+        end
+
+        it 'Should return Blockquote string for BlockquoteJson doc' do
+            entry = getGQLJSONRTE(BlockquoteJson)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq BlockquoteHtml
+            expect(arrayResult).to eq [BlockquoteHtml]
+        end
+
+        it 'Should return Code string for CodeJson doc' do
+            entry = getGQLJSONRTE(CodeJson)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq CodeHtml
+            expect(arrayResult).to eq [CodeHtml]
+        end
+
+        it 'Should return Table string for TableJson doc' do
+            entry = getGQLJSONRTE(TableJson)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq TableHtml
+            expect(arrayResult).to eq [TableHtml]
+        end
+
+        it 'Should return Link string for LinkInPJson doc' do
+            entry = getGQLJSONRTE(LinkInPJson)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq LinkInPHtml
+            expect(arrayResult).to eq [LinkInPHtml]
+        end
+
+        it 'Should return Embed string for EmbedJson doc' do
+            entry = getGQLJSONRTE(EmbedJson)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq EmbedHtml
+            expect(arrayResult).to eq [EmbedHtml]
+        end
+
+        it 'Should return horizontal line string for horizontal line doc' do
+            entry = getGQLJSONRTE(HRJson)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq '<hr />'
+            expect(arrayResult).to eq ['<hr />']
+        end
+    end
+
+    describe 'GQL #JsonToHtml reference' do
+        it 'Should return blank string for non entry option' do 
+            entry = getGQLJSONRTE(AssetReferenceJson)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq ''
+            expect(arrayResult).to eq ['']
+        end
+
+        it 'Should return asset embedded items' do 
+            entry = getGQLJSONRTE(AssetReferenceJson, EmbedEdges)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq AssetReferenceHtml
+            expect(arrayResult).to eq [AssetReferenceHtml]
+        end
+
+        it 'Should return entry block embedded items' do 
+            entry = getGQLJSONRTE(EntryReferenceBlockJson, EmbedEdges)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq EntryReferenceBlockHtml
+            expect(arrayResult).to eq [EntryReferenceBlockHtml]
+        end
+
+        it 'Should return entry link embedded items' do 
+            entry = getGQLJSONRTE(EntryReferenceLinkJson, EmbedEdges)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq EntryReferenceLinkHtml
+            expect(arrayResult).to eq [EntryReferenceLinkHtml]
+        end
+
+        it 'Should return entry inline embedded items' do 
+            entry = getGQLJSONRTE(EntryReferenceInlineJson, EmbedEdges)
+
+            result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
+            arrayResult = ContentstackUtils::GQL.json_to_html(entry['multiple_rte'], ContentstackUtils::Model::Options.new())
+
+            expect(result).to eq EntryReferenceInlineHtml
+            expect(arrayResult).to eq [EntryReferenceInlineHtml]
+        end
     end
 
     def makeRenderFunction(content, option = ContentstackUtils::Model::Options.new(ENTRY_EMBEDDED_ASSET)) 

data/spec/mock/json_to_html_mock.rb

@@ -44,7 +44,6 @@ EntryReferenceInlineJson = '{ "uid":"06e34a7  5e4 e549d", "_version":1, "attrs":
 HRJson = '{ "uid":"06e34a7  5e4 e549d", "_version":1, "attrs":{ }, "children":[{"uid":"f5a7b57 40a8a5c3 576828276b","type":"hr","children":[{"text":""}],"attrs":{ }}],"type":"doc"}'
 H1NonChildJson = '{ "uid":"06e34a7a449d7fc2acd","_version":13,"attrs":{ },"children":[{ "type":"h1","attrs":{ },"uid":"c2dfed70 4d7030c65e2e1"}],"type":"doc"}'
 
-
 JSON_EMBEDDED_ITEMS_ENTRY= {
     "title"=> 'one',
     "url"=> '/one',
@@ -142,4 +141,6 @@ JSON_EMBEDDED_ITEMS_ENTRY= {
           }
       ]
     }
-  }
+  }
+
+  EmbedEdges = '{"edges":[{"node":{"system":{"content_type_uid":"sys_assets","uid":"blt9844"},"created_at":"2020-08-19T09:13:05.864Z","updated_at":"2020-09-10T09:35:28.393Z","created_by":"bltcreate","updated_by":"bltcreate","content_type":"image/png","file_size":"36743","filename":"svg-logo-text.png","url":"/v3/assets/svg-logo-text.png","_version":7,"title":"svg-logo-text.png","description":""}},{"node":{"system":{"content_type_uid":"sys_assets","uid":"blt44asset"},"created_at":"2020-08-19T09:13:32.785Z","updated_at":"2020-08-19T09:13:32.785Z","created_by":"bltcreate","updated_by":"bltcreate","content_type":"application/pdf","file_size":"13264","filename":"title","url":"/v3/assets/blt333/blt44asset/dummy.pdf","_version":1,"title":"dummy.pdf"}},{"node":{"title":"Update this title","url":"","locale":"en-us","system":{"uid":"blttitleuid","content_type_uid":"content_block"},"_version":5,"_in_progress":false,"multi_line":"","rich_text_editor":""}},{"node":{"title":"updated title","rich_text_editor":[""],"locale":"en-us","system":{"uid":"blttitleUpdateuid","content_type_uid":"embeddedrte"},"_in_progress":false}},{"node":{"title":"Entry with embedded entry","rich_text_editor":[""],"locale":"en-us","system":{"uid":"bltemmbedEntryuid","content_type_uid":"embeddedrte"},"_in_progress":false}},{"node":{"system":{"uid":"bltassetEmbuid","content_type_uid":"sys_assets"},"content_type":"image/png","file_size":"36743","filename":"svg-logo-text.png","url":"/v3/assets/blturl/bltassetEmbuid/svg-logo-text.png","title":"svg-logo-text.png","description":""}},{"node":{"title":"Update this title","url":"","locale":"en-us","system":{"uid":"blttitleuid","content_type_uid":"content_block"},"_version":5,"_in_progress":false,"multi_line":"","rich_text_editor":""}},{"node":{"title":"updated title","rich_text_editor":[""],"locale":"en-us","system":{"uid":"blttitleUpdateUID","content_type_uid":"embeddedrte"},"_in_progress":false}},{"node":{"title":"Entry with embedded entry","rich_text_editor":[""],"locale":"en-us","system":{"uid":"bltemmbedEntryUID","content_type_uid":"embeddedrte"},"_in_progress":false}}]}'

data/spec/support/xml_parse.rb

@@ -14,4 +14,18 @@ end
 
 def getJson(text)
     JSON.parse(text)
+end
+
+def getGQLJSONRTE(node, item = '""')
+    entry = "{
+        \"single_rte\": {
+            \"json\": #{node},
+            \"embedded_itemsConnection\": #{item}
+        },
+        \"multiple_rte\": {
+            \"json\": [#{node}],
+            \"embedded_itemsConnection\": #{item}
+        }
+    }"
+    getJson(entry)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentstack_utils
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Contentstack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-16 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport