draftjs_html 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e6d6f1d7f1c978841fe029f93f5db47688459ec70f2b33de5ed7c9cfa6d2758
-  data.tar.gz: 40ee34b8ba65efaf7c3c627046c06bd1e03c32547a17b111cfc661b7bd7a0a7f
+  metadata.gz: 4955cd2cbaade2ea9ae659cb65028e4097fb1d8d95d5058bc165e758f40e7794
+  data.tar.gz: 5bf0f0fbf4e6e73eb3da8b069fe536505a56db67cfed802c04baa2079a8641ff
 SHA512:
-  metadata.gz: 4427355fcb9c1578edc43d67c7fd04ba9c64001dae800996c7124938c0fe2c28d5e4da29e35fda0f2b4659656f829c62dd16b9e482a0e4b6fc780cffe8a1223c
-  data.tar.gz: 1277ff4825ce7a8bb972c4c0cbca2b3b0f440eceee3e6c00346b78b99d9bc900f8497f4a562b56d2cc8427b545418f578c64358d90618dcb7ce39fff5e196b43
+  metadata.gz: a36d06cdc9383a8c27d3d93c08fc59c4a022120aa9951cdf6e9774f0fc77f3e69439ea761a6765469b0f9a4c4879b76b216b465473894b35fbd7e57b5e5ff740
+  data.tar.gz: 16c84f495363d08c997b55de7f53b496d8f92760c936a755c1c1960d024bae7e9fb3235bcbcdb32d05649dc2668c16d4833577fce9b9861273a32f7cae33082a

data/README.md

@@ -77,6 +77,17 @@ HTML, it's also possible to return `Nokogiri::Node` objects or String objects.
 Specify the HTML generation encoding.
 Defaults to `UTF-8`.
 
+#### `squeeze_newlines`
+
+Often times, we'll get text in our blocks that will generate unexpected HTML.
+Most of this is caused by whitespace.
+You can use the `squeeze_newlines` option to collapse consecutive newline/CRLF characters to one, resulting in a single `<br>` tag.
+Defaults to `false`.
+
+```ruby
+
+```
+
 #### `:entity_style_mappings`
 
 Allows the author to specify special mapping functions for entities.
@@ -93,12 +104,11 @@ These may be overridden and appended to, like so:
 
 ```ruby
 DraftjsHtml.to_html(raw_draftjs, options: {
-  block_type_mapping: {
-    'unstyled' => 'span',
-  },
+  squeeze_newlines: true,
 })
 
-# This would generate <span> tags instead of <p> tags for "unstyled" DraftJS blocks.
+# Given a DraftJS block like: `{ text: 'Hi!\n\n\nWelcome to Westeros!\n\n\n'}`
+# This would generate `<p>Hi!<br>Welcome to Westeros!<br></p>`
 ```
 
 #### `:inline_style_mapping`

data/lib/draftjs_html/draftjs/block.rb

@@ -2,12 +2,13 @@
 
 module DraftjsHtml
   module Draftjs
-    Block = Struct.new(:key, :text, :type, :inline_style_ranges, :raw_entity_ranges, keyword_init: true) do
+    Block = Struct.new(:key, :text, :type, :depth, :inline_style_ranges, :raw_entity_ranges, keyword_init: true) do
       def self.parse(raw)
         new(
           key: raw['key'],
           text: raw['text'],
           type: raw['type'],
+          depth: raw['depth'],
           inline_style_ranges: Array(raw['inlineStyleRanges']),
           raw_entity_ranges: Array(raw['entityRanges']),
         )

data/lib/draftjs_html/html_defaults.rb

@@ -0,0 +1,50 @@
+module DraftjsHtml
+  module HtmlDefaults
+    BLOCK_TYPE_TO_HTML = {
+      'unstyled' => 'p',
+      'paragraph' => 'p',
+      'header-one' => 'h1',
+      'header-two' => 'h2',
+      'header-three' => 'h3',
+      'header-four' => 'h4',
+      'header-five' => 'h5',
+      'header-six' => 'h6',
+      'blockquote' => 'blockquote',
+      'code-block' => 'code',
+      'ordered-list-item' => 'li',
+      'unordered-list-item' => 'li',
+      'atomic' => 'figure',
+    }.freeze
+
+    STYLE_MAP = {
+      'BOLD' => 'b',
+      'ITALIC' => 'i',
+      'STRIKETHROUGH' => 'del',
+      'UNDERLINE' => 'u',
+    }.freeze
+
+    ENTITY_ATTRIBUTE_NAME_MAP = {
+      'className' => 'class',
+      'url' => 'href',
+    }.freeze
+
+    DEFAULT_ENTITY_STYLE_FN = ->(_entity, chars, _doc) { chars }
+
+    ENTITY_CONVERSION_MAP = {
+      'LINK' => ->(entity, content, *) {
+        attributes = entity.data.slice('url', 'rel', 'target', 'title', 'className').each_with_object({}) do |(attr, value), h|
+          h[ENTITY_ATTRIBUTE_NAME_MAP.fetch(attr, attr)] = value
+        end
+
+        DraftjsHtml::Node.new('a', attributes, content)
+      },
+      'IMAGE' => ->(entity, *) {
+        attributes = entity.data.slice('src', 'alt', 'className', 'width', 'height').each_with_object({}) do |(attr, value), h|
+          h[ENTITY_ATTRIBUTE_NAME_MAP.fetch(attr, attr)] = value
+        end
+
+        DraftjsHtml::Node.new('img', attributes)
+      }
+    }.freeze
+  end
+end

data/lib/draftjs_html/html_depth.rb

@@ -0,0 +1,65 @@
+module DraftjsHtml
+  # This class manages the depth and nesting of the myriad HTML tags generated by DraftjsHtml::ToHtml.
+  # It is intended to be a private implementation detail.
+  class HtmlDepth # :nodoc:
+    BLOCK_TYPE_TO_HTML_WRAPPER = {
+      'code-block' => 'pre',
+      'ordered-list-item' => 'ol',
+      'unordered-list-item' => 'ul',
+    }.freeze
+
+    attr_reader :body
+
+    def initialize(body)
+      @current_depth = 0
+      @body = body
+      @previous_parents = [body.parent]
+    end
+
+    def apply(block)
+      new_wrapper_tag = BLOCK_TYPE_TO_HTML_WRAPPER[block.type]
+      if body.parent.name != new_wrapper_tag || block.depth != @current_depth
+        if @current_depth < block.depth
+          push_depth(body, new_wrapper_tag)
+        elsif @current_depth > block.depth
+          pop_depth(body, times: @current_depth - block.depth)
+          pop_nesting(body) unless new_wrapper_tag
+        elsif new_wrapper_tag
+          push_nesting(body, new_wrapper_tag)
+        elsif @previous_parents.size > 1
+          pop_nesting(body)
+        end
+        @current_depth = block.depth
+      end
+    end
+
+    private
+
+    def push_depth(builder, tagname)
+      @previous_parents << builder.parent
+      builder.parent = builder.parent.last_element_child
+      push_nesting(builder, tagname)
+    end
+
+    def push_nesting(builder, tagname)
+      node = create_child(builder, tagname)
+      @previous_parents << builder.parent
+      builder.parent = node
+    end
+
+    def pop_depth(builder, times:)
+      times.times do
+        pop_nesting(builder)
+        pop_nesting(builder)
+      end
+    end
+
+    def pop_nesting(builder)
+      builder.parent = @previous_parents.pop
+    end
+
+    def create_child(builder, tagname)
+      builder.parent.add_child(builder.doc.create_element(tagname))
+    end
+  end
+end

data/lib/draftjs_html/node.rb

@@ -18,7 +18,7 @@ module DraftjsHtml
       lines = raw.lines
       text_nodes = lines.flat_map.with_index do |text, i|
         nodes = [Nokogiri::XML::Text.new(text.chomp, document)]
-        nodes << Nokogiri::XML::Node.new('br', document) if i < lines.size - 1
+        nodes << Nokogiri::XML::Node.new('br', document) if text.end_with?("\n")
         nodes
       end
 

data/lib/draftjs_html/overrideable_map.rb

@@ -0,0 +1,25 @@
+module DraftjsHtml
+  class OverrideableMap
+    def initialize(defaults = {})
+      @map = defaults.dup.transform_keys(&:to_s)
+    end
+
+    def with_overrides(overrides)
+      @map.merge!((overrides || {}).transform_keys(&:to_s))
+      self
+    end
+
+    def with_default(default)
+      @default = default
+      self
+    end
+
+    def value_of!(key)
+      @map.fetch(key.to_s)
+    end
+
+    def value_of(key)
+      @map.fetch(key.to_s, @default)
+    end
+  end
+end

data/lib/draftjs_html/to_html.rb

@@ -1,59 +1,14 @@
 require_relative 'node'
+require_relative 'html_depth'
+require_relative 'html_defaults'
+require_relative 'overrideable_map'
 
 module DraftjsHtml
   class ToHtml
-    BLOCK_TYPE_TO_HTML = {
-      'unstyled' => 'p',
-      'paragraph' => 'p',
-      'header-one' => 'h1',
-      'header-two' => 'h2',
-      'header-three' => 'h3',
-      'header-four' => 'h4',
-      'header-five' => 'h5',
-      'header-six' => 'h6',
-      'blockquote' => 'blockquote',
-      'code-block' => 'code',
-      'ordered-list-item' => 'li',
-      'unordered-list-item' => 'li',
-      'atomic' => 'figure',
-    }.freeze
-    BLOCK_TYPE_TO_HTML_WRAPPER = {
-      'code-block' => 'pre',
-      'ordered-list-item' => 'ol',
-      'unordered-list-item' => 'ul',
-    }.freeze
-    STYLE_MAP = {
-      'BOLD' => 'b',
-      'ITALIC' => 'i',
-      'STRIKETHROUGH' => 'del',
-      'UNDERLINE' => 'u',
-    }.freeze
-
-    DEFAULT_ENTITY_STYLE_FN = ->(_entity, chars, _doc) { chars }
-    ENTITY_ATTRIBUTE_NAME_MAP = {
-      'className' => 'class',
-      'url' => 'href',
-    }.freeze
-    ENTITY_CONVERSION_MAP = {
-      'LINK' => ->(entity, content, *) {
-        attributes = entity.data.slice('url', 'rel', 'target', 'title', 'className').each_with_object({}) do |(attr, value), h|
-          h[ENTITY_ATTRIBUTE_NAME_MAP.fetch(attr, attr)] = value
-        end
-
-        DraftjsHtml::Node.new('a', attributes, content)
-      },
-      'IMAGE' => ->(entity, *) {
-        attributes = entity.data.slice('src', 'alt', 'className', 'width', 'height').each_with_object({}) do |(attr, value), h|
-          h[ENTITY_ATTRIBUTE_NAME_MAP.fetch(attr, attr)] = value
-        end
-
-        DraftjsHtml::Node.new('img', attributes)
-      }
-    }.freeze
-
     def initialize(options)
       @options = ensure_options!(options)
       @document = Nokogiri::HTML::Builder.new(encoding: @options.fetch(:encoding, 'UTF-8'))
+      @html_depth = HtmlDepth.new(@document)
     end
 
     def convert(raw_draftjs)
@@ -61,13 +16,14 @@ module DraftjsHtml
 
       @document.html do |html|
         html.body do |body|
-          @previous_parent = body.parent
+          @previous_parents = [body.parent]
 
           draftjs.blocks.each do |block|
-            ensure_nesting_depth(block, body)
+            @html_depth.apply(block)
 
             body.public_send(block_element_for(block)) do |block_body|
               block.each_range do |char_range|
+                squeeze_newlines(char_range)
                 content = try_apply_entity_to(draftjs, char_range)
 
                 apply_styles_to(block_body, char_range.style_names, Node.of(content))
@@ -82,15 +38,8 @@ module DraftjsHtml
 
     private
 
-    def ensure_nesting_depth(block, body)
-      new_wrapper_tag = BLOCK_TYPE_TO_HTML_WRAPPER[block.type]
-      if body.parent.name != new_wrapper_tag
-        if new_wrapper_tag
-          push_nesting(body, new_wrapper_tag)
-        else
-          pop_nesting(body)
-        end
-      end
+    def squeeze_newlines(char_range)
+      char_range.text = @options[:newline_squeezer].call(char_range.text.chomp)
     end
 
     def apply_styles_to(html, style_names, child)
@@ -112,42 +61,33 @@ module DraftjsHtml
     def block_element_for(block)
       return 'br' if block.blank?
 
-      @options[:block_type_mapping].fetch(block.type)
+      @options[:block_type_mapping].value_of!(block.type)
     end
 
     def style_element_for(style)
-      @options[:inline_style_mapping][style]
+      @options[:inline_style_mapping].value_of!(style)
     end
 
     def try_apply_entity_to(draftjs, char_range)
       entity = draftjs.find_entity(char_range.entity_key)
       content = char_range.text
       if entity
-        style_fn = (@options[:entity_style_mappings][entity.type] || DEFAULT_ENTITY_STYLE_FN)
+        style_fn = @options[:entity_style_mappings].value_of(entity.type)
         content = style_fn.call(entity, Node.of(content), @document.parent)
       end
 
       content
     end
 
-    def push_nesting(builder, tagname)
-      node = create_child(builder, tagname)
-      @previous_parent = builder.parent
-      builder.parent = node
-    end
-
-    def pop_nesting(builder)
-      builder.parent = @previous_parent
-    end
-
-    def create_child(builder, tagname)
-      builder.parent.add_child(builder.doc.create_element(tagname))
-    end
-
     def ensure_options!(opts)
-      opts[:entity_style_mappings] = ENTITY_CONVERSION_MAP.merge(opts[:entity_style_mappings] || {}).transform_keys(&:to_s)
-      opts[:block_type_mapping] = BLOCK_TYPE_TO_HTML.merge(opts[:block_type_mapping] || {})
-      opts[:inline_style_mapping] = STYLE_MAP.merge(opts[:inline_style_mapping] || {}).transform_keys(&:to_s)
+      opts[:entity_style_mappings] = OverrideableMap.new(HtmlDefaults::ENTITY_CONVERSION_MAP)
+        .with_overrides(opts[:entity_style_mappings])
+        .with_default(HtmlDefaults::DEFAULT_ENTITY_STYLE_FN)
+      opts[:block_type_mapping] = OverrideableMap.new(HtmlDefaults::BLOCK_TYPE_TO_HTML)
+        .with_overrides(opts[:block_type_mapping])
+      opts[:newline_squeezer] = opts[:squeeze_newlines] ? ->(text) { text.gsub(/(\n|\r\n)+/, "\n") } : ->(text) { text }
+      opts[:inline_style_mapping] = OverrideableMap.new(HtmlDefaults::STYLE_MAP)
+        .with_overrides(opts[:inline_style_mapping])
       opts[:inline_style_renderer] ||= ->(*) { nil }
       opts
     end

data/lib/draftjs_html/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DraftjsHtml
-  VERSION = "0.7.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: draftjs_html
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - TJ Taylor
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-07 00:00:00.000000000 Z
+date: 2022-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -65,7 +65,10 @@ files:
 - lib/draftjs_html/draftjs/entity.rb
 - lib/draftjs_html/draftjs/entity_map.rb
 - lib/draftjs_html/draftjs/to_raw.rb
+- lib/draftjs_html/html_defaults.rb
+- lib/draftjs_html/html_depth.rb
 - lib/draftjs_html/node.rb
+- lib/draftjs_html/overrideable_map.rb
 - lib/draftjs_html/to_html.rb
 - lib/draftjs_html/version.rb
 homepage: https://github.com/dugancathal/draftjs_html
@@ -75,7 +78,7 @@ metadata:
   homepage_uri: https://github.com/dugancathal/draftjs_html
   source_code_uri: https://github.com/dugancathal/draftjs_html
   changelog_uri: https://github.com/dugancathal/draftjs_html/tree/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -90,8 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A tool for converting DraftJS JSON to HTML (and back again)
 test_files: []