Read about our upcoming Code of Conduct on this issue

referable.rb 1.73 KB
Newer Older
Robert Speicher's avatar
Robert Speicher committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# == Referable concern
#
# Contains functionality related to making a model referable in Markdown, such
# as "#1", "!2", "~3", etc.
module Referable
  extend ActiveSupport::Concern

  # Returns the String necessary to reference this object in Markdown
  #
  # from_project - Refering Project object
  #
  # This should be overridden by the including class.
  #
  # Examples:
  #
  #   Issue.first.to_reference               # => "#1"
  #   Issue.last.to_reference(other_project) # => "cross-project#1"
  #
  # Returns a String
  def to_reference(_from_project = nil)
    ''
  end

24
25
26
27
  def reference_link_text(from_project = nil)
    to_reference(from_project)
  end

Robert Speicher's avatar
Robert Speicher committed
28
29
30
31
32
33
34
35
36
37
38
39
40
41
  module ClassMethods
    # The character that prefixes the actual reference identifier
    #
    # This should be overridden by the including class.
    #
    # Examples:
    #
    #   Issue.reference_prefix        # => '#'
    #   MergeRequest.reference_prefix # => '!'
    #
    # Returns a String
    def reference_prefix
      ''
    end
42
43
44
45
46

    # Regexp pattern used to match references to this object
    #
    # This must be overridden by the including class.
    #
Robert Speicher's avatar
Robert Speicher committed
47
    # Returns a Regexp
48
    def reference_pattern
49
      raise NotImplementedError, "#{self} does not implement #{__method__}"
50
    end
51

52
53
54
55
    def reference_valid?(reference)
      true
    end

56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
    def link_reference_pattern(route, pattern)
      %r{
        (?<url>
          #{Regexp.escape(Gitlab.config.gitlab.url)}
          \/#{Project.reference_pattern}
          \/#{Regexp.escape(route)}
          \/#{pattern}
          (?<path>
            (\/[a-z0-9_=-]+)*
          )?
          (?<query>
            \?[a-z0-9_=-]+
            (&[a-z0-9_=-]+)*
          )?
          (?<anchor>\#[a-z0-9_-]+)?
        )
      }x
    end
Robert Speicher's avatar
Robert Speicher committed
74
75
  end
end