2015-04-03 00:46:43 +00:00
|
|
|
module Gitlab
|
|
|
|
module Markdown
|
2015-04-14 22:34:01 +00:00
|
|
|
# HTML filter that replaces issue references with links. References to
|
|
|
|
# issues that do not exist are ignored.
|
2015-04-03 00:46:43 +00:00
|
|
|
#
|
|
|
|
# This filter supports cross-project references.
|
2015-04-14 22:34:01 +00:00
|
|
|
class IssueReferenceFilter < ReferenceFilter
|
2015-04-03 00:46:43 +00:00
|
|
|
include CrossProjectReference
|
|
|
|
|
|
|
|
# Public: Find `#123` issue references in text
|
|
|
|
#
|
|
|
|
# IssueReferenceFilter.references_in(text) do |match, issue, project_ref|
|
|
|
|
# "<a href=...>##{issue}</a>"
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# text - String text to search.
|
|
|
|
#
|
|
|
|
# Yields the String match, the Integer issue ID, 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(ISSUE_PATTERN) do |match|
|
|
|
|
yield match, $~[:issue].to_i, $~[:project]
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Pattern used to extract `#123` issue references from text
|
|
|
|
#
|
|
|
|
# This pattern supports cross-project references.
|
|
|
|
ISSUE_PATTERN = /#{PROJECT_PATTERN}?\#(?<issue>([a-zA-Z\-]+-)?\d+)/
|
|
|
|
|
|
|
|
def call
|
2015-04-14 22:34:01 +00:00
|
|
|
replace_text_nodes_matching(ISSUE_PATTERN) do |content|
|
|
|
|
issue_link_filter(content)
|
2015-04-03 00:46:43 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
# Replace `#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 `#123` references replaced with links. All links
|
|
|
|
# have `gfm` and `gfm-issue` class names attached for styling.
|
|
|
|
def issue_link_filter(text)
|
2015-04-30 20:10:39 +00:00
|
|
|
self.class.references_in(text) do |match, id, project_ref|
|
2015-04-03 00:46:43 +00:00
|
|
|
project = self.project_from_ref(project_ref)
|
|
|
|
|
2015-04-30 20:10:39 +00:00
|
|
|
if project && issue = project.get_issue(id)
|
|
|
|
push_result(:issue, issue)
|
2015-04-15 19:56:45 +00:00
|
|
|
|
2015-04-30 20:10:39 +00:00
|
|
|
url = url_for_issue(id, project, only_path: context[:only_path])
|
2015-04-03 00:46:43 +00:00
|
|
|
|
2015-04-30 21:27:33 +00:00
|
|
|
title = escape_once("Issue: #{issue.title}")
|
2015-04-14 22:34:01 +00:00
|
|
|
klass = reference_class(:issue)
|
2015-04-03 00:46:43 +00:00
|
|
|
|
|
|
|
%(<a href="#{url}"
|
|
|
|
title="#{title}"
|
2015-04-30 20:10:39 +00:00
|
|
|
class="#{klass}">#{project_ref}##{id}</a>)
|
2015-04-03 00:46:43 +00:00
|
|
|
else
|
|
|
|
match
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def url_for_issue(*args)
|
|
|
|
IssuesHelper.url_for_issue(*args)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|