kramdown-prismic 0.2.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb835641c9e7f2e9e600e0307e3bfd6e9eb46e5d83ae257c505c659c20865931
-  data.tar.gz: cba5da2b2d81fff052b24d7921872ec8e9607b726bdbe210ff516b6cf7b6810a
+  metadata.gz: 1ee09d3336016df7164dd139beccbdf493e4fa5c057b2c3d6480d1db7c352da4
+  data.tar.gz: 2b14fca6c580875817413ec64d3f5fc015ef00544ddf7a4aff6bfe0edb8e160c
 SHA512:
-  metadata.gz: 9b4e02f18a5dbf5c51f46cc729c8dd2018d1eec8809790e0492ee22f7886627e5bc77d20dabde755f44883f1c062cd7a7dda33ba8acbe9c4dac165218f23ca70
-  data.tar.gz: 5428075b5c8eac073a1729feac6803a378ac55ba330540c46c230f78b5e965caeb95b26ea60be9f059611d182cb0f6c764c2817f9b03c53b1dcde03ec923d86b
+  metadata.gz: 4a3b05a335d537eedcd4ab32f45dfd7fd28f258c7557a7efe087a8e98b77d1b65922c012c9b5737939d7ea6d1651117061d3158aad626c510408091abb4d210a
+  data.tar.gz: cf73a15a0961791104991790e2f46ee031d80f0265fdaca1e14601822747b43a815af87a7e3c74bb0a8e60774ec847b6e46e6b0bd0eca5a46b2bffe962ede4fe

data/.github/workflows/ci.yml

@@ -2,12 +2,33 @@ name: CI
 
 on: [push, pull_request]
 jobs:
-  test:
+  test-kramdown2:
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        ruby: [2.5, 2.6, 2.7]
+        ruby: [2.6, 2.7, "3.0"]
+        gemfile: [ kramdown2 ]
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}.gemfile
+    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
+
+  test-kramdown1:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby: [2.6, 2.7]
+        gemfile: [ kramdown1 ]
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}.gemfile
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+## Version 0.3.2
+
+- Parse ordered and unordered lists
+- Parse image with link
+
+## 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.
+- XML elements support have been removed.
+
+## 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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,15 +1,17 @@
 PATH
   remote: .
   specs:
-    kramdown-prismic (0.2.1)
-      kramdown (~> 1.0)
+    kramdown-prismic (0.3.2)
+      kramdown (>= 1, < 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    kramdown (1.17.0)
+    kramdown (2.3.1)
+      rexml
     minitest (5.10.3)
-    rake (12.2.1)
+    rake (13.0.6)
+    rexml (3.2.5)
 
 PLATFORMS
   ruby
@@ -17,7 +19,7 @@ PLATFORMS
 DEPENDENCIES
   kramdown-prismic!
   minitest (~> 5.0)
-  rake (~> 12.0)
+  rake (~> 13.0)
 
 BUNDLED WITH
    1.17.2

data/README.md

@@ -1,14 +1,14 @@
 # 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
 
 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).
+The parser part is quite new and not feature complete.
 
 ## Install
 
@@ -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."
-  s.description = "A Kramdown converter to convert documents into prismic rich text format."
-  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.0"
-  s.add_development_dependency "minitest", "~> 5.0"
-  s.add_development_dependency "rake", "~> 12.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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+gem 'kramdown', '~> 1.0'

data/kramdown2.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+gem 'kramdown', '~> 2.0'

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.2.1"
+  VERSION = '0.3.2'
 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,20 +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 == :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
@@ -43,7 +48,6 @@ module Kramdown
             memo << element
             extract_non_nestable_elements(element, elements)
           end
-          memo
         end
       end
 
@@ -59,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
@@ -104,8 +109,7 @@ module Kramdown
         }
       end
 
-      def convert_hr(element)
-      end
+      def convert_hr(element); end
 
       def convert_img(element)
         {
@@ -116,57 +120,91 @@ module Kramdown
           },
           data: {
             origin: {
-              url: element.attr["src"]
+              url: element.attr['src']
+            },
+            alt: element.attr['alt']
+          }
+        }
+      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: element.attr["alt"]
+            alt: image.attr['alt'],
+            linkTo: {
+              url: element.attr['href']
+            }
           }
         }
       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_xml_comment(element)
-        warning('translating xml_comment is not supported')
-        nil
-      end
-
-      def convert_xml_pi(element)
-        warning('translating xml_pi is not supported')
+      def convert_raw(_element)
+        warning('translating raw is not supported')
         nil
       end
 
-      def convert_raw(element)
-        warning('translating raw is not supported')
-        nil
+      def convert_text(element)
+        {
+          type: 'paragraph',
+          content: {
+            text: element.value,
+            spans: []
+          }
+        }
       end
 
-      def extract_content(element, memo={text: '', spans: []})
-        element.children.inject(memo) do |memo2, child|
+      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
 
@@ -187,7 +225,7 @@ module Kramdown
         insert_span(element, memo, {
                       type: 'hyperlink',
                       data: {
-                        url: element.attr["href"]
+                        url: element.attr['href']
                       }
                     })
       end
@@ -208,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
 
@@ -217,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
 
@@ -231,16 +269,16 @@ module Kramdown
       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')]
-      }
+        mdash: [Utils::Entities.entity('mdash')],
+        ndash: [Utils::Entities.entity('ndash')],
+        hellip: [Utils::Entities.entity('hellip')],
+        laquo_space: [Utils::Entities.entity('laquo'), Utils::Entities.entity('nbsp')],
+        raquo_space: [Utils::Entities.entity('nbsp'), Utils::Entities.entity('raquo')],
+        laquo: [Utils::Entities.entity('laquo')],
+        raquo: [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
 
@@ -249,7 +287,7 @@ module Kramdown
       end
 
       def extract_span_smart_quote(element, memo)
-        memo[:text] += ::Kramdown::Utils::Entities.entity(element.value.to_s).char
+        memo[:text] += Utils::Entities.entity(element.value.to_s).char
       end
     end
   end