contentstack_utils 0.1.0.pre.beta.1 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +2 -2
- data/CHANGELOG.md +9 -1
- data/Gemfile.lock +22 -22
- data/README.md +9 -0
- data/contentstack_utils.gemspec +2 -2
- data/lib/contentstack_utils/model/metadata.rb +36 -11
- data/lib/contentstack_utils/model/options.rb +84 -5
- data/lib/contentstack_utils/utils.rb +109 -0
- data/lib/contentstack_utils/version.rb +1 -1
- data/spec/lib/model/metadata_spec.rb +40 -0
- data/spec/lib/model/option_spec.rb +216 -0
- data/spec/lib/utils_spec.rb +578 -0
- data/spec/mock/json_to_html_mock.rb +146 -0
- data/spec/support/xml_parse.rb +18 -0
- metadata +24 -10
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 21932309e73056c667d82fb62ffcc391b31875bbab0862b3c62e6c5cd273f0e4
|
4
|
+
data.tar.gz: 2c62ff41a24c02a1737f192d51389449f9c7f4a3f157f6b3373367a74809b5c2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 597777d333caef160d256e78b740ae5a2068ecbe8bac8b77183df32efc40d781101dcef0787b045ea816e1560ca46704b50e801746a2bce797134538f18fd723
|
7
|
+
data.tar.gz: cd94ed56bae23557502116fd4c1d1d3aca927cdc3d7af38708950cbc52fa8deb6051c529d41c579421e060c8694f57ef56a846a7fdd27a931267747ef0cf81e8
|
data/.gitignore
CHANGED
data/CHANGELOG.md
CHANGED
@@ -1,4 +1,12 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
-
## [1.
|
3
|
+
## [1.1.0](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.1.0) (2021-08-10)
|
4
|
+
- GQL Json rte to Html content support added
|
5
|
+
|
6
|
+
## [1.0.2](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.0.2) (2021-07-16)
|
7
|
+
- JSON RTE support added
|
8
|
+
## [1.0.1](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.0.1) (2021-06-02)
|
9
|
+
- Gemspec Dependency update
|
10
|
+
|
11
|
+
## [1.0.0](https://github.com/contentstack/contentstack-utils-ruby/tree/v1.0.0) (2021-04-05)
|
4
12
|
- Initial release for Contentstack Utils SDK
|
data/Gemfile.lock
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
contentstack_utils (1.0.
|
5
|
-
activesupport
|
6
|
-
nokogiri
|
4
|
+
contentstack_utils (1.0.1)
|
5
|
+
activesupport (>= 3.2, < 6.2)
|
6
|
+
nokogiri (~> 1.11.0)
|
7
7
|
|
8
8
|
GEM
|
9
9
|
remote: https://rubygems.org/
|
10
10
|
specs:
|
11
|
-
activesupport (6.1.
|
11
|
+
activesupport (6.1.3.2)
|
12
12
|
concurrent-ruby (~> 1.0, >= 1.0.2)
|
13
13
|
i18n (>= 1.6, < 2)
|
14
14
|
minitest (>= 5.1)
|
@@ -16,23 +16,23 @@ GEM
|
|
16
16
|
zeitwerk (~> 2.3)
|
17
17
|
addressable (2.7.0)
|
18
18
|
public_suffix (>= 2.0.2, < 5.0)
|
19
|
-
concurrent-ruby (1.1.
|
19
|
+
concurrent-ruby (1.1.8)
|
20
20
|
crack (0.4.5)
|
21
21
|
rexml
|
22
22
|
diff-lcs (1.4.4)
|
23
|
-
docile (1.
|
23
|
+
docile (1.4.0)
|
24
24
|
hashdiff (1.0.1)
|
25
|
-
i18n (1.8.
|
25
|
+
i18n (1.8.10)
|
26
26
|
concurrent-ruby (~> 1.0)
|
27
|
-
mini_portile2 (2.5.
|
28
|
-
minitest (5.14.
|
29
|
-
nokogiri (1.11.
|
27
|
+
mini_portile2 (2.5.3)
|
28
|
+
minitest (5.14.4)
|
29
|
+
nokogiri (1.11.6)
|
30
30
|
mini_portile2 (~> 2.5.0)
|
31
31
|
racc (~> 1.4)
|
32
32
|
public_suffix (4.0.6)
|
33
33
|
racc (1.5.2)
|
34
34
|
rake (13.0.3)
|
35
|
-
rexml (3.2.
|
35
|
+
rexml (3.2.5)
|
36
36
|
rspec (3.10.0)
|
37
37
|
rspec-core (~> 3.10.0)
|
38
38
|
rspec-expectations (~> 3.10.0)
|
@@ -42,19 +42,19 @@ GEM
|
|
42
42
|
rspec-expectations (3.10.1)
|
43
43
|
diff-lcs (>= 1.2.0, < 2.0)
|
44
44
|
rspec-support (~> 3.10.0)
|
45
|
-
rspec-mocks (3.10.
|
45
|
+
rspec-mocks (3.10.2)
|
46
46
|
diff-lcs (>= 1.2.0, < 2.0)
|
47
47
|
rspec-support (~> 3.10.0)
|
48
|
-
rspec-support (3.10.
|
49
|
-
simplecov (0.21.
|
48
|
+
rspec-support (3.10.2)
|
49
|
+
simplecov (0.21.2)
|
50
50
|
docile (~> 1.1)
|
51
51
|
simplecov-html (~> 0.11)
|
52
52
|
simplecov_json_formatter (~> 0.1)
|
53
53
|
simplecov-html (0.12.3)
|
54
|
-
simplecov_json_formatter (0.1.
|
54
|
+
simplecov_json_formatter (0.1.3)
|
55
55
|
tzinfo (2.0.4)
|
56
56
|
concurrent-ruby (~> 1.0)
|
57
|
-
webmock (3.11.
|
57
|
+
webmock (3.11.3)
|
58
58
|
addressable (>= 2.3.6)
|
59
59
|
crack (>= 0.3.2)
|
60
60
|
hashdiff (>= 0.4.0, < 2.0.0)
|
@@ -66,11 +66,11 @@ PLATFORMS
|
|
66
66
|
|
67
67
|
DEPENDENCIES
|
68
68
|
contentstack_utils!
|
69
|
-
rake
|
70
|
-
rspec
|
71
|
-
simplecov
|
72
|
-
webmock
|
73
|
-
yard
|
69
|
+
rake (~> 13.0.3)
|
70
|
+
rspec (~> 3.10.0)
|
71
|
+
simplecov (~> 0.21.1)
|
72
|
+
webmock (~> 3.11.0)
|
73
|
+
yard (~> 0.9.26)
|
74
74
|
|
75
75
|
BUNDLED WITH
|
76
|
-
|
76
|
+
2.2.7
|
data/README.md
CHANGED
@@ -86,3 +86,12 @@ require 'contentstack'
|
|
86
86
|
Contentstack.render_content(@entry.rte_field_uid, ContentstackUtils::Model::Option.new(@entry))
|
87
87
|
end
|
88
88
|
```
|
89
|
+
### GQL Json RTE to HTML
|
90
|
+
To parse JSON RTE content from GQL response to HTML content use `ContentstackUtils::GQL.json_to_html` function as below:
|
91
|
+
|
92
|
+
```ruby
|
93
|
+
require 'contentstack_utils'
|
94
|
+
|
95
|
+
result = ContentstackUtils::GQL.json_to_html(entry['single_rte'], ContentstackUtils::Model::Options.new())
|
96
|
+
|
97
|
+
```
|
data/contentstack_utils.gemspec
CHANGED
@@ -21,8 +21,8 @@ Gem::Specification.new do |s|
|
|
21
21
|
s.test_files = s.files.grep(%r{^spec/})
|
22
22
|
s.require_paths = ["lib"]
|
23
23
|
|
24
|
-
s.add_dependency 'activesupport', '
|
25
|
-
s.add_dependency 'nokogiri', '~> 1.11.0'
|
24
|
+
s.add_dependency 'activesupport', '>= 3.2', '< 6.2'
|
25
|
+
s.add_dependency 'nokogiri', '~> 1.11', '>= 1.11.0'
|
26
26
|
|
27
27
|
s.add_development_dependency 'rake', '~> 13.0.3'
|
28
28
|
s.add_development_dependency 'rspec', '~> 3.10.0'
|
@@ -3,29 +3,46 @@ module ContentstackUtils
|
|
3
3
|
module Model
|
4
4
|
class Metadata
|
5
5
|
def initialize( element )
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
6
|
+
if element.instance_of? Nokogiri::XML::Element
|
7
|
+
@itemType = element.attribute('type') ? element.attribute('type').value : nil
|
8
|
+
@styleType = element.attribute('sys-style-type') ? element.attribute('sys-style-type').value : nil
|
9
|
+
@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)
|
10
|
+
@contentTypeUid = element.attribute('data-sys-content-type-uid') ? element.attribute('data-sys-content-type-uid').value : nil
|
11
|
+
@text = element.text
|
12
|
+
@element = element
|
13
|
+
@attributes = element
|
14
|
+
else
|
15
|
+
@itemType = element["attrs"]['type']
|
16
|
+
@styleType = element["attrs"]['display-type']
|
17
|
+
@itemUid ||= element["attrs"]['entry-uid'] || element["attrs"]['asset-uid']
|
18
|
+
@contentTypeUid = element["attrs"]['content-type-uid']
|
19
|
+
if element["children"] && element["children"].length() > 0
|
20
|
+
child = element["children"]
|
21
|
+
for item in child do
|
22
|
+
if item["type"] == nil && item["text"]
|
23
|
+
@text = item["text"]
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
27
|
+
@element = element
|
28
|
+
@attributes = element["attrs"]
|
29
|
+
end
|
13
30
|
end
|
14
31
|
|
15
32
|
def item_type
|
16
|
-
@itemType ? @itemType
|
33
|
+
@itemType ? @itemType : nil
|
17
34
|
end
|
18
35
|
|
19
36
|
def style_type
|
20
|
-
@styleType ? @styleType
|
37
|
+
@styleType ? @styleType : nil
|
21
38
|
end
|
22
39
|
|
23
40
|
def item_uid
|
24
|
-
@itemUid ? @itemUid
|
41
|
+
@itemUid ? @itemUid : nil
|
25
42
|
end
|
26
43
|
|
27
44
|
def content_type_uid
|
28
|
-
@contentTypeUid ? @contentTypeUid
|
45
|
+
@contentTypeUid ? @contentTypeUid : nil
|
29
46
|
end
|
30
47
|
|
31
48
|
def text
|
@@ -39,6 +56,14 @@ module ContentstackUtils
|
|
39
56
|
def attributes
|
40
57
|
@attributes
|
41
58
|
end
|
59
|
+
|
60
|
+
def get_attribute_value(string)
|
61
|
+
if @attributes.instance_of? Nokogiri::XML::Element
|
62
|
+
@attributes.attribute(string) ? @attributes.attribute(string).value : nil
|
63
|
+
else
|
64
|
+
@attributes[string]
|
65
|
+
end
|
66
|
+
end
|
42
67
|
end
|
43
68
|
end
|
44
69
|
end
|
@@ -5,7 +5,7 @@ module ContentstackUtils
|
|
5
5
|
module Model
|
6
6
|
class Options < Interface::Rendarable
|
7
7
|
|
8
|
-
def initialize(entry)
|
8
|
+
def initialize(entry = nil)
|
9
9
|
@entry = entry
|
10
10
|
end
|
11
11
|
|
@@ -17,15 +17,94 @@ module ContentstackUtils
|
|
17
17
|
renderString = ''
|
18
18
|
case metadata.style_type
|
19
19
|
when 'block'
|
20
|
-
renderString = "<div><p>#{embeddedObject['title'] || embeddedObject['uid']}</p><p>Content type: <span>#{embeddedObject['_content_type_uid']}</span></p></div>"
|
20
|
+
renderString = "<div><p>#{embeddedObject['title'] || embeddedObject['uid']}</p><p>Content type: <span>#{embeddedObject['_content_type_uid'] || embeddedObject['system']['content_type_uid']}</span></p></div>"
|
21
21
|
when 'inline'
|
22
22
|
renderString = "<span>#{embeddedObject["title"] || embeddedObject["uid"]}</span>";
|
23
23
|
when 'link'
|
24
|
-
|
24
|
+
metadata.get_attribute_value("href")
|
25
|
+
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>";
|
25
26
|
when 'display'
|
26
|
-
renderString = "<img src='#{
|
27
|
+
renderString = "<img src='#{metadata.get_attribute_value("src")|| embeddedObject["url"]}' alt='#{(metadata.attributes["alt"] ? metadata.attributes["alt"].value : (embeddedObject["title"] || embeddedObject["filename"] || embeddedObject["uid"]))}' />";
|
27
28
|
when 'download'
|
28
|
-
renderString = "<a href='#{
|
29
|
+
renderString = "<a href='#{metadata.get_attribute_value("href") || embeddedObject["url"]}'>#{(metadata.text && metadata.text != '' ? metadata.text : (embeddedObject["filename"] || embeddedObject["title"] || embeddedObject["uid"]))}</a>";
|
30
|
+
end
|
31
|
+
renderString
|
32
|
+
end
|
33
|
+
|
34
|
+
def render_mark(mark_type, text)
|
35
|
+
renderString = text
|
36
|
+
case mark_type
|
37
|
+
when 'bold'
|
38
|
+
renderString = "<strong>#{text}</strong>"
|
39
|
+
when 'italic'
|
40
|
+
renderString = "<em>#{text}</em>"
|
41
|
+
when 'underline'
|
42
|
+
renderString = "<u>#{text}</u>"
|
43
|
+
when 'strikethrough'
|
44
|
+
renderString = "<strike>#{text}</strike>"
|
45
|
+
when 'inlineCode'
|
46
|
+
renderString = "<span>#{text}</span>"
|
47
|
+
when 'subscript'
|
48
|
+
renderString = "<sub>#{text}</sub>"
|
49
|
+
when 'superscript'
|
50
|
+
renderString = "<sup>#{text}</sup>"
|
51
|
+
end
|
52
|
+
renderString
|
53
|
+
end
|
54
|
+
|
55
|
+
def render_node(node_type, node, inner_html)
|
56
|
+
renderString = ""
|
57
|
+
case node_type
|
58
|
+
when 'doc'
|
59
|
+
renderString = ""
|
60
|
+
when 'p'
|
61
|
+
renderString = "<p>#{inner_html}</p>"
|
62
|
+
when 'a'
|
63
|
+
renderString = "<a href='#{node["attrs"]["href"] || ""}'>#{inner_html}</a>"
|
64
|
+
when 'img'
|
65
|
+
renderString = "<img src='#{node["attrs"]["src"] || ""}' />#{inner_html}"
|
66
|
+
when 'embed'
|
67
|
+
renderString = "<iframe src='#{node["attrs"]["src"] || ""}'></iframe>"
|
68
|
+
when 'h1'
|
69
|
+
renderString = "<h1>#{inner_html}</h1>"
|
70
|
+
when 'h2'
|
71
|
+
renderString = "<h2>#{inner_html}</h2>"
|
72
|
+
when 'h3'
|
73
|
+
renderString = "<h3>#{inner_html}</h3>"
|
74
|
+
when 'h4'
|
75
|
+
renderString = "<h4>#{inner_html}</h4>"
|
76
|
+
when 'h5'
|
77
|
+
renderString = "<h5>#{inner_html}</h5>"
|
78
|
+
when 'h6'
|
79
|
+
renderString = "<h6>#{inner_html}</h6>"
|
80
|
+
when 'ol'
|
81
|
+
renderString = "<ol>#{inner_html}</ol>"
|
82
|
+
when 'ul'
|
83
|
+
renderString = "<ul>#{inner_html}</ul>"
|
84
|
+
when 'li'
|
85
|
+
renderString = "<li>#{inner_html}</li>"
|
86
|
+
when 'hr'
|
87
|
+
renderString = "<hr />"
|
88
|
+
when 'table'
|
89
|
+
renderString = "<table>#{inner_html}</table>"
|
90
|
+
when 'thead'
|
91
|
+
renderString = "<thead>#{inner_html}</thead>"
|
92
|
+
when 'tbody'
|
93
|
+
renderString = "<tbody>#{inner_html}</tbody>"
|
94
|
+
when 'tfoot'
|
95
|
+
renderString = "<tfoot>#{inner_html}</tfoot>"
|
96
|
+
when 'tr'
|
97
|
+
renderString = "<tr>#{inner_html}</tr>"
|
98
|
+
when 'th'
|
99
|
+
renderString = "<th>#{inner_html}</th>"
|
100
|
+
when 'td'
|
101
|
+
renderString = "<td>#{inner_html}</td>"
|
102
|
+
when 'blockquote'
|
103
|
+
renderString = "<blockquote>#{inner_html}</blockquote>"
|
104
|
+
when 'code'
|
105
|
+
renderString = "<code>#{inner_html}</code>"
|
106
|
+
when 'reference'
|
107
|
+
renderString = ""
|
29
108
|
end
|
30
109
|
renderString
|
31
110
|
end
|
@@ -16,6 +16,82 @@ module ContentstackUtils
|
|
16
16
|
end
|
17
17
|
end
|
18
18
|
|
19
|
+
def self.json_to_html(content, options)
|
20
|
+
reference = -> (metadata){
|
21
|
+
result = ""
|
22
|
+
if options.entry != nil
|
23
|
+
object = findObject(metadata, options.entry)
|
24
|
+
if object!= nil && object.length() > 0
|
25
|
+
result = options.render_option(object[0], metadata)
|
26
|
+
end
|
27
|
+
end
|
28
|
+
result
|
29
|
+
}
|
30
|
+
if (content.instance_of? Array)
|
31
|
+
result = []
|
32
|
+
content.each do |n|
|
33
|
+
result.push(json_doc_to_html(n, options, reference) )
|
34
|
+
end
|
35
|
+
result
|
36
|
+
elsif content.instance_of? Hash
|
37
|
+
json_doc_to_html(content, options, reference)
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
def self.json_doc_to_html(node, options, callback)
|
42
|
+
result = ""
|
43
|
+
if node["children"] && node["children"].length() > 0
|
44
|
+
result = node_children_to_html(node["children"], options, callback)
|
45
|
+
end
|
46
|
+
result
|
47
|
+
end
|
48
|
+
|
49
|
+
private_class_method def self.node_children_to_html(nodes, options, callback)
|
50
|
+
nodes.map {|node| node_to_html(node, options, callback)}.join("")
|
51
|
+
end
|
52
|
+
|
53
|
+
private_class_method def self.node_to_html(node, options, callback)
|
54
|
+
html_result = ""
|
55
|
+
if node["type"] == nil && node["text"]
|
56
|
+
html_result = text_to_htms(node, options)
|
57
|
+
elsif node["type"]
|
58
|
+
if node["type"] == "reference"
|
59
|
+
metadata = Model::Metadata.new(node)
|
60
|
+
html_result = callback.call(metadata)
|
61
|
+
else
|
62
|
+
inner_html = json_doc_to_html(node, options, callback)
|
63
|
+
html_result = options.render_node(node["type"], node, inner_html)
|
64
|
+
end
|
65
|
+
end
|
66
|
+
html_result
|
67
|
+
end
|
68
|
+
|
69
|
+
private_class_method def self.text_to_htms(node, options)
|
70
|
+
text = node["text"]
|
71
|
+
if node["superscript"]
|
72
|
+
text = options.render_mark("superscript", text)
|
73
|
+
end
|
74
|
+
if node["subscript"]
|
75
|
+
text = options.render_mark("subscript", text)
|
76
|
+
end
|
77
|
+
if node["inlineCode"]
|
78
|
+
text = options.render_mark("inlineCode", text)
|
79
|
+
end
|
80
|
+
if node["strikethrough"]
|
81
|
+
text = options.render_mark("strikethrough", text)
|
82
|
+
end
|
83
|
+
if node["underline"]
|
84
|
+
text = options.render_mark("underline", text)
|
85
|
+
end
|
86
|
+
if node["italic"]
|
87
|
+
text = options.render_mark("italic", text)
|
88
|
+
end
|
89
|
+
if node["bold"]
|
90
|
+
text = options.render_mark("bold", text)
|
91
|
+
end
|
92
|
+
text
|
93
|
+
end
|
94
|
+
|
19
95
|
private_class_method def self.render_string(string, options)
|
20
96
|
xml_doc = Nokogiri::HTML(appendFrame(string))
|
21
97
|
result = xml_doc.xpath('//documentfragmentcontainer').inner_html
|
@@ -51,4 +127,37 @@ module ContentstackUtils
|
|
51
127
|
end
|
52
128
|
return nil
|
53
129
|
end
|
130
|
+
|
131
|
+
module GQL
|
132
|
+
include ContentstackUtils
|
133
|
+
def self.json_to_html(content, options)
|
134
|
+
embeddedItems = []
|
135
|
+
if content.has_key? 'embedded_itemsConnection'
|
136
|
+
embeddedItems = content['embedded_itemsConnection']['edges'] || []
|
137
|
+
end
|
138
|
+
reference = -> (metadata){
|
139
|
+
result = ""
|
140
|
+
if embeddedItems != nil
|
141
|
+
object = embeddedItems.select { |embedObject| embedObject['node']["system"]["uid"] == metadata.item_uid }
|
142
|
+
if object != nil && object.length() > 0
|
143
|
+
result = options.render_option(object[0]["node"], metadata)
|
144
|
+
end
|
145
|
+
end
|
146
|
+
result
|
147
|
+
}
|
148
|
+
|
149
|
+
if content.has_key? 'json'
|
150
|
+
json = content['json']
|
151
|
+
if (json.instance_of? Array)
|
152
|
+
result = []
|
153
|
+
json.each do |n|
|
154
|
+
result.push(ContentstackUtils.json_doc_to_html(n, options, reference))
|
155
|
+
end
|
156
|
+
result
|
157
|
+
elsif json.instance_of? Hash
|
158
|
+
ContentstackUtils.json_doc_to_html(json, options, reference)
|
159
|
+
end
|
160
|
+
end
|
161
|
+
end
|
162
|
+
end
|
54
163
|
end
|