Merge pull request #4 from shopsmart/upstream-merge

wenga86 · web-flow · commit e955db22f839 · 2024-03-15T10:11:25.000-05:00
Upstream merge
diff --git a/.github/workflows/check-branch.yml b/.github/workflows/check-branch.yml
@@ -0,0 +1,20 @@
+name: 'Check Branch'
+
+on:
+  pull_request:
+
+jobs:
+  check_branch:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Comment PR
+        if: github.base_ref == 'master' && github.head_ref != 'next'
+        uses: thollander/actions-comment-pull-request@v2
+        with:
+          message: |
+            We regret to inform you that you are currently not able to merge your changes into the master branch due to restrictions applied by our SRE team. To proceed with merging your changes, we kindly request that you create a pull request from the next branch. Our team will then review the changes and work with you to ensure a successful merge into the master branch.
+      - name: Check branch
+        if: github.base_ref == 'master' && github.head_ref != 'next'
+        run: |
+          echo "ERROR: We regret to inform you that you are currently not able to merge your changes into the master branch due to restrictions applied by our SRE team. To proceed with merging your changes, we kindly request that you create a pull request from the next branch. Our team will then review the changes and work with you to ensure a successful merge into the master branch."
+          exit 1
diff --git a/.github/workflows/release-gem.yml b/.github/workflows/release-gem.yml
@@ -14,18 +14,14 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: '2.7'
 
     - name: Publish to RubyGems
       run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
         gem build *.gemspec
         gem push *.gem
       env:
-        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+        GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_AUTH_TOKEN }}
diff --git a/.github/workflows/sast-scan.yml b/.github/workflows/sast-scan.yml
diff --git a/.github/workflows/secrets-scan.yml b/.github/workflows/secrets-scan.yml
diff --git a/.ruby-version b/.ruby-version
@@ -1 +1 @@
-2.6
+2.6.10
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Changelog
-
+## [1.2.1](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.2.1) (2024-02-27)
+  - Support for JSON RTE with fragment in nested list
+## [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)
 
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1 +1 @@
-* @contentstack/security-admin @contentstack/sdk-admin
+* @contentstack/security-admin
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    contentstack_utils (1.1.3)
+    contentstack_utils (1.2.1)
       activesupport (~> 5.2)
       nokogiri (~> 1.11)
 
@@ -13,41 +13,43 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.8.1)
+    addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
-    concurrent-ruby (1.2.2)
-    crack (0.4.5)
+    bigdecimal (3.1.7)
+    concurrent-ruby (1.2.3)
+    crack (1.0.0)
+      bigdecimal
       rexml
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     docile (1.4.0)
-    hashdiff (1.0.1)
-    i18n (1.12.0)
+    hashdiff (1.1.0)
+    i18n (1.14.4)
       concurrent-ruby (~> 1.0)
-    mini_portile2 (2.8.1)
-    minitest (5.18.0)
-    nokogiri (1.14.2)
+    mini_portile2 (2.8.5)
+    minitest (5.22.3)
+    nokogiri (1.13.10)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.14.2-x64-mingw32)
+    nokogiri (1.13.10-x64-mingw32)
       racc (~> 1.4)
-    public_suffix (5.0.1)
-    racc (1.6.2)
+    public_suffix (5.0.4)
+    racc (1.7.3)
     rake (13.0.6)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.2)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.2)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.3)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    simplecov (0.21.2)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
@@ -56,25 +58,23 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.11)
       thread_safe (~> 0.1)
-    webmock (3.11.3)
-      addressable (>= 2.3.6)
+    webmock (3.23.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
+    yard (0.9.36)
 
 PLATFORMS
   ruby
   x64-mingw32
 
 DEPENDENCIES
   contentstack_utils!
-  rake (~> 13.0.3)
-  rspec (~> 3.10.0)
-  simplecov (~> 0.21.1)
-  webmock (~> 3.11.0)
-  yard (~> 0.9.26)
+  rake (~> 13.0)
+  rspec (~> 3.13)
+  simplecov (~> 0.22)
+  webmock (~> 3.23)
+  yard (~> 0.9.36)
 
 BUNDLED WITH
    2.3.13
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2012-2023 Contentstack. All Rights Reserved
+Copyright (c) 2012-2024 Contentstack. All Rights Reserved
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/contentstack_utils.gemspec b/contentstack_utils.gemspec
@@ -24,9 +24,9 @@ Gem::Specification.new do |s|
   s.add_dependency 'activesupport', '~> 5.2'
   s.add_dependency 'nokogiri', '~> 1.11'
 
-  s.add_development_dependency 'rake', '~> 13.0.3'
-  s.add_development_dependency 'rspec', '~> 3.10.0'
-  s.add_development_dependency 'webmock', '~> 3.11.0'
-  s.add_development_dependency 'simplecov', '~> 0.21.1'
-  s.add_development_dependency 'yard', '~> 0.9.26'
-end
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rspec', '~> 3.13'
+  s.add_development_dependency 'webmock', '~> 3.23'
+  s.add_development_dependency 'simplecov', '~> 0.22'
+  s.add_development_dependency 'yard', '~> 0.9.36'
+end
diff --git a/lib/contentstack_utils/model/options.rb b/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
@@ -103,8 +105,15 @@ def render_node(node_type, node, inner_html)
                     renderString = "<blockquote>#{inner_html}</blockquote>"
                 when 'code'
                     renderString = "<code>#{inner_html}</code>"
+                when 'fragment'
+                    renderString = "<fragment>#{inner_html}</fragment>"
                 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
diff --git a/lib/contentstack_utils/utils.rb b/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
 
diff --git a/lib/contentstack_utils/version.rb b/lib/contentstack_utils/version.rb
@@ -1,3 +1,3 @@
 module ContentstackUtils
-    VERSION = "1.1.3"
+    VERSION = "1.2.1"
 end
diff --git a/spec/lib/model/option_spec.rb b/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
diff --git a/spec/lib/utils_spec.rb b/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)
 
@@ -514,6 +522,26 @@
             expect(arrayResult).to eq [UnorderListHtml]
         end
 
+        it 'Should return Order List string for OrderListJson with Fragment doc' do
+            entry = getGQLJSONRTE(OrderListFragmentJson)
+
+            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 OrderListFragmentHtml
+            expect(arrayResult).to eq [OrderListFragmentHtml]
+        end
+
+        it 'Should return Unorder List string for UnorderListJson with Fragment doc' do
+            entry = getGQLJSONRTE(UnorderListFragmentJson)
+
+            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 UnorderListFragmentHtml
+            expect(arrayResult).to eq [UnorderListFragmentHtml]
+        end
+
         it 'Should return image string for ImgJson doc' do
             entry = getGQLJSONRTE(ImgJson)
 
diff --git a/spec/mock/json_to_html_mock.rb b/spec/mock/json_to_html_mock.rb

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-* @contentstack/security-admin @contentstack/sdk-admin`
	`1`	`+* @contentstack/security-admin`