debian-mirror-gitlab/lib/gitlab/markdown.rb

116 lines
4.4 KiB
Ruby
Raw Normal View History

2015-04-26 12:48:37 +05:30
require 'html/pipeline'
2014-09-02 18:07:02 +05:30
module Gitlab
# Custom parser for GitLab-flavored Markdown
#
2015-09-11 14:41:01 +05:30
# See the files in `lib/gitlab/markdown/` for specific processing information.
2014-09-02 18:07:02 +05:30
module Markdown
2015-09-11 14:41:01 +05:30
# Provide autoload paths for filters to prevent a circular dependency error
autoload :AutolinkFilter, 'gitlab/markdown/autolink_filter'
autoload :CommitRangeReferenceFilter, 'gitlab/markdown/commit_range_reference_filter'
autoload :CommitReferenceFilter, 'gitlab/markdown/commit_reference_filter'
autoload :EmojiFilter, 'gitlab/markdown/emoji_filter'
autoload :ExternalIssueReferenceFilter, 'gitlab/markdown/external_issue_reference_filter'
autoload :ExternalLinkFilter, 'gitlab/markdown/external_link_filter'
autoload :IssueReferenceFilter, 'gitlab/markdown/issue_reference_filter'
autoload :LabelReferenceFilter, 'gitlab/markdown/label_reference_filter'
autoload :MergeRequestReferenceFilter, 'gitlab/markdown/merge_request_reference_filter'
autoload :RelativeLinkFilter, 'gitlab/markdown/relative_link_filter'
autoload :SanitizationFilter, 'gitlab/markdown/sanitization_filter'
autoload :SnippetReferenceFilter, 'gitlab/markdown/snippet_reference_filter'
autoload :TableOfContentsFilter, 'gitlab/markdown/table_of_contents_filter'
autoload :TaskListFilter, 'gitlab/markdown/task_list_filter'
autoload :UserReferenceFilter, 'gitlab/markdown/user_reference_filter'
2015-04-26 12:48:37 +05:30
# Public: Parse the provided text with GitLab-Flavored Markdown
#
# text - the source text
2015-09-11 14:41:01 +05:30
# options - A Hash of options used to customize output (default: {}):
# :xhtml - output XHTML instead of HTML
# :reference_only_path - Use relative path for reference links
2015-04-26 12:48:37 +05:30
# html_options - extra options for the reference links as given to link_to
2015-09-11 14:41:01 +05:30
def gfm(text, options = {}, html_options = {})
2014-09-02 18:07:02 +05:30
return text if text.nil?
# Duplicate the string so we don't alter the original, then call to_str
# to cast it back to a String instead of a SafeBuffer. This is required
# for gsub calls to work as we need them to.
text = text.dup.to_str
2015-04-26 12:48:37 +05:30
options.reverse_merge!(
xhtml: false,
2015-09-11 14:41:01 +05:30
reference_only_path: true,
project: @project,
current_user: current_user
2015-04-26 12:48:37 +05:30
)
2015-09-11 14:41:01 +05:30
@pipeline ||= HTML::Pipeline.new(filters)
2014-09-02 18:07:02 +05:30
2015-09-11 14:41:01 +05:30
context = {
# SanitizationFilter
pipeline: options[:pipeline],
2015-04-26 12:48:37 +05:30
2015-09-11 14:41:01 +05:30
# EmojiFilter
asset_root: Gitlab.config.gitlab.url,
asset_host: Gitlab::Application.config.asset_host,
2015-04-26 12:48:37 +05:30
2015-09-11 14:41:01 +05:30
# TableOfContentsFilter
no_header_anchors: options[:no_header_anchors],
2015-04-26 12:48:37 +05:30
2015-09-11 14:41:01 +05:30
# ReferenceFilter
current_user: options[:current_user],
only_path: options[:reference_only_path],
project: options[:project],
reference_class: html_options[:class],
2015-04-26 12:48:37 +05:30
2015-09-11 14:41:01 +05:30
# RelativeLinkFilter
ref: @ref,
requested_path: @path,
project_wiki: @project_wiki
2015-04-26 12:48:37 +05:30
}
2015-09-11 14:41:01 +05:30
result = @pipeline.call(text, context)
2015-04-26 12:48:37 +05:30
save_options = 0
if options[:xhtml]
save_options |= Nokogiri::XML::Node::SaveOptions::AS_XHTML
end
text = result[:output].to_html(save_with: save_options)
text.html_safe
2014-09-02 18:07:02 +05:30
end
private
2015-09-11 14:41:01 +05:30
# Filters used in our pipeline
2014-09-02 18:07:02 +05:30
#
2015-09-11 14:41:01 +05:30
# SanitizationFilter should come first so that all generated reference HTML
# goes through untouched.
2014-09-02 18:07:02 +05:30
#
2015-09-11 14:41:01 +05:30
# See https://github.com/jch/html-pipeline#filters for more filters.
def filters
[
Gitlab::Markdown::SanitizationFilter,
Gitlab::Markdown::RelativeLinkFilter,
Gitlab::Markdown::EmojiFilter,
Gitlab::Markdown::TableOfContentsFilter,
Gitlab::Markdown::AutolinkFilter,
Gitlab::Markdown::ExternalLinkFilter,
Gitlab::Markdown::UserReferenceFilter,
Gitlab::Markdown::IssueReferenceFilter,
Gitlab::Markdown::ExternalIssueReferenceFilter,
Gitlab::Markdown::MergeRequestReferenceFilter,
Gitlab::Markdown::SnippetReferenceFilter,
Gitlab::Markdown::CommitRangeReferenceFilter,
Gitlab::Markdown::CommitReferenceFilter,
Gitlab::Markdown::LabelReferenceFilter,
Gitlab::Markdown::TaskListFilter
]
2014-09-02 18:07:02 +05:30
end
end
end