editor_js 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a00ab346b57a44f9fd23bcdca062aa86f0cee25326a5db5e810d193129498a7
-  data.tar.gz: 3e96bc0177d267807ad49915cd2eebb312bb29789931da69ed71cdb58f48dedc
+  metadata.gz: 39729360ee7471d852aa04a598687de0afedb79cd1cf56a2196731bb21c85a5e
+  data.tar.gz: d5781ef2b0f8f48d13386b06e72c5bab6f9bd35dfa1ef84b406ab3cfdc7c7d57
 SHA512:
-  metadata.gz: e65a5f80e1e92a752d39c01a1b72d869d597e12aa541f7790c08d84f3ba84d543f39d74a5758d3a2d54eef8fde9fb32bd8ee90b4a0e5949f044946e27945841a
-  data.tar.gz: af6f3ec9825b66dcadabfb05872de9dcc366be87382997dc468dacdf0da9132e4ca02028ffc307c841ae124a948d72ad42546103db7682caee0c5981ea6e6c21
+  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,85 +1,85 @@
 PATH
   remote: .
   specs:
-    editor_js (0.3.5)
+    editor_js (0.4.0)
       actionview (>= 4)
       activesupport (>= 4)
-      coderay (~> 1.1, >= 1.1.2)
+      commonmarker (~> 0.21.2)
       htmlentities (~> 4.3, >= 4.3.4)
       json-schema (~> 2)
-      redcarpet (~> 3.5)
-      sanitize (~> 5.1)
+      rouge (~> 3.26)
+      sanitize (~> 6.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionview (6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.0.3.2)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    addressable (2.7.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
+    ast (2.4.2)
     builder (3.2.4)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.6)
+    coderay (1.1.3)
+    commonmarker (0.21.2)
+      ruby-enum (~> 0.5)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    erubi (1.9.0)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    erubi (1.10.0)
     htmlentities (4.3.4)
-    i18n (1.8.3)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    json (2.3.0)
+    json (2.5.1)
     json-schema (2.8.1)
       addressable (>= 2.4)
-    loofah (2.6.0)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (0.9.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    nokogumbo (2.0.2)
-      nokogiri (~> 1.8, >= 1.8.4)
-    parallel (1.19.1)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
+    minitest (5.14.4)
+    nokogiri (1.12.3-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (4.0.5)
+    public_suffix (4.0.6)
+    racc (1.5.2)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
     rainbow (3.0.0)
-    rake (13.0.1)
-    redcarpet (3.5.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    rake (13.0.6)
+    rouge (3.26.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     rubocop (0.77.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -87,24 +87,24 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    sanitize (5.2.1)
+    ruby-enum (0.9.0)
+      i18n
+    ruby-progressbar (1.11.0)
+    sanitize (6.0.0)
       crass (~> 1.0.2)
-      nokogiri (>= 1.8.0)
-      nokogumbo (~> 2.0)
+      nokogiri (>= 1.12.0)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    zeitwerk (2.3.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.6.1)
+    zeitwerk (2.4.2)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
   bundler (~> 2.0)
@@ -116,4 +116,4 @@ DEPENDENCIES
   simplecov (~> 0.17.1)
 
 BUNDLED WITH
-   2.1.4
+   2.2.25

data/README.md

@@ -2,9 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/editor_js.svg)](https://badge.fury.io/rb/editor_js) [![Build Status](https://travis-ci.org/xiaohui-zhangxh/editor_js.svg?branch=master)](https://travis-ci.org/xiaohui-zhangxh/editor_js) [![Maintainability](https://api.codeclimate.com/v1/badges/e26bf8e27fb3a33735fd/maintainability)](https://codeclimate.com/github/xiaohui-zhangxh/editor_js/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/e26bf8e27fb3a33735fd/test_coverage)](https://codeclimate.com/github/xiaohui-zhangxh/editor_js/test_coverage) ![Downloads](https://ruby-gem-downloads-badge.herokuapp.com/editor_js?type=total)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/editor_js`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A Ruby renderer for EditorJS https://editorjs.io/
 
 ## Installation
 
@@ -34,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

@@ -27,11 +27,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'actionview', '>= 4'
   spec.add_dependency 'activesupport', '>= 4'
-  spec.add_dependency 'json-schema', '~> 2'
-  spec.add_dependency 'sanitize', '~> 5.1'
+  spec.add_dependency 'commonmarker', '~> 0.21.2'
   spec.add_dependency 'htmlentities', '~> 4.3', '>= 4.3.4'
-  spec.add_dependency 'redcarpet', '~> 3.5'
-  spec.add_dependency 'coderay', '~> 1.1', '>= 1.1.2'
+  spec.add_dependency 'json-schema', '~> 2'
+  spec.add_dependency 'rouge', '~> 3.26'
+  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/common_marker/custom_html_render.rb

@@ -0,0 +1,12 @@
+class CommonMarker::CustomHtmlRenderer < CommonMarker::HtmlRenderer
+  def tasklist(node)
+    return '' unless tasklist?(node)
+
+    state = if checked?(node)
+              'checked="" disabled=""'
+            else
+              'disabled=""'
+            end
+    " class=\"task-list-item\"><input type=\"checkbox\" #{state} /"
+  end
+end

data/lib/common_marker/rouge.rb

@@ -0,0 +1,66 @@
+require 'common_marker/custom_html_render'
+
+# frozen_string_literal: true
+module CommonMarker
+  # rouge
+  module Rouge
+    module_function
+
+    def render_doc(text, cmark_options = :DEFAULT, extensions = [], **cmr_options)
+      cmark = cmr_options[:cmark_class] || ::CommonMarker
+
+      ast = cmark.render_doc(text, cmark_options, extensions)
+      process_ast(ast, cmr_options)
+      ast
+    end
+
+    def render_html(text, cmark_options = :DEFAULT, render_options = :UNSAFE, extensions = [], **cmr_options)
+      doc = render_doc(text, cmark_options, extensions, **cmr_options)
+      CommonMarker::CustomHtmlRenderer.new(options: render_options, extensions: extensions).render(doc)
+      # doc.to_html(render_options)
+    end
+
+    def process_ast(ast, cmr_options)
+      ast.walk do |node|
+        if node.type == :code_block
+          next if node.fence_info == ''
+
+          source = node.string_content
+
+          lexer = ::Rouge::Lexer.find_fancy(node.fence_info) || ::Rouge::Lexers::PlainText.new
+
+          formatter_class = cmr_options[:formatter_class]
+          formatter       = cmr_options[:formatter]
+
+          # support format accepting class for a time being
+          if formatter.is_a? Class
+            formatter_class ||= formatter
+            formatter = nil
+          end
+
+          formatter_class ||= ::Rouge::Formatters::HTML
+
+          formatter ||= formatter_class.new(cmr_options[:options] || {})
+
+          html = '<div class="highlighter-rouge language-' + CGI.escapeHTML(node.fence_info) + '">' + formatter.format(lexer.lex(source)) + '</div>'
+
+          new_node = ::CommonMarker::Node.new(:html)
+          new_node.string_content = html
+
+          node.insert_before(new_node)
+          node.delete
+        elsif node.type == :html
+          node.string_content = ::Sanitize.fragment(
+            node.string_content,
+            ::Sanitize::Config.merge(
+              ::Sanitize::Config::BASIC,
+              remove_contents: true
+            )
+          )
+        end
+      end
+    end
+
+    private_class_method :process_ast
+  end
+end

data/lib/editor_js/blocks/markdown_block.rb

@@ -4,21 +4,6 @@ module EditorJs
   module Blocks
     # markdown block
     class MarkdownBlock < Base
-      class HTMLwithCodeRay < Redcarpet::Render::HTML
-        def block_code(code, language)
-          CodeRay.scan(code, language || :text).div(css: :class)
-        end
-
-        def list_item(text, list_type)
-          if text.start_with?("[x]", "[X]")
-            text[0..2] = %(<input type='checkbox' checked='checked' disabled>)
-          elsif text.start_with?("[ ]")
-            text[0..2] = %(<input type='checkbox' disabled>)
-          end
-          %(<li>#{text}</li>)
-        end
-      end
-
       def sanitize!; end
 
       def schema
@@ -31,33 +16,29 @@ module EditorJs
         YAML
       end
 
+      # commonmarker: markdown to html
+      # https://github.com/gjtorikian/commonmarker
+      # https://github.github.com/gfm/#ordered-list
+      # https://meta.stackexchange.com/questions/348746/were-switching-to-commonmark
+
+      # rouge: syntax highlighter
+      # https://github.com/rouge-ruby/rouge/
+      # https://spsarolkar.github.io/rouge-theme-preview/
+      # shell: rougify help style
+      # # Get some CSS
+      # Rouge::Themes::Base16.mode(:light).render(scope: '.highlight')
+      # # Or use Theme#find with string input
+      # Rouge::Theme.find('base16.light').render(scope: '.highlight')
       def render(_options = {})
         content_tag :div, class: css_name do
           content_text = data['text'] || ''
-
-          render_options = {
-            escape_html: true,
-            hard_wrap: true,
-            with_toc_data: true,
-            link_attributes: { rel: 'nofollow', target: '_blank' }
-          }
-          renderer = HTMLwithCodeRay.new(render_options)
-
-          options = {
-            autolink: true,
-            fenced_code_blocks: true,
-            lax_spacing: true,
-            no_intra_emphasis: true,
-            strikethrough: true,
-            tables: true,
-            superscript: true,
-            highlight: true,
-            quote: true,
-            footnotes: true
-          }
-          markdown_to_html = Redcarpet::Markdown.new(renderer, options)
-
-          markdown_to_html.render(content_text).html_safe
+          CommonMarker::Rouge.render_html(
+            content_text,
+            %i[UNSAFE FOOTNOTES STRIKETHROUGH_DOUBLE_TILDE],
+            %i[UNSAFE GITHUB_PRE_LANG HARDBREAKS TABLE_PREFER_STYLE_ATTRIBUTES FULL_INFO_STRING FOOTNOTES],
+            %i[table strikethrough tasklist tagfilter],
+            formatter: Rouge::Formatters::HTMLLegacy.new(inline_theme: 'github')
+          ).html_safe
         end
       end
 

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.5'
+  VERSION = '0.4.0'
 end

data/lib/editor_js.rb

@@ -8,8 +8,9 @@ require 'action_view/helpers'
 require 'json-schema'
 require 'sanitize'
 require 'htmlentities'
-require 'redcarpet'
-require 'coderay'
+require 'commonmarker'
+require 'rouge'
+require 'common_marker/rouge'
 require 'editor_js/version'
 require 'editor_js/blocks/base'
 require 'editor_js/blocks/checklist_block'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: editor_js
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - xiaohui
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -39,87 +39,81 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: json-schema
+  name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 0.21.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
-  name: sanitize
+  name: htmlentities
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.4
 - !ruby/object:Gem::Dependency
-  name: htmlentities
+  name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.3.4
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.3.4
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.26'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.26'
 - !ruby/object:Gem::Dependency
-  name: coderay
+  name: sanitize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -173,6 +167,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- Changes.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -181,6 +176,8 @@ files:
 - bin/console
 - bin/setup
 - editor_js.gemspec
+- lib/common_marker/custom_html_render.rb
+- lib/common_marker/rouge.rb
 - lib/editor_js.rb
 - lib/editor_js/blocks/attaches_block.rb
 - lib/editor_js/blocks/base.rb
@@ -221,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Ruby gem for editorjs.io text editor