kramdown-prismic 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 478fc54041b88fe3724b5adb47ef50c1268fcfed
-  data.tar.gz: dc9377d07e20fd263380158356b94e49f116af53
+  metadata.gz: ab0262b0f760d68d07f7950d9890a58cf61744f9
+  data.tar.gz: c787b185094ed5295b4c5bd33ca0c4b00945180f
 SHA512:
-  metadata.gz: 04deb0aed85ffb4c1f043f80a20e4ecef50ff69d53aa809eca3ec83297c07cc4383dc22d20deb13fdc9d790b48d26610454a170178aa6e0f900e81717c86a66d
-  data.tar.gz: f4b2afe4d8626f581ca937a35eef188d7a0cdd85235902db3dbddb7998e9a5a912c0ae397a4dfe4ee3805a5057f8c0e5a26ffd07e4b78bdad64cd86bc3a57393
+  metadata.gz: 4ced9a6393fd4ef11ec73bee999ed963c8613eac549cfc5355e7685eb2b99e10dda273984247f505751d4f085068a272e1c18eab9e9e3f75dcdc217b2d89bfc6
+  data.tar.gz: 712aaf67c347bcf0b7310b7972a0acd4534d644c0f7eacb5e25159a4f4d9124c658db7ee9cd66f6a8c43ac75ffc6e391d2c9779be66c383a6c949b81d0ab7eae

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kramdown-prismic (0.1.2)
+    kramdown-prismic (0.2.0)
       kramdown (~> 1.0)
 
 GEM

data/README.md

@@ -1,16 +1,88 @@
 # 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 Primic 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     |
@@ -25,9 +97,9 @@ 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     |
+| entity           | converted to unicode     |
+| typographic_sym  | converted to unicode     |
+| smart_quote      | converted to unicode     |
 | abbreviation     | not supported              |
 | html_element     | not supported              |
 | xml_comment      | not supported              |
@@ -35,20 +107,9 @@ Most of the content is translated. See the table below to see the difference:
 | comment          | not supported              |
 | raw              | not supported              |
 
-## Install
-
-```ruby
-gem 'kramdown-prismic', '~> 0.1'
-```
-
-## Usage
-
-```ruby
-require 'kramdown-prismic'
-
-Kramdown::Document.new(markdown).to_prismic
-```
-
 ## License
 
 MIT
+
+[Kramdown]: https://kramdown.gettalong.org/
+[prismic]: https://prismic.io/

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.2"
+  VERSION = "0.2.0"
 end

data/lib/kramdown/parser/prismic.rb

@@ -0,0 +1,97 @@
+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_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,7 +1,7 @@
 require 'minitest/autorun'
 require 'kramdown-prismic'
 
-class KramdownPrismicTest < Minitest::Test
+class KramdownPrismicConverterTest < Minitest::Test
   def test_convert_heading
     expected = [
       {

data/test/parser_test.rb

@@ -0,0 +1,185 @@
+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
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-prismic
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - François de Metz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-02 00:00:00.000000000 Z
+date: 2018-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -70,7 +70,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
@@ -96,4 +98,5 @@ 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