summaryrefslogtreecommitdiff
path: root/lib/gitlab/markdown/commit_range_reference_filter.rb
blob: bb496135d923680695d3dc9b37c7a6f070c39311 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
require 'gitlab/markdown'

module Gitlab
  module Markdown
    # HTML filter that replaces commit range references with links.
    #
    # This filter supports cross-project references.
    class CommitRangeReferenceFilter < ReferenceFilter
      include CrossProjectReference

      # Public: Find commit range references in text
      #
      #   CommitRangeReferenceFilter.references_in(text) do |match, commit_range, project_ref|
      #     "<a href=...>#{commit_range}</a>"
      #   end
      #
      # text - String text to search.
      #
      # Yields the String match, the String commit range, and an optional String
      # of the external project reference.
      #
      # Returns a String replaced with the return of the block.
      def self.references_in(text)
        text.gsub(CommitRange.reference_pattern) do |match|
          yield match, $~[:commit_range], $~[:project]
        end
      end

      def initialize(*args)
        super

        @commit_map = {}
      end

      def call
        replace_text_nodes_matching(CommitRange.reference_pattern) do |content|
          commit_range_link_filter(content)
        end
      end

      # Replace commit range references in text with links to compare the commit
      # ranges.
      #
      # text - String text to replace references in.
      #
      # Returns a String with commit range references replaced with links. All
      # links have `gfm` and `gfm-commit_range` class names attached for
      # styling.
      def commit_range_link_filter(text)
        self.class.references_in(text) do |match, id, project_ref|
          project = self.project_from_ref(project_ref)

          range = CommitRange.new(id, project)

          if range.valid_commits?
            push_result(:commit_range, range)

            url = url_for_commit_range(project, range)

            title = range.reference_title
            klass = reference_class(:commit_range)
            data  = data_attribute(project.id)

            project_ref += '@' if project_ref

            %(<a href="#{url}" #{data}
                 title="#{title}"
                 class="#{klass}">#{project_ref}#{range}</a>)
          else
            match
          end
        end
      end

      def url_for_commit_range(project, range)
        h = Gitlab::Application.routes.url_helpers
        h.namespace_project_compare_url(project.namespace, project,
                                        range.to_param.merge(only_path: context[:only_path]))
      end
    end
  end
end