# frozen_string_literal: true class Milestone < ApplicationRecord include Sortable include Referable include Timebox include Milestoneish include FromUnion include Importable prepend_if_ee('::EE::Milestone') # rubocop: disable Cop/InjectEnterpriseEditionModule has_many :milestone_releases has_many :releases, through: :milestone_releases has_internal_id :iid, scope: :project, track_if: -> { !importing? }, init: ->(s) { s&.project&.milestones&.maximum(:iid) } has_internal_id :iid, scope: :group, track_if: -> { !importing? }, init: ->(s) { s&.group&.milestones&.maximum(:iid) } has_many :events, as: :target, dependent: :delete_all # rubocop:disable Cop/ActiveRecordDependent scope :active, -> { with_state(:active) } scope :started, -> { active.where('milestones.start_date <= CURRENT_DATE') } scope :not_started, -> { active.where('milestones.start_date > CURRENT_DATE') } scope :not_upcoming, -> do active .where('milestones.due_date <= CURRENT_DATE') .order(:project_id, :group_id, :due_date) 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')) } validates_associated :milestone_releases, message: -> (_, obj) { obj[:value].map(&:errors).map(&:full_messages).join(",") } state_machine :state, initial: :active do event :close do transition active: :closed end event :activate do transition closed: :active end state :closed state :active end def self.reference_prefix '%' end 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)} (?: (? \d+(?!\S\w)\b # Integer-based milestone iid, or ) | (? [^"\s]+\b | # String-based single-word milestone title, or "[^"]+" # String-based multi-word milestone surrounded in quotes ) ) }x end def self.link_reference_pattern @link_reference_pattern ||= super("milestones", /(?\d+)/) end def self.upcoming_ids(projects, groups) 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') 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 a 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-foss%1" # Milestone.first.to_reference(same_namespace_project) # => "gitlab-foss%1" # def to_reference(from = nil, format: :name, full: false) format_reference = milestone_format_reference(format) reference = "#{self.class.reference_prefix}#{format_reference}" if project "#{project.to_reference_base(from, full: full)}#{reference}" else reference end end def reference_link_text(from = nil) self.class.reference_prefix + self.title end def for_display self end def can_be_closed? active? && issues.opened.count.zero? end def author_id nil end # TODO: remove after all code paths use `timebox_id` # https://gitlab.com/gitlab-org/gitlab/-/issues/215688 alias_method :milestoneish_id, :timebox_id # TODO: remove after all code paths use (group|project)_timebox? # https://gitlab.com/gitlab-org/gitlab/-/issues/215690 alias_method :group_milestone?, :group_timebox? alias_method :project_milestone?, :project_timebox? def parent if group_milestone? group else project end end private 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 issues_finder_params { project_id: project_id, group_id: group_id, include_subgroups: group_id.present? }.compact end end