mato 2.3.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74c9936ed1ef8bc63b7b0785597f92f4100dad15c432ebf5b6b0bfa5681a2d03
-  data.tar.gz: 8234e66b936b71bbb25d60e5a2df5cbd1a11903c724fab6a0f2c64e22dcc3c3d
+  metadata.gz: 8fcbd9aeee5b4c9a0c3a8a101a876fcb403bae92926a0e2c5d9ca0a56295a37e
+  data.tar.gz: 2ba4fbdb19c68bb02ed208b6787cb09c9992e31ebbbdd78c3e8f410007084bf1
 SHA512:
-  metadata.gz: b21e6c3a89540d0775ff30eccefa0f755b5c9f9dd2ac17d40c0d6818430b68222b34bfa06d6337e55c4c52f890dbf308d5cb8b466c02a0f87fb345d45352372c
-  data.tar.gz: 8fb4996b32a9bbaf34091f7c34fc2e6b03a7fb2899561b98b40cc0e130a024063d0d3e190b751817444e23b9b6c063d67e702dcde77a651aaaffcda5076226f4
+  metadata.gz: 399ce3de0b8f7e4436c12f8275e40623fb7551ffec521a294d7a807b3d6f2756718bb7cdcf8fb145bd345a50c5c5769bf985d55170596b79fed8a48bca56f29d
+  data.tar.gz: 59208ddcb81a19f1cb356715cda80fabdc30e1476c728ac3b8f3ed2ba219b179a1e6a0e21b109f162294fb16231a34bef36034b4be120bcf0a2ce316ef180a9e

data/.github/workflows/detect-secrets-wordlist.txt

@@ -0,0 +1 @@
+dummy

data/.github/workflows/reviewdog.yml

@@ -0,0 +1,41 @@
+name: ReviewDog
+on:
+  pull_request:
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Use ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.1'
+
+    - name: rubocop
+      uses: reviewdog/action-rubocop@v2
+      with:
+        rubocop_version: gemfile
+        rubocop_extensions: rubocop-performance:gemfile
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        reporter: github-pr-review
+        fail_on_error: true
+
+  detect-secrets:
+    runs-on: ubuntu-latest
+    if: ${{ !contains(github.head_ref, 'dependabot') }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: detect-secrets
+        uses: reviewdog/action-detect-secrets@master
+        with:
+          reporter: github-pr-review
+          detect_secrets_flags: --all-files --force-use-all-plugins --word-list .github/workflows/detect-secrets-wordlist.txt

data/.github/workflows/ruby_test.yml

@@ -0,0 +1,23 @@
+name: RubyTest
+
+on:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["3.1", "3.2", "3.3"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake test

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # The revision history of Mato
 
+## v2.5.0 - 2024/05/07
+
+https://github.com/bitjourney/mato/compare/v2.4.0...v2.5.0
+
+* Bump up commonmarker to 1.0
+
+## 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)

data/Gemfile

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

data/README.md

@@ -1,4 +1,4 @@
-# Mato [![Build Status](https://travis-ci.org/bitjourney/mato.svg?branch=master)](https://travis-ci.org/bitjourney/mato) [![Gem Version](https://badge.fury.io/rb/mato.svg)](https://badge.fury.io/rb/mato)
+# Mato [![Gem Version](https://badge.fury.io/rb/mato.svg)](https://badge.fury.io/rb/mato)
 
 **Mato**, standing for **Ma**rkdown **To**oolkit,  is an extensible, pipeline-based markdown processing toolkit, inspired by [HTML::Pipeline](https://github.com/jch/html-pipeline).
 
@@ -89,7 +89,7 @@ mato.process("Hello!").render_html # "<p>HELLO!</p>\n"
 
 ### Markdown Filters
 
-A markdown filter is a callable instance that takes a ``CommonMarker::Node`
+A markdown filter is a callable instance that takes a ``Commonmarker::Node`
 and mutate it in the method. The return value is ignored.
 
 For example:
@@ -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
@@ -189,4 +189,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/bitjou
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/mato/config.rb

@@ -6,29 +6,21 @@ require 'nokogiri'
 
 module Mato
   class Config
-    # https://github.com/gjtorikian/commonmarker#parse-options
-    DEFAULT_MARKDOWN_PARSE_OPTIONS = %i[
-      DEFAULT
-      VALIDATE_UTF8
-      FOOTNOTES
-    ].freeze
-
-    # https://github.com/gjtorikian/commonmarker#render-options
-    DEFAULT_MARKDOWN_RENDER_OPTIONS = [
-      :DEFAULT,
-      :HARDBREAKS, # convert "\n" as <br/>
-      :TABLE_PREFER_STYLE_ATTRIBUTES,
-      :UNSAFE,
-      # :SOURCEPOS, // TODO: enable it after assertions are supported
-    ].freeze
-
-    # https://github.com/github/cmark/tree/master/extensions
-    DEFAULT_MARKDOWN_EXTENSIONS = %i[
-      table
-      strikethrough
-      autolink
-      tagfilter
-    ].freeze
+    DEFAULT_MARKDOWN_OPTIONS = {
+      render: {
+        hardbreaks: true,
+        unsafe: true,
+      },
+      extension: {
+        table: true,
+        strikethrough: true,
+        autolink: true,
+        tagfilter: true,
+        tasklist: false,
+        shortcodes: false,
+        footnotes: true,
+      },
+    }.freeze
 
     # @return [Array<Proc>]
     attr_accessor :text_filters
@@ -39,37 +31,29 @@ module Mato
     # @return [Array<Proc>]
     attr_accessor :html_filters
 
-    # @return [Class<CommonMarker]
+    # @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>]
     attr_accessor :document_factory
 
-    # @return [Array<Symbol>] CommonMarker's parse extensions
-    attr_accessor :markdown_extensions
-
-    # @return [Array<Symbol>] CommonMarker's pars options
-    attr_accessor :markdown_parse_options
-
-    # @return [Array<Symbol>] CommonMarker's HTML rendering options
-    attr_accessor :markdown_render_options
+    # @return [Hash] Commonmarker's options
+    attr_accessor :markdown_options
 
     def initialize
       @text_filters = []
       @markdown_filters = []
       @html_filters = []
 
-      @markdown_parser = CommonMarker
-      @html_parser = Nokogiri::HTML::DocumentFragment
+      @markdown_parser = Commonmarker
+      @html_parser = Nokogiri::HTML4::DocumentFragment
 
       @document_factory = Document
 
-      @markdown_extensions = DEFAULT_MARKDOWN_EXTENSIONS
-      @markdown_parse_options = DEFAULT_MARKDOWN_PARSE_OPTIONS
-      @markdown_render_options = DEFAULT_MARKDOWN_RENDER_OPTIONS
+      @markdown_options = DEFAULT_MARKDOWN_OPTIONS
     end
 
     # @param [Proc] block

data/lib/mato/converter.rb

@@ -29,7 +29,7 @@ module Mato
     end
 
     def run
-      # @type [CommonMarker::Node]
+      # @type [Commonmarker::Node]
       document = processor.parse_markdown(content)
 
       convert_headings!(document)
@@ -45,14 +45,14 @@ module Mato
     def convert_headings!(document)
       document.walk.select do |node|
         node.type == :text &&
-          node.sourcepos[:start_column] == 1 &&
+          node.source_position[:start_column] == 1 &&
           node.parent.type == :paragraph &&
           node.parent.parent.type == :document
       end.reverse_each do |node|
         replacement = node.string_content.gsub(/\A(#+)(?=\S)/, '\1 ')
 
         if node.string_content != replacement
-          pos = node.sourcepos
+          pos = node.source_position
           content_lines[pos[:start_line] - 1][(pos[:start_column] - 1)...pos[:end_column]] = replacement
         end
       end

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 = []

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

@@ -17,7 +17,7 @@ module Mato
         @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)
@@ -72,7 +72,7 @@ module Mato
       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

@@ -43,19 +43,19 @@ module Mato
     end
 
     # @param [String] text
-    # @return [CommonMarker::Node]
+    # @return [Commonmarker::Node]
     def parse_markdown(text)
-      config.markdown_parser.render_doc(text, config.markdown_parse_options, config.markdown_extensions)
+      config.markdown_parser.parse(text, options: config.markdown_options)
     end
 
-    # @param [CommonMarker::Node] markdown_node
+    # @param [Commonmarker::Node] markdown_node
     # @return [String]
     def render_to_html(markdown_node)
-      markdown_node.to_html(config.markdown_render_options)
+      markdown_node.to_html(options: config.markdown_options)
     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.3.2"
+  VERSION = "2.5.0"
 end

data/mato.gemspec

@@ -25,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 = "~> 3.1"
 
-  spec.add_runtime_dependency "commonmarker", ">= 0.18.1"
-  spec.add_runtime_dependency "nokogiri", ">= 1.6"
+  spec.add_runtime_dependency "commonmarker", "~> 1.0"
+  spec.add_runtime_dependency "nokogiri", ">= 1.12"
   spec.add_runtime_dependency "rouge", ">= 3.0.0"
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mato
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.5.0
 platform: ruby
 authors:
 - FUJI Goro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-08 00:00:00.000000000 Z
+date: 2024-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     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
@@ -59,9 +59,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/detect-secrets-wordlist.txt"
+- ".github/workflows/reviewdog.yml"
+- ".github/workflows/ruby_test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -89,7 +91,6 @@ files:
 - lib/mato/timeout.rb
 - lib/mato/version.rb
 - mato.gemspec
-- sider.yml
 homepage: https://github.com/bitjourney/mato
 licenses:
 - MIT
@@ -104,16 +105,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: MArkdown TOolkit

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-rvm:
-  - 2.7
-  - 3.0
-  - ruby-head
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-
-cache: bundler
-before_install: gem install bundler
-notifications:
-  slack:
-    secure: W/CuFdMffK19NqZ7hX5Cx1ekLwY5WYtyi91CgYJ5jUYZq6hY7sZAHItfvbB7kwVc5vGzDVzBp1L4+iR44OX1+3sbJQ8OHUfWNksRME5NAHeHKUnkeoMAToTy6gv8GTSDOkBoMxgtZQQwaFFxOVQF4UknLCKvwz1JRBf3zjEG7zyKlBQuYSkMQQm4xA/qmgb6nCAqSzMJxN4Gl57LKphCScKO5ZK6hUuaJv4H6y3NfDbKAEwidEUaMqnU1TtLTkqhSqVve/JMlBoynYFIezBu7R35cyHFdE8l1OaYFvIJo6nsyRZr9RVhp20wlLyL2dsM4IUBTfLf1dCw94U8VE3cCkYEh7MxQv/NAkDpkBsI9E4GGOfmuXRxcoQGoKRI9GHleg8hm/E39134JhVKNL2L5RGg/8ULNPPrQjMf0GWSxhtqBXN7vzuP4ZfAMzEDDGFehCmmzrE5qIdcRwXCI3+QRX7XAWL+Ql+xljoxZjl2f7wHSx3COChkol0V8CEGAyOTJc3qnci5jPs5mSByqv3RyO0meYiJCJ1Ce2FTjCOHs1G9D58xfra6AVA8FmOk43+iN8QZyUIqd+MsenL2k89LqMijoC208xI6WI88C9tMHDA8tmi8yJt6PA00emC+Gzy9xPCYsZ+dZhymOPDcAbBlez+j3weEEDROF0Jlewt4X8Q=

data/sider.yml

@@ -1,4 +0,0 @@
-linter:
-  rubocop:
-    gems:
-      - "rubocop-performance"