kramdown-prismic 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 784c5db25b65fde0e92c1bc62bdd66449c0146b8
-  data.tar.gz: 37059d2067f4a37515281b650fb93b040578b0fd
+SHA256:
+  metadata.gz: 3229f319815e16e39608a957bb9f596e623a6ef605be3955c46723de2aedbb98
+  data.tar.gz: '08f9b62d41e583e99d51373ddb875352abec6226f2a584c6f9d21b61c15ed26f'
 SHA512:
-  metadata.gz: b8e0c03b2c032fa205ccc69dca3e30bf0ee64d2d656631aceb9c10a360fbc89eddfebe6535c2b005bb08c30f58ef42eadc36e3a145e0d79ba76e09da28fe9a18
-  data.tar.gz: 2dc64bc2e5efa943c9c286c7b9f8bc56dae50f98ff2371b68a890fbf98d03a703305273d9e16b88f194032691f23e13f1e6133aa8acd5014b8c94f15c5e3b5ca
+  metadata.gz: 8c3bf867920d85af049006027d70f156cca4c0863cd8c40784eb473121153652acc368906e1100fabdb90d36a04f73c9a966090c8a68e7d55fc8c55f0e3610e7
+  data.tar.gz: e4daf1cfe1886f809f0234d7a181b22e677be78401f06c4f4657d89a519e61b13d56ce1dcabcad11ed13bbe782f359c3214c5650da098b8b72c65fccdeb230b4

data/.github/workflows/ci.yml

@@ -0,0 +1,18 @@
+name: CI
+
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby: [2.5, 2.6, 2.7]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake test

data/Changelog.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## Version 0.2.2
+
+- Convert links with only an image inside. See #1.
+
+## Version 0.2.1
+
+- Parse embed elements
+- Convert inline code
+
+## Version 0.2.0
+
+- Add parser to convert prismic to markdown
+
+## Version 0.1.2
+
+- fix output with empty paragraph
+
+## Version 0.1.1
+
+- Fix json of the image
+
+## Version 0.1.0
+
+- Initial version

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    kramdown-prismic (0.1.1)
+    kramdown-prismic (0.2.2)
       kramdown (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    kramdown (1.15.0)
+    kramdown (1.17.0)
     minitest (5.10.3)
-    rake (12.2.1)
+    rake (13.0.6)
 
 PLATFORMS
   ruby
@@ -17,7 +17,7 @@ PLATFORMS
 DEPENDENCIES
   kramdown-prismic!
   minitest (~> 5.0)
-  rake (~> 12.0)
+  rake (~> 13.0)
 
 BUNDLED WITH
-   1.14.6
+   1.17.2

data/LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
 Copyright (c) 2017 Stormz
+Copyright (c) 2021 François de Metz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,19 +1,94 @@
 # Kramdown Prismic
 
-A Kramdown converter to convert documents into prismic rich text format.
+A [Kramdown][] parser and converter to convert documents into [prismic][] rich text format and back.
+
+A useful usage is to convert markdown documents to prismic for import purpose. Then you can even convert prismic format back to markdown.
 
 ## Status
 
-Most of the content is translated. See the table below to see the difference:
+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).
+
+## Install
+
+```ruby
+gem 'kramdown-prismic', '~> 0.1'
+```
+
+## Usage
+
+**Convert kramdown documents to Prismic**
+
+```ruby
+require 'kramdown-prismic'
+
+kramdown = '# Hello world'
+Kramdown::Document.new(kramdown).to_prismic
+```
+
+**Convert markdown documents to Prismic**
+
+```ruby
+require 'kramdown-prismic'
+
+markdown = '# Hello world'
+Kramdown::Document.new(markdown, input: :markdown).to_prismic
+```
+
+**Convert HTML documents to Prismic**
+
+```ruby
+require 'kramdown-prismic'
+
+html = '<h1>Hello world</h1>'
+Kramdown::Document.new(html, input: :html).to_prismic
+```
+
+**Convert Prismic to markdown**
+
+```ruby
+require 'kramdown-prismic'
+prismic = [
+  {
+    type: "heading1",
+    content: {
+      text: "This is the document title",
+      spans: []
+    }
+  }
+]
+Kramdown::Document.new(prismic, input: :prismic).to_kramdown
+```
+
+### Lookup for warnings
+
+If there is some elements that cannot be converted (see the status table), a warning will be emitted.
+
+For instance, html elements in the markdown is not supported:
+
+```ruby
+require 'kramdown-prismic'
+
+markdown = '<h1>Hello world</h1>'
+result = Kramdown::Document.new(markdown, input: :markdown)
+result.to_prismic
+p result.warnings
+```
 
 ### Difference between markdown and rich text
 
+Some elements cannot be converted, due to some Prismic limitations. The table below explain the difference and limitations of the current converter:
+
 | Markdown         | Prismic                    |
 |------------------|----------------------------|
-| Blockquote       | translated to preformatted |
+| blockquote       | converted to preformatted  |
 | hr               | nothing                    |
 | img              | moved to the top level     |
 | nested list      | moved to the top level     |
+| entity           | converted to unicode       |
+| typographic_sym  | converted to unicode       |
+| smart_quote      | converted to unicode       |
 | dl               | not supported              |
 | dt               | not supported              |
 | dd               | not supported              |
@@ -25,9 +100,6 @@ Most of the content is translated. See the table below to see the difference:
 | td               | not supported              |
 | math             | not supported              |
 | footnote         | not supported              |
-| entity           | Transformed to unicode     |
-| typographic_sym  | Transformed to unicode     |
-| smart_quote      | Transformed to unicode     |
 | abbreviation     | not supported              |
 | html_element     | not supported              |
 | xml_comment      | not supported              |
@@ -35,20 +107,19 @@ Most of the content is translated. See the table below to see the difference:
 | comment          | not supported              |
 | raw              | not supported              |
 
-## Install
+## Develop
 
-```ruby
-gem 'kramdown-prismic', '~> 0.1'
-```
+Install dependencies:
 
-## Usage
+    bundle install
 
-```ruby
-require 'kramdown-prismic'
+Run tests:
 
-Kramdown::Document.new(markdown).to_prismic
-```
+    bundle exec rake test
 
 ## License
 
 MIT
+
+[Kramdown]: https://kramdown.gettalong.org/
+[prismic]: https://prismic.io/

data/kramdown-prismic.gemspec

@@ -17,5 +17,5 @@ Gem::Specification.new do |s|
 
   s.add_dependency "kramdown", "~> 1.0"
   s.add_development_dependency "minitest", "~> 5.0"
-  s.add_development_dependency "rake", "~> 12.0"
+  s.add_development_dependency "rake", "~> 13.0"
 end

data/lib/kramdown-prismic.rb

@@ -1,4 +1,5 @@
 require 'kramdown'
 
+require 'kramdown/parser/prismic'
 require 'kramdown/converter/prismic'
 require 'kramdown-prismic/version'

data/lib/kramdown-prismic/version.rb

@@ -1,3 +1,3 @@
 module KramdownPrismic
-  VERSION = "0.1.1"
+  VERSION = "0.2.2"
 end

data/lib/kramdown/converter/prismic.rb

@@ -32,7 +32,9 @@ module Kramdown
 
       def extract_non_nestable_elements(child, elements)
         child.children = child.children.inject([]) do |memo, element|
-          if element.type == :img
+          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
           elsif element.type == :ul
@@ -59,6 +61,7 @@ module Kramdown
       end
 
       def convert_p(element)
+        return nil if element.children.size == 0
         {
           type: "paragraph",
           content: extract_content(element)
@@ -122,6 +125,27 @@ module Kramdown
         }
       end
 
+      # This can only apply when an link with an image inside has been detected
+      def convert_a(element)
+        image = element.children.first
+        {
+          type: 'image',
+          content: {
+            text: '',
+            spans: []
+          },
+          data: {
+            origin: {
+              url: image.attr['src']
+            },
+            alt: image.attr['alt'],
+            linkTo: {
+              url: element.attr['href']
+            }
+          }
+        }
+      end
+
       def convert_html_element(element)
         warning('translating html elements is not supported')
         nil
@@ -211,6 +235,11 @@ module Kramdown
         memo[:text] += "\n"
       end
 
+      def extract_span_codespan(element, memo)
+        warning('translating inline code is not supported')
+        memo[:text] += element.value
+      end
+
       def extract_span_html_element(element, memo)
         warning('translating html elements is not supported')
       end

data/lib/kramdown/parser/prismic.rb

@@ -0,0 +1,101 @@
+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
+        end
+      end
+
+      private
+
+      def parse_heading(block)
+        level = block[:type].match(/heading([1-6])/)[1].to_i
+        Kramdown::Element.new(:header, nil, nil, {level: level, raw_text: ''})
+      end
+
+      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]})
+        p.children << img
+        p
+      end
+
+      def parse_preformatted(block)
+        Kramdown::Element.new(:blockquote)
+      end
+
+      def parse_embed(block)
+        Kramdown::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|
+            el = stack.pop
+            if stack.empty?
+              element.children << el
+            else
+              stack[-1].children << el
+            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
+          end
+
+          char = block[:content][:text][index]
+          next if char.nil?
+          current_text = if stack.empty?
+            element.children.last
+          else
+            stack[-1].children.last
+          end
+          if current_text.nil? || current_text.type != :text
+            current_text = Element.new(:text, "")
+            if stack.empty?
+              element.children << current_text
+            else
+              stack[-1].children << current_text
+            end
+          end
+          current_text.value += char
+        end
+      end
+
+      def find_starting_spans_for(block, index)
+        block[:content][:spans].find_all do |span|
+          span[:start] == index
+        end.sort_by do |span|
+          -span[:end]
+        end
+      end
+
+      def find_ending_spans_for(block, index)
+        block[:content][:spans].find_all do |span|
+          span[:end] == index
+        end
+      end
+    end
+  end
+end

data/test/{kramdown-prismic_test.rb → converter_test.rb}

@@ -1,32 +1,35 @@
+# coding: utf-8
 require 'minitest/autorun'
 require 'kramdown-prismic'
 
-class KramdownPrismicTest < Minitest::Test
-  def test_convert_heading
-    expected = [
-      {
-        type: "heading1",
-        content: {
-          text: "This is the document title",
-          spans: []
+class KramdownPrismicConverterTest < Minitest::Test
+  6.times do |heading|
+    define_method "test_convert_heading_#{heading}" do
+      expected = [
+        {
+          type: "heading#{heading + 1}",
+          content: {
+            text: "This is the document title",
+            spans: []
+          }
         }
-      }
-    ]
-    markdown = "# This is the document title"
-    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+      ]
+      markdown = "#{"#" * (heading + 1)} This is the document title"
+      assert_equal expected, Kramdown::Document.new(markdown, input: :kramdown).to_prismic
+    end
   end
 
-  def test_convert_heading2
+  def test_convert_heading7
     expected = [
       {
-        type: "heading2",
+        type: "heading6",
         content: {
-          text: "This is a document title",
+          text: "# This is the document title",
           spans: []
         }
       }
     ]
-    markdown = "## This is a document title"
+    markdown = "####### This is the document title"
     assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
   end
 
@@ -309,13 +312,6 @@ class KramdownPrismicTest < Minitest::Test
 
   def test_convert_img
     expected = [
-      {
-        type: "paragraph",
-        content: {
-          text: "",
-          spans: []
-        }
-      },
       {
         type: "image",
         content: {
@@ -338,13 +334,6 @@ class KramdownPrismicTest < Minitest::Test
 
   def test_convert_double_img
     expected = [
-      {
-        type: "paragraph",
-        content: {
-          text: "",
-          spans: []
-        }
-      },
       {
         type: "image",
         content: {
@@ -378,6 +367,31 @@ class KramdownPrismicTest < Minitest::Test
     assert_equal 2, doc.warnings.size
   end
 
+  def test_convert_img_with_link
+    expected = [
+      {
+        type: "image",
+        content: {
+          text: "",
+          spans: []
+        },
+        data: {
+          origin: {
+            url: '/img.png'
+          },
+          alt: 'alt text',
+          linkTo: {
+            url: "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
+  end
+
   def test_convert_entity
     expected = [
       {
@@ -428,6 +442,22 @@ class KramdownPrismicTest < Minitest::Test
     assert_equal expected, Kramdown::Document.new(markdown, input: :kramdown).to_prismic
   end
 
+  def test_convert_inline_code
+    expected = [
+      {
+        type: "paragraph",
+        content: {
+          text: "Hello code",
+          spans: []
+        }
+      }
+    ]
+    markdown = "Hello `code`"
+    doc = Kramdown::Document.new(markdown)
+    assert_equal expected, doc.to_prismic
+    assert_equal 1, doc.warnings.size
+  end
+
   def test_convert_br
     expected = [
       {type: "paragraph",

data/test/parser_test.rb

@@ -0,0 +1,204 @@
+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: []
+        }
+      }
+    ]
+    expected = "## This is an h2 title\n\n"
+    doc = Kramdown::Document.new(prismic, input: :prismic)
+    assert_equal expected, doc.to_kramdown
+  end
+
+  def test_parse_paragraph
+    prismic = [
+      {
+        type: "paragraph",
+        content: {
+          text: "This is a paragraph",
+          spans: []
+        }
+      }
+    ]
+    expected = "This is a paragraph\n\n"
+    doc = Kramdown::Document.new(prismic, input: :prismic)
+    assert_equal expected, doc.to_kramdown
+  end
+
+  def test_parse_paragraph_with_spans
+    prismic = [
+      {
+        type: "paragraph",
+        content: {
+          text: "This is a paragraph",
+          spans: [
+            {
+              type: "em",
+              start: 0,
+              end: 4
+            }
+          ]
+        }
+      }
+    ]
+    expected = "*This* is a paragraph\n\n"
+    doc = Kramdown::Document.new(prismic, input: :prismic)
+    assert_equal expected, doc.to_kramdown
+  end
+
+  def test_parse_paragraph_with_multiple_spans
+    prismic = [
+      {
+        type: "paragraph",
+        content: {
+          text: "This is a paragraph",
+          spans: [
+            {
+              type: "em",
+              start: 0,
+              end: 4
+            },
+            {
+              type: "strong",
+              start: 5,
+              end: 7
+            }
+          ]
+        }
+      }
+    ]
+    expected = "*This* **is** a paragraph\n\n"
+    doc = Kramdown::Document.new(prismic, input: :prismic)
+    assert_equal expected, doc.to_kramdown
+  end
+
+  def test_parse_paragraph_with_link
+    prismic = [
+      {
+        type: "paragraph",
+        content: {
+          text: "This is a paragraph",
+          spans: [
+            {
+              type: "hyperlink",
+              start: 0,
+              end: 19,
+              data: {
+                url: "https://prismic.io"
+              }
+            }
+          ]
+        }
+      }
+    ]
+    expected = "[This is a paragraph][1]\n\n\n\n[1]: https://prismic.io\n"
+    doc = Kramdown::Document.new(prismic, input: :prismic)
+    assert_equal expected, doc.to_kramdown
+  end
+
+  def test_parse_paragraph_with_nested_spans
+    prismic = [
+      {
+        type: "paragraph",
+        content: {
+          text: "This is a paragraph",
+          spans: [
+            {
+              type: "em",
+              start: 0,
+              end: 4
+            },
+            {
+              type: "hyperlink",
+              start: 0,
+              end: 19,
+              data: {
+                url: "https://prismic.io"
+              }
+            }
+          ]
+        }
+      }
+    ]
+    expected = "[*This* is a paragraph][1]\n\n\n\n[1]: https://prismic.io\n"
+    doc = Kramdown::Document.new(prismic, input: :prismic)
+    assert_equal expected, doc.to_kramdown
+  end
+
+  def test_parse_image
+    prismic = [
+      {
+        type: "image",
+        content: {
+          text: "",
+          spans: []
+        },
+        data: {
+          origin: {
+            url: '/img.png'
+          },
+          alt: 'alt text'
+        }
+      }
+    ]
+    expected = "![alt text](/img.png)\n\n"
+    doc = Kramdown::Document.new(prismic, input: :prismic)
+    assert_equal expected, doc.to_kramdown
+  end
+
+  def test_parse_preformatted
+    prismic = [
+      {
+        type: "preformatted",
+        content: {
+          text: "This is a pre block\n",
+          spans: []
+        }
+      }
+    ]
+    expected = "> This is a pre block \n\n"
+    doc = Kramdown::Document.new(prismic, input: :prismic)
+    assert_equal expected, doc.to_kramdown
+  end
+
+  def test_parse_embed
+    prismic = [
+      {
+        type: "embed",
+        data: {
+          type: "video",
+          embed_url: "https://www.youtube.com/watch?v=y6y_4_b6RS8"
+        },
+        content: {
+          text: "",
+          spans: []
+        }
+      }
+    ]
+    expected = "<iframe src=\"https://www.youtube.com/watch?v=y6y_4_b6RS8\"></iframe>\n"
+    doc = Kramdown::Document.new(prismic, input: :prismic)
+    assert_equal expected, doc.to_kramdown
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-prismic
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - François de Metz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -44,22 +44,24 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 description: A Kramdown converter to convert documents into prismic rich text format.
 email: francois@2metz.fr
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".travis.yml"
+- Changelog.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -69,7 +71,9 @@ files:
 - lib/kramdown-prismic.rb
 - lib/kramdown-prismic/version.rb
 - lib/kramdown/converter/prismic.rb
-- test/kramdown-prismic_test.rb
+- lib/kramdown/parser/prismic.rb
+- test/converter_test.rb
+- test/parser_test.rb
 homepage: https://github.com/stormz/kramdown-prismic
 licenses:
 - MIT
@@ -89,10 +93,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A Kramdown converter to convert documents into prismic rich text format.
 test_files:
-- test/kramdown-prismic_test.rb
+- test/converter_test.rb
+- test/parser_test.rb