qiita-markdown 0.44.1 → 1.0.0

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

data/spec/qiita/markdown/processor_spec.rb

@@ -69,16 +69,12 @@ describe Qiita::Markdown::Processor do
 
         it "adds ID for ToC" do
           should eq <<-HTML.strip_heredoc
-
             <h1>
             <span id="a" class="fragment"></span><a href="#a"><i class="fa fa-link"></i></a>a</h1>
-
             <h2>
             <span id="a-1" class="fragment"></span><a href="#a-1"><i class="fa fa-link"></i></a>a</h2>
-
             <h3>
             <span id="a-2" class="fragment"></span><a href="#a-2"><i class="fa fa-link"></i></a>a</h3>
-
             <h3>
             <span id="a-3" class="fragment"></span><a href="#a-3"><i class="fa fa-link"></i></a>a</h3>
           HTML
@@ -94,7 +90,6 @@ describe Qiita::Markdown::Processor do
 
         it "generates fragment identifier by sanitizing the special characters in the title" do
           should eq <<-HTML.strip_heredoc
-
             <h1>
             <span id="rb" class="fragment"></span><a href="#rb"><i class="fa fa-link"></i></a><b>R&amp;B</b>
             </h1>
@@ -109,9 +104,10 @@ describe Qiita::Markdown::Processor do
           MARKDOWN
         end
 
-        it "does nothing" do
+        it "adds ID for ToC" do
           should eq <<-HTML.strip_heredoc
-            <h1>foo</h1>
+            <h1>
+            <span id="foo" class="fragment"></span><a href="#foo"><i class="fa fa-link"></i></a>foo</h1>
           HTML
         end
       end
@@ -586,8 +582,8 @@ describe Qiita::Markdown::Processor do
         end
 
         it "wraps it in a element while keeping the width attribute" do
-          should eq %(<p><a href="http://example.com/b.png" target="_blank">) +
-                    %(<img width="80" height="48" alt="a" src="http://example.com/b.png"></a></p>\n)
+          should eq %(<a href="http://example.com/b.png" target="_blank">) +
+                    %(<img width="80" height="48" alt="a" src="http://example.com/b.png"></a>\n)
         end
       end
 
@@ -647,7 +643,7 @@ describe Qiita::Markdown::Processor do
         let(:markdown) do
           <<-MARKDOWN.strip_heredoc
             - [ ] a
-             - [ ] b
+              - [ ] b
           MARKDOWN
         end
 
@@ -656,7 +652,6 @@ describe Qiita::Markdown::Processor do
             <ul>
             <li class="task-list-item">
             <input type="checkbox" class="task-list-item-checkbox" disabled>a
-
             <ul>
             <li class="task-list-item">
             <input type="checkbox" class="task-list-item-checkbox" disabled>b</li>
@@ -698,8 +693,12 @@ describe Qiita::Markdown::Processor do
         it "inserts checkbox" do
           should eq <<-HTML.strip_heredoc
             <ul>
-            <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>
+            <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>
             </ul>
           HTML
         end
@@ -759,20 +758,7 @@ describe Qiita::Markdown::Processor do
         end
 
         it "generates footnotes elements" do
-          should eq <<-HTML.strip_heredoc
-            <p><sup id="fnref1"><a href="#fn1" title="test">1</a></sup></p>
-
-            <div class="footnotes">
-            <hr>
-            <ol>
-
-            <li id="fn1">
-            <p>test <a href="#fnref1">↩</a></p>
-            </li>
-
-            </ol>
-            </div>
-          HTML
+          should include('class="footnotes"')
         end
       end
 
@@ -837,7 +823,8 @@ describe Qiita::Markdown::Processor do
 
         it "does not generate footnote elements" do
           should eq <<-HTML.strip_heredoc
-            <p><a href="test">^1</a></p>
+            <p>[^1]<br>
+            [^1]: test</p>
           HTML
         end
       end
@@ -1085,13 +1072,10 @@ describe Qiita::Markdown::Processor do
 
         it "returns HTML output parsed as markdown" do
           expect(subject).to eq <<-HTML.strip_heredoc
-            <p><details><summary>Folding sample</summary><div>
-
+            <details><summary>Folding sample</summary><div>
             <div class="code-frame" data-lang="rb"><div class="highlight"><pre class="codehilite"><code><span class="nb">puts</span> <span class="s2">"Hello, World"</span>
             </code></pre></div></div>
-
-            <p></p>
-            </div></details></p>
+            </div></details>
           HTML
         end
       end
@@ -1425,14 +1409,14 @@ describe Qiita::Markdown::Processor do
         if allowed
           it "does not sanitize embed code" do
             should eq <<-HTML.strip_heredoc
-              <p data-height="1" data-theme-id="0" data-slug-hash="foo" data-default-tab="bar" data-user="baz" data-embed-version="2" data-pen-title="qux" class="codepen"></p>\n
+              <p data-height="1" data-theme-id="0" data-slug-hash="foo" data-default-tab="bar" data-user="baz" data-embed-version="2" data-pen-title="qux" class="codepen"></p>
               <script src="https://production-assets.codepen.io/assets/embed/ei.js"></script>
             HTML
           end
         else
           it "forces async attribute on script" do
             should eq <<-HTML.strip_heredoc
-              <p data-height="1" data-theme-id="0" data-slug-hash="foo" data-default-tab="bar" data-user="baz" data-embed-version="2" data-pen-title="qux" class="codepen"></p>\n
+              <p data-height="1" data-theme-id="0" data-slug-hash="foo" data-default-tab="bar" data-user="baz" data-embed-version="2" data-pen-title="qux" class="codepen"></p>
               <script src="https://production-assets.codepen.io/assets/embed/ei.js" async="async"></script>
             HTML
           end
@@ -1450,14 +1434,14 @@ describe Qiita::Markdown::Processor do
         if allowed
           it "does not sanitize embed code" do
             should eq <<-HTML.strip_heredoc
-              <p data-height="1" data-theme-id="0" data-slug-hash="foo" data-default-tab="bar" data-user="baz" data-embed-version="2" data-pen-title="qux" class="codepen"></p>\n
+              <p data-height="1" data-theme-id="0" data-slug-hash="foo" data-default-tab="bar" data-user="baz" data-embed-version="2" data-pen-title="qux" class="codepen"></p>
               <script src="https://static.codepen.io/assets/embed/ei.js"></script>
             HTML
           end
         else
           it "forces async attribute on script" do
             should eq <<-HTML.strip_heredoc
-              <p data-height="1" data-theme-id="0" data-slug-hash="foo" data-default-tab="bar" data-user="baz" data-embed-version="2" data-pen-title="qux" class="codepen"></p>\n
+              <p data-height="1" data-theme-id="0" data-slug-hash="foo" data-default-tab="bar" data-user="baz" data-embed-version="2" data-pen-title="qux" class="codepen"></p>
               <script src="https://static.codepen.io/assets/embed/ei.js" async="async"></script>
             HTML
           end
@@ -1747,7 +1731,7 @@ describe Qiita::Markdown::Processor do
 
         it "does not sanitize embed code" do
           should eq <<-HTML.strip_heredoc
-            <blockquote class="twitter-tweet" data-lang="es" data-cards="hidden" data-conversation="none">foo</blockquote>\n
+            <blockquote class="twitter-tweet" data-lang="es" data-cards="hidden" data-conversation="none">foo</blockquote>
             <script async src="https://platform.twitter.com/widgets.js"></script>
           HTML
         end
@@ -1809,14 +1793,16 @@ describe Qiita::Markdown::Processor do
           if allowed
             it "returns simple div element" do
               should eq <<-HTML.strip_heredoc
-                <div data-type="customblock">Some kind of text is here.
+                <div data-type="customblock" data-metadata="">
+                <p>Some kind of text is here.</p>
                 </div>
               HTML
             end
           else
             it "returns simple div element" do
               should eq <<-HTML.strip_heredoc
-                <div>Some kind of text is here.
+                <div>
+                <p>Some kind of text is here.</p>
                 </div>
               HTML
             end
@@ -1829,14 +1815,16 @@ describe Qiita::Markdown::Processor do
           if allowed
             it "returns simple div element" do
               should eq <<-HTML.strip_heredoc
-                <div data-type="customblock" data-metadata="anytype">Some kind of text is here.
+                <div data-type="customblock" data-metadata="anytype">
+                <p>Some kind of text is here.</p>
                 </div>
               HTML
             end
           else
             it "returns simple div element" do
               should eq <<-HTML.strip_heredoc
-                <div>Some kind of text is here.
+                <div>
+                <p>Some kind of text is here.</p>
                 </div>
               HTML
             end
@@ -1851,8 +1839,9 @@ describe Qiita::Markdown::Processor do
               it "returns info note block with class including icon as default type" do
                 should eq <<-HTML.strip_heredoc
                   <div data-type="customblock" data-metadata="note" class="note info">
-                  <span class="fa fa-fw fa-check-circle"></span><p>Some kind of text is here.
-                  </p>
+                  <span class="fa fa-fw fa-check-circle"></span><div>
+                  <p>Some kind of text is here.</p>
+                  </div>
                   </div>
                 HTML
               end
@@ -1860,8 +1849,9 @@ describe Qiita::Markdown::Processor do
               it "returns note block with class including icon" do
                 should eq <<-HTML.strip_heredoc
                   <div class="note info">
-                  <span class="fa fa-fw fa-check-circle"></span><p>Some kind of text is here.
-                  </p>
+                  <span class="fa fa-fw fa-check-circle"></span><div>
+                  <p>Some kind of text is here.</p>
+                  </div>
                   </div>
                 HTML
               end
@@ -1875,8 +1865,9 @@ describe Qiita::Markdown::Processor do
               it "returns warning note block with class including icon" do
                 should eq <<-HTML.strip_heredoc
                   <div data-type="customblock" data-metadata="note warn" class="note warn">
-                  <span class="fa fa-fw fa-exclamation-circle"></span><p>Some kind of text is here.
-                  </p>
+                  <span class="fa fa-fw fa-exclamation-circle"></span><div>
+                  <p>Some kind of text is here.</p>
+                  </div>
                   </div>
                 HTML
               end
@@ -1884,8 +1875,9 @@ describe Qiita::Markdown::Processor do
               it "returns note block with class including icon" do
                 should eq <<-HTML.strip_heredoc
                   <div class="note warn">
-                  <span class="fa fa-fw fa-exclamation-circle"></span><p>Some kind of text is here.
-                  </p>
+                  <span class="fa fa-fw fa-exclamation-circle"></span><div>
+                  <p>Some kind of text is here.</p>
+                  </div>
                   </div>
                 HTML
               end
@@ -1899,8 +1891,9 @@ describe Qiita::Markdown::Processor do
               it "returns alerting note block with class including icon" do
                 should eq <<-HTML.strip_heredoc
                   <div data-type="customblock" data-metadata="note alert" class="note alert">
-                  <span class="fa fa-fw fa-times-circle"></span><p>Some kind of text is here.
-                  </p>
+                  <span class="fa fa-fw fa-times-circle"></span><div>
+                  <p>Some kind of text is here.</p>
+                  </div>
                   </div>
                 HTML
               end
@@ -1908,8 +1901,9 @@ describe Qiita::Markdown::Processor do
               it "returns note block with class including icon" do
                 should eq <<-HTML.strip_heredoc
                   <div class="note alert">
-                  <span class="fa fa-fw fa-times-circle"></span><p>Some kind of text is here.
-                  </p>
+                  <span class="fa fa-fw fa-times-circle"></span><div>
+                  <p>Some kind of text is here.</p>
+                  </div>
                   </div>
                 HTML
               end

data/spec/qiita/markdown/summary_processor_spec.rb

@@ -111,7 +111,6 @@ describe Qiita::Markdown::SummaryProcessor do
       it "flattens them" do
         should eq <<-EOS.strip_heredoc
           Lorem ipsum dolor sit amet.
-
           Consectetur adipisicing elit.
         EOS
       end
@@ -254,7 +253,8 @@ describe Qiita::Markdown::SummaryProcessor do
 
       it "does not generate footnote elements by default" do
         should eq <<-EOS.strip_heredoc
-          <a href="test">^1</a>
+          [^1]
+          [^1]: test
         EOS
       end
     end