draftjs_html 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c112f9e968e0926060a82da8f7e2235bd96a5826b361c2748187b1e6fd9262f
-  data.tar.gz: f87a65d70de90ee9cb22c0b923cca42d24b5555b54402f292fd38a794fda0e18
+  metadata.gz: 570a70e02425c105494fa4abd36c9b51e1e667c4022446dbf83fa7c83b1e4d3d
+  data.tar.gz: b6be5723042425ce04408ec2b996f94b30ab289354829b78eafd3fbde7d17ed1
 SHA512:
-  metadata.gz: ccc0d1b85455ff2f17c501c2dd86c0535b22352e4b7558bc2a014072f2698b4a92a408f636ce1ae7aea6b1538e5b0cae1e4870ceb7ca2f87c80589560918348f
-  data.tar.gz: d2b011db33d20ab293bd709ef5cb96c8458a14753112df0b0f88d628404115cc477357bdaad493415fa6e03f000d326a672d255ed846e6985dd14e95b395538c
+  metadata.gz: 3a1f74891f8942d709dda34cc9d3f2893cba092d09ca797a02c796a75aa314b7966856d5f80564304dd9d45b75e0a0ce649d792e82399af8d8429b6362f3e343
+  data.tar.gz: 1ee7fe5a0df0073220a29acd055cf64ddfa988755c1ad53dd6f58822cad3ec7ffcff368fa8f89f3c972419b10a8b7a4e4a723466a9e5d37ca9bd7eecfe040e9e

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/node.rb

@@ -3,6 +3,14 @@ module DraftjsHtml
     def to_nokogiri(_document)
       node
     end
+
+    def wrap(tagname, attrs = {})
+      Node.new(tagname, attrs, self)
+    end
+
+    def to_s
+      node.to_s
+    end
   end
 
   StringNode = Struct.new(:raw) do
@@ -16,6 +24,14 @@ module DraftjsHtml
 
       Nokogiri::XML::NodeSet.new(document, text_nodes)
     end
+
+    def wrap(tagname, attrs = {})
+      Node.new(tagname, attrs, self)
+    end
+
+    def to_s
+      raw.to_s
+    end
   end
 
   Node = Struct.new(:element_name, :attributes, :content) do
@@ -30,9 +46,17 @@ module DraftjsHtml
 
     def to_nokogiri(document)
       Nokogiri::XML::Node.new(element_name, document).tap do |node|
-        node.content = content
+        node << content.to_nokogiri(document) if content
         (attributes || {}).each { |k, v| node[k] = v }
       end
     end
+
+    def wrap(tagname, attrs = {})
+      Node.new(tagname, attrs, self)
+    end
+
+    def to_s
+      content.to_s
+    end
   end
 end

data/lib/draftjs_html/to_html.rb

@@ -68,9 +68,10 @@ module DraftjsHtml
 
             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, content)
+                apply_styles_to(block_body, char_range.style_names, Node.of(content))
               end
             end
           end
@@ -82,6 +83,10 @@ module DraftjsHtml
 
     private
 
+    def squeeze_newlines(char_range)
+      char_range.text = @options[:newline_squeezer].call(char_range.text)
+    end
+
     def ensure_nesting_depth(block, body)
       new_wrapper_tag = BLOCK_TYPE_TO_HTML_WRAPPER[block.type]
       if body.parent.name != new_wrapper_tag
@@ -124,7 +129,7 @@ module DraftjsHtml
       content = char_range.text
       if entity
         style_fn = (@options[:entity_style_mappings][entity.type] || DEFAULT_ENTITY_STYLE_FN)
-        content = style_fn.call(entity, content, @document.parent)
+        content = style_fn.call(entity, Node.of(content), @document.parent)
       end
 
       content
@@ -147,6 +152,7 @@ module DraftjsHtml
     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[:newline_squeezer] = opts[:squeeze_newlines] ? ->(text) { text.gsub(/(\n|\r\n)+/, "\n") } : ->(text) { text }
       opts[:inline_style_mapping] = STYLE_MAP.merge(opts[:inline_style_mapping] || {}).transform_keys(&:to_s)
       opts[:inline_style_renderer] ||= ->(*) { nil }
       opts

data/lib/draftjs_html/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: draftjs_html
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - TJ Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-06 00:00:00.000000000 Z
+date: 2022-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri