draftjs_html 0.24.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c2703fb050f796abd4f8af851d16b654a2ab84f03e5f8865c92b373b2acfefa
-  data.tar.gz: eced6f85cfefd34f4c50c7fc383526675f26dd7c212a4f7de145721d254b1a28
+  metadata.gz: 9fe4601ed10ebae8924fe906ffad4cd56bebf7867ec80182876ad0a1b5a3b739
+  data.tar.gz: 5d14c45c7192c936fbbe524a72c4886acddaf20f1f2dff5ccf9c1ce3d8de8a5f
 SHA512:
-  metadata.gz: 432d7b8900153f89f8ba506ded86208fe71a4b6b832911693059e0f57cb31b93412ef8fa5a40a8f7d857b370b65e8a523f29d0029dfa2ee8f917ebae2235827e
-  data.tar.gz: 69878d4330ef0d4947f1d95ed165720c0a59b8c0d54793d2e28aad8f5fea40754f95afacc1fc1a29c5b5b9f03e02399d9502924c7c580e7bc953b674f6292644
+  metadata.gz: 38f78c86afbac0244a8eb967be90c6b647001e6a3bbbe3a6648190a45ac9cbecc2359c45f1fee5f995ed9584d037b2c337b8e267dece3c38e15a16a4dde8b775
+  data.tar.gz: 249423024673740842728d7b5cb8ca4ef1aa9bec1ee521be4402e21d5d89afa7f36563232de9c6af62831ae9cac3768c654537d75a8dbb44e25735f4d2dc0ac1

data/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+#  schedule:
+#    - cron: '42 5 * * *'
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '3.0' ]
+
+    runs-on: ubuntu-latest
+    name: Ruby ${{matrix.ruby}}
+    container: ruby:${{matrix.ruby}}
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Show ruby Version
+      run: |
+        ruby -v
+
+    - name: Install Modules
+      run: |
+        ./bin/setup
+
+    - name: Run tests
+      run: |
+        rake spec
+
+

data/README.md

@@ -229,14 +229,43 @@ The callable should return a Hash with symbol keys. The supported values are:
 - `data` (optional, default `{}`)
   - an arbitrary data-bag (Hash) of entity data
 
-#### `:is_semantic_markup:`
+### Spec support
 
-Defaults to `true`.
+To make it easier to test our own code, we've developed a few RSpec matchers that
+make normalization and comparison of raw DraftJS use the RawBuilder DSL. To take
+advantage of this, you can (for RSpec only, currently) include the following in
+your `spec_helper`, or equivalent.
 
-By setting to `false`, the user is stating they want to treat `div` tags as semantic,
-block-level tags. In some markup (emails, for example), there are no semantic tags
-(read, no `p` tags), so the only indications of whitespace and structure come from
-`div` tags. This flag will flush content wrapped in a `div` as a DraftJS block. 
+```ruby
+require 'draftjs_html/spec_support/rspec'
+
+RSpec.configure do |config|
+  config.include DraftjsHtml::SpecSupport::RSpecMatchers
+end
+```
+
+Then, later in your tests, you can assert on raw DraftJS "json" like this:
+
+```ruby
+my_raw_draftjs_hash = { blocks: [{ key: 'a-random-uuid', text: 'Hi!' }], entityMap: {} }
+
+expect(my_raw_draftjs_hash).to eq_raw_draftjs {
+  text_block 'Hi!'
+}
+```
+
+This will normalize the `key` values and other IDs to make _actual_ differences
+easier to spot.
+
+There's also a matcher called `eq_raw_draftjs_ignoring_keys` that takes an explicit
+raw DraftJS hash on both sides.
+
+```ruby
+my_raw_draftjs_hash = { blocks: [{ key: 'a-random-uuid', text: 'Hi!' }], entityMap: {} }
+my_other_draftjs_hash = { blocks: [{ key: 'a-different-random-uuid', text: 'Hi!' }], entityMap: {} }
+
+expect(my_raw_draftjs_hash).to eq_raw_draftjs_ignoring_keys my_other_draftjs_hash
+```
 
 ## Development
 

data/lib/draftjs_html/from_html/char_list.rb

@@ -60,6 +60,10 @@ module DraftjsHtml
         size > 0
       end
 
+      def more_than_whitespace?
+        !text.match?(/^[[:space:]]*$/)
+      end
+
       def atomic?
         @chars.any? && @chars.all?(&:atomic?)
       end

data/lib/draftjs_html/from_html/depth_stack.rb

@@ -1,16 +1,16 @@
 module DraftjsHtml
   class FromHtml < Nokogiri::XML::SAX::Document
     class DepthStack
-      def initialize(is_semantic_markup: true)
+      def initialize(options)
         @stack = []
         @nodes = []
         @list_depth = -1
         @active_styles = []
-        @is_semantic_markup = is_semantic_markup
+        @options = options
       end
 
       def push(tagname, attrs)
-        @stack << PendingBlock.from_tag(tagname, attrs, @nodes.dup, @list_depth, is_semantic_markup: @is_semantic_markup)
+        @stack << PendingBlock.from_tag(tagname, attrs, @nodes.dup, @list_depth, options: @options)
         track_block_node(tagname)
       end
 

data/lib/draftjs_html/from_html/elements.rb

@@ -1,8 +1,9 @@
 module DraftjsHtml
   class FromHtml < Nokogiri::XML::SAX::Document
     INLINE_STYLE_ELEMENTS = HtmlDefaults::HTML_STYLE_TAGS_TO_STYLE.keys.freeze
-    LIST_PARENT_ELEMENTS = %w[ol ul table].freeze
-    INLINE_NON_STYLE_ELEMENTS = %w[a abbr cite font img output q samp span thead tbody td time var].freeze
+    LIST_PARENT_ELEMENTS = %w[ol ul].freeze
+    INLINE_NON_STYLE_ELEMENTS = %w[a abbr cite font img output q samp span table thead tbody td time var].freeze
     BLOCK_CONTENT_ELEMENTS = %w[p dl h1 h2 h3 h4 h5 h6].freeze
+    FLUSH_BOUNDARIES = %w[OPENING div ol ul li tr].freeze
   end
 end

data/lib/draftjs_html/from_html/pending_block.rb

@@ -1,7 +1,7 @@
 module DraftjsHtml
   class FromHtml < Nokogiri::XML::SAX::Document
-    PendingBlock = Struct.new(:tagname, :attrs, :chars, :entities, :pending_entities, :parent_tagnames, :depth, :is_semantic_markup, keyword_init: true) do
-      def self.from_tag(name, attrs, parent_tagnames, depth, is_semantic_markup: true)
+    PendingBlock = Struct.new(:tagname, :attrs, :chars, :entities, :pending_entities, :parent_tagnames, :depth, :options, keyword_init: true) do
+      def self.from_tag(name, attrs, parent_tagnames, depth, options: {})
         self.new(
           tagname: name,
           attrs: attrs,
@@ -10,7 +10,7 @@ module DraftjsHtml
           pending_entities: [],
           depth: depth,
           parent_tagnames: parent_tagnames,
-          is_semantic_markup: is_semantic_markup,
+          options: options
         )
       end
 
@@ -23,9 +23,7 @@ module DraftjsHtml
       end
 
       def flushable?
-        %w[OPENING ol ul li table].include?(parent_tagnames.last) ||
-          (parent_tagnames.last == 'div' && tagname != 'div') ||
-          (!is_semantic_markup && tagname == 'div')
+        FLUSH_BOUNDARIES.include?(parent_tagnames.last)
       end
 
       def consume(other_pending_block)
@@ -35,21 +33,23 @@ module DraftjsHtml
       end
 
       def flush_to(draftjs)
-        if text_buffer.any?
-          text_buffer.each_line do |line|
-            block_type = line.atomic? ? 'atomic' : block_name
-            draftjs.typed_block(block_type, line.text, depth: [depth, 0].max)
+        text_buffer.each_line do |line|
+          block_type = line.atomic? ? 'atomic' : block_name
+          next unless should_flush_line?(line)
 
-            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
+          draftjs.typed_block(block_type, line.text, depth: [depth, 0].max)
 
-            line.style_ranges.each do |style_range|
-              draftjs.inline_style(style_range.style, style_range.range)
-            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
+
+          line.style_ranges.each do |style_range|
+            draftjs.inline_style(style_range.style, style_range.range)
           end
         end
+
+        self.text_buffer = CharList.new
       end
 
       def block_name
@@ -65,6 +65,13 @@ module DraftjsHtml
       def text_buffer=(other)
         self[:chars] = other
       end
+
+      def should_flush_line?(chars)
+        return true if chars.atomic?
+        return true unless options[:squeeze_whitespace_blocks]
+
+        options[:squeeze_whitespace_blocks] && chars.more_than_whitespace?
+      end
     end
   end
 end

data/lib/draftjs_html/from_html.rb

@@ -11,8 +11,8 @@ module DraftjsHtml
     def initialize(options = {})
       @draftjs = Draftjs::RawBuilder.new
       @parser = Nokogiri::HTML4::SAX::Parser.new(self)
-      @depth_stack = DepthStack.new(is_semantic_markup: options.fetch(:is_semantic_markup, true))
       @options = ensure_options!(options.dup)
+      @depth_stack = DepthStack.new(@options)
     end
 
     def convert(raw_html)
@@ -56,6 +56,7 @@ module DraftjsHtml
       when *FromHtml::LIST_PARENT_ELEMENTS
         @depth_stack.push_parent(name, attrs)
       else
+        @depth_stack.flush_to(@draftjs) if FromHtml::FLUSH_BOUNDARIES.include?(name)
         @depth_stack.push(name, attributes)
       end
 
@@ -101,6 +102,7 @@ module DraftjsHtml
         when 'img' then { type: 'IMAGE', mutability: 'IMMUTABLE', atomic: true, data: attrs }
         end
       }
+      opts[:squeeze_whitespace_blocks] ||= false
       opts
     end
   end

data/lib/draftjs_html/html_defaults.rb

@@ -1,6 +1,7 @@
 module DraftjsHtml
   module HtmlDefaults
     BLOCK_TYPE_TO_HTML = {
+      'article' => 'p',
       'paragraph' => 'p',
       'unstyled' => 'p',
       'header-one' => 'h1',

data/lib/draftjs_html/spec_support/rspec.rb

@@ -0,0 +1,42 @@
+require 'rspec/expectations'
+require 'draftjs_html/spec_support'
+
+module DraftjsHtml
+  module SpecSupport
+    module RSpecMatchers
+      extend RSpec::Matchers::DSL
+
+      matcher :eq_raw_draftjs do |expected|
+        include DraftjsHtml::SpecSupport::KeyNormalization
+        match do |actual|
+          @raw_draftjs = normalize_keys(DraftjsHtml::Draftjs::RawBuilder.build(&block_arg))
+          @actual = normalize_keys(actual)
+
+          values_match?(@raw_draftjs, @actual)
+        end
+
+        diffable
+
+        def expected
+          @raw_draftjs
+        end
+      end
+
+      matcher :eq_raw_draftjs_ignoring_keys do |expected|
+        include DraftjsHtml::SpecSupport::KeyNormalization
+        match do |actual|
+          @raw_draftjs = normalize_keys(expected)
+          @actual = normalize_keys(actual)
+
+          values_match?(@raw_draftjs, @actual)
+        end
+
+        diffable
+
+        def expected
+          @raw_draftjs
+        end
+      end
+    end
+  end
+end

data/lib/draftjs_html/spec_support.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DraftjsHtml
+  module SpecSupport
+    module KeyNormalization
+      def normalize_keys(raw_draftjs)
+        draftjs = DraftjsHtml::Draftjs::Content.parse(raw_draftjs)
+        draftjs.blocks.each.with_index do |block, i|
+          block.key = "block-key-#{i}"
+        end
+
+        draftjs.entity_map.keys.each.with_index do |entity_key, i|
+          new_key = "entity-key-#{i}"
+          draftjs.entity_map[new_key] = draftjs.entity_map.delete(entity_key)
+          matching_entity_ranges = draftjs.blocks.flat_map { |block| block.raw_entity_ranges.select { |entity_range| entity_range['key'] == entity_key } }
+          matching_entity_ranges.each { |range| range['key'] = new_key }
+        end
+
+        DraftjsHtml::Draftjs::ToRaw.new.convert(draftjs)
+      end
+    end
+  end
+end

data/lib/draftjs_html/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: draftjs_html
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.26.0
 platform: ruby
 authors:
 - TJ Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-19 00:00:00.000000000 Z
+date: 2023-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -45,6 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -76,6 +77,8 @@ files:
 - lib/draftjs_html/html_depth.rb
 - lib/draftjs_html/node.rb
 - lib/draftjs_html/overrideable_map.rb
+- lib/draftjs_html/spec_support.rb
+- lib/draftjs_html/spec_support/rspec.rb
 - lib/draftjs_html/to_html.rb
 - lib/draftjs_html/version.rb
 homepage: https://github.com/dugancathal/draftjs_html