kramdown-prismic 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5375492a7419784a19fee9021699380d7106184167742f73f693502aeee28767
-  data.tar.gz: 378f78feb7e48a07c5177a7ae98556fb918a6b6258201227a5cfd415dc73d23c
+  metadata.gz: e34361d43f02e8ee666fb78685a040128617accc25d44221ed0f98e45fcc7eae
+  data.tar.gz: 58ceb9f450d5d719b3698dcc37d417d27f6ecff3a8873812426a086bb6296695
 SHA512:
-  metadata.gz: b90f2f0df8505ef0403704d0db3c32aa3003589e5bd958827ed270347e477b7b87f464626781fa0049b43bf5372f6fd501e4d476b83a61d8bd4d0c399f020bcf
-  data.tar.gz: 87d4c10f8ccd35b29ee9fc0b030a604490f35354bb86809bf18c8dfcfe79c3ae62199aa3f2b7195290be38febe09c76a7d9df74734845c9e0b0ebde41602661c
+  metadata.gz: fdd15d2fe0bb82ab3528f818579efe067f82274727c4f59ec262e899ca44224aa18b3c766f73f7c82396a8d803c93d9d92cfd864c4c24587a2743297cc60e0e1
+  data.tar.gz: 4cc36e4dbba12aaad5318267b268773a7010481959f9a4df4ddafaa3fc912cb9bb8830f4ac7fc8709e0c7b38c6ba2fc6a84a3436754c5d044ec4a7ab5be4646e

data/{Changelog.md → CHANGELOG.md}

@@ -1,5 +1,10 @@
 # Changelog
 
+## 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/README.md

@@ -1,8 +1,8 @@
 # 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
 
@@ -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-prismic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'kramdown'
 
 require 'kramdown/parser/prismic'

data/lib/kramdown-prismic/version.rb

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

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
@@ -147,39 +149,62 @@ module Kramdown
       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_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 +225,7 @@ module Kramdown
         insert_span(element, memo, {
                       type: 'hyperlink',
                       data: {
-                        url: element.attr["href"]
+                        url: element.attr['href']
                       }
                     })
       end
@@ -221,7 +246,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 +255,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
 
@@ -251,9 +276,9 @@ module Kramdown
         raquo_space: [::Kramdown::Utils::Entities.entity('nbsp'), ::Kramdown::Utils::Entities.entity('raquo')],
         laquo: [::Kramdown::Utils::Entities.entity('laquo')],
         raquo: [::Kramdown::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
 

data/lib/kramdown/parser/prismic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Kramdown
   module Parser
     class Prismic < Base
@@ -5,9 +7,7 @@ module Kramdown
         @root.options[:encoding] = 'UTF-8'
         @root.children = @source.map do |block|
           type = block[:type]
-          if type.match(/heading/)
-            type = 'heading'
-          end
+          type = 'heading' if type.match(/heading/)
           element = send("parse_#{type}", block)
           parse_spans(element, block)
           element
@@ -18,21 +18,21 @@ module Kramdown
 
       def parse_heading(block)
         level = block[:type].match(/heading([1-6])/)[1].to_i
-        Kramdown::Element.new(:header, nil, nil, {level: level, raw_text: ''})
+        Kramdown::Element.new(:header, nil, nil, { level: level, raw_text: '' })
       end
 
-      def parse_paragraph(block)
+      def parse_paragraph(_block)
         Kramdown::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]})
+        img = Kramdown::Element.new(:img, nil, { 'src' => block[:data][:origin][:url], 'alt' => block[:data][:alt] })
         p.children << img
         p
       end
 
-      def parse_preformatted(block)
+      def parse_preformatted(_block)
         Kramdown::Element.new(:blockquote)
       end
 
@@ -44,11 +44,10 @@ module Kramdown
         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 +56,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

data/test/converter_test.rb

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 require 'kramdown-prismic'
 
@@ -9,12 +10,12 @@ class KramdownPrismicConverterTest < Minitest::Test
         {
           type: "heading#{heading + 1}",
           content: {
-            text: "This is the document title",
+            text: 'This is the document title',
             spans: []
           }
         }
       ]
-      markdown = "#{"#" * (heading + 1)} This is the document title"
+      markdown = "#{'#' * (heading + 1)} This is the document title"
       assert_equal expected, Kramdown::Document.new(markdown, input: :kramdown).to_prismic
     end
   end
@@ -22,26 +23,26 @@ class KramdownPrismicConverterTest < Minitest::Test
   def test_convert_heading7
     expected = [
       {
-        type: "heading6",
+        type: 'heading6',
         content: {
-          text: "# This is the document title",
+          text: '# This is the document title',
           spans: []
         }
       }
     ]
-    markdown = "####### This is the document title"
+    markdown = '####### This is the document title'
     assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
   end
 
   def test_convert_heading_with_spans
     expected = [
       {
-        type: "heading2",
+        type: 'heading2',
         content: {
-          text: "This is a document title",
+          text: 'This is a document title',
           spans: [
             {
-              type: "em",
+              type: 'em',
               start: 0,
               end: 4
             }
@@ -49,56 +50,56 @@ class KramdownPrismicConverterTest < Minitest::Test
         }
       }
     ]
-    markdown = "## *This* is a document title"
+    markdown = '## *This* is a document title'
     assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
   end
 
   def test_convert_paragraph
     expected = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
-          text: "This is a paragraph",
+          text: 'This is a paragraph',
           spans: []
         }
       }
     ]
-    markdown = "This is a paragraph"
+    markdown = 'This is a paragraph'
     assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
   end
 
   def test_convert_paragraph_with_spans
     expected = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
-          text: "This is a paragraph",
+          text: 'This is a paragraph',
           spans: [
             {
-              type: "hyperlink",
+              type: 'hyperlink',
               start: 0,
               end: 19,
               data: {
-                url: "https://prismic.io"
+                url: 'https://prismic.io'
               }
             }
           ]
         }
       }
     ]
-    markdown = "[This is a paragraph](https://prismic.io)"
+    markdown = '[This is a paragraph](https://prismic.io)'
     assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
   end
 
   def test_convert_paragraph_with_strong
     expected = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
-          text: "This is a paragraph",
+          text: 'This is a paragraph',
           spans: [
             {
-              type: "strong",
+              type: 'strong',
               start: 0,
               end: 19
             }
@@ -106,19 +107,19 @@ class KramdownPrismicConverterTest < Minitest::Test
         }
       }
     ]
-    markdown = "**This is a paragraph**"
+    markdown = '**This is a paragraph**'
     assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
   end
 
   def test_convert_paragraph_with_strong2
     expected = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
-          text: "This is a paragraph",
+          text: 'This is a paragraph',
           spans: [
             {
-              type: "strong",
+              type: 'strong',
               start: 0,
               end: 4
             }
@@ -126,19 +127,19 @@ class KramdownPrismicConverterTest < Minitest::Test
         }
       }
     ]
-    markdown = "**This** is a paragraph"
+    markdown = '**This** is a paragraph'
     assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
   end
 
   def test_convert_paragraph_with_em
     expected = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
-          text: "This is a paragraph",
+          text: 'This is a paragraph',
           spans: [
             {
-              type: "em",
+              type: 'em',
               start: 0,
               end: 4
             }
@@ -146,19 +147,19 @@ class KramdownPrismicConverterTest < Minitest::Test
         }
       }
     ]
-    markdown = "*This* is a paragraph"
+    markdown = '*This* is a paragraph'
     assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
   end
 
   def test_convert_list_o
     expected = [
       {
-        type: "o-list-item",
+        type: 'o-list-item',
         content: {
-          text: "This is a list item",
+          text: 'This is a list item',
           spans: [
             {
-              type: "em",
+              type: 'em',
               start: 0,
               end: 4
             }
@@ -166,9 +167,9 @@ class KramdownPrismicConverterTest < Minitest::Test
         }
       },
       {
-        type: "o-list-item",
+        type: 'o-list-item',
         content: {
-          text: "This is a second list item",
+          text: 'This is a second list item',
           spans: []
         }
       }
@@ -180,12 +181,12 @@ class KramdownPrismicConverterTest < Minitest::Test
   def test_convert_list_u
     expected = [
       {
-        type: "list-item",
+        type: 'list-item',
         content: {
-          text: "This is a list item",
+          text: 'This is a list item',
           spans: [
             {
-              type: "em",
+              type: 'em',
               start: 0,
               end: 4
             }
@@ -193,9 +194,9 @@ class KramdownPrismicConverterTest < Minitest::Test
         }
       },
       {
-        type: "list-item",
+        type: 'list-item',
         content: {
-          text: "This is a second list item",
+          text: 'This is a second list item',
           spans: []
         }
       }
@@ -207,16 +208,16 @@ class KramdownPrismicConverterTest < Minitest::Test
   def test_convert_nested_ul
     expected = [
       {
-        type: "list-item",
+        type: 'list-item',
         content: {
           text: "item1\n",
           spans: []
         }
       },
       {
-        type: "list-item",
+        type: 'list-item',
         content: {
-          text: "item2",
+          text: 'item2',
           spans: []
         }
       }
@@ -230,23 +231,23 @@ class KramdownPrismicConverterTest < Minitest::Test
   def test_convert_nested_nested_ul
     expected = [
       {
-        type: "list-item",
+        type: 'list-item',
         content: {
           text: "item1\n",
           spans: []
         }
       },
       {
-        type: "list-item",
+        type: 'list-item',
         content: {
           text: "item2\n",
           spans: []
         }
       },
       {
-        type: "list-item",
+        type: 'list-item',
         content: {
-          text: "item3",
+          text: 'item3',
           spans: []
         }
       }
@@ -260,7 +261,7 @@ class KramdownPrismicConverterTest < Minitest::Test
   def test_convert_preformatted
     expected = [
       {
-        type: "preformatted",
+        type: 'preformatted',
         content: {
           text: "This is a pre block\n",
           spans: []
@@ -274,9 +275,9 @@ class KramdownPrismicConverterTest < Minitest::Test
   def test_convert_blockquote
     expected = [
       {
-        type: "preformatted",
+        type: 'preformatted',
         content: {
-          text: "This is a blockquote",
+          text: 'This is a blockquote',
           spans: []
         }
       }
@@ -287,17 +288,18 @@ class KramdownPrismicConverterTest < Minitest::Test
 
   def test_convert_empty
     expected = []
-    markdown = ""
+    markdown = ''
     assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
   end
 
   def test_convert_span_blank
     expected = [
-      {type: "o-list-item",
-       content: {
-         text: "Testtest",
-         spans: []
-       }
+      {
+        type: 'o-list-item',
+        content: {
+          text: 'Testtest',
+          spans: []
+        }
       }
     ]
     markdown = "\n1. Test\n\n    test\n"
@@ -306,16 +308,16 @@ class KramdownPrismicConverterTest < Minitest::Test
 
   def test_convert_hr
     expected = []
-    markdown = "---"
+    markdown = '---'
     assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
   end
 
   def test_convert_img
     expected = [
       {
-        type: "image",
+        type: 'image',
         content: {
-          text: "",
+          text: '',
           spans: []
         },
         data: {
@@ -326,7 +328,7 @@ class KramdownPrismicConverterTest < Minitest::Test
         }
       }
     ]
-    markdown =  "![alt text](/img.png)"
+    markdown = '![alt text](/img.png)'
     doc = Kramdown::Document.new(markdown)
     assert_equal expected, doc.to_prismic
     assert_equal 0, doc.warnings.size
@@ -335,9 +337,9 @@ class KramdownPrismicConverterTest < Minitest::Test
   def test_convert_double_img
     expected = [
       {
-        type: "image",
+        type: 'image',
         content: {
-          text: "",
+          text: '',
           spans: []
         },
         data: {
@@ -348,9 +350,9 @@ class KramdownPrismicConverterTest < Minitest::Test
         }
       },
       {
-        type: "image",
+        type: 'image',
         content: {
-          text: "",
+          text: '',
           spans: []
         },
         data: {
@@ -361,7 +363,7 @@ class KramdownPrismicConverterTest < Minitest::Test
         }
       }
     ]
-    markdown =  "![](/img.png)![](/img2.png)"
+    markdown = '![](/img.png)![](/img2.png)'
     doc = Kramdown::Document.new(markdown)
     assert_equal expected, doc.to_prismic
     assert_equal 2, doc.warnings.size
@@ -370,9 +372,9 @@ class KramdownPrismicConverterTest < Minitest::Test
   def test_convert_img_with_link
     expected = [
       {
-        type: "image",
+        type: 'image',
         content: {
-          text: "",
+          text: '',
           spans: []
         },
         data: {
@@ -381,12 +383,12 @@ class KramdownPrismicConverterTest < Minitest::Test
           },
           alt: 'alt text',
           linkTo: {
-            url: "https://example.net/"
+            url: 'https://example.net/'
           }
         }
       }
     ]
-    markdown =  "[![alt text](/img.png)](https://example.net/)"
+    markdown = '[![alt text](/img.png)](https://example.net/)'
     doc = Kramdown::Document.new(markdown)
     assert_equal expected, doc.to_prismic
     assert_equal 0, doc.warnings.size
@@ -395,29 +397,28 @@ class KramdownPrismicConverterTest < Minitest::Test
   def test_convert_entity
     expected = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
           text: "\u00a0",
           spans: []
         }
       }
     ]
-    markdown = "&nbsp;"
+    markdown = '&nbsp;'
     assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
   end
 
-  [['mdash' , ' ---', ' —'],
-   ['ndash' , ' --', ' –'],
-   ['hellip' , ' ...', ' …'],
-   ['laquo' , ' <<', ' «'],
-   ['raquo' , '>>', '»'],
-   ['laquo_space' , ' << T', ' « T'],
-   ['raquo_space' , ' >>', ' »']
-  ].each do |symbol|
+  [['mdash', ' ---', ' —'],
+   ['ndash', ' --', ' –'],
+   ['hellip', ' ...', ' …'],
+   ['laquo', ' <<', ' «'],
+   ['raquo', '>>', '»'],
+   ['laquo_space', ' << T', ' « T'],
+   ['raquo_space', ' >>', ' »']].each do |symbol|
     define_method "test_convert_typographic_symbols_#{symbol[0]}" do
       expected = [
         {
-          type: "paragraph",
+          type: 'paragraph',
           content: {
             text: "Hello#{symbol[2]}",
             spans: []
@@ -431,11 +432,12 @@ class KramdownPrismicConverterTest < Minitest::Test
 
   def test_convert_smart_quote
     expected = [
-      {type: "paragraph",
-       content: {
-         text: "Test\u2019",
-         spans: []
-       }
+      {
+        type: 'paragraph',
+        content: {
+          text: "Test\u2019",
+          spans: []
+        }
       }
     ]
     markdown = "Test'"
@@ -445,14 +447,14 @@ class KramdownPrismicConverterTest < Minitest::Test
   def test_convert_inline_code
     expected = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
-          text: "Hello code",
+          text: 'Hello code',
           spans: []
         }
       }
     ]
-    markdown = "Hello `code`"
+    markdown = 'Hello `code`'
     doc = Kramdown::Document.new(markdown)
     assert_equal expected, doc.to_prismic
     assert_equal 1, doc.warnings.size
@@ -460,20 +462,54 @@ class KramdownPrismicConverterTest < Minitest::Test
 
   def test_convert_br
     expected = [
-      {type: "paragraph",
-       content: {
-         text: "Test\n",
-         spans: []
-       }
+      {
+        type: 'paragraph',
+        content: {
+          text: "Test\n",
+          spans: []
+        }
+      }
+    ]
+    html = '<p>Test<br></p>'
+    assert_equal expected, Kramdown::Document.new(html, input: :html).to_prismic
+  end
+
+  def test_convert_html_with_no_tags
+    expected = [
+      {
+        type: 'paragraph',
+        content: {
+          text: "Test\n",
+          spans: []
+        }
       }
     ]
-    html = "<p>Test<br></p>"
+    html = 'Test'
     assert_equal expected, Kramdown::Document.new(html, input: :html).to_prismic
   end
 
+  def test_convert_iframe
+    expected = [
+      {
+        type: 'embed',
+        content: {
+          text: '',
+          spans: []
+        },
+        data: {
+          embed_url: 'https://www.youtube.com/watch?v=dQw4w9WgXcQ',
+          type: 'link'
+        }
+      }
+    ]
+    html = '<iframe src="https://www.youtube.com/watch?v=dQw4w9WgXcQ"></iframe>'
+    doc = Kramdown::Document.new(html, input: :markdown)
+    assert_equal expected, doc.to_prismic
+  end
+
   def test_convert_html
     expected = []
-    html = "<div></div>"
+    html = '<div></div>'
     doc = Kramdown::Document.new(html, input: :markdown)
     assert_equal expected, doc.to_prismic
     assert_equal 1, doc.warnings.size
@@ -482,14 +518,14 @@ class KramdownPrismicConverterTest < Minitest::Test
   def test_convert_span_html
     expected = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
-          text: "",
+          text: '',
           spans: []
         }
       }
     ]
-    html = "<br>"
+    html = '<br>'
     doc = Kramdown::Document.new(html, input: :markdown)
     assert_equal expected, doc.to_prismic
     assert_equal 1, doc.warnings.size
@@ -497,7 +533,7 @@ class KramdownPrismicConverterTest < Minitest::Test
 
   def test_convert_table
     expected = []
-    markdown = "| First cell|Second cell|Third cell|"
+    markdown = '| First cell|Second cell|Third cell|'
     doc = Kramdown::Document.new(markdown, input: :kramdown)
     assert_equal expected, doc.to_prismic
     assert_equal 1, doc.warnings.size
@@ -513,7 +549,7 @@ class KramdownPrismicConverterTest < Minitest::Test
 
   def test_convert_math
     expected = []
-    markdown = "$$ 5 + 5 $$"
+    markdown = '$$ 5 + 5 $$'
     doc = Kramdown::Document.new(markdown, input: :kramdown)
     assert_equal expected, doc.to_prismic
     assert_equal 1, doc.warnings.size
@@ -522,12 +558,13 @@ class KramdownPrismicConverterTest < Minitest::Test
   def test_convert_footnote
     expected = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
-          text: "test",
+          text: 'test',
           spans: []
         }
-      }]
+      }
+    ]
     markdown = "test[^1]\n\n[^1]: test"
     doc = Kramdown::Document.new(markdown, input: :kramdown)
     assert_equal expected, doc.to_prismic
@@ -537,12 +574,13 @@ class KramdownPrismicConverterTest < Minitest::Test
   def test_convert_abbreviation
     expected = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
-          text: "HTML",
+          text: 'HTML',
           spans: []
         }
-      }]
+      }
+    ]
     markdown = "HTML\n\n*[HTML]: test"
     doc = Kramdown::Document.new(markdown, input: :kramdown)
     assert_equal expected, doc.to_prismic

data/test/parser_test.rb

@@ -1,43 +1,32 @@
+# frozen_string_literal: true
+
 require 'minitest/autorun'
 require 'kramdown-prismic'
 
 class KramdownPrismicParserTest < Minitest::Test
-  def test_parse_heading
-    prismic = [
-      {
-        type: "heading1",
-        content: {
-          text: "This is the document title",
-          spans: []
-        }
-      }
-    ]
-    expected = "# This is the document title\n\n"
-    doc = Kramdown::Document.new(prismic, input: :prismic)
-    assert_equal expected, doc.to_kramdown
-  end
-
-  def test_parse_heading2
-    prismic = [
-      {
-        type: "heading2",
-        content: {
-          text: "This is an h2 title",
-          spans: []
+  6.times do |heading|
+    define_method "test_parse_heading_#{heading}" do
+      prismic = [
+        {
+          type: "heading#{heading + 1}",
+          content: {
+            text: 'This is the document title',
+            spans: []
+          }
         }
-      }
-    ]
-    expected = "## This is an h2 title\n\n"
-    doc = Kramdown::Document.new(prismic, input: :prismic)
-    assert_equal expected, doc.to_kramdown
+      ]
+      expected = "#{'#' * (heading + 1)} This is the document title\n\n"
+      doc = Kramdown::Document.new(prismic, input: :prismic)
+      assert_equal expected, doc.to_kramdown
+    end
   end
 
   def test_parse_paragraph
     prismic = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
-          text: "This is a paragraph",
+          text: 'This is a paragraph',
           spans: []
         }
       }
@@ -50,12 +39,12 @@ class KramdownPrismicParserTest < Minitest::Test
   def test_parse_paragraph_with_spans
     prismic = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
-          text: "This is a paragraph",
+          text: 'This is a paragraph',
           spans: [
             {
-              type: "em",
+              type: 'em',
               start: 0,
               end: 4
             }
@@ -71,17 +60,17 @@ class KramdownPrismicParserTest < Minitest::Test
   def test_parse_paragraph_with_multiple_spans
     prismic = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
-          text: "This is a paragraph",
+          text: 'This is a paragraph',
           spans: [
             {
-              type: "em",
+              type: 'em',
               start: 0,
               end: 4
             },
             {
-              type: "strong",
+              type: 'strong',
               start: 5,
               end: 7
             }
@@ -97,16 +86,16 @@ class KramdownPrismicParserTest < Minitest::Test
   def test_parse_paragraph_with_link
     prismic = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
-          text: "This is a paragraph",
+          text: 'This is a paragraph',
           spans: [
             {
-              type: "hyperlink",
+              type: 'hyperlink',
               start: 0,
               end: 19,
               data: {
-                url: "https://prismic.io"
+                url: 'https://prismic.io'
               }
             }
           ]
@@ -121,21 +110,21 @@ class KramdownPrismicParserTest < Minitest::Test
   def test_parse_paragraph_with_nested_spans
     prismic = [
       {
-        type: "paragraph",
+        type: 'paragraph',
         content: {
-          text: "This is a paragraph",
+          text: 'This is a paragraph',
           spans: [
             {
-              type: "em",
+              type: 'em',
               start: 0,
               end: 4
             },
             {
-              type: "hyperlink",
+              type: 'hyperlink',
               start: 0,
               end: 19,
               data: {
-                url: "https://prismic.io"
+                url: 'https://prismic.io'
               }
             }
           ]
@@ -150,9 +139,9 @@ class KramdownPrismicParserTest < Minitest::Test
   def test_parse_image
     prismic = [
       {
-        type: "image",
+        type: 'image',
         content: {
-          text: "",
+          text: '',
           spans: []
         },
         data: {
@@ -171,7 +160,7 @@ class KramdownPrismicParserTest < Minitest::Test
   def test_parse_preformatted
     prismic = [
       {
-        type: "preformatted",
+        type: 'preformatted',
         content: {
           text: "This is a pre block\n",
           spans: []
@@ -186,13 +175,13 @@ class KramdownPrismicParserTest < Minitest::Test
   def test_parse_embed
     prismic = [
       {
-        type: "embed",
+        type: 'embed',
         data: {
-          type: "video",
-          embed_url: "https://www.youtube.com/watch?v=y6y_4_b6RS8"
+          type: 'video',
+          embed_url: 'https://www.youtube.com/watch?v=y6y_4_b6RS8'
         },
         content: {
-          text: "",
+          text: '',
           spans: []
         }
       }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-prismic
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - François de Metz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-10 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -61,19 +61,24 @@ dependencies:
 description: A Kramdown converter to convert documents into prismic rich text format
   and the other way around.
 email: francois@2metz.fr
-executables: []
+executables:
+- markdown2prismic
+- html2prismic
+- prismic2markdown
 extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
-- Changelog.md
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- bin/html2prismic
+- bin/markdown2prismic
+- bin/prismic2markdown
 - kramdown-prismic.gemspec
 - kramdown1.gemfile
 - kramdown2.gemfile

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.2
-  - 2.3
-  - 2.4
-script: bundle exec rake test