added activity events for plugins (#2516)

src/Activity/ActivityService.php

@@ -0,0 +1,104 @@
+<?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\Activity;
+
+use App\Entity\Activity;
+use App\Entity\Project;
+use App\Event\ActivityCreateEvent;
+use App\Event\ActivityCreatePostEvent;
+use App\Event\ActivityCreatePreEvent;
+use App\Event\ActivityMetaDefinitionEvent;
+use App\Event\ActivityUpdatePostEvent;
+use App\Event\ActivityUpdatePreEvent;
+use App\Repository\ActivityRepository;
+use App\Validator\ValidationFailedException;
+use InvalidArgumentException;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
+
+/**
+ * @final
+ */
+class ActivityService
+{
+    /**
+     * @var ActivityRepository
+     */
+    private $repository;
+    /**
+     * @var EventDispatcherInterface
+     */
+    private $dispatcher;
+    /**
+     * @var ValidatorInterface
+     */
+    private $validator;
+
+    public function __construct(ActivityRepository $activityRepository, EventDispatcherInterface $dispatcher, ValidatorInterface $validator)
+    {
+        $this->repository = $activityRepository;
+        $this->dispatcher = $dispatcher;
+        $this->validator = $validator;
+    }
+
+    public function createNewActivity(?Project $project = null): Activity
+    {
+        $activity = new Activity();
+
+        if ($project !== null) {
+            $activity->setProject($project);
+        }
+
+        $this->dispatcher->dispatch(new ActivityMetaDefinitionEvent($activity));
+        $this->dispatcher->dispatch(new ActivityCreateEvent($activity));
+
+        return $activity;
+    }
+
+    public function saveNewActivity(Activity $activity): Activity
+    {
+        if (null !== $activity->getId()) {
+            throw new InvalidArgumentException('Cannot create activity, already persisted');
+        }
+
+        $this->validateActivity($activity);
+
+        $this->dispatcher->dispatch(new ActivityCreatePreEvent($activity));
+        $this->repository->saveActivity($activity);
+        $this->dispatcher->dispatch(new ActivityCreatePostEvent($activity));
+
+        return $activity;
+    }
+
+    /**
+     * @param Activity $activity
+     * @param string[] $groups
+     * @throws ValidationFailedException
+     */
+    private function validateActivity(Activity $activity, array $groups = []): void
+    {
+        $errors = $this->validator->validate($activity, null, $groups);
+
+        if ($errors->count() > 0) {
+            throw new ValidationFailedException($errors, 'Validation Failed');
+        }
+    }
+
+    public function updateActivity(Activity $activity): Activity
+    {
+        $this->validateActivity($activity);
+
+        $this->dispatcher->dispatch(new ActivityUpdatePreEvent($activity));
+        $this->repository->saveActivity($activity);
+        $this->dispatcher->dispatch(new ActivityUpdatePostEvent($activity));
+
+        return $activity;
+    }
+}

src/Controller/ActivityController.php

@@ -9,6 +9,7 @@
 
 namespace App\Controller;
 
+use App\Activity\ActivityService;
 use App\Configuration\SystemConfiguration;
 use App\Entity\Activity;
 use App\Entity\ActivityRate;
@@ -57,12 +58,17 @@ final class ActivityController extends AbstractController
      * @var EventDispatcherInterface
      */
     private $dispatcher;
+    /**
+     * @var ActivityService
+     */
+    private $activityService;
 
-    public function __construct(ActivityRepository $repository, SystemConfiguration $configuration, EventDispatcherInterface $dispatcher)
+    public function __construct(ActivityRepository $repository, SystemConfiguration $configuration, EventDispatcherInterface $dispatcher, ActivityService $activityService)
     {
         $this->repository = $repository;
         $this->configuration = $configuration;
         $this->dispatcher = $dispatcher;
+        $this->activityService = $activityService;
     }
 
     /**
@@ -183,10 +189,7 @@ final class ActivityController extends AbstractController
      */
     public function createAction(Request $request, ?Project $project = null)
     {
-        $activity = new Activity();
-        if (null !== $project) {
-            $activity->setProject($project);
-        }
+        $activity = $this->activityService->createNewActivity($project);
 
         $event = new ActivityMetaDefinitionEvent($activity);
         $this->dispatcher->dispatch($event);
@@ -196,7 +199,7 @@ final class ActivityController extends AbstractController
 
         if ($editForm->isSubmitted() && $editForm->isValid()) {
             try {
-                $this->repository->saveActivity($activity);
+                $this->activityService->saveNewActivity($activity);
                 $this->flashSuccess('action.update.success');
 
                 return $this->redirectToRoute('admin_activity');
@@ -226,7 +229,7 @@ final class ActivityController extends AbstractController
 
         if ($form->isSubmitted() && $form->isValid()) {
             try {
-                $this->repository->saveActivity($activity);
+                $this->activityService->updateActivity($activity);
                 $this->flashSuccess('action.update.success');
 
                 if ($this->isGranted('view', $activity)) {
@@ -286,7 +289,7 @@ final class ActivityController extends AbstractController
 
         if ($editForm->isSubmitted() && $editForm->isValid()) {
             try {
-                $this->repository->saveActivity($activity);
+                $this->activityService->updateActivity($activity);
                 $this->flashSuccess('action.update.success');
 
                 return $this->redirectToRoute('activity_details', ['id' => $activity->getId()]);

src/Customer/CustomerService.php

@@ -23,6 +23,9 @@ use InvalidArgumentException;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
 
+/**
+ * @final
+ */
 class CustomerService
 {
     private $repository;

src/Event/AbstractActivityEvent.php

@@ -0,0 +1,34 @@
+<?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\Event;
+
+use App\Entity\Activity;
+use Symfony\Contracts\EventDispatcher\Event;
+
+/**
+ * Base event class to used with activity manipulations.
+ */
+abstract class AbstractActivityEvent extends Event
+{
+    /**
+     * @var Activity
+     */
+    private $activity;
+
+    public function __construct(Activity $activity)
+    {
+        $this->activity = $activity;
+    }
+
+    public function getActivity(): Activity
+    {
+        return $this->activity;
+    }
+}

src/Event/ActivityCreateEvent.php

@@ -0,0 +1,17 @@
+<?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\Event;
+
+/**
+ * Triggered for new activity instances, which might or might not be saved.
+ */
+final class ActivityCreateEvent extends AbstractActivityEvent
+{
+}

src/Event/ActivityCreatePostEvent.php

@@ -0,0 +1,17 @@
+<?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\Event;
+
+/**
+ * Triggered for activity instances, which were just saved.
+ */
+final class ActivityCreatePostEvent extends AbstractActivityEvent
+{
+}

src/Event/ActivityCreatePreEvent.php

@@ -0,0 +1,17 @@
+<?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\Event;
+
+/**
+ * Triggered for activity instances, which are just about to being saved.
+ */
+final class ActivityCreatePreEvent extends AbstractActivityEvent
+{
+}

src/Event/ActivityUpdatePostEvent.php

@@ -0,0 +1,17 @@
+<?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\Event;
+
+/**
+ * Triggered for activity instances, which were updated.
+ */
+final class ActivityUpdatePostEvent extends AbstractActivityEvent
+{
+}

src/Event/ActivityUpdatePreEvent.php

@@ -0,0 +1,17 @@
+<?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\Event;
+
+/**
+ * Triggered for activity instances, which are about to being updated.
+ */
+final class ActivityUpdatePreEvent extends AbstractActivityEvent
+{
+}

src/Project/ProjectService.php

@@ -23,6 +23,9 @@ use InvalidArgumentException;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\Validator\Validator\ValidatorInterface;
 
+/**
+ * @final
+ */
 class ProjectService
 {
     /**

tests/Activity/ActivityServiceTest.php

@@ -0,0 +1,157 @@
+<?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\Activity;
+
+use App\Activity\ActivityService;
+use App\Entity\Activity;
+use App\Entity\Project;
+use App\Event\ActivityCreateEvent;
+use App\Event\ActivityCreatePostEvent;
+use App\Event\ActivityCreatePreEvent;
+use App\Event\ActivityMetaDefinitionEvent;
+use App\Event\ActivityUpdatePostEvent;
+use App\Event\ActivityUpdatePreEvent;
+use App\Repository\ActivityRepository;
+use App\Validator\ValidationFailedException;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\Validator\ConstraintViolation;
+use Symfony\Component\Validator\ConstraintViolationList;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
+
+/**
+ * @covers \App\Activity\ActivityService
+ */
+class ActivityServiceTest extends TestCase
+{
+    private function getSut(
+        ?EventDispatcherInterface $dispatcher = null,
+        ?ValidatorInterface $validator = null,
+        ?ActivityRepository $repository = null
+    ): ActivityService {
+        if ($repository === null) {
+            $repository = $this->createMock(ActivityRepository::class);
+        }
+
+        if ($dispatcher === null) {
+            $dispatcher = $this->createMock(EventDispatcherInterface::class);
+        }
+
+        if ($validator === null) {
+            $validator = $this->createMock(ValidatorInterface::class);
+            $validator->method('validate')->willReturn(new ConstraintViolationList());
+        }
+
+        $service = new ActivityService($repository, $dispatcher, $validator);
+
+        return $service;
+    }
+
+    public function testCannotSavePersistedProjectAsNew()
+    {
+        $project = $this->createMock(Activity::class);
+        $project->expects($this->once())->method('getId')->willReturn(1);
+
+        $sut = $this->getSut();
+
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Cannot create activity, already persisted');
+
+        $sut->saveNewActivity($project);
+    }
+
+    public function testsaveNewActivityHasValidationError()
+    {
+        $constraints = new ConstraintViolationList();
+        $constraints->add(new ConstraintViolation('toooo many tests', 'abc.def', [], '$root', 'begin', 4, null, null, null, '$cause'));
+
+        $validator = $this->createMock(ValidatorInterface::class);
+        $validator->method('validate')->willReturn($constraints);
+
+        $sut = $this->getSut(null, $validator);
+
+        $this->expectException(ValidationFailedException::class);
+        $this->expectExceptionMessage('Validation Failed');
+
+        $sut->saveNewActivity(new Activity());
+    }
+
+    public function testUpdateDispatchesEvents()
+    {
+        $project = $this->createMock(Activity::class);
+        $project->method('getId')->willReturn(1);
+
+        $dispatcher = $this->createMock(EventDispatcherInterface::class);
+        $dispatcher->expects($this->exactly(2))->method('dispatch')->willReturnCallback(function ($event) use ($project) {
+            if ($event instanceof ActivityUpdatePostEvent) {
+                self::assertSame($project, $event->getActivity());
+            } elseif ($event instanceof ActivityUpdatePreEvent) {
+                self::assertSame($project, $event->getActivity());
+            } else {
+                $this->fail('Invalid event received');
+            }
+        });
+
+        $sut = $this->getSut($dispatcher);
+
+        $sut->updateActivity($project);
+    }
+
+    public function testcreateNewActivityDispatchesEvents()
+    {
+        $dispatcher = $this->createMock(EventDispatcherInterface::class);
+        $dispatcher->expects($this->exactly(2))->method('dispatch')->willReturnCallback(function ($event) {
+            if ($event instanceof ActivityMetaDefinitionEvent) {
+                self::assertInstanceOf(Activity::class, $event->getEntity());
+            } elseif ($event instanceof ActivityCreateEvent) {
+                self::assertInstanceOf(Activity::class, $event->getActivity());
+            } else {
+                $this->fail('Invalid event received');
+            }
+        });
+
+        $sut = $this->getSut($dispatcher);
+
+        $project = new Project();
+        $activity = $sut->createNewActivity($project);
+
+        self::assertSame($project, $activity->getProject());
+    }
+
+    public function testsaveNewActivityDispatchesEvents()
+    {
+        $dispatcher = $this->createMock(EventDispatcherInterface::class);
+        $dispatcher->expects($this->exactly(2))->method('dispatch')->willReturnCallback(function ($event) {
+            if ($event instanceof ActivityCreatePreEvent) {
+                self::assertInstanceOf(Activity::class, $event->getActivity());
+            } elseif ($event instanceof ActivityCreatePostEvent) {
+                self::assertInstanceOf(Activity::class, $event->getActivity());
+            } else {
+                $this->fail('Invalid event received');
+            }
+        });
+
+        $sut = $this->getSut($dispatcher);
+
+        $activity = new Activity();
+        $sut->saveNewActivity($activity);
+    }
+
+    public function testcreateNewActivityWithoutCustomer()
+    {
+        $sut = $this->getSut();
+
+        $project = $sut->createNewActivity();
+        self::assertNull($project->getProject());
+
+        $project = $sut->createNewActivity();
+        self::assertNull($project->getProject());
+    }
+}

tests/Event/AbstractActivityEventTest.php

@@ -0,0 +1,29 @@
+<?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\Event;
+
+use App\Entity\Activity;
+use App\Event\AbstractActivityEvent;
+use PHPUnit\Framework\TestCase;
+use Symfony\Contracts\EventDispatcher\Event;
+
+abstract class AbstractActivityEventTest extends TestCase
+{
+    abstract protected function createActivityEvent(Activity $activity): AbstractActivityEvent;
+
+    public function testGetterAndSetter()
+    {
+        $activity = new Activity();
+        $sut = $this->createActivityEvent($activity);
+
+        self::assertInstanceOf(Event::class, $sut);
+        self::assertSame($activity, $sut->getActivity());
+    }
+}

tests/Event/ActivityCreateEventTest.php

@@ -0,0 +1,26 @@
+<?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\Event;
+
+use App\Entity\Activity;
+use App\Event\AbstractActivityEvent;
+use App\Event\ActivityCreateEvent;
+
+/**
+ * @covers \App\Event\AbstractActivityEvent
+ * @covers \App\Event\ActivityCreateEvent
+ */
+class ActivityCreateEventTest extends AbstractActivityEventTest
+{
+    protected function createActivityEvent(Activity $activity): AbstractActivityEvent
+    {
+        return new ActivityCreateEvent($activity);
+    }
+}

tests/Event/ActivityCreatePostEventTest.php

@@ -0,0 +1,26 @@
+<?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\Event;
+
+use App\Entity\Activity;
+use App\Event\AbstractActivityEvent;
+use App\Event\ActivityCreatePostEvent;
+
+/**
+ * @covers \App\Event\AbstractActivityEvent
+ * @covers \App\Event\ActivityCreatePostEvent
+ */
+class ActivityCreatePostEventTest extends AbstractActivityEventTest
+{
+    protected function createActivityEvent(Activity $activity): AbstractActivityEvent
+    {
+        return new ActivityCreatePostEvent($activity);
+    }
+}

tests/Event/ActivityCreatePreEventTest.php

@@ -0,0 +1,26 @@
+<?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\Event;
+
+use App\Entity\Activity;
+use App\Event\AbstractActivityEvent;
+use App\Event\ActivityCreatePreEvent;
+
+/**
+ * @covers \App\Event\AbstractActivityEvent
+ * @covers \App\Event\ActivityCreatePreEvent
+ */
+class ActivityCreatePreEventTest extends AbstractActivityEventTest
+{
+    protected function createActivityEvent(Activity $activity): AbstractActivityEvent
+    {
+        return new ActivityCreatePreEvent($activity);
+    }
+}

tests/Event/ActivityUpdatePostEventTest.php

@@ -0,0 +1,26 @@
+<?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\Event;
+
+use App\Entity\Activity;
+use App\Event\AbstractActivityEvent;
+use App\Event\ActivityUpdatePostEvent;
+
+/**
+ * @covers \App\Event\AbstractActivityEvent
+ * @covers \App\Event\ActivityUpdatePostEvent
+ */
+class ActivityUpdatePostEventTest extends AbstractActivityEventTest
+{
+    protected function createActivityEvent(Activity $activity): AbstractActivityEvent
+    {
+        return new ActivityUpdatePostEvent($activity);
+    }
+}

tests/Event/ActivityUpdatePreEventTest.php

@@ -0,0 +1,26 @@
+<?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\Event;
+
+use App\Entity\Activity;
+use App\Event\AbstractActivityEvent;
+use App\Event\ActivityUpdatePreEvent;
+
+/**
+ * @covers \App\Event\AbstractActivityEvent
+ * @covers \App\Event\ActivityUpdatePreEvent
+ */
+class ActivityUpdatePreEventTest extends AbstractActivityEventTest
+{
+    protected function createActivityEvent(Activity $activity): AbstractActivityEvent
+    {
+        return new ActivityUpdatePreEvent($activity);
+    }
+}

tests/Event/ReportingEventTest.php

@@ -0,0 +1,35 @@
+<?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\Event;
+
+use App\Entity\User;
+use App\Event\ReportingEvent;
+use App\Reporting\Report;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \App\Event\ReportingEvent
+ */
+class ReportingEventTest extends TestCase
+{
+    public function testGetterAndSetter()
+    {
+        $user = new User();
+
+        $sut = new ReportingEvent($user);
+
+        self::assertSame($user, $sut->getUser());
+        self::assertEquals([], $sut->getReports());
+
+        $report = new Report('id', 'route', 'label', 'icon');
+        $sut->addReport($report);
+        self::assertSame([$report], $sut->getReports());
+    }
+}