Class: Banzai::Filter::SnippetReferenceFilter

Inherits:
AbstractReferenceFilter show all
Defined in:
lib/banzai/filter/snippet_reference_filter.rb

Overview

HTML filter that replaces snippet references with links. References to snippets that do not exist are ignored.

This filter supports cross-project references.

Constant Summary

Constants inherited from AbstractReferenceFilter

AbstractReferenceFilter::REFERENCE_PLACEHOLDER, AbstractReferenceFilter::REFERENCE_PLACEHOLDER_PATTERN

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AbstractReferenceFilter

#call, #current_parent_path, #current_project_namespace_path, #data_attributes_for, #find_for_paths, #find_object_cached, #find_object_from_link, #find_object_from_link_cached, #from_ref_cached, identifier, #identifier, #object_class, #object_link_filter, #object_link_text, #object_link_text_extras, #object_link_title, object_name, object_sym, #object_sym, #parent_per_reference, parse_symbol, #record_identifier, #records_per_parent, #references_in, references_in, #references_per_parent, #relation_for_paths, symbol_from_match, #url_for_object_cached, #wrap_link

Methods included from CrossProjectReference

#parent_from_ref

Methods inherited from ReferenceFilter

call, #call_and_update_nodes, #data_attribute, #each_node, #element_node?, #group, #ignore_ancestor_query, #initialize, #nodes, #project, #reference_class, #replace_link_node_with_href, #replace_link_node_with_text, #replace_text_when_pattern_matches, #skip_project_check?, #text_node?, #user, #validate, #yield_valid_link

Methods included from OutputSafety

#escape_once

Methods included from RequestStoreReferenceCache

#cached_call, #get_or_set_cache

Constructor Details

This class inherits a constructor from Banzai::Filter::ReferenceFilter

Class Method Details

.object_classObject


12
13
14
# File 'lib/banzai/filter/snippet_reference_filter.rb', line 12

def self.object_class
  Snippet
end

Instance Method Details

#find_object(project, id) ⇒ Object


16
17
18
19
20
# File 'lib/banzai/filter/snippet_reference_filter.rb', line 16

def find_object(project, id)
  return unless project.is_a?(Project)

  project.snippets.find_by(id: id)
end

#url_for_object(snippet, project) ⇒ Object


22
23
24
25
26
# File 'lib/banzai/filter/snippet_reference_filter.rb', line 22

def url_for_object(snippet, project)
  h = Gitlab::Routing.url_helpers
  h.project_snippet_url(project, snippet,
                                  only_path: context[:only_path])
end