kevinpapst_kimai2/tests/DataFixtures/TimesheetFixtures.php

<?php

/*
 * This file is part of the Kimai time-tracking app.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace App\Tests\DataFixtures;

use App\Entity\Activity;
use App\Entity\Project;
use App\Entity\Tag;
use App\Entity\Timesheet;
use App\Entity\User;
use App\Entity\UserPreference;
use App\Timesheet\Util;
use Doctrine\Persistence\ObjectManager;
use Faker\Factory;

/**
 * Defines the sample data to load in during controller tests.
 */
final class TimesheetFixtures implements TestFixture
{
    use FixturesTrait;

    private int $running = 0;
    /**
     * @var Activity[]
     */
    private array $activities = [];
    /**
     * @var Project[]
     */
    private array $projects = [];
    private ?\DateTime $startDate = null;
    private ?\DateTime $fixedStartDate = null;
    private bool $fixedRate = false;
    /**
     * @var callable
     */
    private $callback;
    private bool $hourlyRate = false;
    private bool $allowEmptyDescriptions = true;
    private bool $exported = false;
    /**
     * @var array<string|Tag>
     */
    private array $tags = [];

    public function __construct(private ?User $user = null, private int $amount = 0)
    {
    }

    public function setAllowEmptyDescriptions(bool $allowEmptyDescriptions): TimesheetFixtures
    {
        $this->allowEmptyDescriptions = $allowEmptyDescriptions;

        return $this;
    }

    public function setExported(bool $exported): TimesheetFixtures
    {
        $this->exported = $exported;

        return $this;
    }

    public function setFixedRate(bool $fixedRate): TimesheetFixtures
    {
        $this->fixedRate = $fixedRate;

        return $this;
    }

    public function setHourlyRate(bool $hourlyRate): TimesheetFixtures
    {
        $this->hourlyRate = $hourlyRate;

        return $this;
    }

    /**
     * @param string|\DateTime $date
     * @return TimesheetFixtures
     */
    public function setStartDate($date): TimesheetFixtures
    {
        if (!($date instanceof \DateTime)) {
            $date = new \DateTime($date);
        }
        $this->startDate = $date;

        return $this;
    }

    public function setFixedStartDate(\DateTime $date): TimesheetFixtures
    {
        $this->fixedStartDate = $date;

        return $this;
    }

    public function setAmountRunning(int $amount): TimesheetFixtures
    {
        $this->running = $amount;

        return $this;
    }

    public function setAmount(int $amount): TimesheetFixtures
    {
        $this->amount = $amount;

        return $this;
    }

    public function setUser(User $user): TimesheetFixtures
    {
        $this->user = $user;

        return $this;
    }

    /**
     * @param Activity[] $activities
     * @return TimesheetFixtures
     */
    public function setActivities(array $activities): TimesheetFixtures
    {
        $this->activities = $activities;

        return $this;
    }

    /**
     * @param Project[] $projects
     * @return TimesheetFixtures
     */
    public function setProjects(array $projects): TimesheetFixtures
    {
        $this->projects = $projects;

        return $this;
    }

    /**
     * @param string[] $tags
     * @return TimesheetFixtures
     */
    public function setTags(array $tags): TimesheetFixtures
    {
        $this->tags = $tags;

        return $this;
    }

    /**
     * Will be called prior to persisting the object.
     *
     * @param callable $callback
     * @return TimesheetFixtures
     */
    public function setCallback(callable $callback): TimesheetFixtures
    {
        $this->callback = $callback;

        return $this;
    }

    /**
     * @param ObjectManager $manager
     * @return Timesheet[]
     */
    public function load(ObjectManager $manager): array
    {
        $created = [];

        $activities = $this->activities;
        if (empty($activities)) {
            $activities = $this->getAllActivities($manager);
        }

        $projects = $this->projects;
        if (empty($projects)) {
            $projects = $this->getAllProjects($manager);
        }

        $faker = Factory::create();

        $users = [];

        if ($this->user !== null) {
            $users[] = $this->user;
        } else {
            $users = $this->getAllUsers($manager);
        }

        $tags = $this->getTagObjectList();
        foreach ($tags as $tag) {
            if ($tag->getId() === null) {
                $manager->persist($tag);
            }
        }
        $manager->flush();

        for ($i = 0; $i < $this->amount; $i++) {
            $description = $faker->text();
            if ($this->allowEmptyDescriptions) {
                if ($i % 3 == 0) {
                    $description = null;
                } elseif ($i % 2 == 0) {
                    $description = '';
                }
            }

            $user = $users[array_rand($users)];
            $activity = $activities[array_rand($activities)];
            $project = $activity->getProject();

            if (null === $project) {
                $project = $projects[array_rand($projects)];
            }

            $timesheet = $this->createTimesheetEntry(
                $user,
                $activity,
                $project,
                $description,
                $this->getDateTime($i),
                $tags
            );

            if (null !== $this->callback) {
                \call_user_func($this->callback, $timesheet);
            }
            $manager->persist($timesheet);
            $created[] = $timesheet;
        }

        for ($i = 0; $i < $this->running; $i++) {
            $activity = $activities[array_rand($activities)];
            $project = $activity->getProject();
            $user = $users[array_rand($users)];

            if (null === $project) {
                $project = $projects[array_rand($projects)];
            }

            $timesheet = $this->createTimesheetEntry(
                $user,
                $activity,
                $project,
                $faker->text(),
                $this->getDateTime($i),
                $tags,
                false
            );

            if (null !== $this->callback) {
                \call_user_func($this->callback, $timesheet);
            }
            $manager->persist($timesheet);
            $created[] = $timesheet;
        }

        $manager->flush();

        return $created;
    }

    /**
     * @return array<Tag>
     */
    private function getTagObjectList(): array
    {
        $all = [];
        foreach ($this->tags as $tagName) {
            if ($tagName instanceof Tag) {
                $all[] = $tagName;
                continue;
            }

            $tagObject = new Tag();
            $tagObject->setName($tagName);

            $all[] = $tagObject;
        }

        return $all;
    }

    private function getDateTime(int $i): \DateTime
    {
        if ($this->fixedStartDate !== null) {
            return $this->fixedStartDate;
        }

        if ($this->startDate === null) {
            $this->startDate = new \DateTime('2018-04-01');
        }

        $start = clone $this->startDate;
        $start->modify("+ $i days");
        $start->modify('+ ' . rand(1, 172800) . ' seconds'); // up to 2 days

        return $start;
    }

    /**
     * @param \DateTime $start
     * @param array<Tag> $tagArray
     */
    private function createTimesheetEntry(User $user, Activity $activity, Project $project, ?string $description, \DateTime $start, array $tagArray = [], bool $setEndDate = true): Timesheet
    {
        $end = clone $start;
        $end = $end->modify('+ ' . (rand(1, 86400)) . ' seconds');

        $duration = $end->getTimestamp() - $start->getTimestamp();
        $hourlyRate = (float) $user->getPreferenceValue(UserPreference::HOURLY_RATE);
        $rate = Util::calculateRate($hourlyRate, $duration);

        $entry = new Timesheet();
        $entry->setActivity($activity);
        $entry->setProject($project);
        $entry->setDescription($description);
        $entry->setUser($user);
        $entry->setRate($rate);
        $entry->setBegin($start);

        if (\count($tagArray) > 0) {
            foreach ($tagArray as $item) {
                $entry->addTag($item);
            }
        }

        if ($this->fixedRate) {
            $entry->setFixedRate((float) rand(10, 100));
        }

        if ($this->hourlyRate) {
            $entry->setHourlyRate($hourlyRate);
        }

        $entry->setExported($this->exported);

        if ($setEndDate) {
            $entry->setEnd($end);
            $entry->setDuration($duration);
        }

        return $entry;
    }
}