kramdown-prismic 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e34361d43f02e8ee666fb78685a040128617accc25d44221ed0f98e45fcc7eae
-  data.tar.gz: 58ceb9f450d5d719b3698dcc37d417d27f6ecff3a8873812426a086bb6296695
+  metadata.gz: 1ee09d3336016df7164dd139beccbdf493e4fa5c057b2c3d6480d1db7c352da4
+  data.tar.gz: 2b14fca6c580875817413ec64d3f5fc015ef00544ddf7a4aff6bfe0edb8e160c
 SHA512:
-  metadata.gz: fdd15d2fe0bb82ab3528f818579efe067f82274727c4f59ec262e899ca44224aa18b3c766f73f7c82396a8d803c93d9d92cfd864c4c24587a2743297cc60e0e1
-  data.tar.gz: 4cc36e4dbba12aaad5318267b268773a7010481959f9a4df4ddafaa3fc912cb9bb8830f4ac7fc8709e0c7b38c6ba2fc6a84a3436754c5d044ec4a7ab5be4646e
+  metadata.gz: 4a3b05a335d537eedcd4ab32f45dfd7fd28f258c7557a7efe087a8e98b77d1b65922c012c9b5737939d7ea6d1651117061d3158aad626c510408091abb4d210a
+  data.tar.gz: cf73a15a0961791104991790e2f46ee031d80f0265fdaca1e14601822747b43a815af87a7e3c74bb0a8e60774ec847b6e46e6b0bd0eca5a46b2bffe962ede4fe

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 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.2)
       kramdown (>= 1, < 3)
 
 GEM

data/README.md

@@ -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-prismic/version.rb

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

data/lib/kramdown/converter/prismic.rb

@@ -269,13 +269,13 @@ module Kramdown
       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 +287,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/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.2
 platform: ruby
 authors:
 - François de Metz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-12 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown