qiita-markdown 0.44.0 → 1.0.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Qiita
   module Markdown
     module Filters
@@ -9,44 +11,45 @@ module Qiita
       # generated by other filters.
       #
       # @see Qiita::Markdown::Filters::UserInputSanitizerr
-      class FinalSanitizer < HTML::Pipeline::Filter
+      class FinalSanitizer < ::HTML::Pipeline::Filter
         RULE = {
           attributes: {
-            "a" => [
-              "data-hovercard-target-name",
-              "data-hovercard-target-type",
-              "href",
-              "rel",
+            "a" => %w[
+              data-hovercard-target-name
+              data-hovercard-target-type
+              href
+              rel
             ],
             "blockquote" => Embed::Tweet::ATTRIBUTES,
-            "iframe" => [
-              "allowfullscreen",
-              "frameborder",
-              "height",
-              "marginheight",
-              "marginwidth",
-              "scrolling",
-              "src",
-              "style",
-              "width",
+            "iframe" => %w[
+              allowfullscreen
+              frameborder
+              height
+              loading
+              marginheight
+              marginwidth
+              scrolling
+              src
+              style
+              width
             ],
             "img" => [
               "src",
             ],
-            "input" => [
-              "checked",
-              "disabled",
-              "type",
+            "input" => %w[
+              checked
+              disabled
+              type
             ],
-            "div" => [
-              "itemscope",
-              "itemtype",
+            "div" => %w[
+              itemscope
+              itemtype
             ],
             "p" => Embed::CodePen::ATTRIBUTES,
-            "script" => [
-              "async",
-              "src",
-              "type",
+            "script" => %w[
+              async
+              src
+              type
             ].concat(
               Embed::SpeekerDeck::ATTRIBUTES,
               Embed::Docswell::ATTRIBUTES,
@@ -60,104 +63,107 @@ module Qiita
             "th" => [
               "style",
             ],
-            "video" => [
-              "src",
-              "autoplay",
-              "controls",
-              "loop",
-              "muted",
-              "poster",
+            "video" => %w[
+              src
+              autoplay
+              controls
+              loop
+              muted
+              poster
             ],
-            all: [
-              "abbr",
-              "align",
-              "alt",
-              "border",
-              "cellpadding",
-              "cellspacing",
-              "cite",
-              "class",
-              "color",
-              "cols",
-              "colspan",
-              "data-lang",
-              "datetime",
-              "height",
-              "hreflang",
-              "id",
-              "itemprop",
-              "lang",
-              "name",
-              "rowspan",
-              "tabindex",
-              "target",
-              "title",
-              "width",
+            all: %w[
+              abbr
+              align
+              alt
+              border
+              cellpadding
+              cellspacing
+              cite
+              class
+              color
+              cols
+              colspan
+              data-lang
+              data-sourcepos
+              datetime
+              height
+              hreflang
+              id
+              itemprop
+              lang
+              name
+              rowspan
+              tabindex
+              target
+              title
+              width
             ],
           },
           css: {
-            properties: [
-              "background-color",
-              "border",
-              "text-align",
+            properties: %w[
+              background-color
+              border
+              text-align
             ],
           },
-          elements: [
-            "a",
-            "b",
-            "blockquote",
-            "br",
-            "code",
-            "dd",
-            "del",
-            "details",
-            "div",
-            "dl",
-            "dt",
-            "em",
-            "font",
-            "h1",
-            "h2",
-            "h3",
-            "h4",
-            "h5",
-            "h6",
-            "h7",
-            "h8",
-            "hr",
-            "i",
-            "img",
-            "input",
-            "ins",
-            "kbd",
-            "li",
-            "ol",
-            "p",
-            "pre",
-            "q",
-            "rp",
-            "rt",
-            "ruby",
-            "s",
-            "samp",
-            "script",
-            "iframe",
-            "span",
-            "strike",
-            "strong",
-            "sub",
-            "summary",
-            "sup",
-            "table",
-            "tbody",
-            "td",
-            "tfoot",
-            "th",
-            "thead",
-            "tr",
-            "tt",
-            "ul",
-            "var",
+          elements: %w[
+            a
+            b
+            blockquote
+            br
+            caption
+            code
+            dd
+            del
+            details
+            div
+            dl
+            dt
+            em
+            font
+            h1
+            h2
+            h3
+            h4
+            h5
+            h6
+            h7
+            h8
+            hr
+            i
+            img
+            input
+            ins
+            kbd
+            li
+            ol
+            p
+            pre
+            q
+            rp
+            rt
+            ruby
+            s
+            samp
+            script
+            iframe
+            section
+            span
+            strike
+            strong
+            sub
+            summary
+            sup
+            table
+            tbody
+            td
+            tfoot
+            th
+            thead
+            tr
+            tt
+            ul
+            var
           ],
           protocols: {
             "a" => {
@@ -200,7 +206,7 @@ module Qiita
           rule[:attributes][:all] = rule[:attributes][:all] + [:data]
           rule[:elements] = RULE[:elements] + ["video"]
           rule[:transformers] = rule[:transformers] - [Transformers::FilterScript, Transformers::FilterIframe]
-        end
+        end.freeze
 
         def call
           ::Sanitize.clean_node!(doc, rule)

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

@@ -6,6 +6,7 @@ module Qiita
           doc.search("sup > a").each do |a|
             footnote = find_footnote(a)
             next unless footnote
+
             a[:title] = footnote.text.gsub(/\A\n/, "").gsub(/ ↩\n\z/, "")
           end
           doc
@@ -16,6 +17,7 @@ module Qiita
         def find_footnote(a)
           href = a["href"]
           return nil if !href || href.match(/\A#fn\d+\z/).nil?
+
           doc.search(href).first
         end
       end

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

@@ -21,9 +21,9 @@ module Qiita
           GROUP_IDENTIFIER_PATTERN = %r{
             (?:^|\W)
             @((?>[a-z\d][a-z\d-]{2,31}))
-            \/
+            /
             ([A-Za-z\d][A-Za-z\d-]{0,62}[A-Za-z\d])
-            (?!\/)
+            (?!/)
             (?=
               \.+[ \t\W]|
               \.+$|

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Qiita
+  module Markdown
+    module Filters
+      class HeadingAnchor < ::HTML::Pipeline::Filter
+        def call
+          doc.search("h1, h2, h3, h4, h5, h6").each do |heading|
+            heading["id"] = suffixed_id(heading)
+          end
+
+          doc
+        end
+
+        private
+
+        def counter
+          @counter ||= ::Hash.new(0)
+        end
+
+        def get_count(id)
+          counter[id]
+        end
+
+        def increment_count(id)
+          counter[id] += 1
+        end
+
+        def heading_id(node)
+          node.text.downcase.gsub(/[^\p{Word}\- ]/u, "").tr(" ", "-")
+        end
+
+        def suffixed_id(node)
+          id = heading_id(node)
+          count = get_count(id)
+          suffix = count.positive? ? "-#{count}" : ""
+          increment_count(id)
+
+          "#{id}#{suffix}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Qiita
+  module Markdown
+    module Filters
+      class HtmlToc < ::HTML::Pipeline::Filter
+        # @return [Nokogiri::HTML::DocumentFragment]
+        def call
+          headings = doc.search("h1, h2, h3, h4, h5, h6")
+          return "" if headings.empty?
+
+          toc = %W[<ul>\n]
+          top_level = nil
+          last_level = nil
+          depth = 1
+
+          headings.each do |node|
+            heading_rank = node.name.match(/h(\d)/)[1].to_i
+
+            # The first heading is displayed as the top level.
+            # The following headings, of higher rank than the first, are placed as top level.
+            top_level ||= heading_rank
+            current_level = [heading_rank, top_level].max
+
+            link = toc_with_link(node.text, node.attributes["id"]&.value)
+            toc << (nest_string(last_level, current_level) + link)
+
+            depth += current_level - last_level if last_level
+
+            last_level = current_level
+          end
+
+          toc << ("</li>\n</ul>\n" * depth)
+          toc.join
+        end
+
+        private
+
+        # @param text [String]
+        # @param id [String]
+        # @return [String]
+        def toc_with_link(text, id)
+          %(<a href="##{id}">#{CGI.escapeHTML(text)}</a>\n)
+        end
+
+        # @param last_level [Integer, nil]
+        # @param current_level [Integer]
+        # @return [String]
+        def nest_string(last_level, current_level)
+          if last_level.nil?
+            return "<li>\n"
+          elsif current_level == last_level
+            return "</li>\n<li>\n"
+          elsif current_level > last_level
+            level_difference = current_level - last_level
+            return "<ul>\n<li>\n" * level_difference
+          elsif current_level < last_level
+            level_difference = last_level - current_level
+            return %(#{"</li>\n</ul>\n" * level_difference}</li>\n<li>\n)
+          end
+
+          ""
+        end
+      end
+    end
+  end
+end

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

@@ -4,12 +4,12 @@ module Qiita
       class ImageLink < HTML::Pipeline::Filter
         def call
           doc.search("img").each do |img|
-            unless img.ancestors.any? { |ancestor| ancestor.name == "a" }
-              outer = Nokogiri::HTML.fragment(%(<a href="#{img['src']}" target="_blank"></a>))
-              inner = img.clone
-              outer.at("a").add_child(inner)
-              img.replace(outer)
-            end
+            next if img.ancestors.any? { |ancestor| ancestor.name == "a" }
+
+            outer = Nokogiri::HTML.fragment(%(<a href="#{img['src']}" target="_blank"></a>))
+            inner = img.clone
+            outer.at("a").add_child(inner)
+            img.replace(outer)
           end
           doc
         end

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

@@ -6,15 +6,15 @@ module Qiita
 
         REGEXPS = Regexp.union(
           /\#(?:\h{3}|\h{6})/,
-          /rgba?\(\s*(?:\d+(?:\,|\s)\s*){2}\d+\s*\)/,
-          /rgba?\(\s*(?:\d+%(?:\,|\s)\s*){2}\d+%\s*\)/,
-          /rgba?\(\s*(?:\d+\,\s*){3}\d*\.?\d+%?\s*\)/,
-          /rgba?\(\s*(?:\d+\s*){2}\d+\s*\/\s*\d?\.?\d+%?\s*\)/,
-          /rgba?\(\s*(?:\d+%\s*){2}\d+%\s*\/\s*\d?\.?\d+%?\s*\)/,
-          /hsla?\(\s*\d+(?:deg|rad|grad|turn)?\,\s*\d+%\,\s*\d+%\s*\)/,
+          /rgba?\(\s*(?:\d+(?:,|\s)\s*){2}\d+\s*\)/,
+          /rgba?\(\s*(?:\d+%(?:,|\s)\s*){2}\d+%\s*\)/,
+          /rgba?\(\s*(?:\d+,\s*){3}\d*\.?\d+%?\s*\)/,
+          %r{rgba?\(\s*(?:\d+\s*){2}\d+\s*/\s*\d?\.?\d+%?\s*\)},
+          %r{rgba?\(\s*(?:\d+%\s*){2}\d+%\s*/\s*\d?\.?\d+%?\s*\)},
+          /hsla?\(\s*\d+(?:deg|rad|grad|turn)?,\s*\d+%,\s*\d+%\s*\)/,
           /hsla?\(\s*\d+(?:deg|rad|grad|turn)?\s+\d+%\s+\d+%\s*\)/,
-          /hsla?\(\s*\d+(?:deg|rad|grad|turn)?\,\s*(?:\d+%\,\s*){2}\d?\.?\d+%?\s*\)/,
-          /hsla?\(\s*\d+(?:deg|rad|grad|turn)?\s+\d+%\s+\d+%\s*\/\s*\d?\.?\d+%?\s*\)/,
+          /hsla?\(\s*\d+(?:deg|rad|grad|turn)?,\s*(?:\d+%,\s*){2}\d?\.?\d+%?\s*\)/,
+          %r{hsla?\(\s*\d+(?:deg|rad|grad|turn)?\s+\d+%\s+\d+%\s*/\s*\d?\.?\d+%?\s*\)},
         )
 
         COLOR_CODE_PATTERN = /\A\s*(#{REGEXPS})\s*\z/

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

@@ -8,17 +8,17 @@ module Qiita
       class Mention < HTML::Pipeline::MentionFilter
         IGNORE_PARENTS = ::HTML::Pipeline::MentionFilter::IGNORE_PARENTS + Set["blockquote"]
 
-        MentionPattern = /
+        MentionPattern = %r{
           (?:^|\W)
-          @((?>[\w][\w-]{0,30}\w(?:@github)?))
-          (?!\/)
+          @((?>\w[\w-]{0,30}\w(?:@github)?))
+          (?!/)
           (?=
             \.+[ \t\W]|
             \.+$|
             [^0-9a-zA-Z_.]|
             $
           )
-        /ix
+        }ix
 
         # @note Override to use another IGNORE_PARENTS
         def call
@@ -28,8 +28,10 @@ module Qiita
             content = node.to_html
             next unless content.include?("@")
             next if has_ancestor?(node, IGNORE_PARENTS)
+
             html = mention_link_filter(content, base_url, info_url, username_pattern)
             next if html == content
+
             node.replace(html)
           end
           doc
@@ -38,22 +40,22 @@ module Qiita
         # @note Override to use customized MentionPattern and allowed_usernames logic.
         def mention_link_filter(text, _, _, _)
           text.gsub(MentionPattern) do |match|
-            name = $1
+            name = ::Regexp.last_match(1)
             case
             when allowed_usernames && name == "all"
               result[:mentioned_usernames] |= allowed_usernames
               match.sub(
                 "@#{name}",
-                %[<a href="/" class="user-mention" title="#{name}">@#{name}</a>]
+                %(<a href="/" class="user-mention" title="#{name}">@#{name}</a>),
               )
-            when allowed_usernames && !allowed_usernames.include?(name) || name == "all"
+            when (allowed_usernames && !allowed_usernames.include?(name)) || name == "all"
               match
             else
               result[:mentioned_usernames] |= [name]
               url = File.join(base_url, name)
               match.sub(
                 "@#{name}",
-                %[<a href="#{url}" class="user-mention js-hovercard" title="#{name}" data-hovercard-target-type="user" data-hovercard-target-name="#{name}">@#{name}</a>]
+                %(<a href="#{url}" class="user-mention js-hovercard" title="#{name}" data-hovercard-target-type="user" data-hovercard-target-name="#{name}">@#{name}</a>),
               )
             end
           end
@@ -66,7 +68,7 @@ module Qiita
         end
 
         def has_ancestor?(node, tags)
-          super || node.parent.parent && node.parent.parent["class"] == "code-lang"
+          super || (node.parent.parent && node.parent.parent["class"] == "code-lang")
         end
       end
     end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Qiita
+  module Markdown
+    module Filters
+      class QiitaMarker < ::HTML::Pipeline::TextFilter
+        DEFAULT_OPTIONS = {
+          footnotes: true,
+          sourcepos: false,
+        }.freeze
+
+        # @return [Nokogiri::HTML::DocumentFragment]
+        def call
+          ::Nokogiri::HTML.fragment(render(@text))
+        end
+
+        private
+
+        # @param text [String]
+        # @return [String]
+        def render(text)
+          ::QiitaMarker.render_html(text, qiita_marker_options, qiita_marker_extensions)
+        end
+
+        def qiita_marker_options
+          options_to_append = (options[:footnotes] ? [:FOOTNOTES] : [])
+                              .concat(options[:sourcepos] ? [:SOURCEPOS] : [])
+          @qiita_marker_options ||= %i[
+            HARDBREAKS
+            UNSAFE
+            LIBERAL_HTML_TAG
+            STRIKETHROUGH_DOUBLE_TILDE
+            TABLE_PREFER_STYLE_ATTRIBUTES
+            CODE_DATA_METADATA
+            MENTION_NO_EMPHASIS
+            AUTOLINK_CLASS_NAME
+          ].concat(options_to_append)
+        end
+
+        def qiita_marker_extensions
+          @qiita_marker_extensions ||= %i[
+            table
+            strikethrough
+            autolink
+            custom_block
+          ]
+        end
+
+        def options
+          @options ||= DEFAULT_OPTIONS.merge(context[:markdown] || {})
+        end
+      end
+    end
+  end
+end

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

@@ -38,6 +38,7 @@ module Qiita
           doc.traverse do |node|
             next unless node.element?
             next if SIMPLE_ELEMENTS.include?(node.name)
+
             node.replace(node.children)
           end
         end

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

@@ -54,7 +54,7 @@ module Qiita
           end
 
           def call
-            outer = Nokogiri::HTML.fragment(%Q[<div class="code-frame" data-lang="#{language}">])
+            outer = Nokogiri::HTML.fragment(%(<div class="code-frame" data-lang="#{language}">))
             frame = outer.at("div")
             frame.add_child(filename_node) if filename
             frame.add_child(highlighted_node)
@@ -72,7 +72,7 @@ module Qiita
           end
 
           def filename_node
-            %Q[<div class="code-lang"><span class="bold">#{filename}</span></div>]
+            %(<div class="code-lang"><span class="bold">#{filename}</span></div>)
           end
 
           def has_inline_php?
@@ -87,7 +87,7 @@ module Qiita
             if specific_language && Rouge::Lexer.find(specific_language)
               begin
                 highlight(specific_language).presence or raise
-              rescue
+              rescue StandardError
                 highlight(@default_language)
               end
             else
@@ -100,7 +100,7 @@ module Qiita
           end
 
           def language_node
-            Nokogiri::HTML.fragment(%Q[<div class="code-frame" data-lang="#{language}"></div>])
+            Nokogiri::HTML.fragment(%(<div class="code-frame" data-lang="#{language}"></div>))
           end
 
           def specific_language

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

@@ -51,9 +51,7 @@ module Qiita
           node.content.each_char.with_index do |char, index|
             current_char_is_blank = char.strip.empty?
 
-            if !@previous_char_was_blank || !current_char_is_blank
-              @current_length += 1
-            end
+            @current_length += 1 if !@previous_char_was_blank || !current_char_is_blank
 
             @previous_char_was_blank = current_char_is_blank