external_issue_reference_filter.rb 1.93 KB
Newer Older
Robert Speicher's avatar
Robert Speicher committed
1
2
3
module Gitlab
  module Markdown
    # HTML filter that replaces external issue tracker references with links.
4
5
    # References are ignored if the project doesn't use an external issue
    # tracker.
6
    class ExternalIssueReferenceFilter < ReferenceFilter
Robert Speicher's avatar
Robert Speicher committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
      # Public: Find `JIRA-123` issue references in text
      #
      #   ExternalIssueReferenceFilter.references_in(text) do |match, issue|
      #     "<a href=...>##{issue}</a>"
      #   end
      #
      # text - String text to search.
      #
      # Yields the String match and the String issue reference.
      #
      # Returns a String replaced with the return of the block.
      def self.references_in(text)
        text.gsub(ISSUE_PATTERN) do |match|
          yield match, $~[:issue]
        end
      end

      # Pattern used to extract `JIRA-123` issue references from text
      ISSUE_PATTERN = /(?<issue>([A-Z\-]+-)\d+)/

      def call
28
29
        return doc if project.default_issues_tracker?

30
31
        replace_text_nodes_matching(ISSUE_PATTERN) do |content|
          issue_link_filter(content)
Robert Speicher's avatar
Robert Speicher committed
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
        end
      end

      # Replace `JIRA-123` issue references in text with links to the referenced
      # issue's details page.
      #
      # text - String text to replace references in.
      #
      # Returns a String with `JIRA-123` references replaced with links. All
      # links have `gfm` and `gfm-issue` class names attached for styling.
      def issue_link_filter(text)
        project = context[:project]

        self.class.references_in(text) do |match, issue|
          url = url_for_issue(issue, project, only_path: context[:only_path])

          title = "Issue in #{project.external_issue_tracker.title}"
49
          klass = reference_class(:issue)
Robert Speicher's avatar
Robert Speicher committed
50
51
52
53
54
55
56
57
58
59
60
61
62

          %(<a href="#{url}"
               title="#{title}"
               class="#{klass}">#{issue}</a>)
        end
      end

      def url_for_issue(*args)
        IssuesHelper.url_for_issue(*args)
      end
    end
  end
end