kramdown-prismic 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8f60ad20cbfb6c159e57a59ea79acf3123ba6a3
-  data.tar.gz: 28bd2d6a6faf005cbc406ea2c4381369b5499d10
+  metadata.gz: 6b30034b89cbc5bbfe5613435382d48f332000ac
+  data.tar.gz: d546c799b441b0c7802221f668da8b573d48f9be
 SHA512:
-  metadata.gz: d5726fb2ec12cf1c292691b0e92dff4065f42f29bbdf2c7d101a7959faaf5dfb2f823b17133fdb689a31cac08e96b043724e78270f8f9d517bd27e195f593531
-  data.tar.gz: 72a178508efc47257ea3c21970ee3524f307ccfb58df87f7b889caced19b8e442f746de9d7af5433f58aaacd5d65af22fabdf170ff1ba860edc1a05d6edd4e81
+  metadata.gz: 31b0d991eb6a2dedb3b7ad156bdf0782437fe59049b4a5444ec48f4fb269504d203ed5fcfdc79e8c77eaef73462dff4e9e85ad4f5abaf03fd84848a5f2adc012
+  data.tar.gz: 56cb4219036f891f893dc12e1ec1e98d0bb1f80bee1ae7168c8b780644e049273f894e278cb6771f76ec327fd0b5797b5a6dc2f72c46dbec776972e30d79cf2d

data/Gemfile.lock

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

data/README.md

@@ -4,27 +4,9 @@ A Kramdown converter to convert documents into prismic rich text format.
 
 ## Status
 
-*Very early*, still a proof of concept.
+Most of the content is translated. See the table below to see the difference:
 
-TODO:
-
-- [x] heading1
-- [x] heading2
-- [x] heading3
-- [x] heading4
-- [x] heading5
-- [x] heading6
-- [x] paragraph
-- [x] preformatted
-- [x] strong
-- [x] em
-- [x] hyperlink
-- [x] o-list-item
-- [x] list-item
-- [x] Image
-- [ ] Embed
-
-## Difference between markdown and rich text
+### Difference between markdown and rich text
 
 | Markdown         | Prismic                    |
 |------------------|----------------------------|
@@ -32,31 +14,32 @@ TODO:
 | hr               | nothing                    |
 | img              | moved to the top level     |
 | nested list      | moved to the top level     |
-| br               |                            |
-| dl               |                            |
-| dt               |                            |
-| dd               |                            |
-| table            |                            |
-| thead            |                            |
-| tobdy            |                            |
-| tfoot            |                            |
-| tr               |                            |
-| td               |                            |
-| math             |                            |
-| footnote         |                            |
+| dl               | not supported              |
+| dt               | not supported              |
+| dd               | not supported              |
+| table            | not supported              |
+| thead            | not supported              |
+| tobdy            | not supported              |
+| tfoot            | not supported              |
+| tr               | not supported              |
+| td               | not supported              |
+| math             | not supported              |
+| footnote         | not supported              |
 | entity           | Transformed to unicode     |
-| typographic_sym  |                            |
-| smart_quote      |                            |
-| abbreviation     |                            |
+| typographic_sym  | Transformed to unicode     |
+| smart_quote      | Transformed to unicode     |
+| abbreviation     | not supported              |
 | html_element     | not supported              |
-| xml_comment      |                            |
-| xml_pi           |                            |
-| comment          |                            |
-| raw              |                            |
+| xml_comment      | not supported              |
+| xml_pi           | not supported              |
+| comment          | not supported              |
+| raw              | not supported              |
 
 ## Install
 
-Not yet available on rubygems
+```ruby
+gem 'kramdown-prismic', '~> 0.1'
+```
 
 ## Usage
 

data/lib/kramdown-prismic/version.rb

@@ -1,3 +1,3 @@
 module KramdownPrismic
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

data/lib/kramdown/converter/prismic.rb

@@ -34,6 +34,7 @@ module Kramdown
         child.children = child.children.inject([]) do |memo, element|
           if 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
             warning('nested list moved to the top level')
             elements << element
@@ -113,7 +114,8 @@ module Kramdown
             spans: []
           },
           data: {
-            url: element.attr["src"]
+            url: element.attr["src"],
+            alt: element.attr["alt"]
           }
         }
       end
@@ -123,6 +125,41 @@ module Kramdown
         nil
       end
 
+      def convert_table(element)
+        warning('translating table is not supported')
+        nil
+      end
+
+      def convert_dl(element)
+        warning('translating dl is not supported')
+        nil
+      end
+
+      def convert_math(element)
+        warning('translating math is not supported')
+        nil
+      end
+
+      def convert_comment(element)
+        warning('translating comment is not supported')
+        nil
+      end
+
+      def convert_xml_comment(element)
+        warning('translating xml_comment is not supported')
+        nil
+      end
+
+      def convert_xml_pi(element)
+        warning('translating xml_pi 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|
           send("extract_span_#{child.type}", child, memo2)
@@ -176,12 +213,35 @@ module Kramdown
         warning('translating html elements is not supported')
       end
 
+      def extract_span_footnote(element, memo)
+        warning('translating footnote is not supported')
+      end
+
+      def extract_span_abbreviation(element, memo)
+        warning('translating abbreviation is not supported')
+        memo[:text] += element.value
+      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')]
+      }
+      def extract_span_typographic_sym(element, memo)
+        value = TYPOGRAPHIC_SYMS[element.value].map {|e| e.char }.join('')
+        memo[:text] += value
+      end
+
       def extract_span_entity(element, memo)
-        memo[:text] += unicode_char(element.value.code_point)
+        memo[:text] += element.value.char
       end
 
-      def unicode_char(codepoint)
-        Utils::Entities::Entity.new(codepoint, '').char
+      def extract_span_smart_quote(element, memo)
+        memo[:text] += ::Kramdown::Utils::Entities.entity(element.value.to_s).char
       end
     end
   end

data/test/kramdown-prismic_test.rb

@@ -323,12 +323,15 @@ class KramdownPrismicTest < Minitest::Test
           spans: []
         },
         data: {
-          url: '/img.png'
+          url: '/img.png',
+          alt: 'alt text'
         }
       }
     ]
-    markdown =  "![](/img.png)"
-    assert_equal expected, Kramdown::Document.new(markdown).to_prismic
+    markdown =  "![alt text](/img.png)"
+    doc = Kramdown::Document.new(markdown)
+    assert_equal expected, doc.to_prismic
+    assert_equal 0, doc.warnings.size
   end
 
   def test_convert_double_img
@@ -347,7 +350,8 @@ class KramdownPrismicTest < Minitest::Test
           spans: []
         },
         data: {
-          url: '/img.png'
+          url: '/img.png',
+          alt: ''
         }
       },
       {
@@ -357,25 +361,65 @@ class KramdownPrismicTest < Minitest::Test
           spans: []
         },
         data: {
-          url: '/img2.png'
+          url: '/img2.png',
+          alt: ''
         }
       }
     ]
     markdown =  "![](/img.png)![](/img2.png)"
-    assert_equal expected, Kramdown::Document.new(markdown).to_prismic
+    doc = Kramdown::Document.new(markdown)
+    assert_equal expected, doc.to_prismic
+    assert_equal 2, doc.warnings.size
   end
 
   def test_convert_entity
+    expected = [
+      {
+        type: "paragraph",
+        content: {
+          text: "\u00a0",
+          spans: []
+        }
+      }
+    ]
+    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|
+    define_method "test_convert_typographic_symbols_#{symbol[0]}" do
+      expected = [
+        {
+          type: "paragraph",
+          content: {
+            text: "Hello#{symbol[2]}",
+            spans: []
+          }
+        }
+      ]
+      markdown = "Hello#{symbol[1]}"
+      assert_equal expected, Kramdown::Document.new(markdown, input: :kramdown).to_prismic
+    end
+  end
+
+  def test_convert_smart_quote
     expected = [
       {type: "paragraph",
        content: {
-         text: "\u00a0",
+         text: "Test\u2019",
          spans: []
        }
       }
     ]
-    markdown = "&nbsp;"
-    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+    markdown = "Test'"
+    assert_equal expected, Kramdown::Document.new(markdown, input: :kramdown).to_prismic
   end
 
   def test_convert_br
@@ -401,11 +445,12 @@ class KramdownPrismicTest < Minitest::Test
 
   def test_convert_span_html
     expected = [
-      {type: "paragraph",
-       content: {
-         text: "",
-         spans: []
-       }
+      {
+        type: "paragraph",
+        content: {
+          text: "",
+          spans: []
+        }
       }
     ]
     html = "<br>"
@@ -413,4 +458,90 @@ class KramdownPrismicTest < Minitest::Test
     assert_equal expected, doc.to_prismic
     assert_equal 1, doc.warnings.size
   end
+
+  def test_convert_table
+    expected = []
+    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
+  end
+
+  def test_convert_definition
+    expected = []
+    markdown = "kramdown\n: A Markdown-superset converter"
+    doc = Kramdown::Document.new(markdown, input: :kramdown)
+    assert_equal expected, doc.to_prismic
+    assert_equal 1, doc.warnings.size
+  end
+
+  def test_convert_math
+    expected = []
+    markdown = "$$ 5 + 5 $$"
+    doc = Kramdown::Document.new(markdown, input: :kramdown)
+    assert_equal expected, doc.to_prismic
+    assert_equal 1, doc.warnings.size
+  end
+
+  def test_convert_footnote
+    expected = [
+      {
+        type: "paragraph",
+        content: {
+          text: "test",
+          spans: []
+        }
+      }]
+    markdown = "test[^1]\n\n[^1]: test"
+    doc = Kramdown::Document.new(markdown, input: :kramdown)
+    assert_equal expected, doc.to_prismic
+    assert_equal 1, doc.warnings.size
+  end
+
+  def test_convert_abbreviation
+    expected = [
+      {
+        type: "paragraph",
+        content: {
+          text: "HTML",
+          spans: []
+        }
+      }]
+    markdown = "HTML\n\n*[HTML]: test"
+    doc = Kramdown::Document.new(markdown, input: :kramdown)
+    assert_equal expected, doc.to_prismic
+    assert_equal 1, doc.warnings.size
+  end
+
+  def test_convert_comment
+    expected = []
+    markdown = "{::comment}\nComment\n{:/comment}"
+    doc = Kramdown::Document.new(markdown, input: :kramdown)
+    assert_equal expected, doc.to_prismic
+    assert_equal 1, doc.warnings.size
+  end
+
+  def test_convert_xml_comment
+    expected = []
+    markdown = "<!-- a *comment* -->"
+    doc = Kramdown::Document.new(markdown, input: :kramdown)
+    assert_equal expected, doc.to_prismic
+    assert_equal 1, doc.warnings.size
+  end
+
+  def test_convert_xml_pi
+    expected = []
+    markdown = "<? a processing `instruction`?>"
+    doc = Kramdown::Document.new(markdown, input: :kramdown)
+    assert_equal expected, doc.to_prismic
+    assert_equal 1, doc.warnings.size
+  end
+
+  def test_convert_raw
+    expected = []
+    markdown = "{::nomarkdown}\nComment\n{:/nomarkdown}"
+    doc = Kramdown::Document.new(markdown, input: :kramdown)
+    assert_equal expected, doc.to_prismic
+    assert_equal 1, doc.warnings.size
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kramdown-prismic
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - François de Metz