Read about our upcoming Code of Conduct on this issue

This instance was upgraded to Heptapod 0.28.0 today

external_issue_reference_filter.rb 1.94 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
      # 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)
19
        text.gsub(ExternalIssue.reference_pattern) do |match|
Robert Speicher's avatar
Robert Speicher committed
20
21
22
23
24
          yield match, $~[:issue]
        end
      end

      def call
25
26
        # Early return if the project isn't using an external tracker
        return doc if project.nil? || project.default_issues_tracker?
27

28
        replace_text_nodes_matching(ExternalIssue.reference_pattern) do |content|
29
          issue_link_filter(content)
Robert Speicher's avatar
Robert Speicher committed
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
        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])

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

          %(<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