draftjs_html 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20fc136c6cdbd1488b5ba808c3f55caca80f8f748241bc42b53028a544878542
-  data.tar.gz: a39a398da3a5c1513d62d008fb9f80f105a9d4b91137da4b22d072a09727fea1
+  metadata.gz: 9fe4601ed10ebae8924fe906ffad4cd56bebf7867ec80182876ad0a1b5a3b739
+  data.tar.gz: 5d14c45c7192c936fbbe524a72c4886acddaf20f1f2dff5ccf9c1ce3d8de8a5f
 SHA512:
-  metadata.gz: c7926f0d00a1b322a1e76b8a37c36010b356d7cb3cde97662378476e02787ca8ea09227b64a496dd778ef630c70e80f7cc6db69d39f7c84c165b185a2b367627
-  data.tar.gz: 2cddf8a0b594755ae959935f8df954a7543d3208ab4c7ad55ab95b5fe28bb9f802ec140f11dcde9b728cc924e65d077afa5248734098c1013612ab3083e6ed28
+  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,6 +229,44 @@ The callable should return a Hash with symbol keys. The supported values are:
 - `data` (optional, default `{}`)
   - an arbitrary data-bag (Hash) of entity data
 
+### Spec support
+
+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.
+
+```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
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

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.25.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.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - TJ Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-22 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