qiita-markdown 0.44.0 → 1.0.0

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

@@ -1,36 +1,43 @@
+# frozen_string_literal: true
+
 module Qiita
   module Markdown
     module Filters
       # Sanitizes user input if :strict context is given.
-      class UserInputSanitizer < HTML::Pipeline::Filter
+      class UserInputSanitizer < ::HTML::Pipeline::Filter
         RULE = {
           elements: %w[
-            a b blockquote br code dd del details div dl dt em font h1 h2 h3 h4 h5 h6
-            hr i img ins kbd li ol p pre q rp rt ruby s samp script iframe strike strong sub
+            a b blockquote br caption code dd del details div dl dt em font h1 h2 h3 h4 h5 h6
+            hr i img ins kbd li ol p pre q rp rt ruby s samp script iframe section strike strong sub
             summary sup table tbody td tfoot th thead tr ul var
           ],
           attributes: {
-            "a"          => %w[class href rel title],
+            "a" => %w[class href rel title id],
             "blockquote" => %w[cite] + Embed::Tweet::ATTRIBUTES,
-            "code"       => %w[data-metadata],
-            "div"        => %w[class data-type data-metadata],
-            "font"       => %w[color],
-            "h1"         => %w[id],
-            "h2"         => %w[id],
-            "h3"         => %w[id],
-            "h4"         => %w[id],
-            "h5"         => %w[id],
-            "h6"         => %w[id],
-            "img"        => %w[alt height src title width],
-            "ins"        => %w[cite datetime],
-            "li"         => %w[id],
-            "p"          => Embed::CodePen::ATTRIBUTES,
-            "q"          => %w[cite],
-            "script"     => %w[async src id].concat(Embed::SpeekerDeck::ATTRIBUTES, Embed::Docswell::ATTRIBUTES),
-            "iframe"     => %w[
+            "code" => %w[data-metadata],
+            "div" => %w[class data-type data-metadata],
+            "font" => %w[color],
+            "h1" => %w[id],
+            "h2" => %w[id],
+            "h3" => %w[id],
+            "h4" => %w[id],
+            "h5" => %w[id],
+            "h6" => %w[id],
+            "img" => %w[alt height src title width],
+            "ins" => %w[cite datetime],
+            "li" => %w[id],
+            "p" => Embed::CodePen::ATTRIBUTES,
+            "q" => %w[cite],
+            "section" => %w[class],
+            "script" => %w[async src id].concat(
+              Embed::SpeekerDeck::ATTRIBUTES,
+              Embed::Docswell::ATTRIBUTES,
+            ),
+            "iframe" => %w[
               allowfullscreen
               frameborder
               height
+              loading
               marginheight
               marginwidth
               scrolling
@@ -38,20 +45,18 @@ module Qiita
               style
               width
             ],
-            "sup"        => %w[id],
-            "td"         => %w[colspan rowspan style],
-            "th"         => %w[colspan rowspan style],
+            "sup" => %w[id],
+            "td" => %w[colspan rowspan style],
+            "th" => %w[colspan rowspan style],
+            all: %w[data-sourcepos],
           },
           protocols: {
-            "a"          => { "href" => ["http", "https", "mailto", :relative] },
+            "a" => { "href" => ["http", "https", "mailto", :relative] },
             "blockquote" => { "cite" => ["http", "https", :relative] },
-            "q"          => { "cite" => ["http", "https", :relative] },
+            "q" => { "cite" => ["http", "https", :relative] },
           },
           css: {
-            properties: %w[
-              text-align
-              border
-            ],
+            properties: %w[text-align border],
           },
           transformers: [
             Transformers::FilterAttributes,

data/lib/qiita/markdown/processor.rb

@@ -9,7 +9,8 @@ module Qiita
 
       def self.default_filters
         [
-          Filters::Greenmat,
+          Filters::QiitaMarker,
+          Filters::HeadingAnchor,
           Filters::UserInputSanitizer,
           Filters::ImageLink,
           Filters::Footnote,

data/lib/qiita/markdown/summary_processor.rb

@@ -15,7 +15,7 @@ module Qiita
 
       def self.default_filters
         [
-          Filters::Greenmat,
+          Filters::QiitaMarker,
           Filters::UserInputSanitizer,
           Filters::Simplify,
           Filters::Emoji,

data/lib/qiita/markdown/transformers/filter_attributes.rb

@@ -37,6 +37,7 @@ module Qiita
 
         def transform
           return unless FILTERS.key?(name)
+
           FILTERS[name].each_pair do |attr, pattern|
             filter_attribute(attr, pattern) if node.attributes.key?(attr)
           end

data/lib/qiita/markdown/transformers/filter_iframe.rb

@@ -2,8 +2,7 @@ module Qiita
   module Markdown
     module Transformers
       class FilterIframe
-        URL_WHITE_LIST = [
-        ].flatten.freeze
+        URL_WHITE_LIST = [].flatten.freeze
 
         HOST_WHITE_LIST = [
           Embed::Youtube::SCRIPT_HOSTS,

data/lib/qiita/markdown/transformers/filter_script.rb

@@ -45,7 +45,7 @@ module Qiita
         def host_of(url)
           if url
             scheme = URI.parse(url).scheme
-            Addressable::URI.parse(url).host if ["http", "https"].include? scheme
+            Addressable::URI.parse(url).host if %w[http https].include? scheme
           end
         rescue Addressable::URI::InvalidURIError, URI::InvalidURIError
           nil

data/lib/qiita/markdown/transformers/strip_invalid_node.rb

@@ -12,9 +12,7 @@ module Qiita
         end
 
         def transform
-          if has_invalid_list_node? || has_invalid_table_node?
-            node.replace(node.children)
-          end
+          node.replace(node.children) if has_invalid_list_node? || has_invalid_table_node?
         end
 
         private

data/lib/qiita/markdown/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Markdown
-    VERSION = "0.44.0"
+    VERSION = "1.0.0"
   end
 end

data/lib/qiita/markdown.rb

@@ -1,9 +1,9 @@
 require "cgi"
-require "greenmat"
 require "html/pipeline"
 require "linguist"
 require "mem"
 require "nokogiri"
+require "qiita_marker"
 require "rouge"
 require "sanitize"
 
@@ -27,19 +27,18 @@ require "qiita/markdown/filters/emoji"
 require "qiita/markdown/filters/external_link"
 require "qiita/markdown/filters/final_sanitizer"
 require "qiita/markdown/filters/footnote"
-require "qiita/markdown/filters/greenmat"
 require "qiita/markdown/filters/group_mention"
+require "qiita/markdown/filters/heading_anchor"
+require "qiita/markdown/filters/html_toc"
 require "qiita/markdown/filters/image_link"
 require "qiita/markdown/filters/inline_code_color"
 require "qiita/markdown/filters/mention"
+require "qiita/markdown/filters/qiita_marker"
 require "qiita/markdown/filters/simplify"
 require "qiita/markdown/filters/syntax_highlight"
 require "qiita/markdown/filters/toc"
 require "qiita/markdown/filters/truncate"
 require "qiita/markdown/filters/user_input_sanitizer"
-require "qiita/markdown/greenmat/heading_rendering"
-require "qiita/markdown/greenmat/html_renderer"
-require "qiita/markdown/greenmat/html_toc_renderer"
 require "qiita/markdown/base_processor"
 require "qiita/markdown/processor"
 require "qiita/markdown/summary_processor"

data/qiita-markdown.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "qiita/markdown/version"
 
@@ -13,26 +13,25 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
+  spec.add_dependency "addressable"
   spec.add_dependency "gemoji"
   spec.add_dependency "github-linguist", "~> 4.0"
   spec.add_dependency "html-pipeline", "~> 2.0"
   spec.add_dependency "mem"
   spec.add_dependency "rouge", "3.26.0"
-  spec.add_dependency "greenmat", "3.5.1.4"
   spec.add_dependency "sanitize"
-  spec.add_dependency "addressable"
   spec.add_development_dependency "activesupport", "~> 5.2.7"
-  spec.add_development_dependency "benchmark-ips", "~> 1.2"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "codeclimate-test-reporter", "0.4.4"
-  spec.add_development_dependency "simplecov", "!= 0.18.0", "!= 0.18.1", "!= 0.18.2", "!= 0.18.3", "!= 0.18.4", "!= 0.18.5", "!= 0.19.0", "!= 0.19.1"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "qiita_marker", "~> 0.23.6"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.1"
-  spec.add_development_dependency "rubocop", "~> 1.27.0"
+  spec.add_development_dependency "rubocop", "~> 1.39.0"
+  spec.add_development_dependency "simplecov", "!= 0.18.0", "!= 0.18.1", "!= 0.18.2", "!= 0.18.3", "!= 0.18.4", "!= 0.18.5", "!= 0.19.0", "!= 0.19.1"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/spec/qiita/markdown/filters/checkbox_spec.rb

@@ -26,6 +26,34 @@ describe Qiita::Markdown::Filters::Checkbox do
       expect(filter.call.to_s).to eq(output_html)
     end
 
+    context "when list is loose" do
+      let(:input_html) do
+        <<~HTML
+          <li>
+          <p>[ ] a</p>
+          </li>
+          <li>
+          <p>[x] b</p>
+          </li>
+        HTML
+      end
+
+      let(:output_html) do
+        <<~HTML
+          <li class="task-list-item">
+          <p><input type="checkbox" class="task-list-item-checkbox" disabled>a</p>
+          </li>
+          <li class="task-list-item">
+          <p><input type="checkbox" class="task-list-item-checkbox" checked disabled>b</p>
+          </li>
+        HTML
+      end
+
+      it "replaces checkboxes" do
+        expect(filter.call.to_s).to eq(output_html)
+      end
+    end
+
     context "when input html has many spaces after checkbox mark" do
       let(:input_html) do
         <<~HTML

data/spec/qiita/markdown/filters/heading_anchor_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+describe Qiita::Markdown::Filters::HeadingAnchor do
+  subject(:filter) { described_class.new(html) }
+
+  let(:html) do
+    <<~HTML
+      <h1>foo</h1>
+      <h2>bar</h2>
+      <h3>fizz</h3>
+      <p>paragraph</p>
+      <h4>buzz</h4>
+      <h5>hoge</h5>
+      <h6>fuga</h6>
+      <code>code</code>
+    HTML
+  end
+
+  it "renders ids" do
+    expect(filter.call.to_s).to eq(<<~HTML)
+      <h1 id="foo">foo</h1>
+      <h2 id="bar">bar</h2>
+      <h3 id="fizz">fizz</h3>
+      <p>paragraph</p>
+      <h4 id="buzz">buzz</h4>
+      <h5 id="hoge">hoge</h5>
+      <h6 id="fuga">fuga</h6>
+      <code>code</code>
+    HTML
+  end
+
+  context "with headings text is same" do
+    let(:html) do
+      <<~HTML
+        <h1>foo</h1>
+        <h2>foo</h2>
+        <h3>foo</h3>
+        <p>paragraph</p>
+        <h4>foo</h4>
+        <h5>foo</h5>
+        <h6>foo</h6>
+        <code>code</code>
+      HTML
+    end
+
+    it "renders suffixed ids" do
+      expect(filter.call.to_s).to eq(<<~HTML)
+        <h1 id="foo">foo</h1>
+        <h2 id="foo-1">foo</h2>
+        <h3 id="foo-2">foo</h3>
+        <p>paragraph</p>
+        <h4 id="foo-3">foo</h4>
+        <h5 id="foo-4">foo</h5>
+        <h6 id="foo-5">foo</h6>
+        <code>code</code>
+      HTML
+    end
+  end
+
+  context "with characters that cannot included" do
+    let(:html) do
+      <<~HTML
+        <h1>test [foo-bar]</h1>
+      HTML
+    end
+
+    it "renders id with omitted characters" do
+      expect(filter.call.to_s).to eq(<<~HTML)
+        <h1 id="test-foo-bar">test [foo-bar]</h1>
+      HTML
+    end
+  end
+end

data/spec/qiita/markdown/filters/html_toc_spec.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+describe Qiita::Markdown::Filters::HtmlToc do
+  subject(:filter) { described_class.new(html) }
+
+  context "with headings h1, h2, h3, h4, h5, h6" do
+    let(:html) do
+      <<~HTML
+        <h1 id="foo">foo</h1>
+        <h2 id="bar">bar</h2>
+        <h3 id="fizz">fizz</h3>
+        <p>paragraph</p>
+        <h4 id="buzz">buzz</h4>
+        <h5 id="hoge">hoge</h5>
+        <h6 id="fuga">fuga</h6>
+        <code>code</code>
+      HTML
+    end
+
+    let(:result) do
+      <<~HTML
+        <ul>
+        <li>
+        <a href="#foo">foo</a>
+        <ul>
+        <li>
+        <a href="#bar">bar</a>
+        <ul>
+        <li>
+        <a href="#fizz">fizz</a>
+        <ul>
+        <li>
+        <a href="#buzz">buzz</a>
+        <ul>
+        <li>
+        <a href="#hoge">hoge</a>
+        <ul>
+        <li>
+        <a href="#fuga">fuga</a>
+        </li>
+        </ul>
+        </li>
+        </ul>
+        </li>
+        </ul>
+        </li>
+        </ul>
+        </li>
+        </ul>
+        </li>
+        </ul>
+      HTML
+    end
+
+    it "renders nested toc" do
+      expect(filter.call).to eq(result)
+    end
+  end
+
+  context "headings are same rank" do
+    let(:html) do
+      <<~HTML
+        <h1 id="foo">foo</h1>
+        <h1 id="bar">bar</h1>
+        <h1 id="fizz">fizz</h1>
+      HTML
+    end
+
+    let(:result) do
+      <<~HTML
+        <ul>
+        <li>
+        <a href="#foo">foo</a>
+        </li>
+        <li>
+        <a href="#bar">bar</a>
+        </li>
+        <li>
+        <a href="#fizz">fizz</a>
+        </li>
+        </ul>
+      HTML
+    end
+
+    it "renders toc of same level" do
+      expect(filter.call).to eq(result)
+    end
+  end
+
+  context "with heading rank going up" do
+    let(:html) do
+      <<~HTML
+        <h1 id="foo">foo</h1>
+        <h3 id="bar">bar</h3>
+        <h1 id="bazz">bazz</h1>
+      HTML
+    end
+
+    let(:result) do
+      <<~HTML
+        <ul>
+        <li>
+        <a href="#foo">foo</a>
+        <ul>
+        <li>
+        <ul>
+        <li>
+        <a href="#bar">bar</a>
+        </li>
+        </ul>
+        </li>
+        </ul>
+        </li>
+        <li>
+        <a href="#bazz">bazz</a>
+        </li>
+        </ul>
+      HTML
+    end
+
+    it "renders toc that the depth goes up" do
+      expect(filter.call).to eq(result)
+    end
+  end
+
+  context "with starting from h2" do
+    let(:html) do
+      <<~HTML
+        <h2 id="bar">bar</h2>
+        <h3 id="fizz">fizz</h3>
+      HTML
+    end
+
+    let(:result) do
+      <<~HTML
+        <ul>
+        <li>
+        <a href="#bar">bar</a>
+        <ul>
+        <li>
+        <a href="#fizz">fizz</a>
+        </li>
+        </ul>
+        </li>
+        </ul>
+      HTML
+    end
+
+    it "renders h2 as top level" do
+      expect(filter.call).to eq(result)
+    end
+  end
+
+  context "with some heading rank is higher than first heading" do
+    let(:html) do
+      <<~HTML
+        <h2 id="foo">foo</h2>
+        <h3 id="bar">bar</h3>
+        <h1 id="fizz">fizz</h1>
+        <h2 id="bazz">bazz</h2>
+      HTML
+    end
+
+    let(:result) do
+      <<~HTML
+        <ul>
+        <li>
+        <a href="#foo">foo</a>
+        <ul>
+        <li>
+        <a href="#bar">bar</a>
+        </li>
+        </ul>
+        </li>
+        <li>
+        <a href="#fizz">fizz</a>
+        </li>
+        <li>
+        <a href="#bazz">bazz</a>
+        </li>
+        </ul>
+      HTML
+    end
+
+    it "renders higher rank headings at the same level as the first heading" do
+      expect(filter.call).to eq(result)
+    end
+  end
+
+  context "with include html tag" do
+    let(:html) do
+      <<~HTML
+        <h2 id="foo"><strong>foo</strong></h2>
+      HTML
+    end
+
+    let(:result) do
+      <<~HTML
+        <ul>
+        <li>
+        <a href="#foo">foo</a>
+        </li>
+        </ul>
+      HTML
+    end
+
+    it "anchor text does not include html tag" do
+      expect(filter.call).to eq(result)
+    end
+  end
+
+  context "without headings" do
+    let(:html) do
+      <<~HTML
+        <p>paragraph</p>
+      HTML
+    end
+
+    it "renders empty string" do
+      expect(filter.call.to_s).to eq("")
+    end
+  end
+end

data/spec/qiita/markdown/filters/qiita_marker_spec.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+describe Qiita::Markdown::Filters::QiitaMarker do
+  subject(:filter) { described_class.new(markdown, context) }
+
+  let(:context) { nil }
+
+  context "with footnotes" do
+    let(:markdown) do
+      <<~MD
+        foo [^1]
+        [^1]: bar
+      MD
+    end
+
+    it "renders footnotes" do
+      expect(filter.call.to_s).to include('class="footnotes"')
+    end
+
+    context "and disable footnotes option" do
+      let(:context) do
+        {
+          markdown: {
+            footnotes: false,
+          },
+        }
+      end
+
+      it "does not render footnotes" do
+        expect(filter.call.to_s).not_to include('class="footnotes"')
+      end
+    end
+  end
+
+  context "with sourcepos" do
+    let(:markdown) do
+      <<~MD
+        foo bar
+      MD
+    end
+
+    it "does not render HTML containing data-sourcepos" do
+      expect(filter.call.to_s).not_to include("data-sourcepos")
+    end
+
+    context "and enable sourcepos option" do
+      let(:context) do
+        {
+          markdown: {
+            sourcepos: true,
+          },
+        }
+      end
+
+      it "renders HTML containing data-sourcepos" do
+        expect(filter.call.to_s).to include("data-sourcepos")
+      end
+    end
+  end
+end