contentful_converter 0.0.1.12 → 0.0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bcee9dc48afd4c917fb46ba299eb5cad6030fac447ba86de0ae51ad03eef629
-  data.tar.gz: e51cd46ed8ec8eed058d2461d78c06f0de7128aaac5a7d867c4992d4cea41c88
+  metadata.gz: 4af2afd7d0764a46305dea57d839478d7c424478c31beb7707a2e34c18a93815
+  data.tar.gz: bb2172e979ebff1f518f9286653bf84d79437cc905220bf1da0148c4e45021a9
 SHA512:
-  metadata.gz: f6d89e89940edeca060d2c2eab090b3518e87a7282cca6eb27f77978c400935cf40a34a8e355348032b624b936fded51206dfda82ab517acd9130ee1930b231c
-  data.tar.gz: c0c490af7c05434c146f198909e367f8ef861bdd87c126b77906b7e721262549025e39bb4239d73bac87a9af716978446a5b7dd5d283b32be89bbc1710e91a36
+  metadata.gz: 96d859ac6abc2a91cf99b1a53f0dd87116612690eca93cd0c3f454c50f85f6ba34a4d9eb39a79db216b8ae4b6083d6e09e87aead1613044d677886e3bb379622
+  data.tar.gz: a18b48a7d94854c67a89cfaf7cb103c5be8402c6c867e01e5743817665270ec3e88d3e631442f9cac02775c860b532d0ab5e5778b28fe81df4cac73dbd7e6e0a

data/README.md

@@ -45,13 +45,131 @@ ContentfulConverter.convert('<h3>hello world</h3>')
 ```
 
 ### Additional info
-**HREF links**
 
-* HTML hyperlinks with full URL e.g: (https://google.com), will be converted into URL hyperlinks
-
-* HTML hyperlinks without a scheme e.g: ('/aboutus/contact'), will be converted into ENTRY hyperlinks, with the href value as an ID
+**`<a>`**
+
+* HTML hyperlinks with full URL e.g: (`<a href="https://google.com"></a>`), will be converted into URL hyperlinks
+  ```ruby
+  {
+    nodeType: 'paragraph',
+    data: {},
+    content: [
+      {
+        nodeType: 'hyperlink',
+        data: {
+          uri: 'https://google.com'
+        },
+        content: [
+          {
+            marks: [],
+            value: 'click me',
+            nodeType: 'text',
+            data: {}
+          }
+        ]
+      }
+    ]
+  }
+  ```
+
+* HTML hyperlinks without a scheme e.g: (`<a href="/about_us/contact">about us</a>`), will be converted into ENTRY hyperlinks, with the href value as an ID
+  ```ruby
+  {
+    nodeType: "paragraph",
+    data: {},
+    content: [
+      {
+        nodeType: "entry-hyperlink",
+        data: {
+          target: {
+            sys: {
+              id: "/about_us/contact",
+              type: "Link",
+              linkType: "Entry"
+            }
+          }
+        },
+        content: [
+          {
+            data: {},
+            marks: [],
+            value: "about us",
+            nodeType: "text"
+          }
+        ]
+      }
+    ]
+  }
+  ```
+
+* HTML hyperlinks without a scheme but with an extension e.g: (`<a href="/path/to_file.docx">file</a>`), will be converted into ASSET hyperlinks, with the href value as an ID, excluding the extension.
+  ```ruby
+  {
+    nodeType: "paragraph",
+    data: {},
+    content: [
+      {
+        nodeType: "asset-hyperlink",
+        data: {
+          target: {
+            sys: {
+              id: "/path/to_file",
+              type: "Link",
+              linkType: "Entry"
+            }
+          }
+        },
+        content: [
+          {
+            data: {},
+            marks: [],
+            value: "file",
+            nodeType: "text"
+          }
+        ]
+      }
+    ]
+  }
+  ```
+
+**`<embed />`**
+
+If you want to add an embedded entry block, you need to create an `<embed>` element in HTML
+with src as the entry ID and type for the entry type.
+
+* Embedded Entry block: `<embed src="id_of_your_entry_123" type="entry"/>`
+  ```ruby
+    {
+      data: {
+        target: {
+          sys: {
+            id: "id_of_your_entry_123",
+            type: "Link",
+            linkType: "Entry"
+          }
+        }
+      },
+      content: [],
+      nodeType: "embedded-entry-block"
+    }
+  ```
 
-* HTML hyperlinks without a scheme but with an extension e.g: ('myfile.docx'), will be converted into ASSET hyperlinks, with the href value as an ID, minus the extension.
+* Embedded Asset block: `<embed src="id_of_your_entry_123" type="asset"/>`
+  ```ruby
+    {
+      data: {
+        target: {
+          sys: {
+            id: "id_of_your_entry_123",
+            type: "Link",
+            linkType: "Asset"
+          }
+        }
+      },
+      content: [],
+      nodeType: "embedded-asset-block"
+    }
+  ```
 
 ---
 

data/lib/contentful_converter/node_builder.rb

@@ -9,6 +9,7 @@ require 'contentful_converter/nodes/underline'
 require 'contentful_converter/nodes/italic'
 require 'contentful_converter/nodes/strong'
 require 'contentful_converter/nodes/code'
+require 'contentful_converter/nodes/embed'
 require 'contentful_converter/nodes/ordered_list'
 require 'contentful_converter/nodes/unordered_list'
 require 'contentful_converter/nodes/horizontal_line'
@@ -36,6 +37,7 @@ module ContentfulConverter
       'div' => Nodes::Paragraph,
       'br' => Nodes::Paragraph,
       'section' => Nodes::Paragraph,
+      'embed' => Nodes::Embed,
       'hr' => Nodes::HorizontalLine,
       'blockquote' => Nodes::Blockquote,
       'ul' => Nodes::UnorderedList,

data/lib/contentful_converter/nodes/embed.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'contentful_converter/nodes/hyperlink'
+
+module ContentfulConverter
+  module Nodes
+    class Embed < Hyperlink
+      EMBED_VALUES = {
+        asset: 'embedded-asset-block',
+        entry: 'embedded-entry-block'
+      }.freeze
+
+      def needs_p_wrapping?
+        false
+      end
+
+      private
+
+      def type
+        EMBED_VALUES[type_value.downcase.to_sym] || raise('Incorrect embed type')
+      end
+
+      def options
+        hyperlink_entry_option(type_value.capitalize)
+      end
+
+      def type_value
+        nokogiri_node[:type] || raise('Embed element requires a type')
+      end
+
+      def parsed_link
+        nokogiri_node[:src]
+      end
+    end
+  end
+end

data/lib/contentful_converter/nodes/hyperlink.rb

@@ -23,7 +23,7 @@ module ContentfulConverter
       end
 
       def hyperlink_option
-        { data: { uri: parsed_href.to_s } }
+        { data: { uri: parsed_link.to_s } }
       end
 
       def hyperlink_entry_option(type)
@@ -31,7 +31,7 @@ module ContentfulConverter
           data: {
             target: {
               sys: {
-                id: parsed_href.to_s.split('.').first,
+                id: parsed_link.to_s.split('.').first,
                 type: "Link",
                 linkType: type
               }
@@ -41,21 +41,19 @@ module ContentfulConverter
       end
 
       def uri_scheme?
-        parsed_href.scheme
+        parsed_link.scheme
       end
 
       def uri_extension?
-        parsed_href.to_s.split('.')[1]
+        parsed_link.to_s.split('.')[1]
       end
 
-      def parsed_href
-        return URI(href_value) if href_value
-
-        URI('')
+      def parsed_link
+        link_value ? URI(link_value) : URI('')
       end
 
-      def href_value
-        nokogiri_node['href']
+      def link_value
+        nokogiri_node[:href]
       end
     end
   end

data/lib/contentful_converter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ContentfulConverter
-  VERSION = '0.0.1.12'
+  VERSION = '0.0.1.13'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contentful_converter
 version: !ruby/object:Gem::Version
-  version: 0.0.1.12
+  version: 0.0.1.13
 platform: ruby
 authors:
 - Alex Avlonitis
@@ -52,6 +52,7 @@ files:
 - lib/contentful_converter/nodes/blockquote.rb
 - lib/contentful_converter/nodes/code.rb
 - lib/contentful_converter/nodes/document.rb
+- lib/contentful_converter/nodes/embed.rb
 - lib/contentful_converter/nodes/header.rb
 - lib/contentful_converter/nodes/horizontal_line.rb
 - lib/contentful_converter/nodes/hyperlink.rb