increments/qiita-markdown

View on GitHub
lib/qiita/markdown/filters/mention.rb

Summary

Maintainability
A
1 hr
Test Coverage
A
100%
module Qiita
  module Markdown
    module Filters
      # 1. Adds :mentioned_usernames into result Hash as Array of String.
      # 2. Replaces @mention with link.
      #
      # You can pass :allowed_usernames context to limit mentioned usernames.
      class Mention < HTML::Pipeline::MentionFilter
        IGNORE_PARENTS = ::HTML::Pipeline::MentionFilter::IGNORE_PARENTS + Set["blockquote"]

        MentionPattern = %r{
          (?:^|\W)
          @((?>\w[\w-]{0,30}\w(?:@github)?))
          (?!/)
          (?=
            \.+[ \t\W]|
            \.+$|
            [^0-9a-zA-Z_.]|
            $
          )
        }ix

        # @note Override to use another IGNORE_PARENTS
        def call
          result[:mentioned_usernames] ||= []

          doc.search(".//text()").each do |node|
            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
        end

        # @note Override to use customized MentionPattern and allowed_usernames logic.
        def mention_link_filter(text, _, _, _)
          text.gsub(MentionPattern) do |match|
            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>),
              )
            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>),
              )
            end
          end
        end

        private

        def allowed_usernames
          context[:allowed_usernames]
        end

        def has_ancestor?(node, tags)
          super || (node.parent.parent && node.parent.parent["class"] == "code-lang")
        end
      end
    end
  end
end