editor_js 0.3.6.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc68a5b437f52314867a5c04726164825c17d4fae12fa60afe079903b776b9ad
-  data.tar.gz: ab4234218fdea2e6fe97f9860366a4122e3553535b0941175ee06ef262538311
+  metadata.gz: 39729360ee7471d852aa04a598687de0afedb79cd1cf56a2196731bb21c85a5e
+  data.tar.gz: d5781ef2b0f8f48d13386b06e72c5bab6f9bd35dfa1ef84b406ab3cfdc7c7d57
 SHA512:
-  metadata.gz: 3ce06f481e7c0578c6405466ee84a757c4acb2ac7a90c277f4f19bbdfb6f102bb98ea027cf93cf345f0d9f1d0aa42a6d0953fc60c73800b3d50d0f2dae27b32b
-  data.tar.gz: 51a76b6c4af5c00d99752cb06d375b91e74a3be4abef4f325a40b9256ef1a99c321fb74757d3a487dde4ae902bd957cb0689a77a2b4c4d1a365df5e373dfb657
+  metadata.gz: 1dbdc91120a843bac1ceb161e9b1b2de3ee6c7e6fd33a3c2e925cc8cf3fedae7e2e8601379f9d14b0fc5a986c0df1d1eb53f68808775b7151aea0538838dc85e
+  data.tar.gz: 8431e9d06fab59d6e630483ad99176bc72033d58a54bdc2a42214a3c535c7496e2f22c57f6fd5c33f46fe20410efc1dbbd0952a8d276fb8cf24d5ad889787628

data/Changes.md

@@ -0,0 +1,6 @@
+# EditorJS Changes
+
+## 0.4.0
+
+- only discard invalid blocks instead of marking invalid to the whole document.
+- support customized invalid block renderer

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    editor_js (0.3.6.1)
+    editor_js (0.4.0)
       actionview (>= 4)
       activesupport (>= 4)
       commonmarker (~> 0.21.2)
       htmlentities (~> 4.3, >= 4.3.4)
       json-schema (~> 2)
       rouge (~> 3.26)
-      sanitize (~> 6.0)
+      sanitize (~> 6.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -32,6 +32,35 @@ doc.output  # [Hash] return sanitized data
 
 ```
 
+**Capture invalid block:**
+
+```ruby
+class MyInvalidBlockRender do
+  def initialize(raw)
+    @raw = raw
+    # can record/log invalid block from here:
+    # Sentry.capture_message "invalid block: #{raw}"
+  end
+
+  def valid?
+    false
+  end
+
+  def render
+    '<div>invalid block</div>'
+  end
+
+  def plain; end
+  def output; {} end
+end
+
+doc = EditorJs::Document.new(editor_js_output, invalid_block_renderer: MyInvalidBlockRender)
+doc.render  # [String] render HTML for display
+doc.plain   # [String] render text for full-text searching
+doc.output  # [Hash] return sanitized data
+
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/editor_js.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'htmlentities', '~> 4.3', '>= 4.3.4'
   spec.add_dependency 'json-schema', '~> 2'
   spec.add_dependency 'rouge', '~> 3.26'
-  spec.add_dependency 'sanitize', '~> 6.0'
+  spec.add_dependency 'sanitize', '~> 6.0.0'
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/editor_js/document.rb

@@ -21,8 +21,9 @@ module EditorJs
       - version
     YAML
 
-    def initialize(str_or_hash)
+    def initialize(str_or_hash, invalid_block_renderer: nil)
       str_or_hash = JSON.parse(str_or_hash) unless str_or_hash.is_a?(Hash)
+      @invalid_block_renderer = invalid_block_renderer
       @content = str_or_hash
       @blocks = []
     end
@@ -33,12 +34,11 @@ module EditorJs
       @valid = JSON::Validator.validate(SCHEMA, @content)
       return false unless @valid
 
-      blocks = @content['blocks'].map do |blk_data|
-        EditorJs::Blocks::Base.load(blk_data)
-      end
-      @valid = blocks.all?(&:valid?)
-      @blocks = blocks if @valid
-      @valid
+      @blocks = @content['blocks'].map do |blk_data|
+        blk = EditorJs::Blocks::Base.load(blk_data)
+        blk.valid? ? blk : @invalid_block_renderer&.new(blk_data)
+      end.compact
+      @valid = @blocks.count.positive?
     end
 
     def render

data/lib/editor_js/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EditorJs
-  VERSION = '0.3.6.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: editor_js
 version: !ruby/object:Gem::Version
-  version: 0.3.6.1
+  version: 0.4.0
 platform: ruby
 authors:
 - xiaohui
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-12 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -167,6 +167,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Changes.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt