kramdown-prismic 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5375492a7419784a19fee9021699380d7106184167742f73f693502aeee28767
-  data.tar.gz: 378f78feb7e48a07c5177a7ae98556fb918a6b6258201227a5cfd415dc73d23c
+  metadata.gz: 73ce49b872adc3dd34de55efc6c45bdde6ab2ec5cfd04fc4192555639ed63fb3
+  data.tar.gz: f95a92886b915b6bf5c3b283368e84fcb4591b5b3f45e998a7ed13beb31e788f
 SHA512:
-  metadata.gz: b90f2f0df8505ef0403704d0db3c32aa3003589e5bd958827ed270347e477b7b87f464626781fa0049b43bf5372f6fd501e4d476b83a61d8bd4d0c399f020bcf
-  data.tar.gz: 87d4c10f8ccd35b29ee9fc0b030a604490f35354bb86809bf18c8dfcfe79c3ae62199aa3f2b7195290be38febe09c76a7d9df74734845c9e0b0ebde41602661c
+  metadata.gz: 1cd76efd9fb572c3f921c44b0d2ee6f6748c9132ac5827d373e581ec19361609f73acb1bac3fb8f27bc6e5c53219353e363e5a05f71dacbfbef5eb7f1d88ca16
+  data.tar.gz: 03b6033f3576720dfaa823c808c9d29f1264813d8ec82b807f3bc72217263179f110f380b87fac3ea41157cbd4da189254a08edeb4089cb139221b6083bef86a

data/{Changelog.md → CHANGELOG.md}

@@ -1,5 +1,23 @@
 # Changelog
 
+## 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`.
+- Add parsed embed support
+
 ## Version 0.3.0
 
 - Relax the kramdown dependency to allows the version 2.

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

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

data/README.md

@@ -1,14 +1,14 @@
 # Kramdown Prismic
 
-A [Kramdown][] parser and converter to convert documents into [prismic][] rich text format and back.
+A [Kramdown][] parser and converter to convert documents into [prismic][] rich text format and the other way around.
 
-A useful usage is to convert markdown documents to prismic for import purpose. Then you can even convert prismic format back to markdown.
+A useful usage is to convert markdown documents to prismic for [import purpose][prismic-import]. Then you can even convert prismic format back to markdown.
 
 ## Status
 
 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
 
@@ -18,6 +18,22 @@ gem 'kramdown-prismic', '~> 0.1'
 
 ## Usage
 
+### With executables
+
+*markdown2prismic*:
+
+    markdown2prismic $'# My Title\n\nHello world'
+
+*html2prismic*:
+
+    html2prismic '<h1>My Title</h1><p>Hello world</p>'
+
+*prismic2markdown*:
+
+    prismic2markdown '[{"type":"heading1","content":{"text":"My Title","spans":[]}},{"type":"paragraph","content":{"text":"Test","spans":[]}}]'
+
+### As a library
+
 **Convert kramdown documents to Prismic**
 
 ```ruby
@@ -123,3 +139,4 @@ MIT
 
 [Kramdown]: https://kramdown.gettalong.org/
 [prismic]: https://prismic.io/
+[prismic-import]: https://prismic.io/docs/core-concepts/how-to-import-content

data/Rakefile

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.libs << "test"
+  t.libs << 'test'
   t.test_files = FileList['test/*_test.rb']
   t.verbose = true
 end
-

data/bin/html2prismic

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'kramdown-prismic'
+require 'json'
+
+print Kramdown::Document.new(ARGV[0], input: :html).to_prismic.to_json.to_s

data/bin/markdown2prismic

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'kramdown-prismic'
+require 'json'
+
+print Kramdown::Document.new(ARGV[0], input: :markdown).to_prismic.to_json.to_s

data/bin/prismic2markdown

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'kramdown-prismic'
+require 'json'
+
+source = JSON.parse(ARGV[0], symbolize_names: true)
+
+print Kramdown::Document.new(source, input: :prismic).to_kramdown

data/kramdown-prismic.gemspec

@@ -1,21 +1,25 @@
-# encoding: utf-8
-require File.expand_path('../lib/kramdown-prismic/version', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/kramdown-prismic/version', __dir__)
 
 Gem::Specification.new do |s|
   s.name        = 'kramdown-prismic'
   s.version     = KramdownPrismic::VERSION
-  s.summary     = "A Kramdown converter to convert documents into prismic rich text format and the other way around."
-  s.description = "A Kramdown converter to convert documents into prismic rich text format and the other way around."
-  s.authors     = ["François de Metz"]
+  s.summary     = 'A Kramdown converter to convert documents into prismic rich text format and the other way around.'
+  s.description = 'A Kramdown converter to convert documents into prismic rich text format and the other way around.'
+  s.authors     = ['François de Metz']
   s.email       = 'francois@2metz.fr'
 
+  s.executables << 'markdown2prismic'
+  s.executables << 'html2prismic'
+  s.executables << 'prismic2markdown'
   s.files       = `git ls-files`.split("\n")
   s.test_files  = `git ls-files -- test/*`.split("\n")
 
   s.homepage    = 'https://github.com/stormz/kramdown-prismic'
   s.license     = 'MIT'
 
-  s.add_dependency "kramdown", ">= 1", "< 3"
-  s.add_development_dependency "minitest", "~> 5.0"
-  s.add_development_dependency "rake", "~> 13.0"
+  s.add_dependency 'kramdown', '>= 1', '< 3'
+  s.add_development_dependency 'minitest', '~> 5.0'
+  s.add_development_dependency 'rake', '~> 13.0'
 end

data/kramdown1.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/kramdown2.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/lib/kramdown/converter/prismic.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'kramdown/converter/base'
 
 module Kramdown
   module Converter
     class Prismic < Base
       def convert(root)
-        cleanup_ast(root).map { |child|
+        cleanup_ast(root).map do |child|
           convert_element(child)
-        }.compact.flatten
+        end.compact.flatten
       end
 
       private
@@ -21,22 +23,23 @@ module Kramdown
       end
 
       def remove_blanks(root)
-        root.children = root.children.inject([]) do |memo, child|
+        root.children = root.children.each_with_object([]) do |child, memo|
           unless child.type == :blank
             remove_blanks(child)
             memo << child
           end
-          memo
         end
       end
 
       def extract_non_nestable_elements(child, elements)
-        child.children = child.children.inject([]) do |memo, element|
-          if element.type == :a && element.children.size === 1 && element.children.first.type == :img
+        child.children = child.children.each_with_object([]) do |element, memo|
+          if element.type == :a && element.children.size == 1 && element.children.first.type == :img
             elements << element
           elsif element.type == :img
             elements << element
-            warning('images inside content will be moved to the top level and may be rendered differently') if child.children.size > 1
+            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
             warning('nested list moved to the top level')
             elements << element
@@ -45,7 +48,6 @@ module Kramdown
             memo << element
             extract_non_nestable_elements(element, elements)
           end
-          memo
         end
       end
 
@@ -61,9 +63,10 @@ module Kramdown
       end
 
       def convert_p(element)
-        return nil if element.children.size == 0
+        return nil if element.children.size.zero?
+
         {
-          type: "paragraph",
+          type: 'paragraph',
           content: extract_content(element)
         }
       end
@@ -106,8 +109,7 @@ module Kramdown
         }
       end
 
-      def convert_hr(element)
-      end
+      def convert_hr(element); end
 
       def convert_img(element)
         {
@@ -118,9 +120,9 @@ module Kramdown
           },
           data: {
             origin: {
-              url: element.attr["src"]
+              url: element.attr['src']
             },
-            alt: element.attr["alt"]
+            alt: element.attr['alt']
           }
         }
       end
@@ -146,40 +148,85 @@ 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)
-        warning('translating html elements is not supported')
-        nil
+        if element.value == 'iframe'
+          {
+            content: {
+              spans: [],
+              text: ''
+            },
+            type: 'embed',
+            data: {
+              embed_url: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+              type: 'link'
+            }
+          }
+        else
+          warning('translating html elements is not supported')
+          nil
+        end
       end
 
-      def convert_table(element)
+      def convert_table(_element)
         warning('translating table is not supported')
         nil
       end
 
-      def convert_dl(element)
+      def convert_dl(_element)
         warning('translating dl is not supported')
         nil
       end
 
-      def convert_math(element)
+      def convert_math(_element)
         warning('translating math is not supported')
         nil
       end
 
-      def convert_comment(element)
+      def convert_comment(_element)
         warning('translating comment is not supported')
         nil
       end
 
-      def convert_raw(element)
+      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
       end
 
-      def extract_content(element, memo={text: '', spans: []})
-        element.children.inject(memo) do |memo2, child|
+      def convert_text(element)
+        {
+          type: 'paragraph',
+          content: {
+            text: element.value,
+            spans: []
+          }
+        }
+      end
+
+      def extract_content(element, memo = { text: '', spans: [] })
+        element.children.each_with_object(memo) do |child, memo2|
           send("extract_span_#{child.type}", child, memo2)
-          memo2
         end
       end
 
@@ -200,7 +247,7 @@ module Kramdown
         insert_span(element, memo, {
                       type: 'hyperlink',
                       data: {
-                        url: element.attr["href"]
+                        url: element.attr['href']
                       }
                     })
       end
@@ -221,7 +268,7 @@ module Kramdown
         extract_content(element, memo)
       end
 
-      def extract_span_br(element, memo)
+      def extract_span_br(_element, memo)
         memo[:text] += "\n"
       end
 
@@ -230,11 +277,11 @@ module Kramdown
         memo[:text] += element.value
       end
 
-      def extract_span_html_element(element, memo)
+      def extract_span_html_element(_element, _memo)
         warning('translating html elements is not supported')
       end
 
-      def extract_span_footnote(element, memo)
+      def extract_span_footnote(_element, _memo)
         warning('translating footnote is not supported')
       end
 
@@ -243,17 +290,21 @@ 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 {|e| e.char }.join('')
+        value = TYPOGRAPHIC_SYMS[element.value].map(&:char).join('')
         memo[:text] += value
       end
 
@@ -262,7 +313,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

@@ -1,54 +1,84 @@
+# frozen_string_literal: true
+
 module Kramdown
   module Parser
     class Prismic < Base
       def parse
         @root.options[:encoding] = 'UTF-8'
-        @root.children = @source.map do |block|
-          type = block[:type]
-          if type.match(/heading/)
-            type = 'heading'
-          end
-          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)
+      def parse_paragraph(_block)
+        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)
+      def parse_preformatted(_block)
+        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)
         stack = []
 
         (block[:content][:text].size + 1).times do |index|
-
           starting_spans = find_starting_spans_for(block, index)
           ending_spans   = find_ending_spans_for(block, index)
 
-          ending_spans.each do |ending_span|
+          ending_spans.each do |_ending_span|
             el = stack.pop
             if stack.empty?
               element.children << el
@@ -57,22 +87,23 @@ module Kramdown
             end
           end
           starting_spans.each do |starting_span|
-            stack << if starting_span[:type] == "hyperlink"
-              Element.new(:a, nil, {'href' => starting_span[:data][:url]})
-            else
-              Element.new(starting_span[:type].to_sym)
-            end
+            stack << if starting_span[:type] == 'hyperlink'
+                       Element.new(:a, nil, { 'href' => starting_span[:data][:url] })
+                     else
+                       Element.new(starting_span[:type].to_sym)
+                     end
           end
 
           char = block[:content][:text][index]
           next if char.nil?
+
           current_text = if stack.empty?
-            element.children.last
-          else
-            stack[-1].children.last
-          end
+                           element.children.last
+                         else
+                           stack[-1].children.last
+                         end
           if current_text.nil? || current_text.type != :text
-            current_text = Element.new(:text, "")
+            current_text = Element.new(:text, '')
             if stack.empty?
               element.children << current_text
             else