draftjs_exporter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8d59bea7ea1b40766a3e78d33535290d288026b
-  data.tar.gz: 96f8e16bfede94708c613c5205fc6450d22f428e
+  metadata.gz: 09a55e5243dc77a0e6b9711abced8fd26cab0776
+  data.tar.gz: d0f789f42a140cfcc4bd92bd8f1aa653bd2e033a
 SHA512:
-  metadata.gz: 0133625911008a1a5f663dc5356dd47c54c9fc3abd097ab6f6f52f770a89fd89c4f329827d24e416c83988f29acbd9abafc471fac1e08717c23e5f6eeeed43e4
-  data.tar.gz: 4b6ca1fed16749d841f3ad4b58af395bb927a12ad5cf88b869a26901635a93c70f6042358b841c322f0311430d69c152a40685c55548dd891ef6c83c4bf9275b
+  metadata.gz: 5bf865cb2d2a3a1305e13698800d028c38695a694212cdd5534eb1bdeef4a40c04dadbaa5f1bfbc913f022cb64555a9ef864aa26e06a346b78afcb7be275061a
+  data.tar.gz: 565b824cbd6355dd65bef816aa553dca4ca9562b9981557594145bb8f797fb31b67221b97d0eefeeeb12370f322ece790e4538374d707af852a0ac8913b0f754

data/lib/draftjs_exporter/entity_state.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 require 'draftjs_exporter/entities/null'
+require 'draftjs_exporter/error'
 
 module DraftjsExporter
+  class InvalidEntity < DraftjsExporter::Error; end
+
   class EntityState
     attr_reader :entity_decorators, :entity_map, :entity_stack, :root_element
 
@@ -40,7 +43,7 @@ module DraftjsExporter
       _element, expected_entity_details = entity_stack.last
 
       if expected_entity_details != entity_details
-        raise "Invalid entity. Expected #{expected_entity_details.inspect} got #{entity_details.inspect}"
+        raise InvalidEntity, "Expected #{expected_entity_details.inspect} got #{entity_details.inspect}"
       end
 
       entity_stack.pop

data/lib/draftjs_exporter/error.rb

@@ -0,0 +1,3 @@
+module DraftjsExporter
+  class Error < StandardError; end
+end

data/lib/draftjs_exporter/html.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'nokogiri'
+require 'draftjs_exporter/wrapper_state'
 require 'draftjs_exporter/entity_state'
 require 'draftjs_exporter/style_state'
 require 'draftjs_exporter/command'
@@ -15,23 +16,17 @@ module DraftjsExporter
     end
 
     def call(content_state)
-      content_state.fetch(:blocks, []).map { |block|
-        content_state_block(block, content_state.fetch(:entityMap, {}))
-      }.inject(:+)
+      wrapper_state = WrapperState.new(block_map)
+      content_state.fetch(:blocks, []).each do |block|
+        element = wrapper_state.element_for(block)
+        entity_map = content_state.fetch(:entityMap, {})
+        block_contents(element, block, entity_map)
+      end
+      wrapper_state.to_s
     end
 
     private
 
-    def content_state_block(block, entity_map)
-      document = Nokogiri::HTML::Document.new
-      fragment = Nokogiri::HTML::DocumentFragment.new(document)
-      type = block.fetch(:type, 'unstyled')
-      element = document.create_element(*block_options(type)) { |e|
-        block_contents(e, block, entity_map)
-      }
-      fragment.add_child(element).to_s
-    end
-
     def block_contents(element, block, entity_map)
       style_state = StyleState.new(style_map)
       entity_state = EntityState.new(element, entity_decorators, entity_map)
@@ -45,18 +40,6 @@ module DraftjsExporter
       end
     end
 
-    def block_options(type)
-      options = block_map.fetch(type)
-      return [options.fetch(:element)] unless options.key?(:wrapper)
-
-      wrapper = options.fetch(:wrapper)
-      name = wrapper[0]
-      config = wrapper[1] || {}
-      options = {}
-      options[:class] = config.fetch(:className) if config.key?(:className)
-      [name, options]
-    end
-
     def add_node(element, text, state)
       document = element.document
       node = if state.text?

data/lib/draftjs_exporter/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module DraftjsExporter
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/lib/draftjs_exporter/wrapper_state.rb

@@ -0,0 +1,70 @@
+module DraftjsExporter
+  class WrapperState
+    def initialize(block_map)
+      @block_map = block_map
+      @document = Nokogiri::HTML::Document.new
+      @fragment = Nokogiri::HTML::DocumentFragment.new(document)
+      reset_wrapper
+    end
+
+    def element_for(block)
+      type = block.fetch(:type, 'unstyled')
+      document.create_element(block_options(type)).tap do |e|
+        parent_for(type).add_child(e)
+      end
+    end
+
+    def to_s
+      fragment.to_s
+    end
+
+    private
+
+    attr_reader :fragment, :document, :block_map, :wrapper
+
+    def set_wrapper(element, options = {})
+      @wrapper = [element, options]
+    end
+
+    def wrapper_element
+      @wrapper[0] || fragment
+    end
+
+    def wrapper_options
+      @wrapper[1]
+    end
+
+    def parent_for(type)
+      options = block_map.fetch(type)
+      return reset_wrapper unless options.key?(:wrapper)
+
+      new_options = nokogiri_options(*options.fetch(:wrapper))
+      return wrapper_element if new_options == wrapper_options
+
+      create_wrapper(new_options)
+    end
+
+    def reset_wrapper
+      set_wrapper(fragment)
+      wrapper_element
+    end
+
+    def nokogiri_options(element_name, element_attributes)
+      config = element_attributes || {}
+      options = {}
+      options[:class] = config.fetch(:className) if config.key?(:className)
+      [element_name, options]
+    end
+
+    def block_options(type)
+      block_map.fetch(type).fetch(:element)
+    end
+
+    def create_wrapper(options)
+      document.create_element(*options).tap do |new_element|
+        reset_wrapper.add_child(new_element)
+        set_wrapper(new_element, options)
+      end
+    end
+  end
+end

data/spec/integrations/html_spec.rb

@@ -24,55 +24,181 @@ RSpec.describe DraftjsExporter::HTML do
   end
 
   describe '#call' do
-    it 'decodes the content_state to html' do
-      input = {
-        entityMap: {
-          '0' => {
-            type: 'LINK',
-            mutability: 'MUTABLE',
-            data: {
-              url: 'http://example.com'
+    context 'with different blocks' do
+      it 'decodes the content_state to html' do
+        input = {
+          entityMap: {},
+          blocks: [
+            {
+              key: '5s7g9',
+              text: 'Header',
+              type: 'header-one',
+              depth: 0,
+              inlineStyleRanges: [],
+              entityRanges: []
+            },
+            {
+              key: 'dem5p',
+              text: 'some paragraph text',
+              type: 'unstyled',
+              depth: 0,
+              inlineStyleRanges: [],
+              entityRanges: []
+            }
+          ]
+        }
+
+        expected_output = <<-OUTPUT.strip
+<h1>Header</h1><div>some paragraph text</div>
+        OUTPUT
+
+        expect(mapper.call(input)).to eq(expected_output)
+      end
+    end
+
+    context 'with inline styles' do
+      it 'decodes the content_state to html' do
+        input = {
+          entityMap: {},
+          blocks: [
+            {
+              key: 'dem5p',
+              text: 'some paragraph text',
+              type: 'unstyled',
+              depth: 0,
+              inlineStyleRanges: [
+                {
+                  offset: 0,
+                  length: 4,
+                  style: 'ITALIC'
+                }
+              ],
+              entityRanges: []
+            }
+          ]
+        }
+
+        expected_output = <<-OUTPUT.strip
+<div>
+<span style="fontStyle: italic;">some</span> paragraph text</div>
+        OUTPUT
+
+        expect(mapper.call(input)).to eq(expected_output)
+      end
+    end
+
+    context 'with entities' do
+      it 'decodes the content_state to html' do
+        input = {
+          entityMap: {
+            '0' => {
+              type: 'LINK',
+              mutability: 'MUTABLE',
+              data: {
+                url: 'http://example.com'
+              }
             }
-          }
-        },
-        blocks: [
-          {
-            key: '5s7g9',
-            text: 'Header',
-            type: 'header-one',
-            depth: 0,
-            inlineStyleRanges: [],
-            entityRanges: []
           },
-          {
-            key: 'dem5p',
-            text: 'some paragraph text',
-            type: 'unstyled',
-            depth: 0,
-            inlineStyleRanges: [
-              {
-                offset: 0,
-                length: 4,
-                style: 'ITALIC'
+          blocks: [
+            {
+              key: 'dem5p',
+              text: 'some paragraph text',
+              type: 'unstyled',
+              depth: 0,
+              inlineStyleRanges: [],
+              entityRanges: [
+                {
+                  offset: 5,
+                  length: 9,
+                  key: 0
+                }
+              ]
+            }
+          ]
+        }
+
+        expected_output = <<-OUTPUT.strip
+<div>some <a href="http://example.com">paragraph</a> text</div>
+        OUTPUT
+
+        expect(mapper.call(input)).to eq(expected_output)
+      end
+
+      it 'throws an error if entities cross over' do
+        input = {
+          entityMap: {
+            '0' => {
+              type: 'LINK',
+              mutability: 'MUTABLE',
+              data: {
+                url: 'http://foo.example.com'
               }
-            ],
-            entityRanges: [
-              {
-                offset: 5,
-                length: 9,
-                key: 0
+            },
+            '1' => {
+              type: 'LINK',
+              mutability: 'MUTABLE',
+              data: {
+                url: 'http://bar.example.com'
               }
-            ]
-          }
-        ]
-      }
+            }
+          },
+          blocks: [
+            {
+              key: 'dem5p',
+              text: 'some paragraph text',
+              type: 'unstyled',
+              depth: 0,
+              inlineStyleRanges: [],
+              entityRanges: [
+                {
+                  offset: 5,
+                  length: 9,
+                  key: 0
+                },
+                {
+                  offset: 2,
+                  length: 9,
+                  key: 1
+                }
+              ]
+            }
+          ]
+        }
+
+        expect { mapper.call(input) }.to raise_error(DraftjsExporter::InvalidEntity)
+      end
+    end
+
+    context 'with wrapped blocks' do
+      it 'decodes the content_state to html' do
+        input = {
+          entityMap: {},
+          blocks: [
+            {
+              key: 'dem5p',
+              text: 'item1',
+              type: 'unordered-list-item',
+              depth: 0,
+              inlineStyleRanges: [],
+              entityRanges: []
+            },
+            {
+              key: 'dem5p',
+              text: 'item2',
+              type: 'unordered-list-item',
+              depth: 0,
+              inlineStyleRanges: [],
+              entityRanges: []
+            }
+          ]
+        }
 
-      expected_output = <<-OUTPUT.strip
-<h1>Header</h1><div>
-<span style="fontStyle: italic;">some</span> <a href="http://example.com">paragraph</a> text</div>
-      OUTPUT
+        expected_output = <<-EOS.strip
+<ul class="public-DraftStyleDefault-ul">\n<li>item1</li>\n<li>item2</li>\n</ul>
+EOS
 
-      expect(mapper.call(input)).to eq(expected_output)
+        expect(mapper.call(input)).to eq(expected_output)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: draftjs_exporter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Theo Cushion
@@ -126,9 +126,11 @@ files:
 - lib/draftjs_exporter/entities/link.rb
 - lib/draftjs_exporter/entities/null.rb
 - lib/draftjs_exporter/entity_state.rb
+- lib/draftjs_exporter/error.rb
 - lib/draftjs_exporter/html.rb
 - lib/draftjs_exporter/style_state.rb
 - lib/draftjs_exporter/version.rb
+- lib/draftjs_exporter/wrapper_state.rb
 - spec/integrations/html_spec.rb
 - spec/integrations/requires_spec.rb
 - spec/spec_helper.rb
@@ -152,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Export Draft.js content state into HTML