kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Update ReferenceFilter docs

Browse source 
[ci skip]
This commit is contained in:
Robert Speicher 2015-10-07 18:25:36 -04:00
parent 72afcbcd37
commit e0f9d3a547
1 changed files with 9 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
lib/gitlab/markdown/reference_filter.rb
View file

@ -11,9 +11,6 @@ module Gitlab
# Context options: # Context options:
# :project (required) - Current project, ignored if reference is cross-project. # :project (required) - Current project, ignored if reference is cross-project.
# :only_path - Generate path-only links. # :only_path - Generate path-only links.
#
# Results:
# :references - A Hash of references that were found and replaced.
class ReferenceFilter < HTML::Pipeline::Filter class ReferenceFilter < HTML::Pipeline::Filter
def self.user_can_reference?(user, node, context) def self.user_can_reference?(user, node, context)
if node.has_attribute?('data-project') if node.has_attribute?('data-project')
@ -33,14 +30,16 @@ module Gitlab
# Returns a data attribute String to attach to a reference link # Returns a data attribute String to attach to a reference link
# #
# id - Object ID # attributes - Hash, where the key becomes the data attribute name and the
# type - Object type (default: :project) # value is the data attribute value
# #
# Examples: # Examples:
# #
# data_attribute(project: 1) # => "data-reference-filter=\"SomeReferenceFilter\" data-project=\"1\"" # data_attribute(project: 1, issue: 2)
# data_attribute(user: 2) # => "data-reference-filter=\"SomeReferenceFilter\" data-user=\"2\"" # # => "data-reference-filter=\"Gitlab::Markdown::SomeReferenceFilter\" data-project=\"1\" data-issue=\"2\""
# data_attribute(group: 3) # => "data-reference-filter=\"SomeReferenceFilter\" data-group=\"3\"" #
# data_attribute(project: 3, merge_request: 4)
# # => "data-reference-filter=\"Gitlab::Markdown::SomeReferenceFilter\" data-project=\"3\" data-merge-request=\"4\""
# #
# Returns a String # Returns a String
def data_attribute(attributes = {}) def data_attribute(attributes = {})
@ -86,7 +85,7 @@ module Gitlab
# Yields the current node's String contents. The result of the block will # Yields the current node's String contents. The result of the block will
# replace the node's existing content and update the current document. # replace the node's existing content and update the current document.
# #
# Returns the updated Nokogiri::XML::Document object. # Returns the updated Nokogiri::HTML::DocumentFragment object.
def replace_text_nodes_matching(pattern) def replace_text_nodes_matching(pattern)
return doc if project.nil? return doc if project.nil?