qiita-markdown 0.44.0 → 1.0.0

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: qiita-markdown
 version: !ruby/object:Gem::Version
-  version: 0.44.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: gemoji
   requirement: !ruby/object:Gem::Requirement
@@ -81,27 +95,41 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.26.0
 - !ruby/object:Gem::Dependency
-  name: greenmat
+  name: sanitize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.1.4
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.1.4
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sanitize
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.7
+- !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -109,13 +137,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.4
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -123,61 +165,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: qiita_marker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.7
+        version: 0.23.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.7
+        version: 0.23.6
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 1.39.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 1.39.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -234,62 +276,6 @@ dependencies:
     - - "!="
       - !ruby/object:Gem::Version
         version: 0.19.1
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.27.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.27.0
 description: 
 email:
 - r7kamura@gmail.com
@@ -307,8 +293,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- benchmark/heading_anchor_rendering.rb
-- benchmark/sample.md
 - lib/qiita-markdown.rb
 - lib/qiita/markdown.rb
 - lib/qiita/markdown/base_processor.rb
@@ -328,19 +312,18 @@ files:
 - 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/heading_anchor.rb
+- lib/qiita/markdown/filters/html_toc.rb
 - lib/qiita/markdown/filters/image_link.rb
 - lib/qiita/markdown/filters/inline_code_color.rb
 - lib/qiita/markdown/filters/mention.rb
+- lib/qiita/markdown/filters/qiita_marker.rb
 - lib/qiita/markdown/filters/simplify.rb
 - 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
@@ -350,16 +333,18 @@ files:
 - lib/qiita/markdown/version.rb
 - qiita-markdown.gemspec
 - spec/qiita/markdown/filters/checkbox_spec.rb
-- spec/qiita/markdown/filters/greenmat_spec.rb
+- spec/qiita/markdown/filters/heading_anchor_spec.rb
+- spec/qiita/markdown/filters/html_toc_spec.rb
 - spec/qiita/markdown/filters/inline_code_color_spec.rb
-- spec/qiita/markdown/greenmat/html_toc_renderer_spec.rb
+- spec/qiita/markdown/filters/qiita_marker_spec.rb
 - spec/qiita/markdown/processor_spec.rb
 - spec/qiita/markdown/summary_processor_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/increments/qiita-markdown
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -368,22 +353,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Qiita-specified markdown processor.
-test_files:
-- spec/qiita/markdown/filters/checkbox_spec.rb
-- 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
+test_files: []

data/benchmark/heading_anchor_rendering.rb

@@ -1,248 +0,0 @@
-require "benchmark/ips"
-require "qiita/markdown"
-
-# The old implementation
-module PostProcess
-  class Processor < Qiita::Markdown::Processor
-    def filters
-      @filters ||= [
-        Filters::Greenmat,
-        Filters::Toc,
-      ]
-    end
-  end
-
-  module Filters
-    class Greenmat < HTML::Pipeline::TextFilter
-      class << self
-        # Memoize.
-        # @return [Greenmat::Markdown]
-        def renderer
-          @renderer ||= ::Greenmat::Markdown.new(
-            ::Greenmat::Render::HTML.new(
-              hard_wrap: true,
-            ),
-            autolink: true,
-            fenced_code_blocks: true,
-            footnotes: true,
-            no_intra_emphasis: true,
-            no_mention_emphasis: true,
-            strikethrough: true,
-            tables: true,
-          )
-        end
-      end
-
-      # @return [Nokogiri::HTML::DocumentFragment]
-      def call
-        Nokogiri::HTML.fragment(self.class.renderer.render(@text))
-      end
-    end
-
-    class Toc < HTML::Pipeline::Filter
-      def call
-        counter = Hash.new(0)
-        doc.css("h1, h2, h3, h4, h5, h6").each do |node|
-          heading = Heading.new(node, counter)
-          heading.add_anchor_element if heading.has_first_child?
-          heading.increment
-        end
-        doc
-      end
-
-      class Heading
-        def initialize(node, counter)
-          @node = node
-          @counter = counter
-        end
-
-        def add_anchor_element
-          first_child.add_previous_sibling(anchor_element)
-        end
-
-        def anchor_element
-          %[<span id="#{suffixed_id}" class="fragment"></span><a href="##{suffixed_id}"><i class="fa fa-link"></i></a>]
-        end
-
-        def content
-          @content ||= node.children.first
-        end
-
-        def count
-          @counter[id]
-        end
-
-        def first_child
-          @first_child ||= @node.children.first
-        end
-
-        def has_count?
-          count > 0
-        end
-
-        def has_first_child?
-          !!first_child
-        end
-
-        def id
-          @node.text.downcase.gsub(/[^\p{Word}\- ]/u, "").tr(" ", "-")
-        end
-
-        def increment
-          @counter[id] += 1
-        end
-
-        def suffix
-          has_count? ? "-#{count}" : ""
-        end
-
-        def suffixed_id
-          "#{id}#{suffix}"
-        end
-      end
-    end
-  end
-end
-
-# The new implementation
-module Rendering
-  class Processor < Qiita::Markdown::Processor
-    def filters
-      @filters ||= [
-        Filters::Greenmat,
-      ]
-    end
-  end
-
-  module Filters
-    class Greenmat < HTML::Pipeline::TextFilter
-      def call
-        Nokogiri::HTML.fragment(greenmat.render(@text))
-      end
-
-      private
-
-      # Memoize.
-      # @return [Greenmat::Markdown]
-      def greenmat
-        @renderer ||= ::Greenmat::Markdown.new(
-          HTMLRenderer.new(hard_wrap: true, with_toc_data: true),
-          autolink: true,
-          fenced_code_blocks: true,
-          footnotes: true,
-          no_intra_emphasis: true,
-          no_mention_emphasis: true,
-          strikethrough: true,
-          tables: true,
-        )
-      end
-
-      class HTMLRenderer < ::Greenmat::Render::HTML
-        def initialize(extensions = {})
-          super
-          @with_toc_data = extensions[:with_toc_data]
-        end
-
-        def header(text, level)
-          heading = heading_class.new(text, level, counter)
-          heading.to_s.tap do
-            heading.increment
-          end
-        end
-
-        private
-
-        def heading_class
-          @heading_class ||= (@with_toc_data ? HeadingWithAnchor : Heading)
-        end
-
-        def counter
-          @counter ||= Hash.new(0)
-        end
-
-        Heading = Struct.new(:body, :level, :counter) do
-          # For reference, C implementation of Redcarpet::Render::HTML#header is the following:
-          # https://github.com/vmg/redcarpet/blob/v3.2.3/ext/redcarpet/html.c#L281-L296
-          def to_s
-            "\n<h#{level}>#{body}</h#{level}>\n"
-          end
-
-          def increment
-            # no-op
-          end
-
-          private
-
-          def content
-            body
-          end
-        end
-
-        class HeadingWithAnchor < Heading
-          def to_s
-            "\n<h#{level}>#{anchor_element}#{body}</h#{level}>\n"
-          end
-
-          def increment
-            counter[id] += 1
-          end
-
-          private
-
-          def anchor_element
-            %(<span id="#{suffixed_id}" class="fragment"></span><a href="##{suffixed_id}"><i class="fa fa-link"></i></a>)
-          end
-
-          def count
-            counter[id]
-          end
-
-          def has_count?
-            count > 0
-          end
-
-          def id
-            @id ||= text.downcase.gsub(/[^\p{Word}\- ]/u, "").tr(" ", "-")
-          end
-
-          def text
-            Nokogiri::HTML.fragment(body).text
-          end
-
-          def suffix
-            has_count? ? "-#{count}" : ""
-          end
-
-          def suffixed_id
-            @suffixed_id ||= "#{id}#{suffix}"
-          end
-        end
-      end
-    end
-  end
-end
-
-markdown = File.read(File.join(File.dirname(__FILE__), "sample.md"))
-
-Benchmark.ips do |benchmark|
-  benchmark.report("post process") do
-    PostProcess::Processor.new.call(markdown)
-  end
-
-  benchmark.report("rendering") do
-    Rendering::Processor.new.call(markdown)
-  end
-
-  benchmark.compare!
-end
-
-# Calculating -------------------------------------
-#         post process         4 i/100ms
-#            rendering        14 i/100ms
-# -------------------------------------------------
-#         post process       44.9 (±13.4%) i/s -        224 in   5.066301s
-#            rendering      151.1 (±16.5%) i/s -        742 in   5.057789s
-#
-# Comparison:
-#            rendering:      151.1 i/s
-#         post process:       44.9 i/s - 3.36x slower