kramdown-prismic 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ab0262b0f760d68d07f7950d9890a58cf61744f9
-  data.tar.gz: c787b185094ed5295b4c5bd33ca0c4b00945180f
+SHA256:
+  metadata.gz: e34361d43f02e8ee666fb78685a040128617accc25d44221ed0f98e45fcc7eae
+  data.tar.gz: 58ceb9f450d5d719b3698dcc37d417d27f6ecff3a8873812426a086bb6296695
 SHA512:
-  metadata.gz: 4ced9a6393fd4ef11ec73bee999ed963c8613eac549cfc5355e7685eb2b99e10dda273984247f505751d4f085068a272e1c18eab9e9e3f75dcdc217b2d89bfc6
-  data.tar.gz: 712aaf67c347bcf0b7310b7972a0acd4534d644c0f7eacb5e25159a4f4d9124c658db7ee9cd66f6a8c43ac75ffc6e391d2c9779be66c383a6c949b81d0ab7eae
+  metadata.gz: fdd15d2fe0bb82ab3528f818579efe067f82274727c4f59ec262e899ca44224aa18b3c766f73f7c82396a8d803c93d9d92cfd864c4c24587a2743297cc60e0e1
+  data.tar.gz: 4cc36e4dbba12aaad5318267b268773a7010481959f9a4df4ddafaa3fc912cb9bb8830f4ac7fc8709e0c7b38c6ba2fc6a84a3436754c5d044ec4a7ab5be4646e

data/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on: [push, pull_request]
+jobs:
+  test-kramdown2:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        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
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake test

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+## 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.0)
-      kramdown (~> 1.0)
+    kramdown-prismic (0.3.0)
+      kramdown (>= 1, < 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    kramdown (1.15.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.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,8 +1,8 @@
 # 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
 
@@ -18,7 +18,23 @@ gem 'kramdown-prismic', '~> 0.1'
 
 ## Usage
 
-### Convert kramdown documents to Prismic
+### 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
 require 'kramdown-prismic'
@@ -27,7 +43,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 +52,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 +61,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 +102,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 +116,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,9 +123,20 @@ 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
 
 [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.0"
+  VERSION = '0.3.1'
 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"]
+            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: 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,15 +246,20 @@ module Kramdown
         extract_content(element, memo)
       end
 
-      def extract_span_br(element, memo)
+      def extract_span_br(_element, memo)
         memo[:text] += "\n"
       end
 
-      def extract_span_html_element(element, memo)
+      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
 
-      def extract_span_footnote(element, memo)
+      def extract_span_footnote(_element, _memo)
         warning('translating footnote is not supported')
       end
 
@@ -233,9 +276,9 @@ module Kramdown
         raquo_space: [::Kramdown::Utils::Entities.entity('nbsp'), ::Kramdown::Utils::Entities.entity('raquo')],
         laquo: [::Kramdown::Utils::Entities.entity('laquo')],
         raquo: [::Kramdown::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