Added support for the <br> tag and support for nested assets in the t… (#14) (#15)

* Added support for the <br> tag and support for nested assets in the the image

* Added version and change log

* Added Testcases

* Resolved dependency gem issues in latest ruby versions

* Added test case for break tag

* Changed tag to full name

* Changed method name from 'text_to_htms' to 'text_to_html'

* Changed version from 1.1.4 to 1.2.0

Author: sunil-lakshman

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
+## [1.2.0](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.2.0) (2023-06-20)
+  - Support for nested assets in the the image and br tag
 ## [1.1.3](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.1.3) (2023-03-16)
   - Dependency gem max version issue resolved. (Activesupport gem)
 

Gemfile.lock

@@ -1,38 +1,35 @@
 PATH
   remote: .
   specs:
-    contentstack_utils (1.1.3)
+    contentstack_utils (1.2.0)
       activesupport (>= 3.2)
       nokogiri (~> 1.11)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.7.3)
+    activesupport (7.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.8.1)
+    addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
     hashdiff (1.0.1)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    mini_portile2 (2.8.1)
-    minitest (5.18.0)
-    nokogiri (1.13.10)
-      mini_portile2 (~> 2.8.0)
-      racc (~> 1.4)
-    nokogiri (1.13.10-x64-mingw32)
+    mini_portile2 (2.8.2)
+    minitest (5.18.1)
+    nokogiri (1.15.2)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     public_suffix (5.0.1)
-    racc (1.6.2)
+    racc (1.7.1)
     rake (13.0.6)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -60,10 +57,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
-    zeitwerk (2.6.7)
+    yard (0.9.34)
 
 PLATFORMS
   ruby

contentstack_utils.gemspec

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

lib/contentstack_utils/model/options.rb

@@ -48,6 +48,8 @@ def render_mark(mark_type, text)
                     renderString = "<sub>#{text}</sub>"
                 when 'superscript'
                     renderString = "<sup>#{text}</sup>"
+                when 'break'
+                    renderString = "<br />"
                 end
                 renderString
             end
@@ -104,7 +106,12 @@ def render_node(node_type, node, inner_html)
                 when 'code'
                     renderString = "<code>#{inner_html}</code>"
                 when 'reference'
-                    renderString = ""
+                    if (node["attrs"]['type'] === 'asset') 
+                        renderString = "<img src=#{node["attrs"]['asset-link']} alt=#{node["attrs"]['asset-name']} />"
+                    else 
+                        renderString = "" 
+                    end
+
                 when 'span'
                     renderString = "<span>#{inner_html}</span>"
                 end

lib/contentstack_utils/utils.rb

@@ -23,6 +23,11 @@ def self.json_to_html(content, options)
                 object = findObject(metadata, options.entry)
                 if object!= nil && object.length() > 0 
                     result = options.render_option(object[0], metadata)
+                else
+                    content.each do |node|
+                        inner_html = json_doc_to_html(node, options, reference)
+                        result =  options.render_node(node["type"], node, inner_html)
+                    end
                 end
             end
             result
@@ -53,7 +58,7 @@ def self.json_doc_to_html(node, options, callback)
     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)            
+            html_result = text_to_html(node, options)            
         elsif node["type"]
             if node["type"] == "reference"
                 metadata = Model::Metadata.new(node)
@@ -66,7 +71,7 @@ def self.json_doc_to_html(node, options, callback)
         html_result
     end
 
-    private_class_method def self.text_to_htms(node, options)
+    private_class_method def self.text_to_html(node, options)
         text = node["text"]
         if node["superscript"]
             text = options.render_mark("superscript", text)
@@ -89,6 +94,9 @@ def self.json_doc_to_html(node, options, callback)
         if node["bold"]
             text = options.render_mark("bold", text)
         end
+        if node["break"]
+            text = options.render_mark("break", text)
+        end
         text
     end
 

lib/contentstack_utils/version.rb

@@ -1,3 +1,3 @@
 module ContentstackUtils
-    VERSION = "1.1.3"
+    VERSION = "1.2.0"
 end

spec/lib/model/option_spec.rb

@@ -98,6 +98,8 @@ def getMetadata(itemType=nil, styleType=nil, linkText=nil)
             to eq "<sub>#{linkText}</sub>"
             expect(subject.render_mark('superscript', linkText)).
             to eq "<sup>#{linkText}</sup>"
+            expect(subject.render_mark('break', linkText)).
+            to eq "<br />"
             expect(subject.render_mark('', linkText)).
             to eq linkText
         end

spec/lib/utils_spec.rb

@@ -377,6 +377,14 @@
             expect(result).to eq AssetReferenceHtml
         end
 
+        it 'Should return asset embedded items for assest-link' do 
+            doc = getJson(AssetReferenceJson)
+
+            result = ContentstackUtils.json_to_html(doc, ContentstackUtils::Model::Options.new(JSON_EMBEDDED_ITEMS_ENTRY))
+            
+            expect(result).to eq "<img src='/v3/dummy.pdf' alt='dummy.pdf' />"
+        end
+
         it 'Should return entry block embedded items' do 
             doc = getJson(EntryReferenceBlockJson)