slate_serializer 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd6b813d519bd321d72ec19a4c80d3cc8ac0532baf90fdcd1185024c95d119bb
-  data.tar.gz: 7e88e166f5626372712d92e8a77ec888f3b5b5c09bd7ef2290a7ff2029ef1d56
+  metadata.gz: 4e0d368c4f9ece2f7c15b7c102c0acc49b1fe67f4e9cc3d1922ab7d7b699f3ce
+  data.tar.gz: 3d07a16a0b6d42a4f28bd57345f8292768d1ac0724ffdd74f7b0f96d6471c47c
 SHA512:
-  metadata.gz: 62d37fcfe447100f78f57b22d68ce1b7a934d706f93113a26ed08205f424f92a4390445e60af3a89365af07b02a800a9193ccba4f57d98f3ec71f83ce4f316e7
-  data.tar.gz: cd516e95d3798be0add160af27bfe7dc263c25b5f03e00dff5235b7626a8e1f45707e0b0db802ab0545a931b0bf1e3fd2a60aa2c1ead4ef871d880f54c514177
+  metadata.gz: dd6041f7ff0b33d392cd91433cd30218c46c96d1de2c5567c87cc7b69ca6f268a3572d6212a0d31d5323be78293feaaf021eb645cdc552f8b865f58d0d2c6d14
+  data.tar.gz: 5404eae54b4fe2db6c2037c26c32cd9ac86d12056141df8eab73a0eb7b3a04a46565bdc9ca5693b3bd0db35d37f19dfd6bbca56de5c02dc4ba219a60e0a49910

data/.ruby-version

@@ -1 +1 @@
-2.6.2
+3.0.0

data/Gemfile.lock

@@ -1,39 +1,41 @@
 PATH
   remote: .
   specs:
-    slate_serializer (0.2.0)
-      nokogiri (~> 1.10)
+    slate_serializer (0.5.1)
+      nokogiri (~> 1.11)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    mini_portile2 (2.4.0)
-    nokogiri (1.10.3)
-      mini_portile2 (~> 2.4.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    diff-lcs (1.4.4)
+    mini_portile2 (2.5.1)
+    nokogiri (1.11.5)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    racc (1.5.2)
+    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.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
-  rake (~> 10.0)
+  bundler (~> 2.2)
+  rake (~> 13.0)
   rspec (~> 3.0)
   slate_serializer!
 
 BUNDLED WITH
-   1.17.2
+   2.2.3

data/README.md

@@ -27,7 +27,7 @@ To convert between plain text and Slate document use:
 
 To convert between html and Slate document use:
 
-    $ SlateSerializer::Html.deserializer(text) => { document: {...}}
+    $ SlateSerializer::Html.deserializer(html) => { document: {...}}
 
 ## Contributing
 

data/lib/slate_serializer/html.rb

@@ -10,6 +10,7 @@ module SlateSerializer
       'li': 'list-item',
       'p': 'paragraph',
       'div': 'paragraph',
+      'ol1': 'ordered-list',
       'ola': 'alpha-ordered-list',
       'ol': 'ordered-list',
       'ul': 'unordered-list',
@@ -17,10 +18,13 @@ module SlateSerializer
       'tbody': 'tbody',
       'tr': 'tr',
       'td': 'td',
-      'text': 'text'
+      'text': 'text',
+      'hr': 'hr',
+      'figure': 'figure',
+      'figcaption': 'figcaption'
     }.freeze
     # Default block types list
-    BLOCK_ELEMENTS = %w[img li p ol ul table tbody tr td].freeze
+    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
@@ -31,7 +35,7 @@ module SlateSerializer
     }.freeze
 
     class << self
-      # Convert html to a Slare document
+      # Convert html to a Slate document
       #
       # @param html format [String] the HTML
       # @param options [Hash]
@@ -60,6 +64,16 @@ module SlateSerializer
         }
       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.key?(:document)
+
+        serialize_node(value[:document])
+      end
+
       private
 
       attr_accessor :elements, :block_elements, :inline_elements, :mark_elements
@@ -68,8 +82,6 @@ module SlateSerializer
         type = convert_name_to_type(element)
 
         nodes = element.children.flat_map do |child|
-          next if child.text.strip == '' && child.type == 'img'
-
           if block?(child)
             element_to_node(child)
           elsif inline?(child)
@@ -81,7 +93,7 @@ module SlateSerializer
           end
         end.compact
 
-        nodes << { marks: [], object: 'text', text: '' } if nodes.empty?
+        nodes << { marks: [], object: 'text', text: '' } if nodes.empty? && type != 'image'
 
         {
           data: element.attributes.each_with_object({}) { |a, h| h[a[1].name] = a[1].value },
@@ -131,7 +143,7 @@ module SlateSerializer
 
       def convert_name_to_type(element)
         type = [element.name, element.attributes['type']&.value].compact.join
-        elements[type.to_sym]
+        elements[type.to_sym] || elements[:p]
       end
 
       def convert_name_to_mark(name)
@@ -175,6 +187,26 @@ module SlateSerializer
           }
         }
       end
+
+      def serialize_node(node)
+        if node[:object] == 'document'
+          node[:nodes].map { |n| serialize_node(n) }.join
+        elsif node[:object] == 'block'
+          children = node[:nodes].map { |n| serialize_node(n) }.join
+
+          element = ELEMENTS.find { |_, v| v == node[:type] }[0]
+          data = node[:data].map { |k, v| "#{k}=\"#{v}\"" }
+
+          if %i[ol1 ola].include?(element)
+            data << ["type=\"#{element.to_s[-1]}\""]
+            element = :ol
+          end
+
+          "<#{element}#{!data.empty? ? " #{data.join(' ')}" : ''}>#{children}</#{element}>"
+        else
+          node[:text]
+        end
+      end
     end
   end
 end

data/lib/slate_serializer/version.rb

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

data/slate_serializer.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'nokogiri', '~> 1.10'
-  spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slate_serializer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Wesley Stam
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-07-03 00:00:00.000000000 Z
+date: 2021-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - wesley@stam.me
 executables: []
@@ -92,7 +92,7 @@ homepage: https://github.com/wesleystam/slate_serializer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,8 +107,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Serializer for Slate documents written in Ruby
 test_files: []