gitlab-org--gitlab-foss/app/models/milestone.rb

332 lines
9.3 KiB
Ruby
Raw Normal View History

# frozen_string_literal: true
2012-04-08 17:28:58 -04:00
class Milestone < ActiveRecord::Base
# Represents a "No Milestone" state used for filtering Issues and Merge
# Requests that have no milestone assigned.
MilestoneStruct = Struct.new(:title, :name, :id)
None = MilestoneStruct.new('No Milestone', 'No Milestone', 0)
Any = MilestoneStruct.new('Any Milestone', '', -1)
2016-03-11 12:46:14 -05:00
Upcoming = MilestoneStruct.new('Upcoming', '#upcoming', -2)
Started = MilestoneStruct.new('Started', '#started', -3)
include CacheMarkdownField
2018-04-20 10:00:15 -04:00
include AtomicInternalId
2018-05-11 03:52:48 -04:00
include IidRoutes
2015-02-05 19:49:41 -05:00
include Sortable
2015-12-24 08:43:07 -05:00
include Referable
include StripAttribute
2016-03-06 23:07:19 -05:00
include Milestoneish
include Gitlab::SQL::Pattern
cache_markdown_field :title, pipeline: :single_line
cache_markdown_field :description
2012-04-08 17:28:58 -04:00
belongs_to :project
2017-07-07 11:08:49 -04:00
belongs_to :group
2018-04-20 10:00:15 -04:00
has_internal_id :iid, scope: :project, init: ->(s) { s&.project&.milestones&.maximum(:iid) }
has_internal_id :iid, scope: :group, init: ->(s) { s&.group&.milestones&.maximum(:iid) }
2012-04-08 17:28:58 -04:00
has_many :issues
has_many :labels, -> { distinct.reorder('labels.title') }, through: :issues
has_many :merge_requests
has_many :events, as: :target, dependent: :destroy # rubocop:disable Cop/ActiveRecordDependent
2012-04-08 17:28:58 -04:00
2017-07-07 11:08:49 -04:00
scope :of_projects, ->(ids) { where(project_id: ids) }
scope :of_groups, ->(ids) { where(group_id: ids) }
2013-02-18 04:10:09 -05:00
scope :active, -> { with_state(:active) }
scope :closed, -> { with_state(:closed) }
2017-07-07 11:08:49 -04:00
scope :for_projects, -> { where(group: nil).includes(:project) }
scope :for_projects_and_groups, -> (projects, groups) do
projects = projects.compact if projects.is_a? Array
projects = [] if projects.nil?
2017-07-07 11:08:49 -04:00
groups = groups.compact if groups.is_a? Array
groups = [] if groups.nil?
2017-07-07 11:08:49 -04:00
where(project_id: projects).or(where(group_id: groups))
2017-07-07 11:08:49 -04:00
end
scope :order_by_name_asc, -> { order(Arel::Nodes::Ascending.new(arel_table[:title].lower)) }
scope :reorder_by_due_date_asc, -> { reorder(Gitlab::Database.nulls_last_order('due_date', 'ASC')) }
2017-07-07 11:08:49 -04:00
validates :group, presence: true, unless: :project
validates :project, presence: true, unless: :group
2012-12-14 00:34:05 -05:00
2017-07-07 11:08:49 -04:00
validate :uniqueness_of_title, if: :title_changed?
validate :milestone_type_check
2017-03-31 11:11:28 -04:00
validate :start_date_should_be_less_than_due_date, if: proc { |m| m.start_date.present? && m.due_date.present? }
2013-02-18 04:10:09 -05:00
strip_attributes :title
2013-02-18 08:22:18 -05:00
state_machine :state, initial: :active do
2013-02-18 04:10:09 -05:00
event :close do
2013-02-18 08:22:18 -05:00
transition active: :closed
2013-02-18 04:10:09 -05:00
end
event :activate do
2013-02-18 08:22:18 -05:00
transition closed: :active
2013-02-18 04:10:09 -05:00
end
state :closed
state :active
end
2012-04-08 17:28:58 -04:00
alias_attribute :name, :title
2015-08-13 10:48:21 -04:00
class << self
# Searches for milestones with a matching title or description.
#
# This method uses ILIKE on PostgreSQL and LIKE on MySQL.
#
# query - The search query as a String
#
# Returns an ActiveRecord::Relation.
2015-08-13 10:48:21 -04:00
def search(query)
fuzzy_search(query, [:title, :description])
2015-08-13 10:48:21 -04:00
end
2017-07-07 11:08:49 -04:00
# Searches for milestones with a matching title.
#
# This method uses ILIKE on PostgreSQL and LIKE on MySQL.
#
# query - The search query as a String
#
# Returns an ActiveRecord::Relation.
def search_title(query)
fuzzy_search(query, [:title])
end
2017-07-07 11:08:49 -04:00
def filter_by_state(milestones, state)
case state
when 'closed' then milestones.closed
when 'all' then milestones
else milestones.active
end
end
def count_by_state
reorder(nil).group(:state).count
end
def predefined?(milestone)
milestone == Any ||
milestone == None ||
milestone == Upcoming ||
milestone == Started
end
2015-08-13 10:48:21 -04:00
end
def self.reference_prefix
'%'
end
2015-12-24 08:43:07 -05:00
def self.reference_pattern
# NOTE: The iid pattern only matches when all characters on the expression
# are digits, so it will match %2 but not %2.1 because that's probably a
# milestone name and we want it to be matched as such.
@reference_pattern ||= %r{
(#{Project.reference_pattern})?
#{Regexp.escape(reference_prefix)}
(?:
(?<milestone_iid>
\d+(?!\S\w)\b # Integer-based milestone iid, or
) |
(?<milestone_name>
[^"\s]+\b | # String-based single-word milestone title, or
"[^"]+" # String-based multi-word milestone surrounded in quotes
)
)
}x
2015-12-24 08:43:07 -05:00
end
def self.link_reference_pattern
@link_reference_pattern ||= super("milestones", /(?<milestone>\d+)/)
2015-12-24 08:43:07 -05:00
end
def self.upcoming_ids(projects, groups)
rel = unscoped
.for_projects_and_groups(projects, groups)
.active.where('milestones.due_date > NOW()')
if Gitlab::Database.postgresql?
rel.order(:project_id, :group_id, :due_date).select('DISTINCT ON (project_id, group_id) id')
else
# We need to use MySQL's NULL-safe comparison operator `<=>` here
# because one of `project_id` or `group_id` is always NULL
join_clause = <<~HEREDOC
LEFT OUTER JOIN milestones earlier_milestones
ON milestones.project_id <=> earlier_milestones.project_id
AND milestones.group_id <=> earlier_milestones.group_id
AND milestones.due_date > earlier_milestones.due_date
AND earlier_milestones.due_date > NOW()
AND earlier_milestones.state = 'active'
HEREDOC
2017-06-21 09:48:12 -04:00
rel
.joins(join_clause)
.where('earlier_milestones.id IS NULL')
.select(:id)
end
2016-03-11 12:46:14 -05:00
end
def participants
User.joins(assigned_issues: :milestone).where("milestones.id = ?", id).distinct
end
def self.sort_by_attribute(method)
sorted =
case method.to_s
when 'due_date_asc'
reorder_by_due_date_asc
when 'due_date_desc'
reorder(Gitlab::Database.nulls_last_order('due_date', 'DESC'))
when 'name_asc'
reorder(Arel::Nodes::Ascending.new(arel_table[:title].lower))
when 'name_desc'
reorder(Arel::Nodes::Descending.new(arel_table[:title].lower))
when 'start_date_asc'
reorder(Gitlab::Database.nulls_last_order('start_date', 'ASC'))
when 'start_date_desc'
reorder(Gitlab::Database.nulls_last_order('start_date', 'DESC'))
else
order_by(method)
end
sorted.with_order_id_desc
end
def self.states_count(projects, groups = nil)
return STATE_COUNT_HASH unless projects || groups
counts = Milestone
.for_projects_and_groups(projects, groups)
.reorder(nil)
.group(:state)
.count
{
opened: counts['active'] || 0,
closed: counts['closed'] || 0,
all: counts.values.sum
}
end
##
# Returns the String necessary to reference this Milestone in Markdown. Group
# milestones only support name references, and do not support cross-project
# references.
#
# format - Symbol format to use (default: :iid, optional: :name)
#
# Examples:
#
# Milestone.first.to_reference # => "%1"
# Milestone.first.to_reference(format: :name) # => "%\"goal\""
# Milestone.first.to_reference(cross_namespace_project) # => "gitlab-org/gitlab-ce%1"
# Milestone.first.to_reference(same_namespace_project) # => "gitlab-ce%1"
#
2017-11-22 08:20:35 -05:00
def to_reference(from = nil, format: :name, full: false)
format_reference = milestone_format_reference(format)
reference = "#{self.class.reference_prefix}#{format_reference}"
2016-01-07 06:26:05 -05:00
if project
2017-11-22 08:20:35 -05:00
"#{project.to_reference(from, full: full)}#{reference}"
else
reference
end
2015-12-24 08:43:07 -05:00
end
2017-11-22 08:20:35 -05:00
def reference_link_text(from = nil)
self.class.reference_prefix + self.title
2015-12-24 08:43:07 -05:00
end
def milestoneish_id
id
end
2017-07-07 11:08:49 -04:00
def for_display
self
end
2012-12-14 00:34:05 -05:00
def can_be_closed?
2013-02-18 04:10:09 -05:00
active? && issues.opened.count.zero?
2012-12-18 22:14:05 -05:00
end
def author_id
nil
end
def title=(value)
write_attribute(:title, sanitize_title(value)) if value.present?
2016-05-04 17:21:57 -04:00
end
2017-07-07 11:08:49 -04:00
def safe_title
title.to_slug.normalize.to_s
end
def parent
group || project
end
def group_milestone?
2017-07-07 11:08:49 -04:00
group_id.present?
end
def project_milestone?
2017-07-07 11:08:49 -04:00
project_id.present?
end
private
2017-07-07 11:08:49 -04:00
# Milestone titles must be unique across project milestones and group milestones
def uniqueness_of_title
if project
relation = Milestone.for_projects_and_groups([project_id], [project.group&.id])
elsif group
relation = Milestone.for_projects_and_groups(group.projects.select(:id), [group.id])
2017-07-07 11:08:49 -04:00
end
title_exists = relation.find_by_title(title)
errors.add(:title, "already being used for another group or project milestone.") if title_exists
end
# Milestone should be either a project milestone or a group milestone
def milestone_type_check
if group_id && project_id
field = project_id_changed? ? :project_id : :group_id
errors.add(field, "milestone should belong either to a project or a group.")
end
end
def milestone_format_reference(format = :iid)
raise ArgumentError, 'Unknown format' unless [:iid, :name].include?(format)
if group_milestone? && format == :iid
raise ArgumentError, 'Cannot refer to a group milestone by an internal id!'
end
if format == :name && !name.include?('"')
%("#{name}")
else
iid
end
end
def sanitize_title(value)
CGI.unescape_html(Sanitize.clean(value.to_s))
end
2016-11-15 12:48:30 -05:00
def start_date_should_be_less_than_due_date
if due_date <= start_date
errors.add(:due_date, "must be greater than start date")
2016-11-15 12:48:30 -05:00
end
end
def issues_finder_params
{ project_id: project_id }
end
2012-04-08 17:28:58 -04:00
end