100 lines
2.4 KiB
Ruby
100 lines
2.4 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
# == 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 - Referring parent 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 = nil, full:)
|
|
''
|
|
end
|
|
|
|
# If this referable object can serve as the base for the
|
|
# reference of child objects (e.g. projects are the base of
|
|
# issues), but it is formatted differently, then you may wish
|
|
# to override this method.
|
|
def to_reference_base(from = nil, full:)
|
|
to_reference(from, full: full)
|
|
end
|
|
|
|
def reference_link_text(from = nil)
|
|
to_reference(from)
|
|
end
|
|
|
|
included do
|
|
alias_method :non_referable_inspect, :inspect
|
|
alias_method :inspect, :referable_inspect
|
|
end
|
|
|
|
def referable_inspect
|
|
if respond_to?(:id)
|
|
"#<#{self.class.name} id:#{id} #{to_reference(full: true)}>"
|
|
else
|
|
"#<#{self.class.name} #{to_reference(full: true)}>"
|
|
end
|
|
end
|
|
|
|
class_methods do
|
|
# 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
|
|
|
|
# Regexp pattern used to match references to this object
|
|
#
|
|
# This must be overridden by the including class.
|
|
#
|
|
# Returns a Regexp
|
|
def reference_pattern
|
|
raise NotImplementedError, "#{self} does not implement #{__method__}"
|
|
end
|
|
|
|
def reference_valid?(reference)
|
|
true
|
|
end
|
|
|
|
def link_reference_pattern(route, pattern)
|
|
%r{
|
|
(?<url>
|
|
#{Regexp.escape(Gitlab.config.gitlab.url)}
|
|
\/#{Project.reference_pattern}
|
|
(?:\/\-)?
|
|
\/#{route.is_a?(Regexp) ? route : Regexp.escape(route)}
|
|
\/#{pattern}
|
|
(?<path>
|
|
(\/[a-z0-9_=-]+)*\/*
|
|
)?
|
|
(?<query>
|
|
\?[a-z0-9_=-]+
|
|
(&[a-z0-9_=-]+)*
|
|
)?
|
|
(?<anchor>\#[a-z0-9_-]+)?
|
|
)
|
|
}x
|
|
end
|
|
end
|
|
end
|