qiita-markdown 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d82079377c4ce72ef4a32e6a1c30d7b63f6e8f87
-  data.tar.gz: 8b080251af685ea2b9547266edfb4d6a554ca5be
+  metadata.gz: 48dcd3a415c694cd2793884f2b1fff63a05a291c
+  data.tar.gz: 03ef10b80d3fff879e4fe499dc0f1e487edf0735
 SHA512:
-  metadata.gz: c544a2bd69d30ca9386f03b24e688a939576179e604ca0c666b122220083943c884bf8610e15e4ca904d060e75c79860b3753f832d4cc7da9f8e4e3c6b62e1ef
-  data.tar.gz: 415900299a6b8277d64c0b60143b76277f2f26fedaf6e8698f5032843e88569b93c2ebae3d5ec2aad291cbc15cd40b0496598edeb45c02c87efd8e4cf24e0cf4
+  metadata.gz: 35ffe04259cc89c0c2c0980f5bc7531fc7d7d9362bfd004b31cb1d9b920703f99e03315a5093f6af63465570c7546782ed6b8557476159d437710aa082dd57e4
+  data.tar.gz: 2b4f1b18fd5f068f4f3c309e1afa998168459ad65ee171a3d1a8d414dcc96ddd29f628d11c00ac65f4f3118cee1200834cfde864d34c3d40e2d736b2ab6a2350

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.6.0
+* Add `:escape_html` extension to Qiita::Markdown::Greenmat::HTMLToCRenderer.
+* Fix backward incompatibility of fragment identifier of heading that includes special HTML characters in v0.5.0.
+
 ## 0.5.0
 - Add renderers Qiita::Markdown::Greenmat::HTMLRenderer and Qiita::Markdown::Greenmat::HTMLToCRenderer which can be passed to `Redcarpet::Markdown.new` and generate consistent heading fragment identifiers.
 

data/benchmark/heading_anchor_rendering.rb

@@ -160,11 +160,11 @@ module Rendering
           @counter ||= Hash.new(0)
         end
 
-        Heading = Struct.new(:text, :level, :counter) do
+        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}>#{content}</h#{level}>\n"
+            "\n<h#{level}>#{body}</h#{level}>\n"
           end
 
           def increment
@@ -174,21 +174,21 @@ module Rendering
           private
 
           def content
-            text
+            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 content
-            anchor_element + text
-          end
-
           def anchor_element
             %(<span id="#{suffixed_id}" class="fragment"></span><a href="##{suffixed_id}"><i class="fa fa-link"></i></a>)
           end
@@ -205,6 +205,10 @@ module Rendering
             @id ||= text.downcase.gsub(/[^\p{Word}\- ]/u, "").gsub(" ", "-")
           end
 
+          def text
+            Nokogiri::HTML.fragment(body).text
+          end
+
           def suffix
             has_count? ? "-#{count}" : ""
           end
@@ -234,12 +238,11 @@ end
 
 # Calculating -------------------------------------
 #         post process         4 i/100ms
-#            rendering        22 i/100ms
+#            rendering        14 i/100ms
 # -------------------------------------------------
-#         post process       48.3 (±16.6%) i/s -        236 in   5.027265s
-#            rendering      227.3 (±15.8%) i/s -       1122 in   5.084983s
+#         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:      227.3 i/s
-#         post process:       48.3 i/s - 4.70x slower
-#
+#            rendering:      151.1 i/s
+#         post process:       44.9 i/s - 3.36x slower

data/lib/qiita/markdown.rb

@@ -1,4 +1,5 @@
 require "active_support/core_ext/object/blank"
+require "cgi"
 require "greenmat"
 require "html/pipeline"
 require "linguist"

data/lib/qiita/markdown/greenmat/heading_rendering.rb

@@ -6,7 +6,17 @@ module Qiita
           @counter ||= Hash.new(0)
         end
 
-        AbstractHeading = Struct.new(:text, :level, :counter) do
+        class AbstractHeading
+          attr_reader :raw_body, :level, :counter, :escape_html
+          alias_method :escape_html?, :escape_html
+
+          def initialize(raw_body, level, counter, escape_html = false)
+            @raw_body = raw_body
+            @level = level
+            @counter = counter
+            @escape_html = escape_html
+          end
+
           def to_s
             fail NotImplementedError
           end
@@ -25,10 +35,18 @@ module Qiita
             count > 0
           end
 
+          def body
+            escape_html? ? CGI.escape_html(raw_body) : raw_body
+          end
+
           def id
             @id ||= text.downcase.gsub(/[^\p{Word}\- ]/u, "").gsub(" ", "-")
           end
 
+          def text
+            Nokogiri::HTML.fragment(raw_body).text
+          end
+
           def suffix
             has_count? ? "-#{count}" : ""
           end

data/lib/qiita/markdown/greenmat/html_renderer.rb

@@ -26,7 +26,7 @@ module Qiita
           # 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}>#{text}</h#{level}>\n"
+            "\n<h#{level}>#{body}</h#{level}>\n"
           end
 
           def increment
@@ -36,7 +36,7 @@ module Qiita
 
         class HeadingWithAnchor < AbstractHeading
           def to_s
-            "\n<h#{level}>#{anchor_element}#{text}</h#{level}>\n"
+            "\n<h#{level}>#{anchor_element}#{body}</h#{level}>\n"
           end
 
           def increment

data/lib/qiita/markdown/greenmat/html_toc_renderer.rb

@@ -4,8 +4,9 @@ module Qiita
       class HTMLToCRenderer < ::Greenmat::Render::HTML_TOC
         include HeadingRendering
 
-        def initialize(*)
+        def initialize(extensions = {})
           super
+          @extensions = extensions
           @last_level = 0
         end
 
@@ -32,7 +33,7 @@ module Qiita
         def generate_heading_html(text, level, level_difference)
           html = list_item_preceding_html(level_difference)
 
-          anchor = HeadingAnchor.new(text, level, heading_counter)
+          anchor = HeadingAnchor.new(text, level, heading_counter, escape_html?)
           html << anchor.to_s
           anchor.increment
 
@@ -52,9 +53,13 @@ module Qiita
           html << "<li>\n"
         end
 
+        def escape_html?
+          @extensions[:escape_html]
+        end
+
         class HeadingAnchor < AbstractHeading
           def to_s
-            "<a href=\"##{suffixed_id}\">#{text}</a>\n"
+            "<a href=\"##{suffixed_id}\">#{body}</a>\n"
           end
 
           def increment

data/lib/qiita/markdown/version.rb

@@ -1,5 +1,5 @@
 module Qiita
   module Markdown
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

data/spec/qiita/markdown/greenmat/html_renderer_spec.rb

@@ -31,6 +31,21 @@ describe Qiita::Markdown::Greenmat::HTMLRenderer do
           <h3><span id="a-3" class="fragment"></span><a href="#a-3"><i class="fa fa-link"></i></a>a</h3>
         EOS
       end
+
+      context "and heading title including special HTML characters" do
+        let(:markdown) do
+          <<-EOS.strip_heredoc
+            # <b>R&amp;B</b>
+          EOS
+        end
+
+        it "generates fragment identifier by sanitizing the characters in the title" do
+          should eq <<-EOS.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>
+          EOS
+        end
+      end
     end
 
     context "without :with_toc_data extension" do

data/spec/qiita/markdown/greenmat/html_toc_renderer_spec.rb

@@ -1,7 +1,8 @@
 require "active_support/core_ext/string/strip"
 
 describe Qiita::Markdown::Greenmat::HTMLToCRenderer do
-  let(:renderer) { described_class.new }
+  let(:renderer) { described_class.new(extension) }
+  let(:extension) { {} }
   let(:greenmat) { ::Greenmat::Markdown.new(renderer) }
   subject(:rendered_html) { greenmat.render(markdown) }
 
@@ -94,4 +95,42 @@ describe Qiita::Markdown::Greenmat::HTMLToCRenderer do
       EOS
     end
   end
+
+  context "with heading title including special HTML characters" do
+    let(:markdown) do
+      <<-EOS.strip_heredoc
+        # <b>R&amp;B</b>
+      EOS
+    end
+
+    it "generates fragment identifier by sanitizing the characters in the title" do
+      should eq <<-EOS.strip_heredoc
+        <ul>
+        <li>
+        <a href="#rb"><b>R&amp;B</b></a>
+        </li>
+        </ul>
+      EOS
+    end
+  end
+
+  context "with :escape_html extension" do
+    let(:extension) { { escape_html: true } }
+
+    let(:markdown) do
+      <<-EOS.strip_heredoc
+        # <b>R&amp;B</b>
+      EOS
+    end
+
+    it "escapes special HTML characters in heading title" do
+      should eq <<-EOS.strip_heredoc
+        <ul>
+        <li>
+        <a href="#rb">&lt;b&gt;R&amp;amp;B&lt;/b&gt;</a>
+        </li>
+        </ul>
+      EOS
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qiita-markdown
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ryo Nakamura