Merge pull request increments#34 from increments/group-mention

Support group mention

Author: r7kamura

lib/qiita/markdown.rb

@@ -12,6 +12,7 @@
 require "qiita/markdown/filters/emoji"
 require "qiita/markdown/filters/footnote"
 require "qiita/markdown/filters/greenmat"
+require "qiita/markdown/filters/group_mention"
 require "qiita/markdown/filters/image_link"
 require "qiita/markdown/filters/mention"
 require "qiita/markdown/filters/sanitize"

lib/qiita/markdown/filters/group_mention.rb

@@ -0,0 +1,99 @@
+module Qiita
+  module Markdown
+    module Filters
+      class GroupMention < HTML::Pipeline::Filter
+        # @note Override
+        def call
+          if context[:group_mention_url_generator]
+            result[:mentioned_groups] ||= []
+            doc.search(".//text()").each do |node|
+              mentionable_node = MentionableNode.new(node, context[:group_mention_url_generator])
+              unless mentionable_node.ignorable?
+                result[:mentioned_groups] |= mentionable_node.groups
+                node.replace(mentionable_node.replaced_html)
+              end
+            end
+          end
+          doc
+        end
+
+        class MentionableNode
+          GROUP_IDENTIFIER_PATTERN = %r{
+            (?:^|\W)
+            @((?>[a-z\d][a-z\d-]{2,31}))
+            \/
+            ([A-Za-z\d][A-Za-z\d-]{0,14}[A-Za-z\d])
+            (?!\/)
+            (?=
+              \.+[ \t\W]|
+              \.+$|
+              [^0-9a-zA-Z_.]|
+              $
+            )
+          }x
+
+          IGNORED_ANCESTOR_ELEMENT_NAMES = %w(
+            a
+            blockquote
+            code
+            pre
+            style
+          ).freeze
+
+          # @param node [Nokogiri::XML::Node]
+          # @param group_mention_url_generator [Proc]
+          def initialize(node, group_mention_url_generator)
+            @group_mention_url_generator = group_mention_url_generator
+            @node = node
+          end
+
+          # @return [Array<Hash>]
+          def groups
+            @groups ||= []
+          end
+
+          # @return [false, true]
+          def ignorable?
+            !has_at_mark? || has_any_ignored_ancestor? || !replaced?
+          end
+
+          # @return [String]
+          def replaced_html
+            @replaced_html ||= html.gsub(GROUP_IDENTIFIER_PATTERN) do |_match|
+              team_url_name = ::Regexp.last_match(1)
+              group_url_name = ::Regexp.last_match(2)
+              group = { group_url_name: group_url_name, team_url_name: team_url_name }
+              groups << group
+              %(<a href="#{@group_mention_url_generator.call(group)}">) +
+                %(@#{team_url_name}/#{group_url_name}</a>)
+            end
+          end
+
+          private
+
+          # @return [false, true]
+          def has_any_ignored_ancestor?
+            @node.ancestors.any? do |node|
+              IGNORED_ANCESTOR_ELEMENT_NAMES.include?(node.name.downcase)
+            end
+          end
+
+          # @return [false, true]
+          def has_at_mark?
+            html.include?("@")
+          end
+
+          # @return [String]
+          def html
+            @html ||= @node.to_html
+          end
+
+          # @return [false, true]
+          def replaced?
+            html != replaced_html
+          end
+        end
+      end
+    end
+  end
+end

lib/qiita/markdown/processor.rb

@@ -14,6 +14,7 @@ class Processor
         Filters::Emoji,
         Filters::SyntaxHighlight,
         Filters::Mention,
+        Filters::GroupMention,
         Filters::Sanitize,
       ]
 

spec/qiita/markdown/processor_spec.rb

@@ -457,6 +457,40 @@
       end
     end
 
+    context "with group mention" do
+      let(:markdown) do
+        "@alice/bob"
+      end
+
+      it "does not replace it" do
+        is_expected.to eq <<-EOS.strip_heredoc
+          <p>@alice/bob</p>
+        EOS
+      end
+    end
+
+    context "with group mention" do
+      let(:context) do
+        super().merge(group_mention_url_generator: lambda do |group|
+          "https://#{group[:team_url_name]}.example.com/groups/#{group[:group_url_name]}"
+        end)
+      end
+
+      let(:markdown) do
+        "@alice/bob"
+      end
+
+      it "replaces it with preferred link and updates :mentioned_groups" do
+        is_expected.to eq <<-EOS.strip_heredoc
+          <p><a href="https://alice.example.com/groups/bob">@alice/bob</a></p>
+        EOS
+        expect(result[:mentioned_groups]).to eq [{
+          group_url_name: "bob",
+          team_url_name: "alice",
+        }]
+      end
+    end
+
     context "with normal link" do
       let(:markdown) do
         "[](/example)"