TimeTrack.java

/*
 * BSD 2-Clause License
 * 
 * Copyright (c) 2022, [Aleksandra Serba, Marcin Czerniak, Bartosz Wawrzyniak, Adrian Antkowiak]
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package dev.vernite.vernite.task.time;

import java.util.Date;

import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.FetchType;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import jakarta.persistence.ManyToOne;
import jakarta.validation.constraints.NotNull;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;
import lombok.ToString;

import com.fasterxml.jackson.annotation.JsonIgnore;

import dev.vernite.vernite.common.exception.ConflictStateException;
import dev.vernite.vernite.task.Task;
import dev.vernite.vernite.user.User;

/**
 * Entity for tracking time spent on a task.
 */
@Data
@Entity
@NoArgsConstructor
public class TimeTrack {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private long id;

    private boolean edited = false;

    @NotNull
    @Column(nullable = false)
    private Date startDate;

    private Date endDate;

    @JsonIgnore
    @ToString.Exclude
    @EqualsAndHashCode.Exclude
    @ManyToOne(fetch = FetchType.LAZY, optional = false)
    private User user;

    @JsonIgnore
    @ToString.Exclude
    @EqualsAndHashCode.Exclude
    @ManyToOne(fetch = FetchType.LAZY, optional = false)
    private Task task;

    /**
     * Creates a new time track with the current date as the start date.
     * 
     * @param user the user who is tracking the time
     * @param task the task the user is tracking the time on
     */
    public TimeTrack(User user, Task task) {
        this.user = user;
        this.task = task;
        this.startDate = new Date();
    }

    /**
     * Creates a new time track with the given start and end date.
     * 
     * @param user      the user who is tracking the time
     * @param task      the task the user is tracking the time on
     * @param startDate the start date of the time track
     * @param endDate   the end date of the time track
     */
    public TimeTrack(User user, Task task, Date startDate, Date endDate) {
        this.user = user;
        this.task = task;
        this.startDate = startDate;
        this.endDate = endDate;
        this.edited = true;

        if (startDate.after(endDate)) {
            throw new ConflictStateException("start date is after end date");
        }
    }

    /**
     * Creates a new time track from a request.
     * 
     * @param user   the user who is tracking the time
     * @param task   the task the user is tracking the time on
     * @param create the request to create the time track from
     */
    public TimeTrack(User user, Task task, CreateTimeTrack create) {
        this(user, task, create.getStartDate(), create.getEndDate());
    }

    /**
     * Updates the time track with the given update.
     * 
     * @param update the update to update the time track with
     */
    public void update(UpdateTimeTrack update) {
        if (endDate == null) {
            throw new ConflictStateException("time track is not finished");
        }

        if (update.getStartDate() != null) {
            this.startDate = update.getStartDate();
            this.edited = true;
        }
        if (update.getEndDate() != null) {
            this.endDate = update.getEndDate();
            this.edited = true;
        }

        if (startDate.after(endDate)) {
            throw new ConflictStateException("start date is after end date");
        }
        if (endDate.after(new Date())) {
            throw new ConflictStateException("end date is in the future");
        }
    }

    public long getTaskId() {
        return task.getNumber();
    }

    public long getProjectId() {
        return task.getStatus().getProject().getId();
    }

    public long getUserId() {
        return user.getId();
    }
}