mato 2.1.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf9376fe32fa4245c884ab54cfccc6cbc263198d86a401e8601b79d3dc76cfd2
-  data.tar.gz: 88785abe066ee18c23b5b07cc3cc8b35cbdf6e447008c9a27e0bdfc7c6738351
+  metadata.gz: f7985e295c016bbc58c5cc8accc3c81e33e8351a13ed23e9ccc9bb55fe083a01
+  data.tar.gz: d18bb43005111174d922335385453ae4779d449a6efe75431693930fc72309f9
 SHA512:
-  metadata.gz: d51e4046173e64152c07b133d7fe3d04af92e3dc4664c3346fdcd5f57da402005fd5b05a64bfb24bc158f52dc3536c7f1f3c56e210cf0e234dab114aaf2c95c1
-  data.tar.gz: 633e03865baf4e21eb5e026aedd40ce447aa63750de3a6b216f0d695fc4e11385914e98aac4affdad99e556290d4ad7885296f54ef7e159d401323011aa0394e
+  metadata.gz: '08a8c3e69c1af3426109ff111846d3eba57fd91ff3095a606b9c3bae412b7b8947782017143dd894d161872b2907f3084611fe8bfb27e8e900f392bb321e09f5'
+  data.tar.gz: a4dc40fb37b6db9c12e5011e9ea3391d155e78ecbd922d6021a73d2d00ccdb7bc56708e2a17f972d604674accec01ad792f7535abfb385caceb192997179663f

data/.rubocop.yml

@@ -1,11 +1,16 @@
 # See also https://github.com/onk/onkcop/blob/master/config/rubocop.yml
+require:
+  - rubocop-performance
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
   DisplayCopNames: true
   Exclude:
     - bin/**/*
 
+Metrics:
+  Enabled: false
+
 Lint/UnusedBlockArgument:
   Enabled: false
 
@@ -21,31 +26,7 @@ Layout/MultilineMethodCallIndentation:
 Layout/EmptyLinesAroundClassBody:
   Enabled: false
 
-Metrics/AbcSize:
-  Max: 35
-
-Metrics/PerceivedComplexity:
-  Max: 10
-
-Metrics/CyclomaticComplexity:
-  Max: 10
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/LineLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Max: 45
-
-Metrics/ModuleLength:
-  Enabled: false
-
-Metrics/ParameterLists:
+Layout/LineLength:
   Enabled: false
 
 Style/RescueStandardError:
@@ -63,6 +44,12 @@ Style/Documentation:
 Naming/FileName:
   Enabled: false
 
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
 Style/GuardClause:
   Enabled: false
 
@@ -90,7 +77,10 @@ Style/SignalException:
 Style/StringLiterals:
   Enabled: false
 
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 
 Style/TrailingCommaInArguments:
@@ -117,6 +107,9 @@ Style/AsciiComments:
 Style/EmptyMethod:
   EnforcedStyle: expanded
 
+Style/RaiseArgs:
+  Enabled: false
+
 Naming/VariableNumber:
   Enabled: false
 
@@ -143,3 +136,20 @@ Style/NonNilCheck:
 
 Performance/RedundantBlockCall:
   Enabled: false
+
+# Configure pending cops
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true

data/.travis.yml

@@ -1,8 +1,9 @@
-sudo: false
 language: ruby
 rvm:
-  - 2.3
   - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
   - ruby-head
 
 matrix:

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # The revision history of Mato
 
+## 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)
+
+
+## v2.1.4 - 2019/4/11
+
+https://github.com/bitjourney/mato/compare/v2.1.3...v2.1.4
+
+* Fix broken mention link process in case of including unexpected text
+
+## v2.1.3 - 2019/1/15
+
+https://github.com/bitjourney/mato/compare/v2.1.2...v2.1.3
+
+* Fix anchor in case of heading which is only special characters
+
+## v2.1.2 - 2018/10/23
+
+https://github.com/bitjourney/mato/compare/v2.1.1...v2.1.2
+
+* Add UNSAFE to DEFAULT_MARKDOWN_RENDER_OPTIONS
+
 ## v2.1.1 - 2018/02/22
 
 https://github.com/bitjourney/mato/compare/v2.1.0...v2.1.1

data/Gemfile

@@ -12,4 +12,6 @@ gem "m"
 gem "minitest"
 gem "minitest-power_assert"
 gem "rake", ">= 10.0"
-gem "rubocop"
+gem 'rr'
+gem "rubocop", '>= 0.78.0'
+gem 'rubocop-performance'

data/lib/mato/anchor_builder.rb

@@ -44,7 +44,13 @@ module Mato
     end
 
     def make_anchor_id_prefix(text)
-      ERB::Util.url_encode(text.downcase.gsub(/[^\p{Word}\- ]/u, "").tr(" ", "-"))
+      prefix = ERB::Util.url_encode(text.downcase.gsub(/[^\p{Word}\- ]/u, "").tr(" ", "-"))
+
+      if prefix.empty?
+        "user-content" # GitHub compatible
+      else
+        prefix
+      end
     end
   end
 end

data/lib/mato/config.rb

@@ -18,6 +18,7 @@ module Mato
       :DEFAULT,
       :HARDBREAKS, # convert "\n" as <br/>
       :TABLE_PREFER_STYLE_ATTRIBUTES,
+      :UNSAFE,
       # :SOURCEPOS, // TODO: enable it after assertions are supported
     ].freeze
 
@@ -79,16 +80,19 @@ module Mato
 
     def append_text_filter(text_filter, timeout: nil, on_timeout: nil, on_error: nil)
       raise "text_filter must respond to call()" unless text_filter.respond_to?(:call)
+
       text_filters.push(wrap(text_filter, timeout: timeout, on_timeout: on_timeout, on_error: on_error))
     end
 
     def append_markdown_filter(markdown_filter, timeout: nil, on_timeout: nil, on_error: nil)
       raise "markdown_filter must respond to call()" unless markdown_filter.respond_to?(:call)
+
       markdown_filters.push(wrap(markdown_filter, timeout: timeout, on_timeout: on_timeout, on_error: on_error))
     end
 
     def append_html_filter(html_filter, timeout: nil, on_timeout: nil, on_error: nil)
       raise "html_filter must respond to call()" unless html_filter.respond_to?(:call)
+
       html_filters.push(wrap(html_filter, timeout: timeout, on_timeout: on_timeout, on_error: on_error))
     end
 

data/lib/mato/converter.rb

@@ -48,7 +48,7 @@ module Mato
           node.sourcepos[:start_column] == 1 &&
           node.parent.type == :paragraph &&
           node.parent.parent.type == :document
-      end.reverse.each do |node|
+      end.reverse_each do |node|
         replacement = node.string_content.gsub(/\A(#+)(?=\S)/, '\1 ')
 
         if node.string_content != replacement

data/lib/mato/document.rb

@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 
 require_relative './renderers/html_renderer'

data/lib/mato/html_filters/bare_inline_element.rb

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

data/lib/mato/html_filters/mention_link.rb

@@ -37,7 +37,9 @@ module Mato
           next if text_node.content == candidate_html
 
           candidate_fragment = text_node.replace(candidate_html)
-          candidate_fragment.css('span').each do |mention_element|
+          candidate_fragment.css('span.mention-candidate').each do |mention_element|
+            next unless mention_element.child
+
             (candidate_map[mention_element.child.content] ||= []) << mention_element
           end
 
@@ -50,6 +52,8 @@ module Mato
           # cleanup
           candidates.each do |candidate_fragment|
             candidate_fragment.css('span.mention-candidate').each do |node|
+              next unless node.child
+
               node.replace(node.child.content)
             end
           end

data/lib/mato/html_filters/syntax_highlight.rb

@@ -5,6 +5,12 @@
 module Mato
   module HtmlFilters
     class SyntaxHighlight
+      class RougeError < StandardError
+      end
+
+      def initialize(on_rouge_error: ->(ex) { warn ex })
+        @on_rouge_error = on_rouge_error
+      end
 
       # @param [Nokogiri::HTML::DocumentFragment] doc
       def call(doc)
@@ -57,11 +63,21 @@ module Mato
 
         lexer = guess_lexer(language, filename, source)
 
-        document = Nokogiri::HTML.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>})
+        begin
+          document = Nokogiri::HTML.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>})
+        rescue => ex
+          if ex.is_a?(RougeError) && !lexer.is_a?(Rouge::Lexers::PlainText)
+            # Retry highlighting with PlainText lexer if Rouge raises an error.
+            # It avoids to affect the error to whole of converting.
+            lexer = Rouge::Lexers::PlainText.new
+            retry
+          else
+            raise ex
+          end
+        end
 
         document
       end
@@ -79,6 +95,9 @@ module Mato
       def format(lexer, source)
         tokens = lexer.lex(source)
         formatter.format(tokens)
+      rescue => ex
+        @on_rouge_error.call(ex)
+        raise RougeError.new
       end
     end
   end

data/lib/mato/html_filters/task_list.rb

@@ -3,15 +3,18 @@
 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
@@ -37,18 +40,34 @@ 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
 

data/lib/mato/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mato
-  VERSION = "2.1.1"
+  VERSION = "2.3.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.3"
+  spec.required_ruby_version = ">= 2.4"
 
-  spec.add_runtime_dependency "commonmarker", ">= 0.17.8"
+  spec.add_runtime_dependency "commonmarker", ">= 0.18.1"
   spec.add_runtime_dependency "nokogiri", ">= 1.6"
   spec.add_runtime_dependency "rouge", ">= 3.0.0"
 end

data/sider.yml

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mato
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.3.0
 platform: ruby
 authors:
 - FUJI Goro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-22 00:00:00.000000000 Z
+date: 2020-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.8
+        version: 0.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.8
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -89,10 +89,15 @@ files:
 - lib/mato/timeout.rb
 - lib/mato/version.rb
 - mato.gemspec
+- sider.yml
 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:
@@ -101,15 +106,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.0.pre1
 signing_key: 
 specification_version: 4
 summary: MArkdown TOolkit