gitlab-org--gitlab-foss/lib/gitlab/reference_extractor.rb

92 lines
2.6 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
module Gitlab
# Extract possible GFM references from an arbitrary String for further processing.
class ReferenceExtractor < Banzai::ReferenceExtractor
REFERABLES = %i(user issue label milestone mentioned_user mentioned_group mentioned_project
merge_request snippet commit commit_range directly_addressed_user epic iteration vulnerability).freeze
attr_accessor :project, :current_user, :author
def initialize(project, current_user = nil)
2015-03-27 06:37:45 -04:00
@project = project
2015-03-27 07:58:23 -04:00
@current_user = current_user
2015-10-22 09:40:36 -04:00
@references = {}
super()
end
def analyze(text, context = {})
super(text, context.merge(project: project))
end
def references(type, ids_only: false)
refs = super(type, project, current_user, ids_only: ids_only)
update_visible_nodes_set(refs[:nodes], refs[:visible_nodes])
refs[:visible]
end
# this method is stateful, it tracks if all nodes from `references`
# calls are visible or not
def all_visible?
not_visible_nodes.empty?
end
def reset_memoized_values
@references = {}
super()
end
REFERABLES.each do |type|
define_method(type.to_s.pluralize) do
@references[type] ||= references(type)
end
if %w(mentioned_user mentioned_group mentioned_project).include?(type.to_s)
define_method("#{type}_ids") do
@references[type] ||= references(type, ids_only: true)
end
end
end
2015-12-17 17:08:14 -05:00
def issues
if project&.external_references_supported?
if project.issues_enabled?
@references[:all_issues] ||= references(:external_issue) + references(:issue)
else
@references[:external_issue] ||= references(:external_issue) +
references(:issue).select { |i| i.project_id != project.id }
end
2015-12-17 17:08:14 -05:00
else
@references[:issue] ||= references(:issue)
2015-12-17 17:08:14 -05:00
end
end
def all
REFERABLES.each { |referable| send(referable.to_s.pluralize) } # rubocop:disable GitlabSecurity/PublicSend
@references.values.flatten
end
def self.references_pattern
return @pattern if @pattern
patterns = REFERABLES.map do |type|
Banzai::ReferenceParser[type].reference_type.to_s.classify.constantize.try(:reference_pattern)
end.uniq
@pattern = Regexp.union(patterns.compact)
end
private
def update_visible_nodes_set(all, visible)
not_visible_nodes.merge(all)
not_visible_nodes.subtract(visible)
end
def not_visible_nodes
@not_visible_nodes ||= Set.new
end
end
end