kramdown-prismic 0.3.2 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ee09d3336016df7164dd139beccbdf493e4fa5c057b2c3d6480d1db7c352da4
-  data.tar.gz: 2b14fca6c580875817413ec64d3f5fc015ef00544ddf7a4aff6bfe0edb8e160c
+  metadata.gz: f68acd9978784949a29e81dc9109f155a5aaa3fbe278142a48b5ea0d667f327b
+  data.tar.gz: eabfc7d18d6ad918f14645d8988d818f27dee74d885ac2e5d22241f633fbc43b
 SHA512:
-  metadata.gz: 4a3b05a335d537eedcd4ab32f45dfd7fd28f258c7557a7efe087a8e98b77d1b65922c012c9b5737939d7ea6d1651117061d3158aad626c510408091abb4d210a
-  data.tar.gz: cf73a15a0961791104991790e2f46ee031d80f0265fdaca1e14601822747b43a815af87a7e3c74bb0a8e60774ec847b6e46e6b0bd0eca5a46b2bffe962ede4fe
+  metadata.gz: f98e7ec71902a5b7314a978ccae442d2eda5922e69a8217cc6fefcb78c33c19db41244901e50c8fa31517ee468ca62625ffaff987ef683e81532d9cdd2cafe1d
+  data.tar.gz: 7246ec24dd0a0d96b0f736c9f08e0d4c7a8477af0d920091091c8cfee817fb350aeace1175bc33dc7776770c3737fe96054baed3299733c9be4d75af1a3dbf13

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## Version 0.3.6
+
+- Fix converting nested numbered list.
+
+## 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kramdown-prismic (0.3.2)
+    kramdown-prismic (0.3.6)
       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.
 

data/lib/kramdown/converter/prismic.rb

@@ -40,7 +40,7 @@ module Kramdown
             if child.children.size > 1
               warning('images inside content will be moved to the top level and may be rendered differently')
             end
-          elsif element.type == :ul
+          elsif [:ul, :ol].include?(element.type)
             warning('nested list moved to the top level')
             elements << element
             extract_non_nestable_elements(element, elements)
@@ -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,6 +291,10 @@ 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: [Utils::Entities.entity('mdash')],
         ndash: [Utils::Entities.entity('ndash')],

data/lib/kramdown-prismic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module KramdownPrismic
-  VERSION = '0.3.2'
+  VERSION = '0.3.6'
 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 = [
       {
@@ -228,6 +269,29 @@ class KramdownPrismicConverterTest < Minitest::Test
     assert_equal 1, doc.warnings.size
   end
 
+  def test_convert_nested_ol
+    expected = [
+      {
+        type: 'list-item',
+        content: {
+          text: "item1\n",
+          spans: []
+        }
+      },
+      {
+        type: 'o-list-item',
+        content: {
+          text: 'item2',
+          spans: []
+        }
+      }
+    ]
+    markdown = "- item1\n  1. item2"
+    doc = Kramdown::Document.new(markdown, input: :markdown)
+    assert_equal expected, doc.to_prismic
+    assert_equal 1, doc.warnings.size
+  end
+
   def test_convert_nested_nested_ul
     expected = [
       {
@@ -474,6 +538,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 +665,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}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-prismic
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.6
 platform: ruby
 authors:
 - François de Metz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2021-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown