Display meta-fields in datatables (#1116)

tests/Export/Renderer/AbstractRendererTest.php

@@ -11,17 +11,28 @@ namespace App\Tests\Export\Renderer;
 
 use App\Configuration\LanguageFormattings;
 use App\Entity\Activity;
+use App\Entity\ActivityMeta;
 use App\Entity\Customer;
+use App\Entity\CustomerMeta;
+use App\Entity\MetaTableTypeInterface;
 use App\Entity\Project;
+use App\Entity\ProjectMeta;
 use App\Entity\Tag;
 use App\Entity\Timesheet;
 use App\Entity\TimesheetMeta;
 use App\Entity\User;
+use App\Event\ActivityMetaDisplayEvent;
+use App\Event\CustomerMetaDisplayEvent;
+use App\Event\ProjectMetaDisplayEvent;
+use App\Event\TimesheetMetaDisplayEvent;
 use App\Export\RendererInterface;
 use App\Repository\Query\TimesheetQuery;
 use App\Twig\DateExtensions;
 use App\Utils\LocaleSettings;
 use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Contracts\Translation\TranslatorInterface;
@@ -52,7 +63,10 @@ abstract class AbstractRendererTest extends KernelTestCase
         $translator = $this->getMockBuilder(TranslatorInterface::class)->getMock();
         $dateExtension = new DateExtensions($localeSettings);
 
-        return new $classname($translator, $dateExtension);
+        $dispatcher = new EventDispatcher();
+        $dispatcher->addSubscriber(new MetaFieldColumnSubscriber());
+
+        return new $classname($translator, $dateExtension, $dispatcher);
     }
 
     /**
@@ -63,14 +77,18 @@ abstract class AbstractRendererTest extends KernelTestCase
     {
         $customer = new Customer();
         $customer->setName('Customer Name');
+        $customer->setMetaField((new CustomerMeta())->setName('customer-foo')->setValue('customer-bar')->setIsVisible(true));
 
         $project = new Project();
         $project->setName('project name');
         $project->setCustomer($customer);
+        $project->setMetaField((new ProjectMeta())->setName('project-bar')->setValue('project-bar')->setIsVisible(true));
+        $project->setMetaField((new ProjectMeta())->setName('project-foo2')->setValue('project-foo2')->setIsVisible(true));
 
         $activity = new Activity();
         $activity->setName('activity description');
         $activity->setProject($project);
+        $activity->setMetaField((new ActivityMeta())->setName('activity-foo')->setValue('activity-bar')->setIsVisible(true));
 
         $userMethods = ['getId', 'getPreferenceValue', 'getUsername'];
         $user1 = $this->getMockBuilder(User::class)->setMethods($userMethods)->disableOriginalConstructor()->getMock();
@@ -153,3 +171,47 @@ abstract class AbstractRendererTest extends KernelTestCase
         return $renderer->render($entries, $query);
     }
 }
+
+class MetaFieldColumnSubscriber implements EventSubscriberInterface
+{
+    public static function getSubscribedEvents(): array
+    {
+        return [
+            TimesheetMetaDisplayEvent::class => ['loadTimesheetField', 200],
+            CustomerMetaDisplayEvent::class => ['loadCustomerField', 200],
+            ProjectMetaDisplayEvent::class => ['loadProjectField', 200],
+            ActivityMetaDisplayEvent::class => ['loadActivityField', 200],
+        ];
+    }
+
+    public function loadTimesheetField(TimesheetMetaDisplayEvent $event)
+    {
+        $event->addField($this->prepareEntity(new TimesheetMeta(), 'foo'));
+        $event->addField($this->prepareEntity(new TimesheetMeta(), 'foo2'));
+    }
+
+    public function loadCustomerField(CustomerMetaDisplayEvent $event)
+    {
+        $event->addField($this->prepareEntity(new CustomerMeta(), 'customer-foo'));
+    }
+
+    public function loadProjectField(ProjectMetaDisplayEvent $event)
+    {
+        $event->addField($this->prepareEntity(new ProjectMeta(), 'project-foo'));
+        $event->addField($this->prepareEntity(new ProjectMeta(), 'project-foo2')->setIsVisible(false));
+    }
+
+    public function loadActivityField(ActivityMetaDisplayEvent $event)
+    {
+        $event->addField($this->prepareEntity(new ActivityMeta(), 'activity-foo'));
+    }
+
+    private function prepareEntity(MetaTableTypeInterface $meta, string $name)
+    {
+        return $meta
+            ->setLabel('Working place')
+            ->setName($name)
+            ->setType(TextType::class)
+            ->setIsVisible(true);
+    }
+}

tests/Export/Renderer/CsvRendererTest.php

@@ -92,12 +92,15 @@ class CsvRendererTest extends AbstractRendererTest
             13 => ' EUR 84.00 ',
             14 => 'meta-bar',
             15 => 'meta-bar2',
+            16 => 'customer-bar',
+            17 => '',
+            18 => 'project-foo2',
+            19 => 'activity-bar',
         ];
 
         self::assertEquals(7, count($all));
+        self::assertEquals($expected, $all[5]);
         self::assertEquals(count($expected), count($all[0]));
         self::assertEquals('foo', $all[4][11]);
-
-        self::assertEquals($expected, $all[5]);
     }
 }

tests/Export/Renderer/HtmlRendererTest.php

@@ -10,6 +10,7 @@
 namespace App\Tests\Export\Renderer;
 
 use App\Export\Renderer\HtmlRenderer;
+use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\HttpFoundation\Request;
 use Twig\Environment;
 
@@ -23,7 +24,8 @@ class HtmlRendererTest extends AbstractRendererTest
     public function testConfiguration()
     {
         $sut = new HtmlRenderer(
-            $this->getMockBuilder(Environment::class)->disableOriginalConstructor()->getMock()
+            $this->getMockBuilder(Environment::class)->disableOriginalConstructor()->getMock(),
+            new EventDispatcher()
         );
 
         $this->assertEquals('html', $sut->getId());
@@ -41,7 +43,7 @@ class HtmlRendererTest extends AbstractRendererTest
         $request->setLocale('en');
         $stack->push($request);
 
-        $sut = new HtmlRenderer($twig);
+        $sut = new HtmlRenderer($twig, new EventDispatcher());
 
         $response = $this->render($sut);
 

tests/Export/ServiceExportTest.php

@@ -12,6 +12,7 @@ namespace App\Tests\Export;
 use App\Export\Renderer\HtmlRenderer;
 use App\Export\ServiceExport;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\EventDispatcher\EventDispatcher;
 use Twig\Environment;
 
 /**
@@ -36,7 +37,8 @@ class ServiceExportTest extends TestCase
         $sut = new ServiceExport([]);
 
         $sut->addRenderer(new HtmlRenderer(
-            $this->getMockBuilder(Environment::class)->disableOriginalConstructor()->getMock()
+            $this->getMockBuilder(Environment::class)->disableOriginalConstructor()->getMock(),
+            new EventDispatcher()
         ));
 
         $this->assertEquals(1, count($sut->getRenderer()));
@@ -45,7 +47,8 @@ class ServiceExportTest extends TestCase
     public function testAddViaConstruct()
     {
         $renderer = [new HtmlRenderer(
-            $this->getMockBuilder(Environment::class)->disableOriginalConstructor()->getMock()
+            $this->getMockBuilder(Environment::class)->disableOriginalConstructor()->getMock(),
+            new EventDispatcher()
         )];
         $sut = new ServiceExport($renderer);