mato 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d94a4026d7fadd8bc561d9489f2a89238ce6b4100e4e8d887832be86304feb33
-  data.tar.gz: fb26a18fa1f92dfc655f2b53a5aac5af2b3fe945bf2a42cbc8c0966d8f964044
+  metadata.gz: a0009a682500eef0ba90fc7166044321a21e0dc8cde9e290938466d81e5d93a9
+  data.tar.gz: 44dfea37fc148c34c423d91d496316618f24d911dbc340ebba691cd17632a980
 SHA512:
-  metadata.gz: d698ea373d885e1c9716077dffd1aefc50426c398b68038c288e83f05fb016f26aa1302a1fc93447ec9d8c1b409f2c6f03e2474315075cfdb6e72037c20dfb1a
-  data.tar.gz: c39ed1a90becdb01f2d3b8447b67b79f3ce6efa8dcfbfce39d4c4c5d7e315ae69941655ff0d831829e955b6fd0102db592923501354c6cc74208f3065b8926ad
+  metadata.gz: 703fb8e5f8132eb78887d30d8245c0738ff8b5e14e4662bef1e6f572571429465472b18fe853e3ac58ee1d15f87ef32460f6f2bc716db44e568ffdccd8bd02c1
+  data.tar.gz: 265481153e3404d01049e6f79550573839024095597168180c6310a8bbc8d9b2ed491dad9723fee3a4d57ca38888b64341c173054c8418ae1eb04497cfc9802a

data/.rubocop.yml

@@ -3,7 +3,7 @@ require:
   - rubocop-performance
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.7
   DisplayCopNames: true
   Exclude:
     - bin/**/*

data/.travis.yml

@@ -1,9 +1,7 @@
 language: ruby
 rvm:
-  - 2.4
-  - 2.5
-  - 2.6
   - 2.7
+  - 3.0
   - ruby-head
 
 matrix:

data/CHANGELOG.md

@@ -1,9 +1,29 @@
 # The revision history of Mato
 
+## v2.4.0 - 2021/08/25
+
+https://github.com/bitjourney/mato/compare/v2.3.2...v2.4.0
+
+* BREAKING: Drop support for Ruby 2.4, 2.5, and 2.6
+* Bump up minimum dependency of nokogiri to 1.12
+
+## v2.3.2 - 2021/01/08
+
+* Fix error on mention link with Nokogiri v1.11.0+. [#26](https://github.com/bitjourney/mato/pull/26)
+
+## v2.3.1 - 2020/07/15
+
+* Allow loose task list. [#24](https://github.com/bitjourney/mato/pull/24)
+
+## v2.3.0 - 2020/06/16
+
+* Add `convert_empty_task_list` option to TaskList filter to convert task list event if the text is empty. [#23](https://github.com/bitjourney/mato/pull/23)
+
 ## v2.2.0 - 2020/05/08
 
 https://github.com/bitjourney/mato/compare/v2.1.4...v2.2.0
 
+* BREAKING: Drop support for Ruby 2.3
 * Display code block as plan text if Rouge raises an error [#21](https://github.com/bitjourney/mato/pull/21)
 
 

data/Gemfile

@@ -7,6 +7,7 @@ gemspec
 
 gem "sanitize", ">= 3.0"
 
+gem 'activesupport'
 gem "bundler", ">= 1.14"
 gem "m"
 gem "minitest"

data/README.md

@@ -108,7 +108,7 @@ mato.process("Hello!").render_html # "<p>HELLO!</p>\n"
 
 ### HTML Filters
 
-An HTML filter is a callable object that takes a ``Nokogiri::HTML::DocumentFragment`
+An HTML filter is a callable object that takes a ``Nokogiri::HTML4::DocumentFragment`
 and mutate it in the method. The return value is ignored.
 
 ```ruby

data/lib/mato/config.rb

@@ -42,7 +42,7 @@ module Mato
     # @return [Class<CommonMarker]
     attr_accessor :markdown_parser
 
-    # @return [Cass<Nokogiri::HTML::DocumentFragment>]
+    # @return [Cass<Nokogiri::HTML4::DocumentFragment>]
     attr_accessor :html_parser
 
     # @return [Class<Mato::Document>]
@@ -63,7 +63,7 @@ module Mato
       @html_filters = []
 
       @markdown_parser = CommonMarker
-      @html_parser = Nokogiri::HTML::DocumentFragment
+      @html_parser = Nokogiri::HTML4::DocumentFragment
 
       @document_factory = Document
 

data/lib/mato/document.rb

@@ -6,19 +6,19 @@ require_relative './renderers/html_toc_renderer'
 # Intermediate document class, which instance is *serializable*.
 module Mato
   class Document
-    # @return [Nokogiri::HTML::DocumentFragment]
+    # @return [Nokogiri::HTML4::DocumentFragment]
     attr_reader :fragment
 
     def self.empty
-      new(Nokogiri::HTML.fragment(''))
+      new(Nokogiri::HTML4.fragment(''))
     end
 
-    # @param [Nokogiri::HTML::DocumentFragment] fragment
+    # @param [Nokogiri::HTML4::DocumentFragment] fragment
     def initialize(fragment)
       @fragment = fragment
     end
 
-    # @return [Nokogiri::HTML::DocumentFragment] A copy of fragment that are modified by html_filters
+    # @return [Nokogiri::HTML4::DocumentFragment] A copy of fragment that are modified by html_filters
     def apply_html_filters(*html_filters)
       new_fragment = fragment.dup
       html_filters.each do |html_filter|
@@ -58,7 +58,7 @@ module Mato
     end
 
     def marshal_load(data)
-      initialize(Nokogiri::HTML.fragment(data[:fragment]).freeze)
+      initialize(Nokogiri::HTML4.fragment(data[:fragment]).freeze)
     end
   end
 end

data/lib/mato/html_filters/bare_inline_element.rb

@@ -18,7 +18,7 @@ module Mato
         doc.children.each do |node|
           next unless STANDALONE_INLINE_ELEMENTS.include?(node.name)
 
-          parent = Nokogiri::HTML.fragment('<p/>')
+          parent = Nokogiri::HTML4.fragment('<p/>')
           parent.child.add_child(node.dup)
           node.replace(parent)
         end

data/lib/mato/html_filters/mention_link.rb

@@ -22,7 +22,7 @@ module Mato
         @link_builder = link_builder
       end
 
-      # @param [Nokogiri::HTML::DocumentFragment] doc
+      # @param [Nokogiri::HTML4::DocumentFragment] doc
       def call(doc)
         candidate_map = {}
         candidates = []
@@ -53,6 +53,11 @@ module Mato
           candidates.each do |candidate_fragment|
             candidate_fragment.css('span.mention-candidate').each do |node|
               next unless node.child
+              # If link_builder calls Node#replace for a node,
+              # the node's parent becames nil.
+              # Node#replace doesn't accept node that doesn't have parent since Nokogiri v1.11.0,
+              # so we need to skip it.
+              next unless node.parent
 
               node.replace(node.child.content)
             end

data/lib/mato/html_filters/section_anchor.rb

@@ -12,7 +12,7 @@ module Mato
         @anchor_icon_element = anchor_icon_element
       end
 
-      # @param [Nokogiri::HTML::DocumentFragment] doc
+      # @param [Nokogiri::HTML4::DocumentFragment] doc
       def call(doc)
         anchor_builder = AnchorBuilder.new(@anchor_icon_element)
 

data/lib/mato/html_filters/syntax_highlight.rb

@@ -12,7 +12,7 @@ module Mato
         @on_rouge_error = on_rouge_error
       end
 
-      # @param [Nokogiri::HTML::DocumentFragment] doc
+      # @param [Nokogiri::HTML4::DocumentFragment] doc
       def call(doc)
         doc.search("pre").each do |pre|
           if pre.at('code')
@@ -64,7 +64,7 @@ module Mato
         lexer = guess_lexer(language, filename, source)
 
         begin
-          document = Nokogiri::HTML.fragment(%{<div class="code-frame"/>})
+          document = Nokogiri::HTML4.fragment(%{<div class="code-frame"/>})
           div = document.at('div')
           div.add_child(label_fragment(filename || language || lexer.tag)) if filename || !lexer.is_a?(Rouge::Lexers::PlainText)
           div.add_child(%{<pre class="highlight"><code data-lang="#{lexer.tag}">#{format(lexer, source)}</code></pre>})
@@ -83,7 +83,7 @@ module Mato
       end
 
       def label_fragment(label)
-        Nokogiri::HTML.fragment(%{<div class="code-label"/>}).tap do |fragment|
+        Nokogiri::HTML4.fragment(%{<div class="code-label"/>}).tap do |fragment|
           fragment.at('div').add_child(Nokogiri::XML::Text.new(label, fragment))
         end
       end

data/lib/mato/html_filters/task_list.rb

@@ -3,18 +3,21 @@
 module Mato
   module HtmlFilters
     class TaskList
-      CHECKED_MARK = "[x] "
-      UNCHECKED_MARK = "[ ] "
+      CHECKED_MARK = /\A\[x\] /
+      UNCHECKED_MARK = /\A\[ \] /
+      CHECKED_MARK_FOR_EMPTY_TASK_LIST = /\A\[x\] ?/
+      UNCHECKED_MARK_FOR_EMPTY_TASK_LIST = /\A\[ \] ?/
 
       DEFAULT_TASK_LIST_CLASS = "task-list-item"
       DEFAULT_CHECKBOX_CLASS = "task-list-item-checkbox"
 
-      def initialize(task_list_class: DEFAULT_TASK_LIST_CLASS, checkbox_class: DEFAULT_CHECKBOX_CLASS)
+      def initialize(task_list_class: DEFAULT_TASK_LIST_CLASS, checkbox_class: DEFAULT_CHECKBOX_CLASS, convert_empty_task_list: false)
         @task_list_class = task_list_class
         @checkbox_class = checkbox_class
+        @convert_empty_task_list = convert_empty_task_list
       end
 
-      # @param [Nokogiri::HTML::DocumentFragment] doc
+      # @param [Nokogiri::HTML4::DocumentFragment] doc
       def call(doc)
         doc.search("li").each do |li|
           weave(li)
@@ -23,7 +26,7 @@ module Mato
 
       # @param [Nokogiri::XML::Node] li
       def weave(li)
-        text_node = li.xpath('.//text()').first
+        text_node = li.xpath('./p[1]/text()').first || li.xpath('.//text()').first
         checked = has_checked_mark?(text_node)
         unchecked = has_unchecked_mark?(text_node)
 
@@ -37,23 +40,39 @@ module Mato
       end
 
       def has_checked_mark?(text_node)
-        text_node&.content&.start_with?(CHECKED_MARK)
+        text_node&.content&.match?(checked_mark)
       end
 
       def has_unchecked_mark?(text_node)
-        text_node&.content&.start_with?(UNCHECKED_MARK)
+        text_node&.content&.match?(unchecked_mark)
       end
 
       def trim_mark(content, checked)
         if checked
-          content.sub(CHECKED_MARK, '')
+          content.sub(checked_mark, '')
         else
-          content.sub(UNCHECKED_MARK, '')
+          content.sub(unchecked_mark, '')
+        end
+      end
+
+      def checked_mark
+        if @convert_empty_task_list
+          CHECKED_MARK_FOR_EMPTY_TASK_LIST
+        else
+          CHECKED_MARK
+        end
+      end
+
+      def unchecked_mark
+        if @convert_empty_task_list
+          UNCHECKED_MARK_FOR_EMPTY_TASK_LIST
+        else
+          UNCHECKED_MARK
         end
       end
 
       def build_checkbox_node(checked)
-        Nokogiri::HTML.fragment('<input type="checkbox"/>').tap do |fragment|
+        Nokogiri::HTML4.fragment('<input type="checkbox"/>').tap do |fragment|
           checkbox = fragment.children.first
           checkbox["class"] = @checkbox_class
           checkbox["disabled"] = 'disabled'

data/lib/mato/html_filters/token_link.rb

@@ -20,7 +20,7 @@ module Mato
         @builder = builder
       end
 
-      # @param [Nokogiri::HTML::DocumentFragment] doc
+      # @param [Nokogiri::HTML4::DocumentFragment] doc
       def call(doc)
         doc.xpath('.//text()').each do |text_node|
           next if has_ancestor?(text_node, 'a', 'code')

data/lib/mato/processor.rb

@@ -55,7 +55,7 @@ module Mato
     end
 
     # @param [String] html
-    # @return [Nokogiri::HTML::DocumentFragment]
+    # @return [Nokogiri::HTML4::DocumentFragment]
     def parse_html(html)
       config.html_parser.parse(html)
     end

data/lib/mato/renderers/html_renderer.rb

@@ -3,7 +3,7 @@
 module Mato
   module Renderers
     class HtmlRenderer
-      # @param [Nokogiri::HTML::DocumentFragment] doc
+      # @param [Nokogiri::HTML4::DocumentFragment] doc
       # @return [String]
       def call(doc)
         doc.to_html

data/lib/mato/renderers/html_toc_renderer.rb

@@ -9,7 +9,7 @@ module Mato
       H_SELECTOR = %w(h1 h2 h3 h4 h5 h6).join(',')
       ANCHOR_SELECTOR = "a.#{AnchorBuilder::CSS_CLASS_NAME}"
 
-      # @param [Nokogiri::HTML::DocumentFragment] doc
+      # @param [Nokogiri::HTML4::DocumentFragment] doc
       # @return [String]
       def call(doc)
         s = +''

data/lib/mato/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mato
-  VERSION = "2.2.0"
+  VERSION = "2.4.0"
 end

data/mato.gemspec

@@ -13,6 +13,11 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/bitjourney/mato"
   spec.license       = "MIT"
 
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = 'https://github.com/bitjourney/mato/blob/master/CHANGELOG.md'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/bitjourney/mato/issues'
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(?:test|spec|features|example)/})
   end
@@ -20,9 +25,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.4"
+  spec.required_ruby_version = ">= 2.7"
 
   spec.add_runtime_dependency "commonmarker", ">= 0.18.1"
-  spec.add_runtime_dependency "nokogiri", ">= 1.6"
+  spec.add_runtime_dependency "nokogiri", ">= 1.12"
   spec.add_runtime_dependency "rouge", ">= 3.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mato
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - FUJI Goro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
@@ -93,7 +93,11 @@ files:
 homepage: https://github.com/bitjourney/mato
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/bitjourney/mato
+  source_code_uri: https://github.com/bitjourney/mato
+  changelog_uri: https://github.com/bitjourney/mato/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/bitjourney/mato/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -102,14 +106,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.pre1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: MArkdown TOolkit