Class: Qiita::Markdown::Filters::Mention

Inherits:
HTML::Pipeline::MentionFilter
  • Object
show all
Defined in:
lib/qiita/markdown/filters/mention.rb

Overview

  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.

Constant Summary collapse

IGNORE_PARENTS = 
::HTML::Pipeline::MentionFilter::IGNORE_PARENTS + Set["blockquote"]
MentionPattern = 
/
  (?:^|\W)
  @((?>[\w][\w-]{0,30}\w(?:@github)?))
  (?!\/)
  (?=
    \.+[ \t\W]|
    \.+$|
    [^0-9a-zA-Z_.]|
    $
  )
/ix

Instance Method Summary collapse

Instance Method Details

#call ⇒ Object

Note:

Override to use another IGNORE_PARENTS



24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/qiita/markdown/filters/mention.rb', line 24

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

#mention_link_filter(text, _, _, _) ⇒ Object

Note:

Override to use customized MentionPattern and allowed_usernames logic.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/qiita/markdown/filters/mention.rb', line 39

def mention_link_filter(text, _, _, _)
  text.gsub(MentionPattern) do |match|
    name = $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