131 lines
4.2 KiB
Ruby
131 lines
4.2 KiB
Ruby
# == Mentionable concern
|
|
#
|
|
# Contains functionality related to objects that can mention Users, Issues, MergeRequests, or Commits by
|
|
# GFM references.
|
|
#
|
|
# Used by Issue, Note, MergeRequest, and Commit.
|
|
#
|
|
module Mentionable
|
|
extend ActiveSupport::Concern
|
|
|
|
module ClassMethods
|
|
# Indicate which attributes of the Mentionable to search for GFM references.
|
|
def attr_mentionable(attr, options = {})
|
|
attr = attr.to_s
|
|
mentionable_attrs << [attr, options]
|
|
end
|
|
end
|
|
|
|
included do
|
|
# Accessor for attributes marked mentionable.
|
|
cattr_accessor :mentionable_attrs, instance_accessor: false do
|
|
[]
|
|
end
|
|
|
|
if self < Participable
|
|
participant -> (user, ext) { all_references(user, extractor: ext) }
|
|
end
|
|
end
|
|
|
|
# Returns the text used as the body of a Note when this object is referenced
|
|
#
|
|
# By default this will be the class name and the result of calling
|
|
# `to_reference` on the object.
|
|
def gfm_reference(from_project = nil)
|
|
# "MergeRequest" > "merge_request" > "Merge request" > "merge request"
|
|
friendly_name = self.class.to_s.underscore.humanize.downcase
|
|
|
|
"#{friendly_name} #{to_reference(from_project)}"
|
|
end
|
|
|
|
# The GFM reference to this Mentionable, which shouldn't be included in its #references.
|
|
def local_reference
|
|
self
|
|
end
|
|
|
|
def all_references(current_user = nil, text = nil, extractor: nil)
|
|
extractor ||= Gitlab::ReferenceExtractor.
|
|
new(project, current_user)
|
|
|
|
if text
|
|
extractor.analyze(text, author: author)
|
|
else
|
|
self.class.mentionable_attrs.each do |attr, options|
|
|
text = __send__(attr)
|
|
options = options.merge(cache_key: [self, attr], author: author)
|
|
|
|
extractor.analyze(text, options)
|
|
end
|
|
end
|
|
|
|
extractor
|
|
end
|
|
|
|
def mentioned_users(current_user = nil)
|
|
all_references(current_user).users
|
|
end
|
|
|
|
# Extract GFM references to other Mentionables from this Mentionable. Always excludes its #local_reference.
|
|
def referenced_mentionables(current_user = self.author, text = nil)
|
|
refs = all_references(current_user, text)
|
|
refs = (refs.issues + refs.merge_requests + refs.commits)
|
|
|
|
# We're using this method instead of Array diffing because that requires
|
|
# both of the object's `hash` values to be the same, which may not be the
|
|
# case for otherwise identical Commit objects.
|
|
refs.reject { |ref| ref == local_reference }
|
|
end
|
|
|
|
# Create a cross-reference Note for each GFM reference to another Mentionable found in the +mentionable_attrs+.
|
|
def create_cross_references!(author = self.author, without = [], text = nil)
|
|
refs = referenced_mentionables(author, text)
|
|
|
|
# We're using this method instead of Array diffing because that requires
|
|
# both of the object's `hash` values to be the same, which may not be the
|
|
# case for otherwise identical Commit objects.
|
|
refs.reject! { |ref| without.include?(ref) || cross_reference_exists?(ref) }
|
|
|
|
refs.each do |ref|
|
|
SystemNoteService.cross_reference(ref, local_reference, author)
|
|
end
|
|
end
|
|
|
|
# When a mentionable field is changed, creates cross-reference notes that
|
|
# don't already exist
|
|
def create_new_cross_references!(author = self.author)
|
|
changes = detect_mentionable_changes
|
|
|
|
return if changes.empty?
|
|
|
|
original_text = changes.collect { |_, vals| vals.first }.join(' ')
|
|
|
|
preexisting = referenced_mentionables(author, original_text)
|
|
create_cross_references!(author, preexisting)
|
|
end
|
|
|
|
private
|
|
|
|
# Returns a Hash of changed mentionable fields
|
|
#
|
|
# Preference is given to the `changes` Hash, but falls back to
|
|
# `previous_changes` if it's empty (i.e., the changes have already been
|
|
# persisted).
|
|
#
|
|
# See ActiveModel::Dirty.
|
|
#
|
|
# Returns a Hash.
|
|
def detect_mentionable_changes
|
|
source = (changes.present? ? changes : previous_changes).dup
|
|
|
|
mentionable = self.class.mentionable_attrs.map { |attr, options| attr }
|
|
|
|
# Only include changed fields that are mentionable
|
|
source.select { |key, val| mentionable.include?(key) }
|
|
end
|
|
|
|
# Determine whether or not a cross-reference Note has already been created between this Mentionable and
|
|
# the specified target.
|
|
def cross_reference_exists?(target)
|
|
SystemNoteService.cross_reference_exists?(target, local_reference)
|
|
end
|
|
end
|