lwe_slate_serializer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e1afc95f11d60edc3272a0097520e1bddca78ee9a8c37cd6908ff63ed0563bd
+  data.tar.gz: 98c0ee15eebb1e2e5e7537419c4144d2985121487c8fa65cc26064da3871b02f
+SHA512:
+  metadata.gz: 4d84ccba0d9b4027b1888696aa01a34de921d51826c0665671497c640b9d559ddbfa739b09a1d5c0a946671a5539b29b26149ad4056466ae44404351109f4f9b
+  data.tar.gz: e5f8ff256e04ef82167592b755699ebe1fa80506edcb0d4f99bf46ccc5474f4454011cb32488b50fb08a8882034ae36d7a1d8bcd1a78614af96bac7d4a62dbb9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in slate_serializer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    lwe_slate_serializer (1.0.0)
+      nokogiri (~> 1.11)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    mini_portile2 (2.8.0)
+    nokogiri (1.13.3)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.2)
+  lwe_slate_serializer!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.22

data/README.md

@@ -0,0 +1,34 @@
+# SlateSerializer
+
+SlateSerializer de- and serializer text and html to Slate document values in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slate_serializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slate_serializer
+
+## Usage
+
+To convert between plain text and Slate document use:
+
+    $ SlateSerializer::Plain.serializer([...]) => text
+    $ SlateSerializer::Plain.deserializer(text) => [...]
+
+To convert between html and Slate document use:
+
+    $ SlateSerializer::Html.deserializer(html) => [...]
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wesleystam/slate_serializer.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'slate_serializer'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/slate_serializer/html.rb

@@ -0,0 +1,188 @@
+require 'nokogiri'
+
+module SlateSerializer
+  # Html de- and serializer
+  class Html
+    # Default lookup list to convert html tags to object types
+    ELEMENTS = {
+      'a': 'link',
+      'img': 'image',
+      'li': 'list-item',
+      'p': 'paragraph',
+      'div': 'paragraph',
+      'ol1': 'ordered-list',
+      'ola': 'alpha-ordered-list',
+      'ol': 'ordered-list',
+      'ul': 'unordered-list',
+      'table': 'table',
+      'tbody': 'tbody',
+      'tr': 'tr',
+      'td': 'td',
+      'text': 'text',
+      'hr': 'hr',
+      'figure': 'figure',
+      'figcaption': 'figcaption'
+    }.freeze
+    # Default block types list
+    BLOCK_ELEMENTS = %w[figure figcaption hr img li p ol ul table tbody tr td].freeze
+    # Default inline types list
+    INLINE_ELEMENTS = %w[a].freeze
+    # Default mark types list
+    MARK_ELEMENTS = {
+      'em': 'italic',
+      'strong': 'bold',
+      'u': 'underline'
+    }.freeze
+
+    class << self
+      # Convert html to a Slate document
+      #
+      # @param html format [String] the HTML
+      # @param options [Hash]
+      # @option options [Array] :elements Lookup list to convert html tags to object types
+      # @option options [Array] :block_elemnts List of block types
+      # @option options [Array] :inline_elemnts List of inline types
+      # @option options [Array] :mark_elemnts List of mark types
+      def deserializer(html, options = {})
+        return empty_state if html.nil? || html == ''
+
+        self.elements = options[:elements] || ELEMENTS
+        self.block_elements = options[:block_elements] || BLOCK_ELEMENTS
+        self.inline_elements = options[:inline_elements] || INLINE_ELEMENTS
+        self.mark_elements = options[:mark_elements] || MARK_ELEMENTS
+
+        html = html.gsub('<br>', "\n")
+        Nokogiri::HTML.fragment(html).elements.map do |element|
+          element_to_node(element)
+        end
+      end
+
+      # Convert html to a Slate document
+      #
+      # @param value format [Hash] the Slate document
+      # @return [String] plain text version of the Slate documnent
+      def serializer(value)
+        return '' unless value.is_a?(Array)
+
+        value.map { |n| serialize_node(n) }.join
+      end
+
+      private
+
+      attr_accessor :elements, :block_elements, :inline_elements, :mark_elements
+
+      def element_to_node(element)
+        type = convert_name_to_type(element)
+        children = element.children.flat_map do |child|
+          if block?(child)
+            element_to_node(child)
+          elsif inline?(child)
+            element_to_inline(child)
+          else
+            next if child.text.strip == ''
+
+            element_to_texts(child)
+          end
+        end.compact
+
+        children << { text: '' } if children.empty? && type != 'image'
+
+        node = {
+          children: children,
+          type: type
+        }
+
+        type.is_a?(Proc) ? type.call(node, element) : node
+      end
+
+      def element_to_inline(element)
+        type = convert_name_to_type(element)
+        nodes = element.children.flat_map do |child|
+          element_to_texts(child)
+        end
+
+        {
+          children: nodes,
+          type: type
+        }
+      end
+
+      def element_to_texts(element)
+        nodes = []
+        mark = convert_name_to_mark(element.name)
+
+        if element.class == Nokogiri::XML::Element
+          element.children.each do |child|
+            nodes << element_to_text(child, mark)
+          end
+        else
+          nodes << element_to_text(element)
+        end
+
+        nodes
+      end
+
+      def element_to_text(element, mark = nil)
+        {
+          text: element.text
+        }.tap do |text|
+          [mark, convert_name_to_mark(element.name)].compact.each do |m|
+            text[m[:type].to_sym] = true
+          end
+        end
+      end
+
+      def convert_name_to_type(element)
+        type = [element.name, element.attributes['type']&.value].compact.join
+        elements[type.to_sym] || elements[:p]
+      end
+
+      def convert_name_to_mark(name)
+        type = mark_elements[name.to_sym]
+
+        return nil unless type
+
+        {
+          type: type
+        }
+      end
+
+      def block?(element)
+        block_elements.include?(element.name)
+      end
+
+      def inline?(element)
+        inline_elements.include?(element.name)
+      end
+
+      def empty_state
+        [
+          {
+            type: 'paragraph',
+            children: [
+              {
+                text: ''
+              }
+            ]
+          }
+        ] 
+      end
+
+      def serialize_node(node)
+        if node[:text]
+          node[:text]
+        else
+          children = node[:children].map { |n| serialize_node(n) }.join
+
+          element = ELEMENTS.find { |_, v| v == node[:type] }[0]
+          
+          if %i[ol1 ola].include?(element)
+            element = :ol
+          end
+
+          "<#{element}>#{children}</#{element}>"
+        end
+      end
+    end
+  end
+end

data/lib/slate_serializer/plain.rb

@@ -0,0 +1,69 @@
+module SlateSerializer
+  # Text  de- and serializer
+  class Plain
+    class << self
+      # Convert text to a Slate document
+      #
+      # @param text format [String] the text
+      # return [Hash] Slate document
+      def deserializer(text)
+        text = '' if text.nil?
+
+        lines = split_text_into_lines(text)
+        convert_lines_into_nodes(lines)
+      end
+
+      # Convert a Slate Document to plain text
+      #
+      # @param value format [Hash] the Slate document
+      # @param options format [Hash] options for the serializer, delimitter defaults to "\n"
+      # @return [String] plain text version of the Slate documnent
+      def serializer(value, options = {})
+        return '' unless value.is_a?(Array)
+
+        options[:delimiter] = "\n" unless options.key?(:delimiter)
+
+        value.map { |n| serialize_node(n, options) }.join(options[:delimiter])
+      end
+
+      private
+
+      def split_text_into_lines(text)
+        lines = text.strip.split("\n").map(&:strip)
+        blocks = []
+
+        loop do
+          index = lines.find_index('')
+          if index.nil?
+            blocks << lines.join("\n")
+            break
+          end
+
+          blocks << lines[0...index].join("\n")
+          lines.shift(index + 1)
+        end
+
+        blocks.length == 1 ? blocks : blocks.reject { |block| block == '' }
+      end
+
+      def convert_lines_into_nodes(lines)
+        lines.map do |line|
+          {
+            type: 'paragraph',
+            children: [
+              text: line
+            ]
+          }
+        end
+      end
+
+      def serialize_node(node, options)
+        if node[:text]
+          node[:text]
+        else
+          node[:children].map { |n| serialize_node(n, options) }.join(options[:delimiter])          
+        end
+      end
+    end
+  end
+end

data/lib/slate_serializer/version.rb

@@ -0,0 +1,3 @@
+module SlateSerializer
+  VERSION = '1.0.0'.freeze
+end

data/lib/slate_serializer.rb

@@ -0,0 +1,7 @@
+require 'slate_serializer/html'
+require 'slate_serializer/plain'
+require 'slate_serializer/version'
+
+# Main module
+module SlateSerializer
+end

data/slate_serializer.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slate_serializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lwe_slate_serializer'
+  spec.version       = SlateSerializer::VERSION
+  spec.authors       = ['Wesley Stam', 'Paul Crabtree']
+  spec.email         = ['wesley@stam.me', 'paul@learningwithexperts.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Serializer for Slate documents written in Ruby'
+  spec.homepage      = 'https://github.com/learningwithexperts/slate_serializer'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  #spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'nokogiri', '~> 1.11'
+  spec.add_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: lwe_slate_serializer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Wesley Stam
+- Paul Crabtree
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- wesley@stam.me
+- paul@learningwithexperts.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slate_serializer.rb
+- lib/slate_serializer/html.rb
+- lib/slate_serializer/plain.rb
+- lib/slate_serializer/version.rb
+- slate_serializer.gemspec
+homepage: https://github.com/learningwithexperts/slate_serializer
+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: []
+rubygems_version: 3.3.8
+signing_key:
+specification_version: 4
+summary: Serializer for Slate documents written in Ruby
+test_files: []