draftjs_html 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b5496551a743763154bdec10a56591d3369eb6361c863ebc0e2defd95dd539e
-  data.tar.gz: 714eb86046e0008bc944a18edcb4137ec5034401c9a5df7e02140a7b634289c7
+  metadata.gz: 84ac3de7f21860685dbf39a24fb921227a1ccce6d97940acd279976daab15970
+  data.tar.gz: 2d3511eef3134a6cc01cd3da0147b3c347209c6c90ef4f5aaea90c681af979b1
 SHA512:
-  metadata.gz: a90d95f982a2bc56c1ab87326aa9226229ed8676920cd26c01f6cf3711910f85405c802fb8c707bec1ecae16b6d86dcd750dd92c9bab2fb7dafd158ddeaa7ecb
-  data.tar.gz: 7232b75cb4d677c5cc9ea3e38e5d605a4d3d7bde1ec7842405b025e21fa2d5145a2317eebb1a72f88a0555c63123bb660c695750b2111ac60ec9fb5b27875a2d
+  metadata.gz: 2775eac524063149973d4908f9f30f5e9a4d6b734f35e44b459454a95cc6a415a25a1b36daf07af3b34b1bf08b2b96c2980e6be12a9b21ed23c162100688ad03
+  data.tar.gz: dd0c42f5271934a1a17452159e7dbad8b51bd4ad0637a9b87cf4c77b43c6ea690bdda838830d92b1fcd929e985d88958fa5bd5326af89dc3e9db76e7e84a5fe2

data/README.md

@@ -127,6 +127,20 @@ DraftjsHtml.to_html(raw_draftjs, options: {
 # This would generate <strong> tags instead of <b> tags around ranges of `BOLD` inline styles.
 ```
 
+You may also add attributes to tags created by `inline_style_mapping`s by using a two element array.
+The first element should be the tagname and the second argument a hash of attributes to values, like this:
+
+```ruby
+
+DraftjsHtml.to_html(raw_draftjs, options: {
+  inline_style_mapping: {
+    'BOLD' => ['strong', style: 'font-weight: 900'],
+  },
+})
+```
+
+# This would generate <strong> tags instead of <b> tags around ranges of `BOLD` inline styles.
+
 #### `:inline_style_renderer`
 
 If the direct mapping from `:inline_style_mapping` isn't enough, you can supply a custom function for rendering a style range.

data/lib/draftjs_html/from_html/char_list.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+require 'set'
+
+module DraftjsHtml
+  class FromHtml < Nokogiri::XML::SAX::Document
+    class CharList
+      module FinishableRange
+        def range
+          start..finish
+        end
+
+        def try_finish(index)
+          self[:finish] ||= index
+        end
+      end
+
+      Char = Struct.new(:it, :styles, :entity, :atomic, keyword_init: true) do
+        def atomic?
+          self.atomic
+        end
+
+        def styles
+          self[:styles] ||= Set.new
+        end
+      end
+
+      EntityRange = Struct.new(:entity, :start, :finish, keyword_init: true) do
+        include FinishableRange
+      end
+
+      StyleRange = Struct.new(:style, :start, :finish, keyword_init: true) do
+        include FinishableRange
+      end
+
+      attr_reader :chars
+
+      def initialize(initial = [])
+        @chars = initial.dup
+      end
+
+      def append(str, styles: Set.new, entity: nil)
+        @chars << Char.new(it: "\n") if @chars.last&.atomic?
+
+        @chars += str.chars.map { Char.new(it: _1, styles: Set.new(styles), entity: entity) }
+      end
+
+      def append_char(char)
+        @chars << char
+      end
+
+      def text
+        @chars.map(&:it).join
+      end
+
+      def size
+        @chars.size
+      end
+
+      def any?
+        size > 0
+      end
+
+      def atomic?
+        @chars.any? && @chars.all?(&:atomic?)
+      end
+
+      def each_line
+        return to_enum(:each_line) unless block_given?
+
+        line = self.class.new
+        chars.each do |c|
+          if c.it == "\n"
+            yield  line
+            line = self.class.new
+            next
+          end
+
+          line.append_char(c)
+        end
+
+        yield line if line.any?
+      end
+
+      def apply_entity(range, entity)
+        @chars[range].each { _1.entity = entity }
+      end
+
+      def append_atomic_entity(entity)
+        append("\n") if @chars.any?
+        append_char(Char.new(it: ' ', atomic: true, entity: entity))
+      end
+
+      def append_styles(range, styles)
+        @chars[range].each { _1.styles += Array(styles) }
+      end
+
+      def +(other)
+        self.class.new(@chars + other.chars)
+      end
+
+      def entity_ranges
+        current_entity = nil
+
+        entity_ranges = @chars.each_with_object(Array.new).with_index do |(char, ranges), i|
+          next if char.entity == current_entity
+
+          current_entity = char.entity
+          ranges.last&.try_finish(i - 1)
+          ranges << EntityRange.new(entity: char.entity, start: i) if char.entity
+        end
+
+        entity_ranges.last&.try_finish(@chars.size - 1)
+        entity_ranges
+      end
+
+      def style_ranges
+        style_ranges = @chars.each_with_object({}).with_index do |(char, ranges_by_style), i|
+          char.styles.each do |style|
+            ranges_by_style[style] ||= []
+            if i > 0 && @chars[i-1].styles.include?(style)
+              ranges_by_style[style].last << i
+            else
+              ranges_by_style[style] << [i]
+            end
+          end
+        end
+
+        style_ranges.flat_map do |style, ranges|
+          ranges.map do |range|
+            StyleRange.new(style: style, start: range.first, finish: range.last)
+          end
+        end
+      end
+
+      private
+
+      def find_overlapping_styles(descriptors)
+        descriptors.select do |candidate_a|
+          candidate_range = candidate_a[:start]..candidate_a[:finish]
+          (descriptors - [candidate_a]).any? do |other|
+            other_range = other[:start]..other[:finish]
+            range_overlaps?(candidate_range, other_range)
+          end
+        end
+      end
+
+      def range_overlaps?(candidate_range, other_range)
+        other_range.begin == candidate_range.begin || candidate_range.cover?(other_range.begin) || other_range.cover?(candidate_range.begin)
+      end
+    end
+  end
+end

data/lib/draftjs_html/from_html/depth_stack.rb

@@ -5,7 +5,7 @@ module DraftjsHtml
         @stack = []
         @nodes = []
         @list_depth = -1
-        @style_stack = StyleStack.new
+        @active_styles = []
       end
 
       def push(tagname, attrs)
@@ -26,8 +26,7 @@ module DraftjsHtml
           @nodes.pop
         end
         blocks.reverse_each do |pending_block|
-          pending_block.flush_to(draftjs, @style_stack)
-          pending_block.apply_entities_to(draftjs)
+          pending_block.flush_to(draftjs)
         end
         @list_depth -= 1
       end
@@ -59,34 +58,35 @@ module DraftjsHtml
           next unless user_created_entity
 
           if content == '' && !user_created_entity[:atomic]
-            current.text_buffer << ' '
-            range = range.begin..(range.end+1)
+            current.text_buffer.append(' ', entity: user_created_entity)
+          elsif content == '' && user_created_entity[:atomic]
+            current.text_buffer.append_atomic_entity(user_created_entity)
+          else
+            current.text_buffer.apply_entity(range, user_created_entity)
           end
-          current.entities << user_created_entity.merge(start: range.begin, finish: range.end)
         end
       end
 
       def style_start(tagname)
-        @style_stack.track_start(tagname, current_character_offset + 1)
+        @active_styles += [DraftjsHtml::HtmlDefaults::HTML_STYLE_TAGS_TO_STYLE[tagname]]
       end
 
       def style_end(tagname)
-        @style_stack.track_end(tagname, current_character_offset)
+        @active_styles.delete_at(@active_styles.index(DraftjsHtml::HtmlDefaults::HTML_STYLE_TAGS_TO_STYLE[tagname]))
       end
 
       def flush_to(draftjs)
-        current.flush_to(draftjs, @style_stack)
-        current.apply_entities_to(draftjs)
+        current.flush_to(draftjs)
       end
 
       def append_text(chars)
-        current.text_buffer << chars unless chars.empty?
+        current.text_buffer.append(chars, styles: @active_styles) unless chars.empty?
       end
 
       private
 
       def current_text_buffer
-        current.text_buffer.join
+        current.text_buffer.text
       end
 
       def current_character_offset

data/lib/draftjs_html/from_html/pending_block.rb

@@ -6,7 +6,7 @@ module DraftjsHtml
           tagname: name,
           attrs: attrs,
           entities: [],
-          chars: [],
+          chars: CharList.new,
           pending_entities: [],
           depth: depth,
           parent_tagnames: parent_tagnames,
@@ -17,12 +17,8 @@ module DraftjsHtml
         self[:chars]
       end
 
-      def clear_text_buffer
-        self[:chars] = []
-      end
-
       def character_offset
-        text_buffer.join.length - 1
+        text_buffer.size - 1
       end
 
       def flushable?
@@ -36,31 +32,21 @@ module DraftjsHtml
         self.entities += other_pending_block.entities
       end
 
-      def flush_to(draftjs, styles)
+      def flush_to(draftjs)
         if text_buffer.any?
-          chars.join.lines.each do |line|
-            draftjs.typed_block(block_name, line.chomp, depth: [depth, 0].max)
-          end
-
-          styles.each do |descriptor|
-            finish = descriptor[:finish] || character_offset
-            draftjs.inline_style(descriptor[:style], descriptor[:start]..finish)
-          end
-        end
+          text_buffer.each_line do |line|
+            block_type = line.atomic? ? 'atomic' : block_name
+            draftjs.typed_block(block_type, line.text, depth: [depth, 0].max)
 
-        clear_text_buffer
-        styles.clear_finished
-      end
+            line.entity_ranges.each do |entity_range|
+              entity = entity_range.entity
+              draftjs.apply_entity entity[:type], entity_range.range, data: entity[:data], mutability: entity.fetch(:mutability, 'IMMUTABLE')
+            end
 
-      def apply_entities_to(draftjs)
-        Array(entities).each do |entity|
-          range = entity[:start]..entity[:finish]
-          if entity[:atomic]
-            draftjs.typed_block('atomic', ' ', depth: [depth, 0].max)
-            range = 0..0
+            line.style_ranges.each do |style_range|
+              draftjs.inline_style(style_range.style, style_range.range)
+            end
           end
-
-          draftjs.apply_entity entity[:type], range, data: entity[:data], mutability: entity.fetch(:mutability, 'IMMUTABLE')
         end
       end
 

data/lib/draftjs_html/from_html.rb

@@ -1,9 +1,9 @@
 require 'stringio'
 require_relative 'html_defaults'
 require_relative 'from_html/elements'
-require_relative 'from_html/style_stack'
 require_relative 'from_html/pending_block'
 require_relative 'from_html/depth_stack'
+require_relative 'from_html/char_list'
 
 module DraftjsHtml
   class FromHtml < Nokogiri::XML::SAX::Document

data/lib/draftjs_html/html_defaults.rb

@@ -29,7 +29,10 @@ module DraftjsHtml
       'code' => 'CODE',
     }.freeze
 
-    STYLE_MAP = HTML_STYLE_TAGS_TO_STYLE.invert.freeze
+    STYLE_MAP = HTML_STYLE_TAGS_TO_STYLE.invert.merge(
+      'HIGHLIGHT' => 'em',
+      'RTL' => ['div', dir: 'rtl']
+    ).freeze
 
     ENTITY_ATTRIBUTE_NAME_MAP = {
       'className' => 'class',

data/lib/draftjs_html/to_html.rb

@@ -49,7 +49,8 @@ module DraftjsHtml
       return append_child(html, custom_render_content) if custom_render_content
 
       style, *rest = style_names
-      html.public_send(style_element_for(style)) do |builder|
+
+      html.public_send(*style_element_for(style)) do |builder|
         apply_styles_to(builder, rest, child)
       end
     end
@@ -78,7 +79,7 @@ module DraftjsHtml
     end
 
     def style_element_for(style)
-      @options[:inline_style_mapping].value_of!(style)
+      Array(@options[:inline_style_mapping].value_of!(style))
     end
 
     def try_apply_entity_to(draftjs, char_range)

data/lib/draftjs_html/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: draftjs_html
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.22.0
 platform: ruby
 authors:
 - TJ Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -68,10 +68,10 @@ files:
 - lib/draftjs_html/draftjs/raw_builder.rb
 - lib/draftjs_html/draftjs/to_raw.rb
 - lib/draftjs_html/from_html.rb
+- lib/draftjs_html/from_html/char_list.rb
 - lib/draftjs_html/from_html/depth_stack.rb
 - lib/draftjs_html/from_html/elements.rb
 - lib/draftjs_html/from_html/pending_block.rb
-- lib/draftjs_html/from_html/style_stack.rb
 - lib/draftjs_html/html_defaults.rb
 - lib/draftjs_html/html_depth.rb
 - lib/draftjs_html/node.rb
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: A tool for converting DraftJS JSON to HTML (and back again)

data/lib/draftjs_html/from_html/style_stack.rb

@@ -1,50 +0,0 @@
-module DraftjsHtml
-  class FromHtml < Nokogiri::XML::SAX::Document
-    class StyleStack
-      def initialize
-        @stack = []
-      end
-
-      def clear_finished
-        @stack.delete_if { !!_1[:finish] }
-      end
-
-      def each(&block)
-        @stack.reverse_each.group_by { _1[:tagname] }.each do |_, descriptors|
-          overlapping_ranges = find_overlapping_styles(descriptors)
-          widest_descriptor = overlapping_ranges.max_by { (_1[:start].._1[:finish]).size }
-
-          applicable_styles = descriptors - overlapping_ranges + [widest_descriptor].compact
-          applicable_styles.each(&block)
-        end
-      end
-
-      def track_start(tagname, current_character_offset)
-        style = DraftjsHtml::HtmlDefaults::HTML_STYLE_TAGS_TO_STYLE[tagname]
-        @stack.unshift({ tagname: tagname, style: style, start: current_character_offset })
-      end
-
-      def track_end(tagname, current_character_offset)
-        descriptor_index = @stack.find_index { _1[:tagname] == tagname && !_1[:finish] }
-        descriptor = @stack[descriptor_index]
-        descriptor[:finish] = current_character_offset
-      end
-
-      private
-
-      def find_overlapping_styles(descriptors)
-        descriptors.select do |candidate_a|
-          candidate_range = candidate_a[:start]..candidate_a[:finish]
-          (descriptors - [candidate_a]).any? do |other|
-            other_range = other[:start]..other[:finish]
-            range_overlaps?(candidate_range, other_range)
-          end
-        end
-      end
-
-      def range_overlaps?(candidate_range, other_range)
-        other_range.begin == candidate_range.begin || candidate_range.cover?(other_range.begin) || other_range.cover?(candidate_range.begin)
-      end
-    end
-  end
-end