contentstack_utils 0.1.0.pre.beta.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df97218ab0794ad8c4adff69d4146df7e736eecb5b302c2f2bf8892e45c53262
-  data.tar.gz: 1112de7f8c3df79c172b623f1981e8de31d54c4ac3407e07aad5a5058f72ba1f
+  metadata.gz: 21932309e73056c667d82fb62ffcc391b31875bbab0862b3c62e6c5cd273f0e4
+  data.tar.gz: 2c62ff41a24c02a1737f192d51389449f9c7f4a3f157f6b3373367a74809b5c2
 SHA512:
-  metadata.gz: 03d0dd9b13849d6f605855ec2e0bbdf551c0b02489bb38d8432747002639482db8188d065c53f9468367b7c9dba4654130927fdd1bf721d12576292853b4f868
-  data.tar.gz: 4e232dc32139bb1500fdfb6755710ba180d5492d1cda14ee3937af2b3a607c48fb3ba08fe5cf6bf742d8945bced1d7c8c01127d049d5f7760a146cef1abf30e5
+  metadata.gz: 597777d333caef160d256e78b740ae5a2068ecbe8bac8b77183df32efc40d781101dcef0787b045ea816e1560ca46704b50e801746a2bce797134538f18fd723
+  data.tar.gz: cd94ed56bae23557502116fd4c1d1d3aca927cdc3d7af38708950cbc52fa8deb6051c529d41c579421e060c8694f57ef56a846a7fdd27a931267747ef0cf81e8

data/.gitignore

@@ -1,4 +1,4 @@
-contentstack-*
+contentstack_utils-*
 build_doc.sh
 test
 doc
@@ -7,4 +7,4 @@ coverage
 \.yardoc
 .DS_Store
 .bundle/
-*/rspec_results.html
+**/rspec_results.html

data/CHANGELOG.md

@@ -1,4 +1,12 @@
 # Changelog
 
-## [1.0.0](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.0.0) (2021-04-02)
+## [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
+
+## [1.0.0](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.0.0) (2021-04-05)
   - Initial release for Contentstack Utils SDK

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    contentstack_utils (1.0.0)
-      activesupport
-      nokogiri
+    contentstack_utils (1.0.1)
+      activesupport (>= 3.2, < 6.2)
+      nokogiri (~> 1.11.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.0)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -16,23 +16,23 @@ GEM
       zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
-    docile (1.3.4)
+    docile (1.4.0)
     hashdiff (1.0.1)
-    i18n (1.8.7)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    mini_portile2 (2.5.0)
-    minitest (5.14.2)
-    nokogiri (1.11.0)
+    mini_portile2 (2.5.3)
+    minitest (5.14.4)
+    nokogiri (1.11.6)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
     public_suffix (4.0.6)
     racc (1.5.2)
     rake (13.0.3)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -42,19 +42,19 @@ GEM
     rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    simplecov (0.21.1)
+    rspec-support (3.10.2)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
+    simplecov_json_formatter (0.1.3)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    webmock (3.11.0)
+    webmock (3.11.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -66,11 +66,11 @@ PLATFORMS
 
 DEPENDENCIES
   contentstack_utils!
-  rake
-  rspec
-  simplecov
-  webmock
-  yard
+  rake (~> 13.0.3)
+  rspec (~> 3.10.0)
+  simplecov (~> 0.21.1)
+  webmock (~> 3.11.0)
+  yard (~> 0.9.26)
 
 BUNDLED WITH
-   1.17.2
+   2.2.7

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/contentstack_utils.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^spec/})
   s.require_paths = ["lib"]
 
-  s.add_dependency 'activesupport', '~> 6.1.0'
-  s.add_dependency 'nokogiri', '~> 1.11.0'
+  s.add_dependency 'activesupport', '>= 3.2', '< 6.2'
+  s.add_dependency 'nokogiri', '~> 1.11', '>= 1.11.0'
 
   s.add_development_dependency 'rake', '~> 13.0.3'
   s.add_development_dependency 'rspec', '~> 3.10.0'

data/lib/contentstack_utils/model/metadata.rb

@@ -3,29 +3,46 @@ module ContentstackUtils
     module Model
         class Metadata 
             def initialize( element )
-                @itemType = element.attribute('type')
-                @styleType = element.attribute('sys-style-type')
-                @itemUid ||= element.attribute('data-sys-entry-uid') || element.attribute('data-sys-asset-uid')
-                @contentTypeUid = element.attribute('data-sys-content-type-uid')
-                @text = element.text
-                @element = element
-                @attributes = element.attributes
+                if element.instance_of? Nokogiri::XML::Element
+                    @itemType = element.attribute('type') ? element.attribute('type').value : nil
+                    @styleType = element.attribute('sys-style-type') ? element.attribute('sys-style-type').value : nil
+                    @itemUid ||= (element.attribute('data-sys-entry-uid') ? element.attribute('data-sys-entry-uid').value : nil) || (element.attribute('data-sys-asset-uid') ? element.attribute('data-sys-asset-uid').value : nil)
+                    @contentTypeUid = element.attribute('data-sys-content-type-uid') ? element.attribute('data-sys-content-type-uid').value : nil
+                    @text = element.text
+                    @element = element
+                    @attributes = element
+                else
+                    @itemType = element["attrs"]['type']
+                    @styleType = element["attrs"]['display-type']
+                    @itemUid ||= element["attrs"]['entry-uid'] || element["attrs"]['asset-uid']
+                    @contentTypeUid = element["attrs"]['content-type-uid']
+                    if element["children"] && element["children"].length() > 0 
+                        child = element["children"]
+                        for item in child do
+                            if item["type"] == nil && item["text"] 
+                                @text = item["text"] 
+                            end
+                        end
+                    end   
+                    @element = element
+                    @attributes = element["attrs"]
+                end
             end
 
             def item_type 
-                @itemType ? @itemType.value : nil
+                @itemType ? @itemType : nil
             end
 
             def style_type 
-                @styleType ? @styleType.value : nil
+                @styleType ? @styleType : nil
             end
 
             def item_uid 
-                @itemUid ? @itemUid.value : nil
+                @itemUid ? @itemUid : nil
             end
 
             def content_type_uid 
-                @contentTypeUid ? @contentTypeUid.value : nil
+                @contentTypeUid ? @contentTypeUid : nil
             end
 
             def text 
@@ -39,6 +56,14 @@ module ContentstackUtils
             def attributes 
                 @attributes
             end
+
+            def get_attribute_value(string)
+                if @attributes.instance_of? Nokogiri::XML::Element
+                    @attributes.attribute(string) ? @attributes.attribute(string).value : nil
+                else
+                    @attributes[string]
+                end 
+            end
         end
     end
 end

data/lib/contentstack_utils/model/options.rb

@@ -5,7 +5,7 @@ module ContentstackUtils
     module Model
         class Options < Interface::Rendarable
 
-            def initialize(entry)
+            def initialize(entry = nil)
                 @entry = entry
             end
 
@@ -17,15 +17,94 @@ 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'
-                    renderString = "<a href='#{(metadata.attributes["href"] ? metadata.attributes["href"].value : nil) || embeddedObject["url"] || embeddedObject["title"] || embeddedObject["uid"]}'>#{(metadata.text && metadata.text != '' ? metadata.text : (embeddedObject["title"] || embeddedObject["uid"]))}</a>";
+                    metadata.get_attribute_value("href")
+                    renderString = "<a href='#{metadata.get_attribute_value("href") || embeddedObject["url"] || embeddedObject["title"] || embeddedObject["uid"]}'>#{(metadata.text && metadata.text != '' ? metadata.text : (embeddedObject["title"] || embeddedObject["uid"]))}</a>";
                 when 'display'
-                    renderString = "<img src='#{(metadata.attributes["href"] ? metadata.attributes["href"].value : nil)|| embeddedObject["url"]}' alt='#{(metadata.attributes["alt"] ? metadata.attributes["alt"].value : (embeddedObject["title"] || embeddedObject["filename"] || embeddedObject["uid"]))}' />";
+                    renderString = "<img src='#{metadata.get_attribute_value("src")|| embeddedObject["url"]}' alt='#{(metadata.attributes["alt"] ? metadata.attributes["alt"].value : (embeddedObject["title"] || embeddedObject["filename"] || embeddedObject["uid"]))}' />";
                 when 'download'
-                    renderString = "<a href='#{(metadata.attributes["href"] ? metadata.attributes["href"].value : nil) || embeddedObject["url"]}'>#{(metadata.text && metadata.text != '' ? metadata.text : (embeddedObject["filename"] || embeddedObject["title"] || embeddedObject["uid"]))}</a>";
+                    renderString = "<a href='#{metadata.get_attribute_value("href") || embeddedObject["url"]}'>#{(metadata.text && metadata.text != '' ? metadata.text : (embeddedObject["filename"] || embeddedObject["title"] || embeddedObject["uid"]))}</a>";
+                end
+                renderString
+            end
+
+            def render_mark(mark_type, text)
+                renderString = text
+                case mark_type
+                when 'bold'
+                    renderString = "<strong>#{text}</strong>"
+                when 'italic'
+                    renderString = "<em>#{text}</em>"
+                when 'underline'
+                    renderString = "<u>#{text}</u>"
+                when 'strikethrough'
+                    renderString = "<strike>#{text}</strike>"
+                when 'inlineCode'
+                    renderString = "<span>#{text}</span>"
+                when 'subscript'
+                    renderString = "<sub>#{text}</sub>"
+                when 'superscript'
+                    renderString = "<sup>#{text}</sup>"
+                end
+                renderString
+            end
+
+            def render_node(node_type, node, inner_html)
+                renderString = ""
+                case node_type
+                when 'doc'
+                    renderString = ""
+                when 'p'
+                    renderString = "<p>#{inner_html}</p>"
+                when 'a'
+                    renderString = "<a href='#{node["attrs"]["href"] || ""}'>#{inner_html}</a>"
+                when 'img'
+                    renderString = "<img src='#{node["attrs"]["src"] || ""}' />#{inner_html}"
+                when 'embed'
+                    renderString = "<iframe src='#{node["attrs"]["src"] || ""}'></iframe>"
+                when 'h1'
+                    renderString = "<h1>#{inner_html}</h1>"
+                when 'h2'
+                    renderString = "<h2>#{inner_html}</h2>"
+                when 'h3'
+                    renderString = "<h3>#{inner_html}</h3>"
+                when 'h4'
+                    renderString = "<h4>#{inner_html}</h4>"
+                when 'h5'
+                    renderString = "<h5>#{inner_html}</h5>"
+                when 'h6'
+                    renderString = "<h6>#{inner_html}</h6>"
+                when 'ol'
+                    renderString = "<ol>#{inner_html}</ol>"
+                when 'ul'
+                    renderString = "<ul>#{inner_html}</ul>"
+                when 'li'
+                    renderString = "<li>#{inner_html}</li>"
+                when 'hr'
+                    renderString = "<hr />"
+                when 'table'
+                    renderString = "<table>#{inner_html}</table>"
+                when 'thead'
+                    renderString = "<thead>#{inner_html}</thead>"
+                when 'tbody'
+                    renderString = "<tbody>#{inner_html}</tbody>"
+                when 'tfoot'
+                    renderString = "<tfoot>#{inner_html}</tfoot>"
+                when 'tr'
+                    renderString = "<tr>#{inner_html}</tr>"
+                when 'th'
+                    renderString = "<th>#{inner_html}</th>"
+                when 'td'
+                    renderString = "<td>#{inner_html}</td>"
+                when 'blockquote'
+                    renderString = "<blockquote>#{inner_html}</blockquote>"
+                when 'code'
+                    renderString = "<code>#{inner_html}</code>"
+                when 'reference'
+                    renderString = ""
                 end
                 renderString
             end

data/lib/contentstack_utils/utils.rb

@@ -16,6 +16,82 @@ module ContentstackUtils
         end
     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, reference) )
+            end
+            result
+        elsif content.instance_of? Hash
+            json_doc_to_html(content, options, reference)
+        end
+    end
+
+    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, callback)
+        end
+        result
+    end
+
+    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, callback)
+        html_result = ""
+        if node["type"] == nil && node["text"] 
+            html_result = text_to_htms(node, options)            
+        elsif node["type"]
+            if node["type"] == "reference"
+                metadata = Model::Metadata.new(node)
+                html_result = callback.call(metadata)
+            else
+                inner_html = json_doc_to_html(node, options, callback)
+                html_result =  options.render_node(node["type"], node, inner_html)
+            end 
+        end
+        html_result
+    end
+
+    private_class_method def self.text_to_htms(node, options)
+        text = node["text"]
+        if node["superscript"]
+            text = options.render_mark("superscript", text)
+        end
+        if node["subscript"]
+            text = options.render_mark("subscript", text)
+        end
+        if node["inlineCode"]
+            text = options.render_mark("inlineCode", text)
+        end
+        if node["strikethrough"]
+            text = options.render_mark("strikethrough", text)
+        end
+        if node["underline"]
+            text = options.render_mark("underline", text)
+        end
+        if node["italic"]
+            text = options.render_mark("italic", text)
+        end
+        if node["bold"]
+            text = options.render_mark("bold", text)
+        end
+        text
+    end
+
     private_class_method def self.render_string(string, options) 
         xml_doc = Nokogiri::HTML(appendFrame(string))
         result = xml_doc.xpath('//documentfragmentcontainer').inner_html
@@ -51,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