kramdown-prismic 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6528bd7b5eab9c6cb2d3b777a4c6b24785bfbf71
+  data.tar.gz: 9851247bafd3d8e18030657fe4dad10c4a0ca3ef
+SHA512:
+  metadata.gz: fc5bed50cbee721945804e15f38116561b97d873736f85308e11d0772535c8a32c4a5822165295440d8933fc1e42f7122f433aba2d2b00449cab4501214113b2
+  data.tar.gz: 1ea9592644dd399893061a7cc53592d7aab77153045b58ee3f2a636dc68a731c63831f5e1f934f8d8fdca45278b74e343e849da2d4b031031b6eff997ee284a1

data/.gitignore

@@ -0,0 +1,2 @@
+/vendor
+/.bundle

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    kramdown-prismic (0.0.1)
+      kramdown (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    kramdown (1.15.0)
+    minitest (5.10.3)
+    rake (12.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  kramdown-prismic!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   1.14.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Stormz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Kramdown Prismic
+
+A Kramdown converter to convert documents into prismic rich text format.
+
+## Status
+
+*Very early*, still a proof of concept.
+
+TODO:
+
+- [x] heading1
+- [x] heading2
+- [x] heading3
+- [x] heading4
+- [x] heading5
+- [x] heading6
+- [x] paragraph
+- [ ] preformatted
+- [x] strong
+- [x] em
+- [x] hyperlink
+- [x] o-list-item
+- [x] list-item
+- [ ] Image
+- [ ] Embed
+
+## Difference between markdown and rich text
+
+| Markdown     | Prismic                    |
+|--------------|----------------------------|
+| Blockquote   | translated to preformatted |
+| hr           | nothing                    |
+
+## Install
+
+Not yet available on rubygems
+
+## Usage
+
+```ruby
+require 'kramdown-prismic'
+
+Kramdown::Document.new(markdown).to_prismic
+```
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+

data/kramdown-prismic.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require File.expand_path('../lib/kramdown-prismic/version', __FILE__)
+
+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.email       = 'francois@2metz.fr'
+
+  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"
+end

data/lib/kramdown-prismic.rb

@@ -0,0 +1,4 @@
+require 'kramdown'
+
+require 'kramdown/converter/prismic'
+require 'kramdown-prismic/version'

data/lib/kramdown-prismic/version.rb

@@ -0,0 +1,3 @@
+module KramdownPrismic
+  VERSION = "0.0.1"
+end

data/lib/kramdown/converter/prismic.rb

@@ -0,0 +1,122 @@
+require 'kramdown/converter/base'
+
+module Kramdown
+  module Converter
+    class Prismic < Base
+      def convert(root)
+        root.children.map { |child|
+          convert_element(child)
+        }.compact.flatten
+      end
+
+      private
+
+      def convert_element(element)
+        send("convert_#{element.type}", element)
+      end
+
+      def convert_blank(element)
+      end
+
+      def convert_header(element)
+        {
+          type: "heading#{element.options[:level]}",
+          content: extract_content(element)
+        }
+      end
+
+      def convert_p(element)
+        {
+          type: "paragraph",
+          content: extract_content(element)
+        }
+      end
+
+      def convert_ol(element)
+        convert_list(element, 'o-list-item')
+      end
+
+      def convert_ul(element)
+        convert_list(element, 'list-item')
+      end
+
+      def convert_list(element, type)
+        element.children.map do |child|
+          convert_li(type, child)
+        end
+      end
+
+      def convert_li(type, element)
+        {
+          type: type,
+          content: extract_content(element)
+        }
+      end
+
+      def convert_codeblock(element)
+        {
+          type: 'preformatted',
+          content: {
+            text: element.value,
+            spans: []
+          }
+        }
+      end
+
+      def convert_blockquote(element)
+        {
+          type: 'preformatted',
+          content: extract_content(element)
+        }
+      end
+
+      def convert_hr(element)
+      end
+
+      def extract_content(element, memo={text: '', spans: []})
+        element.children.inject(memo) do |memo2, child|
+          send("extract_span_#{child.type}", child, memo2)
+          memo2
+        end
+      end
+
+      def insert_span(element, memo, span)
+        span[:start] = memo[:text].size
+        extract_content(element, memo)
+        span[:end] = memo[:text].size
+        memo[:spans] << span
+        memo
+      end
+
+      def extract_span_text(element, memo)
+        memo[:text] += element.value
+        memo
+      end
+
+      def extract_span_a(element, memo)
+        insert_span(element, memo, {
+                      type: 'hyperlink',
+                      data: {
+                        url: element.attr["href"]
+                      }
+                    })
+      end
+
+      def extract_span_strong(element, memo)
+        insert_span(element, memo, {
+                      type: 'strong'
+                    })
+      end
+
+      def extract_span_em(element, memo)
+        insert_span(element, memo, {
+                      type: 'em'
+                    })
+      end
+
+      def extract_span_p(element, memo)
+        extract_content(element, memo)
+      end
+    end
+  end
+end

data/test/kramdown-prismic_test.rb

@@ -0,0 +1,243 @@
+require 'minitest/autorun'
+require 'kramdown-prismic'
+
+class KramdownPrismicTest < Minitest::Test
+  def test_convert_heading
+    expected = [
+      {
+        type: "heading1",
+        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
+  end
+
+  def test_convert_heading2
+    expected = [
+      {
+        type: "heading2",
+        content: {
+          text: "This is a document title",
+          spans: []
+        }
+      }
+    ]
+    markdown = "## This is a document title"
+    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+  end
+
+  def test_convert_heading_with_spans
+    expected = [
+      {
+        type: "heading2",
+        content: {
+          text: "This is a document title",
+          spans: [
+            {
+              type: "em",
+              start: 0,
+              end: 4
+            }
+          ]
+        }
+      }
+    ]
+    markdown = "## *This* is a document title"
+    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+  end
+
+  def test_convert_paragraph
+    expected = [
+      {
+        type: "paragraph",
+        content: {
+          text: "This is a paragraph",
+          spans: []
+        }
+      }
+    ]
+    markdown = "This is a paragraph"
+    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+  end
+
+  def test_convert_paragraph_with_spans
+    expected = [
+      {
+        type: "paragraph",
+        content: {
+          text: "This is a paragraph",
+          spans: [
+            {
+              type: "hyperlink",
+              start: 0,
+              end: 19,
+              data: {
+                url: "https://prismic.io"
+              }
+            }
+          ]
+        }
+      }
+    ]
+    markdown = "[This is a paragraph](https://prismic.io)"
+    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+  end
+
+  def test_convert_paragraph_with_strong
+    expected = [
+      {
+        type: "paragraph",
+        content: {
+          text: "This is a paragraph",
+          spans: [
+            {
+              type: "strong",
+              start: 0,
+              end: 19
+            }
+          ]
+        }
+      }
+    ]
+    markdown = "**This is a paragraph**"
+    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+  end
+
+  def test_convert_paragraph_with_strong2
+    expected = [
+      {
+        type: "paragraph",
+        content: {
+          text: "This is a paragraph",
+          spans: [
+            {
+              type: "strong",
+              start: 0,
+              end: 4
+            }
+          ]
+        }
+      }
+    ]
+    markdown = "**This** is a paragraph"
+    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+  end
+
+  def test_convert_paragraph_with_em
+    expected = [
+      {
+        type: "paragraph",
+        content: {
+          text: "This is a paragraph",
+          spans: [
+            {
+              type: "em",
+              start: 0,
+              end: 4
+            }
+          ]
+        }
+      }
+    ]
+    markdown = "*This* is a paragraph"
+    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+  end
+
+  def test_convert_list_o
+    expected = [
+      {
+        type: "o-list-item",
+        content: {
+          text: "This is a list item",
+          spans: [
+            {
+              type: "em",
+              start: 0,
+              end: 4
+            }
+          ]
+        }
+      },
+      {
+        type: "o-list-item",
+        content: {
+          text: "This is a second list item",
+          spans: []
+        }
+      }
+    ]
+    markdown = "1. *This* is a list item\n2. This is a second list item"
+    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+  end
+
+  def test_convert_list_u
+    expected = [
+      {
+        type: "list-item",
+        content: {
+          text: "This is a list item",
+          spans: [
+            {
+              type: "em",
+              start: 0,
+              end: 4
+            }
+          ]
+        }
+      },
+      {
+        type: "list-item",
+        content: {
+          text: "This is a second list item",
+          spans: []
+        }
+      }
+    ]
+    markdown = "- *This* is a list item\n- This is a second list item"
+    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+  end
+
+  def test_convert_preformatted
+    expected = [
+      {
+        type: "preformatted",
+        content: {
+          text: "This is a pre block\n",
+          spans: []
+        }
+      }
+    ]
+    markdown = "    This is a pre block\n"
+    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+  end
+
+  def test_convert_blockquote
+    expected = [
+      {
+        type: "preformatted",
+        content: {
+          text: "This is a blockquote",
+          spans: []
+        }
+      }
+    ]
+    markdown = "> This is a blockquote\n"
+    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+  end
+
+  def test_convert_empty
+    expected = []
+    markdown = ""
+    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+  end
+
+  def test_convert_hr
+    expected = []
+    markdown = "---"
+    assert_equal expected, Kramdown::Document.new(markdown, input: :markdown).to_prismic
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: kramdown-prismic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- François de Metz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: A Kramdown converter to convert documents into prismic rich text format.
+email: francois@2metz.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- kramdown-prismic.gemspec
+- lib/kramdown-prismic.rb
+- lib/kramdown-prismic/version.rb
+- lib/kramdown/converter/prismic.rb
+- test/kramdown-prismic_test.rb
+homepage: https://github.com/stormz/kramdown-prismic
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A Kramdown converter to convert documents into prismic rich text format.
+test_files:
+- test/kramdown-prismic_test.rb