kramdown-prismic 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ab0262b0f760d68d07f7950d9890a58cf61744f9
-  data.tar.gz: c787b185094ed5295b4c5bd33ca0c4b00945180f
+SHA256:
+  metadata.gz: bb835641c9e7f2e9e600e0307e3bfd6e9eb46e5d83ae257c505c659c20865931
+  data.tar.gz: cba5da2b2d81fff052b24d7921872ec8e9607b726bdbe210ff516b6cf7b6810a
 SHA512:
-  metadata.gz: 4ced9a6393fd4ef11ec73bee999ed963c8613eac549cfc5355e7685eb2b99e10dda273984247f505751d4f085068a272e1c18eab9e9e3f75dcdc217b2d89bfc6
-  data.tar.gz: 712aaf67c347bcf0b7310b7972a0acd4534d644c0f7eacb5e25159a4f4d9124c658db7ee9cd66f6a8c43ac75ffc6e391d2c9779be66c383a6c949b81d0ab7eae
+  metadata.gz: 9b4e02f18a5dbf5c51f46cc729c8dd2018d1eec8809790e0492ee22f7886627e5bc77d20dabde755f44883f1c062cd7a7dda33ba8acbe9c4dac165218f23ca70
+  data.tar.gz: 5428075b5c8eac073a1729feac6803a378ac55ba330540c46c230f78b5e965caeb95b26ea60be9f059611d182cb0f6c764c2817f9b03c53b1dcde03ec923d86b

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

@@ -1,5 +1,14 @@
 # Changelog
 
+## 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

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    kramdown-prismic (0.2.0)
+    kramdown-prismic (0.2.1)
       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)
 
@@ -20,4 +20,4 @@ DEPENDENCIES
   rake (~> 12.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

@@ -18,7 +18,7 @@ gem 'kramdown-prismic', '~> 0.1'
 
 ## Usage
 
-### Convert kramdown documents to Prismic
+**Convert kramdown documents to Prismic**
 
 ```ruby
 require 'kramdown-prismic'
@@ -27,7 +27,7 @@ kramdown = '# Hello world'
 Kramdown::Document.new(kramdown).to_prismic
 ```
 
-### Convert markdown documents to Prismic
+**Convert markdown documents to Prismic**
 
 ```ruby
 require 'kramdown-prismic'
@@ -36,7 +36,7 @@ markdown = '# Hello world'
 Kramdown::Document.new(markdown, input: :markdown).to_prismic
 ```
 
-### Convert HTML documents to Prismic
+**Convert HTML documents to Prismic**
 
 ```ruby
 require 'kramdown-prismic'
@@ -45,7 +45,7 @@ html = '<h1>Hello world</h1>'
 Kramdown::Document.new(html, input: :html).to_prismic
 ```
 
-### Convert Primic to markdown
+**Convert Prismic to markdown**
 
 ```ruby
 require 'kramdown-prismic'
@@ -86,6 +86,9 @@ Some elements cannot be converted, due to some Prismic limitations. The table be
 | 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              |
@@ -97,9 +100,6 @@ Some elements cannot be converted, due to some Prismic limitations. The table be
 | td               | not supported              |
 | math             | not supported              |
 | footnote         | not supported              |
-| 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              |
@@ -107,6 +107,16 @@ Some elements cannot be converted, due to some Prismic limitations. The table be
 | comment          | not supported              |
 | raw              | not supported              |
 
+## Develop
+
+Install dependencies:
+
+    bundle install
+
+Run tests:
+
+    bundle exec rake test
+
 ## License
 
 MIT

data/lib/kramdown-prismic/version.rb

@@ -1,3 +1,3 @@
 module KramdownPrismic
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/kramdown/converter/prismic.rb

@@ -212,6 +212,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

@@ -36,6 +36,10 @@ module Kramdown
         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 = []
 

data/test/converter_test.rb

@@ -1,32 +1,35 @@
+# coding: utf-8
 require 'minitest/autorun'
 require 'kramdown-prismic'
 
 class KramdownPrismicConverterTest < Minitest::Test
-  def test_convert_heading
-    expected = [
-      {
-        type: "heading1",
-        content: {
-          text: "This is the document title",
-          spans: []
+  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
 
@@ -414,6 +417,22 @@ class KramdownPrismicConverterTest < 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

@@ -182,4 +182,23 @@ class KramdownPrismicParserTest < Minitest::Test
     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.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - François de Metz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-05 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -58,6 +58,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".travis.yml"
 - Changelog.md
@@ -92,8 +93,7 @@ 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.