2018-07-25 09:30:33 +00:00
# frozen_string_literal: true
2019-03-28 13:17:42 +00:00
class Milestone < ApplicationRecord
2015-06-28 20:12:32 +00:00
# Represents a "No Milestone" state used for filtering Issues and Merge
# Requests that have no milestone assigned.
2015-12-02 13:10:43 +00:00
MilestoneStruct = Struct . new ( :title , :name , :id )
2019-08-09 09:59:38 +00:00
None = MilestoneStruct . new ( 'No Milestone' , 'No Milestone' , 0 )
Any = MilestoneStruct . new ( 'Any Milestone' , '' , - 1 )
2016-03-11 17:46:14 +00:00
Upcoming = MilestoneStruct . new ( 'Upcoming' , '#upcoming' , - 2 )
2017-03-10 19:01:05 +00:00
Started = MilestoneStruct . new ( 'Started' , '#started' , - 3 )
2015-06-28 20:12:32 +00:00
2016-10-06 21:17:11 +00:00
include CacheMarkdownField
2018-04-20 14:00:15 +00:00
include AtomicInternalId
2018-05-11 07:52:48 +00:00
include IidRoutes
2015-02-06 00:49:41 +00:00
include Sortable
2015-12-24 13:43:07 +00:00
include Referable
2015-11-26 15:16:50 +00:00
include StripAttribute
2016-03-07 04:07:19 +00:00
include Milestoneish
2019-09-04 16:19:31 +00:00
include FromUnion
2017-11-24 10:45:19 +00:00
include Gitlab :: SQL :: Pattern
2013-08-21 09:16:26 +00:00
2016-10-06 21:17:11 +00:00
cache_markdown_field :title , pipeline : :single_line
cache_markdown_field :description
2012-04-08 21:28:58 +00:00
belongs_to :project
2017-07-07 15:08:49 +00:00
belongs_to :group
2019-09-03 09:38:59 +00:00
# A one-to-one relationship is set up here as part of a MVC: https://gitlab.com/gitlab-org/gitlab-ce/issues/62402
# However, on the long term, we will want a many-to-many relationship between Release and Milestone.
# The "has_one through" allows us today to set up this one-to-one relationship while setting up the architecture for the long-term (ie intermediate table).
has_one :milestone_release
has_one :release , through : :milestone_release
2018-04-20 14:00:15 +00: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 21:28:58 +00:00
has_many :issues
2019-01-16 12:09:29 +00:00
has_many :labels , - > { distinct . reorder ( 'labels.title' ) } , through : :issues
2012-10-26 13:53:45 +00:00
has_many :merge_requests
2019-09-06 09:54:58 +00:00
has_many :events , as : :target , dependent : :delete_all # rubocop:disable Cop/ActiveRecordDependent
2012-04-08 21:28:58 +00:00
2017-07-07 15:08:49 +00:00
scope :of_projects , - > ( ids ) { where ( project_id : ids ) }
scope :of_groups , - > ( ids ) { where ( group_id : ids ) }
2013-02-18 09:10:09 +00:00
scope :active , - > { with_state ( :active ) }
scope :closed , - > { with_state ( :closed ) }
2017-07-07 15:08:49 +00:00
scope :for_projects , - > { where ( group : nil ) . includes ( :project ) }
2019-03-11 14:15:05 +00:00
scope :started , - > { active . where ( 'milestones.start_date <= CURRENT_DATE' ) }
2017-07-07 15:08:49 +00:00
2018-12-17 12:59:23 +00:00
scope :for_projects_and_groups , - > ( projects , groups ) do
projects = projects . compact if projects . is_a? Array
projects = [ ] if projects . nil?
2017-07-07 15:08:49 +00:00
2018-12-17 12:59:23 +00:00
groups = groups . compact if groups . is_a? Array
groups = [ ] if groups . nil?
2017-07-07 15:08:49 +00:00
2019-01-11 14:58:18 +00:00
where ( project_id : projects ) . or ( where ( group_id : groups ) )
2017-07-07 15:08:49 +00:00
end
2018-09-17 16:35:39 +00:00
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 15:08:49 +00:00
validates :group , presence : true , unless : :project
validates :project , presence : true , unless : :group
2012-12-14 05:34:05 +00:00
2017-07-07 15:08:49 +00:00
validate :uniqueness_of_title , if : :title_changed?
validate :milestone_type_check
2017-03-31 15:11:28 +00:00
validate :start_date_should_be_less_than_due_date , if : proc { | m | m . start_date . present? && m . due_date . present? }
2019-05-31 10:31:47 +00:00
validate :dates_within_4_digits
2019-09-03 09:38:59 +00:00
validates_associated :milestone_release , message : - > ( _ , obj ) { obj [ :value ] . errors . full_messages . join ( " , " ) }
2013-02-18 09:10:09 +00:00
2015-11-26 15:16:50 +00:00
strip_attributes :title
2013-02-18 13:22:18 +00:00
state_machine :state , initial : :active do
2013-02-18 09:10:09 +00:00
event :close do
2013-02-18 13:22:18 +00:00
transition active : :closed
2013-02-18 09:10:09 +00:00
end
event :activate do
2013-02-18 13:22:18 +00:00
transition closed : :active
2013-02-18 09:10:09 +00:00
end
state :closed
state :active
end
2012-04-08 21:28:58 +00:00
2015-10-09 04:24:55 +00:00
alias_attribute :name , :title
2015-08-13 14:48:21 +00:00
class << self
2019-01-17 14:35:23 +00:00
# Searches for milestones with a matching title or description.
2016-03-01 16:05:26 +00:00
#
# This method uses ILIKE on PostgreSQL and LIKE on MySQL.
#
# query - The search query as a String
#
# Returns an ActiveRecord::Relation.
2015-08-13 14:48:21 +00:00
def search ( query )
2017-11-24 11:24:24 +00:00
fuzzy_search ( query , [ :title , :description ] )
2015-08-13 14:48:21 +00:00
end
2017-07-07 15:08:49 +00:00
2019-01-17 14:35:23 +00: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 15:08:49 +00:00
def filter_by_state ( milestones , state )
case state
when 'closed' then milestones . closed
when 'all' then milestones
else milestones . active
end
end
2017-12-01 19:08:38 +00:00
2018-12-20 11:14:33 +00:00
def count_by_state
reorder ( nil ) . group ( :state ) . count
end
2017-12-01 19:08:38 +00:00
def predefined? ( milestone )
milestone == Any ||
milestone == None ||
milestone == Upcoming ||
milestone == Started
end
2015-08-13 14:48:21 +00:00
end
2016-03-31 02:12:34 +00:00
def self . reference_prefix
'%'
end
2015-12-24 13:43:07 +00:00
def self . reference_pattern
2016-04-06 00:35:43 +00:00
# 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.
2016-05-19 04:45:25 +00:00
@reference_pattern || = %r{
2016-03-31 02:12:34 +00:00
( #{Project.reference_pattern})?
#{Regexp.escape(reference_prefix)}
( ?:
2016-04-06 00:35:43 +00:00
( ? < milestone_iid >
\ d + ( ?! \ S \ w ) \ b # Integer-based milestone iid, or
) |
2016-03-31 02:12:34 +00:00
( ? < milestone_name >
2016-04-06 00:35:43 +00:00
[ ^ " \s ]+ \b | # String-based single-word milestone title, or
" [^ " ] + " # String-based multi-word milestone surrounded in quotes
2016-03-31 02:12:34 +00:00
)
)
} x
2015-12-24 13:43:07 +00:00
end
def self . link_reference_pattern
2016-03-24 15:41:48 +00:00
@link_reference_pattern || = super ( " milestones " , / (?<milestone> \ d+) / )
2015-12-24 13:43:07 +00:00
end
2018-11-15 06:56:51 +00:00
def self . upcoming_ids ( projects , groups )
2019-07-24 13:59:55 +00:00
unscoped
. for_projects_and_groups ( projects , groups )
. active . where ( 'milestones.due_date > CURRENT_DATE' )
. order ( :project_id , :group_id , :due_date ) . select ( 'DISTINCT ON (project_id, group_id) id' )
2016-03-11 17:46:14 +00:00
end
2017-05-04 12:11:15 +00:00
def participants
2018-10-26 16:19:28 +00:00
User . joins ( assigned_issues : :milestone ) . where ( " milestones.id = ? " , id ) . distinct
2017-05-04 12:11:15 +00:00
end
2018-04-04 09:19:47 +00:00
def self . sort_by_attribute ( method )
2018-08-06 19:38:37 +00:00
sorted =
case method . to_s
when 'due_date_asc'
2018-09-17 16:35:39 +00:00
reorder_by_due_date_asc
2018-08-06 19:38:37 +00:00
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
2017-03-24 00:39:12 +00:00
end
2018-10-16 13:18:25 +00:00
def self . states_count ( projects , groups = nil )
return STATE_COUNT_HASH unless projects || groups
counts = Milestone
2019-01-11 14:58:18 +00:00
. for_projects_and_groups ( projects , groups )
2018-10-16 13:18:25 +00:00
. reorder ( nil )
. group ( :state )
. count
{
opened : counts [ 'active' ] || 0 ,
closed : counts [ 'closed' ] || 0 ,
all : counts . values . sum
}
end
2016-04-01 00:54:00 +00:00
##
2017-08-03 11:50:06 +00:00
# Returns the String necessary to reference this Milestone in Markdown. Group
# milestones only support name references, and do not support cross-project
# references.
2016-04-01 00:54:00 +00:00
#
# format - Symbol format to use (default: :iid, optional: :name)
#
# Examples:
#
2016-11-02 23:49:13 +00:00
# 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"
2016-04-01 00:54:00 +00:00
#
2017-11-22 13:20:35 +00:00
def to_reference ( from = nil , format : :name , full : false )
2016-03-31 02:12:34 +00:00
format_reference = milestone_format_reference ( format )
reference = " #{ self . class . reference_prefix } #{ format_reference } "
2016-01-07 11:26:05 +00:00
2017-08-03 11:50:06 +00:00
if project
2017-11-22 13:20:35 +00:00
" #{ project . to_reference ( from , full : full ) } #{ reference } "
2017-08-03 11:50:06 +00:00
else
reference
end
2015-12-24 13:43:07 +00:00
end
2017-11-22 13:20:35 +00:00
def reference_link_text ( from = nil )
2018-12-19 11:12:19 +00:00
self . class . reference_prefix + self . title
2015-12-24 13:43:07 +00:00
end
2018-12-20 11:14:33 +00:00
def milestoneish_id
2016-12-16 15:52:27 +00:00
id
end
2017-07-07 15:08:49 +00:00
def for_display
self
end
2012-12-14 05:34:05 +00:00
def can_be_closed?
2013-02-18 09:10:09 +00:00
active? && issues . opened . count . zero?
2012-12-19 03:14:05 +00:00
end
2012-12-14 20:05:10 +00:00
def author_id
2014-03-25 12:01:52 +00:00
nil
2012-12-14 20:05:10 +00:00
end
2015-10-15 16:10:35 +00:00
2016-05-09 14:58:20 +00:00
def title = ( value )
2016-09-26 23:47:34 +00:00
write_attribute ( :title , sanitize_title ( value ) ) if value . present?
2016-05-04 21:21:57 +00:00
end
2017-07-07 15:08:49 +00:00
def safe_title
title . to_slug . normalize . to_s
end
def parent
group || project
end
2019-09-03 21:29:55 +00:00
alias_method :resource_parent , :parent
2017-07-07 15:08:49 +00:00
2017-08-24 16:41:44 +00:00
def group_milestone?
2017-07-07 15:08:49 +00:00
group_id . present?
end
2017-08-24 16:37:37 +00:00
def project_milestone?
2017-07-07 15:08:49 +00:00
project_id . present?
end
2016-03-31 02:12:34 +00:00
private
2017-07-07 15:08:49 +00: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
2019-01-11 14:58:18 +00:00
relation = Milestone . for_projects_and_groups ( group . projects . select ( :id ) , [ group . id ] )
2017-07-07 15:08:49 +00:00
end
title_exists = relation . find_by_title ( title )
2019-04-12 12:28:07 +00:00
errors . add ( :title , _ ( " already being used for another group or project milestone. " ) ) if title_exists
2017-07-07 15:08:49 +00:00
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
2019-04-12 12:28:07 +00:00
errors . add ( field , _ ( " milestone should belong either to a project or a group. " ) )
2017-07-07 15:08:49 +00:00
end
end
2016-04-01 00:54:00 +00:00
def milestone_format_reference ( format = :iid )
2019-04-12 12:28:07 +00:00
raise ArgumentError , _ ( 'Unknown format' ) unless [ :iid , :name ] . include? ( format )
2016-03-31 02:12:34 +00:00
2017-09-20 09:55:54 +00:00
if group_milestone? && format == :iid
2019-04-12 12:28:07 +00:00
raise ArgumentError , _ ( 'Cannot refer to a group milestone by an internal id!' )
2017-09-20 09:55:54 +00:00
end
2016-03-31 02:12:34 +00:00
if format == :name && ! name . include? ( '"' )
%( " #{ name } " )
else
2016-04-01 00:54:00 +00:00
iid
2016-03-31 02:12:34 +00:00
end
end
2016-09-26 23:47:34 +00:00
def sanitize_title ( value )
CGI . unescape_html ( Sanitize . clean ( value . to_s ) )
end
2016-11-15 17:48:30 +00:00
def start_date_should_be_less_than_due_date
if due_date < = start_date
2019-04-12 12:28:07 +00:00
errors . add ( :due_date , _ ( " must be greater than start date " ) )
2016-11-15 17:48:30 +00:00
end
end
2017-01-06 12:47:18 +00:00
2019-05-31 10:31:47 +00:00
def dates_within_4_digits
if start_date && start_date > Date . new ( 9999 , 12 , 31 )
errors . add ( :start_date , _ ( " date must not be after 9999-12-31 " ) )
end
if due_date && due_date > Date . new ( 9999 , 12 , 31 )
errors . add ( :due_date , _ ( " date must not be after 9999-12-31 " ) )
end
end
2017-01-06 12:47:18 +00:00
def issues_finder_params
2017-06-09 18:53:32 +00:00
{ project_id : project_id }
2017-01-06 12:47:18 +00:00
end
2012-04-08 21:28:58 +00:00
end