draftjs_html 0.30.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87efa57150dbbe1c730824cea917dbabaad3aec0512232102995863da4f0e30c
-  data.tar.gz: b634cbce19c5da38dbd36df706f9f4ba90a0391a1e487907bd355c2d4772eda0
+  metadata.gz: 41707ca7969d9183fb2ab221f48e48a7004cb4ed9b8e9f4640bd53fb64c69912
+  data.tar.gz: 9ce23beaa990033c0ba30b8e791ee4c147c03efd324ed8eec277404e942f252f
 SHA512:
-  metadata.gz: 80fc8946627d72d1d3add5c3e0e6e4a91656aa715cec1d20d4471273ad129abccbbe47c81077b2874c896733528537c8bdcce7a99d825f0d908b3e524f2efd48
-  data.tar.gz: dd460fa38fea6e915a442ba231993e231c009784618b0ed36f9d7f7e583cedef6246f20447ae16937c0ba98b09f9977390738771161a4a08571ff6ee8ab107e6
+  metadata.gz: 44427ea0eca8b9c47b5371305f57d70ae182806883b415f5841ea8654abc4c3958f515d84b11aa2ff343f5005cf5d6ada2a704394fe556e1dc0d58e684a0caa1
+  data.tar.gz: bb5ef7669e67d1b1bf0e40afc5081941cda97487deeb5fd757e2d06a60861ac4e92b21ae9e93f7bfeed45ac151816bab8df823bdf02caa847d7a13ed2c8815e3

data/README.md

@@ -139,7 +139,7 @@ DraftjsHtml.to_html(raw_draftjs, options: {
 })
 ```
 
-# This would generate <strong> tags instead of <b> tags around ranges of `BOLD` inline styles.
+**Note:** This would generate <strong> tags instead of <b> tags around ranges of `BOLD` inline styles.
 
 #### `:inline_style_renderer`
 
@@ -229,6 +229,19 @@ The callable should return a Hash with symbol keys. The supported values are:
 - `data` (optional, default `{}`)
   - an arbitrary data-bag (Hash) of entity data
 
+### Draftjs parsing
+
+If you want to directly manipulate the structure of the Draftjs, you can use the `DraftjsHtml::Draftjs.parse(raw_draftjs)` directly.
+This method assumes that the `raw_draftjs` hash is well-formed & valid, containing the `"blocks"` and `"entityMap"` keys.
+
+If you’re dealing with unknown input, you can use `.safe_parse` instead to return a guaranteed, benign object.
+See `DraftjsHtml::Draftjs::NullContent` for its implementation – the API matches that of `DraftjsHtml::Draftjs::Content`.
+
+**Note:** Neither of the parse methods parse JSON strings, they expect Ruby hash objects.
+
+These parsed objects support rudimentary validation.
+Note that the `DraftjsHtml::Draftjs::NullContent` version always presents as invalid.
+
 ### Spec support
 
 To make it easier to test our own code, we've developed a few RSpec matchers that

data/lib/draftjs_html/draftjs/block.rb

@@ -73,6 +73,10 @@ module DraftjsHtml
       def add_style(name, range)
         inline_styles << ApplicableRange.new(name: name, range: range)
       end
+
+      def add_entity(key, range)
+        entity_ranges << ApplicableRange.new(name: key, range: range)
+      end
     end
   end
 end

data/lib/draftjs_html/draftjs/content.rb

@@ -4,9 +4,16 @@ module DraftjsHtml
   module Draftjs
     class Content
       def self.parse(raw)
+        validate_raw_input!(raw)
         new(raw['blocks'].map { Block.parse(**_1) }, EntityMap.parse(raw['entityMap']))
       end
 
+      def self.validate_raw_input!(raw)
+        raise InvalidRawDraftjs.new('raw cannot be nil') if raw.nil?
+        raise InvalidRawDraftjs.new('raw must contain "blocks" array') unless raw['blocks'].is_a?(Array)
+        raise InvalidRawDraftjs.new('raw must contain "entityMap" hash') unless raw['entityMap'].is_a?(Hash)
+      end
+
       attr_reader :blocks, :entity_map
 
       def initialize(blocks, entity_map)
@@ -18,9 +25,35 @@ module DraftjsHtml
         entity_map[key]
       end
 
+      def attach_entity(entity, block, range)
+        new_key = new_entity_key
+        entity_map[new_key] = entity
+        block.add_entity(new_key, range)
+      end
+
       def to_raw
         ToRaw.new.convert(self)
       end
+
+      def valid?
+        self.class.validate_raw_input!({ 'blocks' => blocks, 'entityMap' => entity_map })
+        true
+      rescue
+        false
+      end
+
+      def invalid?
+        !!valid?
+      end
+
+      private
+
+      def new_entity_key
+        loop do
+          key = SecureRandom.uuid
+          break key unless entity_map.key?(key)
+        end
+      end
     end
   end
 end

data/lib/draftjs_html/draftjs/null_content.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module DraftjsHtml
+  module Draftjs
+    class NullContent
+      def blocks
+        []
+      end
+
+      def entity_map
+        {}
+      end
+
+      def find_entity(_key)
+        nil
+      end
+
+      def attach_entity(_entity, _block, _range)
+        nil
+      end
+
+      def to_raw
+        ToRaw.new.convert(self)
+      end
+
+      def valid?
+        false
+      end
+
+      def invalid?
+        true
+      end
+    end
+  end
+end

data/lib/draftjs_html/draftjs.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'draftjs/content'
+require_relative 'draftjs/null_content'
 require_relative 'draftjs/character_meta'
 require_relative 'draftjs/applicable_range'
 require_relative 'draftjs/block'
@@ -14,5 +15,11 @@ module DraftjsHtml
     def self.parse(raw)
       Content.parse(raw)
     end
+
+    def self.safe_parse(raw)
+      Content.parse(raw)
+    rescue
+      NullContent.new
+    end
   end
 end

data/lib/draftjs_html/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module DraftjsHtml
+  Error = Class.new(StandardError)
+  InvalidRawDraftjs = Class.new(Error)
+end

data/lib/draftjs_html/version.rb

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

data/lib/draftjs_html.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'draftjs_html/errors'
 require_relative "draftjs_html/version"
 require 'nokogiri'
 require_relative 'draftjs_html/draftjs'
@@ -8,8 +9,6 @@ require_relative 'draftjs_html/to_html'
 require_relative 'draftjs_html/from_html'
 
 module DraftjsHtml
-  class Error < StandardError; end
-
   def self.to_html(raw_draftjs, options: {})
     ToHtml.new(options).convert(raw_draftjs)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: draftjs_html
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.32.0
 platform: ruby
 authors:
 - TJ Taylor
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-08 00:00:00.000000000 Z
+date: 2023-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -66,8 +66,10 @@ files:
 - lib/draftjs_html/draftjs/content.rb
 - lib/draftjs_html/draftjs/entity.rb
 - lib/draftjs_html/draftjs/entity_map.rb
+- lib/draftjs_html/draftjs/null_content.rb
 - lib/draftjs_html/draftjs/raw_builder.rb
 - lib/draftjs_html/draftjs/to_raw.rb
+- lib/draftjs_html/errors.rb
 - lib/draftjs_html/from_html.rb
 - lib/draftjs_html/from_html/char_list.rb
 - lib/draftjs_html/from_html/depth_stack.rb
@@ -88,7 +90,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
@@ -103,8 +105,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: A tool for converting DraftJS JSON to HTML (and back again)
 test_files: []