kramdown-prismic 0.3.1 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e34361d43f02e8ee666fb78685a040128617accc25d44221ed0f98e45fcc7eae
-  data.tar.gz: 58ceb9f450d5d719b3698dcc37d417d27f6ecff3a8873812426a086bb6296695
+  metadata.gz: fe3e038c22a918d48b71b44a5b4910910bd8b47bf18516244510ba3e2ddc5602
+  data.tar.gz: 6d0280c72a7efee6a1edc6b15c06068c014c1eb21c3950fbc9768a8f0942ca92
 SHA512:
-  metadata.gz: fdd15d2fe0bb82ab3528f818579efe067f82274727c4f59ec262e899ca44224aa18b3c766f73f7c82396a8d803c93d9d92cfd864c4c24587a2743297cc60e0e1
-  data.tar.gz: 4cc36e4dbba12aaad5318267b268773a7010481959f9a4df4ddafaa3fc912cb9bb8830f4ac7fc8709e0c7b38c6ba2fc6a84a3436754c5d044ec4a7ab5be4646e
+  metadata.gz: 99c4e82d82ae1d57b66747991976660aff280a52f346b7d459f80b3d8b86d6829eaf2bc966b6387cd4aec1fb2fbf7819db8c40e57da28f9a2c583cb1482965e7
+  data.tar.gz: c7c91856d596c6f4441e333f00830facddcf744ab588bccd02f25e2ad749b700b6fcae7aeb3181c7261b3f1bce0e21f07dfa2fa504de9f8e5c9bc8a41d21be37

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## Version 0.3.5
+
+- Convert `br` element when converting HTML documents.
+
+## Version 0.3.4
+
+- Convert `strong` and `em` elements when converting HTML documents.
+
+## Version 0.3.3
+
+- Renable converting xml comments
+
+## Version 0.3.2
+
+- Parse ordered and unordered lists
+- Parse image with link
+
 ## Version 0.3.1
 
 - Add binaries `html2primisc`, `markdown2prismic` and `primisc2markdown`.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kramdown-prismic (0.3.0)
+    kramdown-prismic (0.3.5)
       kramdown (>= 1, < 3)
 
 GEM

data/README.md

@@ -1,4 +1,4 @@
-# Kramdown Prismic
+# Kramdown Prismic ![build](https://img.shields.io/github/workflow/status/stormz/kramdown-prismic/CI) [![gem](https://img.shields.io/gem/v/kramdown-prismic)](https://rubygems.org/gems/kramdown-prismic)
 
 A [Kramdown][] parser and converter to convert documents into [prismic][] rich text format and the other way around.
 
@@ -8,7 +8,7 @@ A useful usage is to convert markdown documents to prismic for [import purpose][
 
 The converter part (kramdown to prismic) is working and fairly complete. See *Difference between markdown and rich text* below to know more about limitations.
 
-The parser part is quite new and not feature complete (missing list item for instance).
+The parser part is quite new and not feature complete.
 
 ## Install
 

data/lib/kramdown/converter/prismic.rb

@@ -110,6 +110,7 @@ module Kramdown
       end
 
       def convert_hr(element); end
+      def convert_br(element); end
 
       def convert_img(element)
         {
@@ -148,6 +149,23 @@ module Kramdown
         }
       end
 
+      def convert_strong(element)
+        convert_sub_html_element(element, 'strong')
+      end
+
+      def convert_em(element)
+        convert_sub_html_element(element, 'em')
+      end
+
+      def convert_sub_html_element(element, type)
+        content = extract_content(element)
+        content[:spans].push({ type: type, start: 0, end: content[:text].size })
+        {
+          type: 'paragraph',
+          content: content
+        }
+      end
+
       def convert_html_element(element)
         if element.value == 'iframe'
           {
@@ -187,6 +205,11 @@ module Kramdown
         nil
       end
 
+      def convert_xml_comment(_element)
+        warning('translating xml comment is not supported')
+        nil
+      end
+
       def convert_raw(_element)
         warning('translating raw is not supported')
         nil
@@ -268,14 +291,18 @@ module Kramdown
         memo[:text] += element.value
       end
 
+      def extract_span_xml_comment(element, memo)
+        warning('translating xml comment is not supported')
+      end
+
       TYPOGRAPHIC_SYMS = {
-        mdash: [::Kramdown::Utils::Entities.entity('mdash')],
-        ndash: [::Kramdown::Utils::Entities.entity('ndash')],
-        hellip: [::Kramdown::Utils::Entities.entity('hellip')],
-        laquo_space: [::Kramdown::Utils::Entities.entity('laquo'), ::Kramdown::Utils::Entities.entity('nbsp')],
-        raquo_space: [::Kramdown::Utils::Entities.entity('nbsp'), ::Kramdown::Utils::Entities.entity('raquo')],
-        laquo: [::Kramdown::Utils::Entities.entity('laquo')],
-        raquo: [::Kramdown::Utils::Entities.entity('raquo')]
+        mdash: [Utils::Entities.entity('mdash')],
+        ndash: [Utils::Entities.entity('ndash')],
+        hellip: [Utils::Entities.entity('hellip')],
+        laquo_space: [Utils::Entities.entity('laquo'), Utils::Entities.entity('nbsp')],
+        raquo_space: [Utils::Entities.entity('nbsp'), Utils::Entities.entity('raquo')],
+        laquo: [Utils::Entities.entity('laquo')],
+        raquo: [Utils::Entities.entity('raquo')]
       }.freeze
       def extract_span_typographic_sym(element, memo)
         value = TYPOGRAPHIC_SYMS[element.value].map(&:char).join('')
@@ -287,7 +314,7 @@ module Kramdown
       end
 
       def extract_span_smart_quote(element, memo)
-        memo[:text] += ::Kramdown::Utils::Entities.entity(element.value.to_s).char
+        memo[:text] += Utils::Entities.entity(element.value.to_s).char
       end
     end
   end

data/lib/kramdown/parser/prismic.rb

@@ -5,39 +5,70 @@ module Kramdown
     class Prismic < Base
       def parse
         @root.options[:encoding] = 'UTF-8'
-        @root.children = @source.map do |block|
-          type = block[:type]
-          type = 'heading' if type.match(/heading/)
-          element = send("parse_#{type}", block)
-          parse_spans(element, block)
-          element
+        @root.children = @source.reduce([]) do |memo, block|
+          parse_element(block, memo)
         end
       end
 
       private
 
+      def parse_element(block, memo)
+        type = block[:type].gsub('-', '_')
+        type = 'heading' if type.match(/heading/)
+        if type == 'list_item'
+          parse_list(:ul, block, memo)
+          memo
+        elsif type == 'o_list_item'
+          parse_list(:ol, block, memo)
+          memo
+        else
+          element = send("parse_#{type}", block)
+          parse_spans(element, block)
+          memo << element
+        end
+      end
+
       def parse_heading(block)
         level = block[:type].match(/heading([1-6])/)[1].to_i
-        Kramdown::Element.new(:header, nil, nil, { level: level, raw_text: '' })
+        Element.new(:header, nil, nil, { level: level, raw_text: '' })
       end
 
       def parse_paragraph(_block)
-        Kramdown::Element.new(:p)
+        Element.new(:p)
       end
 
       def parse_image(block)
-        p = Kramdown::Element.new(:p)
-        img = Kramdown::Element.new(:img, nil, { 'src' => block[:data][:origin][:url], 'alt' => block[:data][:alt] })
-        p.children << img
+        p = Element.new(:p)
+        img = Element.new(:img, nil, { 'src' => block[:data][:origin][:url], 'alt' => block[:data][:alt] })
+        if block[:data][:linkTo]
+          a = Element.new(:a, nil, { 'href' => block[:data][:linkTo][:url] })
+          a.children << img
+          p.children << a
+        else
+          p.children << img
+        end
         p
       end
 
       def parse_preformatted(_block)
-        Kramdown::Element.new(:blockquote)
+        Element.new(:blockquote)
+      end
+
+      def parse_list(type, block, memo)
+        list = memo.last
+        unless list && list.type == type
+          list = Element.new(type)
+          memo << list
+        end
+        li = Element.new(:li, nil, nil)
+        list.children << li
+        p = Element.new(:p, nil, nil, transparent: true)
+        li.children << p
+        parse_spans(p, block)
       end
 
       def parse_embed(block)
-        Kramdown::Element.new(:html_element, 'iframe', { src: block[:data][:embed_url] })
+        Element.new(:html_element, 'iframe', { src: block[:data][:embed_url] })
       end
 
       def parse_spans(element, block)

data/lib/kramdown-prismic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KramdownPrismic
-  VERSION = '0.3.1'
+  VERSION = '0.3.5'
 end

data/test/converter_test.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 # frozen_string_literal: true
 
 require 'minitest/autorun'
@@ -131,6 +132,26 @@ class KramdownPrismicConverterTest < Minitest::Test
     assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
   end
 
+  def test_convert_html_strong
+    expected = [
+      {
+        type: 'paragraph',
+        content: {
+          text: 'This is a paragraph',
+          spans: [
+            {
+              type: 'strong',
+              start: 0,
+              end: 19
+            }
+          ]
+        }
+      }
+    ]
+    markdown = '<strong>This is a paragraph</strong>'
+    assert_equal expected, Kramdown::Document.new(markdown, input: :html).to_prismic
+  end
+
   def test_convert_paragraph_with_em
     expected = [
       {
@@ -151,6 +172,26 @@ class KramdownPrismicConverterTest < Minitest::Test
     assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
   end
 
+  def test_convert_html_em
+    expected = [
+      {
+        type: 'paragraph',
+        content: {
+          text: 'This',
+          spans: [
+            {
+              type: 'em',
+              start: 0,
+              end: 4
+            }
+          ]
+        }
+      }
+    ]
+    markdown = '<em>This</em>'
+    assert_equal expected, Kramdown::Document.new(markdown, input: :html).to_prismic
+  end
+
   def test_convert_list_o
     expected = [
       {
@@ -474,6 +515,20 @@ class KramdownPrismicConverterTest < Minitest::Test
     assert_equal expected, Kramdown::Document.new(html, input: :html).to_prismic
   end
 
+  def test_convert_br_in_root_element
+    expected = [
+      {
+        type: 'paragraph',
+        content: {
+          text: "Test\n",
+          spans: []
+        }
+      }
+    ]
+    html = '<br><p>Test<br></p>'
+    assert_equal expected, Kramdown::Document.new(html, input: :html).to_prismic
+  end
+
   def test_convert_html_with_no_tags
     expected = [
       {
@@ -587,6 +642,30 @@ class KramdownPrismicConverterTest < Minitest::Test
     assert_equal 1, doc.warnings.size
   end
 
+  def test_convert_xml_comment
+    expected = []
+    markdown = "<!-- Main -->"
+    doc = Kramdown::Document.new(markdown, input: :kramdown)
+    assert_equal expected, doc.to_prismic
+    assert_equal 1, doc.warnings.size
+  end
+
+  def test_convert_span_xml_comment
+    expected = [
+      {
+        type: 'paragraph',
+        content: {
+          text: 'test  test',
+          spans: []
+        }
+      }
+    ]
+    markdown = "test <!-- Main --> test"
+    doc = Kramdown::Document.new(markdown, input: :kramdown)
+    assert_equal expected, doc.to_prismic
+    assert_equal 1, doc.warnings.size
+  end
+
   def test_convert_comment
     expected = []
     markdown = "{::comment}\nComment\n{:/comment}"

data/test/parser_test.rb

@@ -136,6 +136,114 @@ class KramdownPrismicParserTest < Minitest::Test
     assert_equal expected, doc.to_kramdown
   end
 
+  def test_parse_list_item
+    prismic = [
+      {
+        type: 'list-item',
+        content: {
+          text: 'Hello',
+          spans: []
+        }
+      },
+      {
+        type: 'list-item',
+        content: {
+          text: 'World',
+          spans: []
+        }
+      }
+    ]
+    expected = "* Hello\n* World\n\n"
+    doc = Kramdown::Document.new(prismic, input: :prismic)
+    assert_equal expected, doc.to_kramdown
+  end
+
+  def test_parse_list_item_and_spans
+    prismic = [
+      {
+        type: 'list-item',
+        content: {
+          text: 'Hello',
+          spans: [
+            {
+              type: 'em',
+              start: 0,
+              end: 5
+            }
+          ]
+        }
+      },
+      {
+        type: 'list-item',
+        content: {
+          text: 'World',
+          spans: []
+        }
+      }
+    ]
+    expected = "* *Hello*\n* World\n\n"
+    doc = Kramdown::Document.new(prismic, input: :prismic)
+    assert_equal expected, doc.to_kramdown
+  end
+
+  def test_parse_o_list_item
+    prismic = [
+      {
+        type: 'o-list-item',
+        content: {
+          text: 'Hello',
+          spans: []
+        }
+      },
+      {
+        type: 'o-list-item',
+        content: {
+          text: 'World',
+          spans: []
+        }
+      }
+    ]
+    expected = "1.  Hello\n2.  World\n\n"
+    doc = Kramdown::Document.new(prismic, input: :prismic)
+    assert_equal expected, doc.to_kramdown
+  end
+
+  def test_parse_o_list_item_and_list_item
+    prismic = [
+      {
+        type: 'o-list-item',
+        content: {
+          text: 'Hello',
+          spans: []
+        }
+      },
+      {
+        type: 'o-list-item',
+        content: {
+          text: 'World',
+          spans: []
+        }
+      },
+      {
+        type: 'list-item',
+        content: {
+          text: 'Test',
+          spans: []
+        }
+      },
+      {
+        type: 'list-item',
+        content: {
+          text: 'roger',
+          spans: []
+        }
+      }
+    ]
+    expected = "1.  Hello\n2.  World\n\n* Test\n* roger\n\n"
+    doc = Kramdown::Document.new(prismic, input: :prismic)
+    assert_equal expected, doc.to_kramdown
+  end
+
   def test_parse_image
     prismic = [
       {
@@ -157,6 +265,30 @@ class KramdownPrismicParserTest < Minitest::Test
     assert_equal expected, doc.to_kramdown
   end
 
+  def test_parse_img_with_link
+    prismic = [
+      {
+        type: 'image',
+        content: {
+          text: '',
+          spans: []
+        },
+        data: {
+          origin: {
+            url: '/img.png'
+          },
+          alt: 'alt text',
+          linkTo: {
+            url: 'https://example.net/'
+          }
+        }
+      }
+    ]
+    expected = "[![alt text](/img.png)][1]\n\n\n\n[1]: https://example.net/\n"
+    doc = Kramdown::Document.new(prismic, input: :prismic)
+    assert_equal expected, doc.to_kramdown
+  end
+
   def test_parse_preformatted
     prismic = [
       {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-prismic
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.5
 platform: ruby
 authors:
 - François de Metz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-12 00:00:00.000000000 Z
+date: 2021-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A Kramdown converter to convert documents into prismic rich text format and