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) Upcoming = MilestoneStruct.new('Upcoming', '#upcoming', -2) Started = MilestoneStruct.new('Started', '#started', -3) include CacheMarkdownField include InternalId include Sortable include Referable include StripAttribute include Milestoneish cache_markdown_field :title, pipeline: :single_line cache_markdown_field :description belongs_to :project has_many :issues has_many :labels, -> { distinct.reorder('labels.title') }, through: :issues has_many :merge_requests has_many :participants, -> { distinct.reorder('users.name') }, through: :issues, source: :assignee has_many :events, as: :target, dependent: :destroy scope :active, -> { with_state(:active) } scope :closed, -> { with_state(:closed) } scope :of_projects, ->(ids) { where(project_id: ids) } validates :title, presence: true, uniqueness: { scope: :project_id } validates :project, presence: true validate :start_date_should_be_less_than_due_date, if: proc { |m| m.start_date.present? && m.due_date.present? } strip_attributes :title 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 alias_attribute :name, :title class << self # Searches for milestones matching the given query. # # This method uses ILIKE on PostgreSQL and LIKE on MySQL. # # query - The search query as a String # # Returns an ActiveRecord::Relation. def search(query) t = arel_table pattern = "%#{query}%" where(t[:title].matches(pattern).or(t[:description].matches(pattern))) end 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_by_projects(projects) rel = unscoped.of_projects(projects).active.where('due_date > ?', Time.now) if Gitlab::Database.postgresql? rel.order(:project_id, :due_date).select('DISTINCT ON (project_id) id') else rel. group(:project_id). having('due_date = MIN(due_date)'). pluck(:id, :project_id, :due_date). map(&:first) end end def self.sort(method) case method.to_s when 'due_date_asc' reorder(Gitlab::Database.nulls_last_order('due_date', 'ASC')) when 'due_date_desc' reorder(Gitlab::Database.nulls_last_order('due_date', 'DESC')) 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 end ## # Returns the String necessary to reference this Milestone in Markdown # # 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" # def to_reference(from_project = nil, format: :iid, full: false) format_reference = milestone_format_reference(format) reference = "#{self.class.reference_prefix}#{format_reference}" "#{project.to_reference(from_project, full: full)}#{reference}" end def reference_link_text(from_project = nil) self.title end def milestoneish_ids id end def can_be_closed? active? && issues.opened.count.zero? end def author_id nil end def title=(value) write_attribute(:title, sanitize_title(value)) if value.present? end # Sorts the issues for the given IDs. # # This method runs a single SQL query using a CASE statement to update the # position of all issues in the current milestone (scoped to the list of IDs). # # Given the ids [10, 20, 30] this method produces a SQL query something like # the following: # # UPDATE issues # SET position = CASE # WHEN id = 10 THEN 1 # WHEN id = 20 THEN 2 # WHEN id = 30 THEN 3 # ELSE position # END # WHERE id IN (10, 20, 30); # # This method expects that the IDs given in `ids` are already Fixnums. def sort_issues(ids) pairs = [] ids.each_with_index do |id, index| pairs << id pairs << index + 1 end conditions = 'WHEN id = ? THEN ? ' * ids.length issues.where(id: ids). update_all(["position = CASE #{conditions} ELSE position END", *pairs]) end private def milestone_format_reference(format = :iid) raise ArgumentError, 'Unknown format' unless [:iid, :name].include?(format) if format == :name && !name.include?('"') %("#{name}") else iid end end def sanitize_title(value) CGI.unescape_html(Sanitize.clean(value.to_s)) end def start_date_should_be_less_than_due_date if due_date <= start_date errors.add(:start_date, "Can't be greater than due date") end end def issues_finder_params { project_id: project_id } end end