qiita-markdown 0.44.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb18cd9f37329069980cc0322cff454cb1dcbd57ad3fe6836f40b3d8e968e304
-  data.tar.gz: ad7d5e7d89eeb283616d04e2fbdc8a1bb2b090897bf1538f6033d061cbe8d958
+  metadata.gz: 196cc261921bae3253f06a912b56e96a5912ed4552ec6352415756bcca1d98ed
+  data.tar.gz: '018a907a21f827e68a814ce0d15ff96f3cdccb4e6e52411b7ff63399c5c55f4b'
 SHA512:
-  metadata.gz: 4f38820e6f6eafd5135f7d6788e9b0f31ff45b42e85afc0ffb14213e263bb951250f734b1473cf1ffbcc21a5b22d823aed16235ab06bf2f218c39ff9aa59a42f
-  data.tar.gz: 0f4b493d2cb3c06de1c2a7d68455f39a9e496d2ae95ed6ff845b8caf3367128ae0ca863a937b44ddb87147573b261178bd6573c4c6042de14a19c7c56d3e5ca1
+  metadata.gz: 267fcb94bfc63e83b1f42bb42d01f61744d3979be9a92b1df767fc3c7ff3beed8b6299958677835f113abed3c6990bced41618c916650f34c31d5d125e16750d
+  data.tar.gz: 4a072057a0d55751e5b9e52357641930b1fd0301fe779720820705d453aaaae4fe5cd20bfec3354bb47eb8981ff3742b8a200b8bc647c3b42c5b99e27930458c

data/.github/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '2.6'
+          ruby-version: '2.7'
           bundler-cache: true
       - name: Test & publish code coverage
         if: "${{ env.CC_TEST_REPORTER_ID != '' }}"
@@ -37,7 +37,7 @@ jobs:
       fail-fast: false
       matrix:
         os: ['ubuntu-18.04', 'ubuntu-latest', 'macos-latest']
-        ruby: ['2.6', '2.7', '3.0', '3.1']
+        ruby: ['2.7', '3.0', '3.1']
         experimental: [false]
         include:
           - os: 'ubuntu-latest'

data/.rubocop.yml

@@ -6,10 +6,6 @@ AllCops:
 Metrics/ClassLength:
   Enabled: false
 
-Style/AsciiComments:
-  Exclude:
-    - benchmark/**/*
-
 Style/Documentation:
   Enabled: false
 

data/.rubocop_todo.yml

@@ -1,27 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --exclude-limit 99999`
-# on 2022-04-15 03:12:24 UTC using RuboCop version 1.27.0.
+# on 2022-11-15 12:42:36 UTC using RuboCop version 1.39.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
-# Include: **/*.gemspec
-Gemspec/OrderedDependencies:
-  Exclude:
-    - 'qiita-markdown.gemspec'
-
-# Offense count: 1
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequireMFA:
-  Exclude:
-    - 'qiita-markdown.gemspec'
-
 # Offense count: 1
 # Configuration parameters: Include.
 # Include: **/*.gemspec
@@ -29,66 +13,16 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'qiita-markdown.gemspec'
 
-# Offense count: 1
-# This cop supports safe auto-correction (--auto-correct).
-Layout/ClosingHeredocIndentation:
-  Exclude:
-    - 'spec/qiita/markdown/processor_spec.rb'
-
-# Offense count: 9
-# This cop supports safe auto-correction (--auto-correct).
-Layout/EmptyLineAfterGuardClause:
-  Exclude:
-    - 'lib/qiita/markdown/filters/custom_block.rb'
-    - 'lib/qiita/markdown/filters/external_link.rb'
-    - 'lib/qiita/markdown/filters/footnote.rb'
-    - 'lib/qiita/markdown/filters/mention.rb'
-    - 'lib/qiita/markdown/filters/simplify.rb'
-    - 'lib/qiita/markdown/transformers/filter_attributes.rb'
-
-# Offense count: 22
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
-# SupportedHashRocketStyles: key, separator, table
-# SupportedColonStyles: key, separator, table
-# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Layout/HashAlignment:
-  Exclude:
-    - 'lib/qiita/markdown/filters/user_input_sanitizer.rb'
-
-# Offense count: 1
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBrackets.
-# SupportedStyles: space, no_space, compact
-# SupportedStylesForEmptyBrackets: space, no_space
-Layout/SpaceInsideArrayLiteralBrackets:
-  Exclude:
-    - 'lib/qiita/markdown/transformers/filter_iframe.rb'
-
-# Offense count: 2
-# This cop supports safe auto-correction (--auto-correct).
-Lint/AmbiguousOperatorPrecedence:
-  Exclude:
-    - 'lib/qiita/markdown/filters/mention.rb'
-
-# Offense count: 5
-# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+# Offense count: 8
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 22
+  Max: 26
 
 # Offense count: 10
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
 Metrics/MethodLength:
   Max: 20
 
-# Offense count: 2
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: EnforcedStyle, BlockForwardingName.
-# SupportedStyles: anonymous, explicit
-Naming/BlockForwarding:
-  Exclude:
-    - 'lib/qiita/markdown/filters/truncate.rb'
-
 # Offense count: 1
 Naming/ConstantName:
   Exclude:
@@ -102,53 +36,28 @@ Naming/FileName:
   Exclude:
     - 'lib/qiita-markdown.rb'
 
-# Offense count: 33
+# Offense count: 21
 # Configuration parameters: ForbiddenDelimiters.
 # ForbiddenDelimiters: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
 Naming/HeredocDelimiterNaming:
   Exclude:
-    - 'spec/qiita/markdown/greenmat/html_toc_renderer_spec.rb'
     - 'spec/qiita/markdown/summary_processor_spec.rb'
 
-# Offense count: 3
-# Configuration parameters: EnforcedStyleForLeadingUnderscores.
-# SupportedStylesForLeadingUnderscores: disallowed, required, optional
-Naming/MemoizedInstanceVariableName:
-  Exclude:
-    - 'benchmark/heading_anchor_rendering.rb'
-    - 'lib/qiita/markdown/filters/greenmat.rb'
-    - 'lib/qiita/markdown/greenmat/heading_rendering.rb'
-
 # Offense count: 1
 # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
+# AllowedNames: as, at, by, db, id, if, in, io, ip, of, on, os, pp, to
 Naming/MethodParameterName:
   Exclude:
     - 'lib/qiita/markdown/filters/footnote.rb'
 
-# Offense count: 3
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: percent_q, bare_percent
-Style/BarePercentLiterals:
-  Exclude:
-    - 'lib/qiita/markdown/filters/syntax_highlight.rb'
-
-# Offense count: 1
-# This cop supports safe auto-correction (--auto-correct).
-Style/ExpandPathArguments:
-  Exclude:
-    - 'qiita-markdown.gemspec'
-
-# Offense count: 47
-# This cop supports safe auto-correction (--auto-correct).
+# Offense count: 37
+# This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: always, always_true, never
 Style/FrozenStringLiteralComment:
   Exclude:
     - 'Gemfile'
     - 'Rakefile'
-    - 'benchmark/heading_anchor_rendering.rb'
     - 'lib/qiita-markdown.rb'
     - 'lib/qiita/markdown.rb'
     - 'lib/qiita/markdown/base_processor.rb'
@@ -161,12 +70,9 @@ Style/FrozenStringLiteralComment:
     - 'lib/qiita/markdown/embed/youtube.rb'
     - 'lib/qiita/markdown/filters/checkbox.rb'
     - 'lib/qiita/markdown/filters/code_block.rb'
-    - 'lib/qiita/markdown/filters/custom_block.rb'
     - 'lib/qiita/markdown/filters/emoji.rb'
     - 'lib/qiita/markdown/filters/external_link.rb'
-    - 'lib/qiita/markdown/filters/final_sanitizer.rb'
     - 'lib/qiita/markdown/filters/footnote.rb'
-    - 'lib/qiita/markdown/filters/greenmat.rb'
     - 'lib/qiita/markdown/filters/group_mention.rb'
     - 'lib/qiita/markdown/filters/image_link.rb'
     - 'lib/qiita/markdown/filters/inline_code_color.rb'
@@ -175,10 +81,6 @@ Style/FrozenStringLiteralComment:
     - 'lib/qiita/markdown/filters/syntax_highlight.rb'
     - 'lib/qiita/markdown/filters/toc.rb'
     - 'lib/qiita/markdown/filters/truncate.rb'
-    - 'lib/qiita/markdown/filters/user_input_sanitizer.rb'
-    - 'lib/qiita/markdown/greenmat/heading_rendering.rb'
-    - 'lib/qiita/markdown/greenmat/html_renderer.rb'
-    - 'lib/qiita/markdown/greenmat/html_toc_renderer.rb'
     - 'lib/qiita/markdown/processor.rb'
     - 'lib/qiita/markdown/summary_processor.rb'
     - 'lib/qiita/markdown/transformers/filter_attributes.rb'
@@ -187,166 +89,40 @@ Style/FrozenStringLiteralComment:
     - 'lib/qiita/markdown/transformers/strip_invalid_node.rb'
     - 'lib/qiita/markdown/version.rb'
     - 'qiita-markdown.gemspec'
-    - 'spec/qiita/markdown/filters/greenmat_spec.rb'
     - 'spec/qiita/markdown/filters/inline_code_color_spec.rb'
-    - 'spec/qiita/markdown/greenmat/html_toc_renderer_spec.rb'
     - 'spec/qiita/markdown/processor_spec.rb'
     - 'spec/qiita/markdown/summary_processor_spec.rb'
     - 'spec/spec_helper.rb'
 
-# Offense count: 6
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: EnforcedShorthandSyntax, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
-# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
-# SupportedShorthandSyntax: always, never, either
-Style/HashSyntax:
-  EnforcedStyle: ruby19
-  EnforcedShorthandSyntax: never
-
-# Offense count: 2
-# This cop supports safe auto-correction (--auto-correct).
-Style/IfUnlessModifier:
-  Exclude:
-    - 'lib/qiita/markdown/filters/truncate.rb'
-    - 'lib/qiita/markdown/transformers/strip_invalid_node.rb'
-
 # Offense count: 17
-# This cop supports safe auto-correction (--auto-correct).
+# This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: literals, strict
 Style/MutableConstant:
   Exclude:
     - 'lib/qiita/markdown/embed/code_pen.rb'
-    - 'lib/qiita/markdown/filters/group_mention.rb'
-    - 'lib/qiita/markdown/filters/inline_code_color.rb'
-    - 'lib/qiita/markdown/filters/mention.rb'
     - 'lib/qiita/markdown/embed/tweet.rb'
     - 'lib/qiita/markdown/filters/checkbox.rb'
     - 'lib/qiita/markdown/filters/code_block.rb'
+    - 'lib/qiita/markdown/filters/group_mention.rb'
+    - 'lib/qiita/markdown/filters/inline_code_color.rb'
+    - 'lib/qiita/markdown/filters/mention.rb'
     - 'lib/qiita/markdown/filters/simplify.rb'
     - 'lib/qiita/markdown/filters/syntax_highlight.rb'
     - 'lib/qiita/markdown/version.rb'
 
-# Offense count: 2
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: EnforcedStyle, MinBodyLength.
-# SupportedStyles: skip_modifier_ifs, always
-Style/Next:
-  Exclude:
-    - 'lib/qiita/markdown/filters/code_block.rb'
-    - 'lib/qiita/markdown/filters/image_link.rb'
-
-# Offense count: 5
-# This cop supports unsafe auto-correction (--auto-correct-all).
-# Configuration parameters: EnforcedStyle, IgnoredMethods.
-# SupportedStyles: predicate, comparison
-Style/NumericPredicate:
-  Exclude:
-    - 'spec/**/*'
-    - 'benchmark/heading_anchor_rendering.rb'
-    - 'lib/qiita/markdown/greenmat/heading_rendering.rb'
-    - 'lib/qiita/markdown/greenmat/html_toc_renderer.rb'
-
-# Offense count: 1
-# Configuration parameters: AllowedMethods.
-# AllowedMethods: respond_to_missing?
-Style/OptionalBooleanParameter:
-  Exclude:
-    - 'lib/qiita/markdown/greenmat/heading_rendering.rb'
-
-# Offense count: 1
-# This cop supports safe auto-correction (--auto-correct).
-Style/OrAssignment:
-  Exclude:
-    - 'lib/qiita/markdown/greenmat/html_toc_renderer.rb'
-
-# Offense count: 9
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Exclude:
-    - 'benchmark/heading_anchor_rendering.rb'
-    - 'lib/qiita/markdown/filters/mention.rb'
-    - 'lib/qiita/markdown/filters/syntax_highlight.rb'
-    - 'spec/qiita/markdown/processor_spec.rb'
-    - 'spec/qiita/markdown/summary_processor_spec.rb'
-
 # Offense count: 1
-# This cop supports safe auto-correction (--auto-correct).
-Style/PerlBackrefs:
-  Exclude:
-    - 'lib/qiita/markdown/filters/mention.rb'
-
-# Offense count: 1
-# This cop supports unsafe auto-correction (--auto-correct-all).
+# This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: Methods.
 Style/RedundantArgument:
   Exclude:
     - 'lib/qiita/markdown/filters/custom_block.rb'
 
-# Offense count: 1
-# This cop supports safe auto-correction (--auto-correct).
-Style/RedundantRegexpCharacterClass:
-  Exclude:
-    - 'lib/qiita/markdown/filters/mention.rb'
-
-# Offense count: 9
-# This cop supports safe auto-correction (--auto-correct).
-Style/RedundantRegexpEscape:
-  Exclude:
-    - 'lib/qiita/markdown/filters/group_mention.rb'
-    - 'lib/qiita/markdown/filters/inline_code_color.rb'
-
-# Offense count: 4
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
-# SupportedStyles: slashes, percent_r, mixed
-Style/RegexpLiteral:
-  Exclude:
-    - 'lib/qiita/markdown/filters/inline_code_color.rb'
-    - 'lib/qiita/markdown/filters/mention.rb'
-
-# Offense count: 1
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: implicit, explicit
-Style/RescueStandardError:
-  Exclude:
-    - 'lib/qiita/markdown/filters/syntax_highlight.rb'
-
 # Offense count: 2
-# This cop supports safe auto-correction (--auto-correct).
+# This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods, MaxChainLength.
 # AllowedMethods: present?, blank?, presence, try, try!
 Style/SafeNavigation:
   Exclude:
     - 'lib/qiita/markdown/filters/custom_block.rb'
     - 'lib/qiita/markdown/filters/toc.rb'
-
-# Offense count: 3
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: only_raise, only_fail, semantic
-Style/SignalException:
-  Exclude:
-    - 'lib/qiita/markdown/greenmat/heading_rendering.rb'
-    - 'spec/qiita/markdown/summary_processor_spec.rb'
-
-# Offense count: 13
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInArguments:
-  Exclude:
-    - 'lib/qiita/markdown/filters/mention.rb'
-    - 'spec/qiita/markdown/processor_spec.rb'
-
-# Offense count: 12
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: EnforcedStyle, MinSize, WordRegex.
-# SupportedStyles: percent, brackets
-Style/WordArray:
-  Exclude:
-    - 'lib/qiita/markdown/filters/final_sanitizer.rb'
-    - 'lib/qiita/markdown/transformers/filter_script.rb'
-    - 'spec/qiita/markdown/processor_spec.rb'

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## Unreleased
 
+## 1.0.0
+
+- Drop Ruby 2.6 support
+- Change markdown parser from Greenmat to Qiita Marker
+- Fix bug on rendering loose tasklist
+
+### Braking change on HTML output
+
+Some notations will be changed between Greenmat and Qiita Marker and rendering results may change. More details, see [#130](https://github.com/increments/qiita-markdown/issues/130).
+
+## 0.44.1
+
+- Rename package name from `Qiita::Markdown` to `Qiita Markdown` in README
+- Bump rubocop from 1.27.0 to 1.39.0 and apply rubocop auto correct
+
 ## 0.44.0
 
 - Support Figma embedding scripts

data/README.md

@@ -1,4 +1,4 @@
-# Qiita::Markdown
+# Qiita Markdown
 
 [![Gem Version](https://badge.fury.io/rb/qiita-markdown.svg)](https://badge.fury.io/rb/qiita-markdown)
 [![Build Status](https://travis-ci.org/increments/qiita-markdown.svg)](https://travis-ci.org/increments/qiita-markdown)
@@ -16,6 +16,7 @@ Qiita-specified markdown processor.
 - Syntax highlighting
 - Mention
 - Footnotes
+- Note notation's custom block
 
 ## Basic Usage
 
@@ -42,7 +43,7 @@ processor.call(markdown)
 
 ### Filters
 
-Qiita::Markdown is built on [jch/html-pipeline](https://github.com/jch/html-pipeline).
+Qiita Markdown is built on [jch/html-pipeline](https://github.com/jch/html-pipeline).
 Add your favorite html-pipeline-compatible filters.
 
 ```ruby
@@ -68,7 +69,8 @@ processor.call(text)
 :inline_code_color_class_name - Class name for inline code color. (String)
 :language_aliases             - Alias table for some language names. (Hash)
 :markdown                     - A hash for enabling / disabling optional Markdown syntax. (Hash)
-                                Currently only :footnotes (default: true) is supported.
+                                Currently :footnotes (default: true) and :sourcepos (defalut: false) are supported.
+                                For more information on these options, please see [increments/qiita_marker](https://github.com/increments/qiita_marker).
 :rule                         - Sanitization rule table. (Hash)
 :script                       - A flag to allow to embed script element. (Boolean)
 ```

data/lib/qiita/markdown/filters/checkbox.rb

@@ -55,7 +55,11 @@ module Qiita
           end
 
           def first_text_node
-            if @node.children.first && @node.children.first.name == "p"
+            is_loose_list_node = @node.children.first&.text == "\n" && @node.children[1]&.name == "p"
+
+            if is_loose_list_node
+              @node.children[1].children.first
+            elsif @node.children.first && @node.children.first.name == "p"
               @node.children.first.children.first
             else
               @node.children.first

data/lib/qiita/markdown/filters/code_block.rb

@@ -16,19 +16,19 @@ module Qiita
         def call
           result[:codes] ||= []
           doc.search("pre").each do |pre|
-            if (code = pre.at("code"))
-              metadata = Metadata.new(code["data-metadata"])
-              filename = metadata.filename
-              language = metadata.language
-              language = language_aliases[language] || language
-              pre["filename"] = filename if filename
-              pre["lang"] = language if language
-              result[:codes] << {
-                code: pre.text,
-                filename: filename,
-                language: language,
-              }
-            end
+            next unless (code = pre.at("code"))
+
+            metadata = Metadata.new(code["data-metadata"])
+            filename = metadata.filename
+            language = metadata.language
+            language = language_aliases[language] || language
+            pre["filename"] = filename if filename
+            pre["lang"] = language if language
+            result[:codes] << {
+              code: pre.text,
+              filename: filename,
+              language: language,
+            }
           end
           doc
         end

data/lib/qiita/markdown/filters/custom_block.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Qiita
   module Markdown
     module Filters
@@ -8,6 +10,7 @@ module Qiita
           doc.search('div[data-type="customblock"]').each do |div|
             metadata = Metadata.new(div["data-metadata"])
             next unless ALLOWED_TYPES.include?(metadata.type)
+
             klass = Object.const_get("#{self.class}::#{metadata.type.capitalize}")
             klass.new(div, metadata.subtype).convert
           end
@@ -30,7 +33,7 @@ module Qiita
           attr_reader :node, :type
 
           ALLOWED_TYPES = %w[info warn alert].freeze
-          DEFAULT_TYPE = "info".freeze
+          DEFAULT_TYPE = "info"
 
           # @param node [Nokogiri::XML::Node]
           # @param type [String, nil]
@@ -40,17 +43,16 @@ module Qiita
           end
 
           def convert
-            node.inner_html = message
+            children = node.children
+            children.each(&:unlink)
+            node.add_child("<div></div>")
+            node.children.first.children = children
             node["class"] = "note #{type}"
             node.children.first.add_previous_sibling(icon) if icon
           end
 
           private
 
-          def message
-            "<p>#{node.text}</p>"
-          end
-
           def icon
             {
               info: %(<span class="fa fa-fw fa-check-circle"></span>),

data/lib/qiita/markdown/filters/external_link.rb

@@ -7,9 +7,11 @@ module Qiita
         def call
           doc.search("a").each do |anchor|
             next unless anchor["href"]
+
             href = anchor["href"].strip
             href_host = host_of(href)
             next unless href_host
+
             if href_host != hostname
               anchor["rel"] = "nofollow noopener"
               anchor["target"] = "_blank"