Refactoring and tests update

pfilsx · Apr 17, 2019 · 681add5 · 681add5
1 parent 249f0bb
commit 681add5
Show file tree

Hide file tree

Showing 15 changed files with 199 additions and 48 deletions.
diff --git a/src/Grid/DataGridBuilder.php b/src/Grid/DataGridBuilder.php
@@ -113,6 +113,12 @@ public function enablePagination($options = []): DataGridBuilderInterface
         return $this;
     }
 
+    public function setCountFieldName(string $name): DataGridBuilderInterface
+    {
+        $this->provider->setCountFieldName($name);
+        return $this;
+    }
+
     /**
      * @internal
      * @return array

diff --git a/src/Grid/DataGridBuilderInterface.php b/src/Grid/DataGridBuilderInterface.php
@@ -20,6 +20,8 @@ public function setNoDataMessage(string $message): self;
 
     public function enablePagination($options = []): self;
 
+    public function setCountFieldName(string $name): self;
+
     /**
      * @internal
      * @return array

diff --git a/src/Grid/Providers/DataProvider.php b/src/Grid/Providers/DataProvider.php
@@ -14,6 +14,8 @@ abstract class DataProvider implements DataProviderInterface
 {
     protected $pager;
 
+    protected $countFieldName;
+
     /**
      * @internal
      * @return Pager
@@ -32,6 +34,17 @@ public function setPager(Pager $pager): void
         $this->pager = $pager;
     }
 
+    public function setCountFieldName(string $name): DataProviderInterface
+    {
+        $this->countFieldName = $name;
+        return $this;
+    }
+
+    public function getCountFieldName(): string
+    {
+        return $this->countFieldName;
+    }
+
     public static function create($data, ManagerRegistry $doctrine): DataProviderInterface
     {
         if ($data instanceof ServiceEntityRepository) {

diff --git a/src/Grid/Providers/DataProviderInterface.php b/src/Grid/Providers/DataProviderInterface.php
@@ -35,4 +35,8 @@ public function addRelationFilter(string $attribute, $value, string $relationCla
     public function addCustomFilter(string $attribute, $value, callable $callback): self;
 
     public function addDateFilter(string $attribute, $value, string $comparison = 'equal'): self;
+
+    public function setCountFieldName(string $name): self;
+
+    public function getCountFieldName(): string;
 }
diff --git a/src/Grid/Providers/QueryBuilderDataProvider.php b/src/Grid/Providers/QueryBuilderDataProvider.php
@@ -6,6 +6,7 @@
 
 use DateTime;
 use Doctrine\ORM\QueryBuilder;
+use Pfilsx\DataGrid\DataGridException;
 use Pfilsx\DataGrid\Grid\DataGridItem;
 use Pfilsx\DataGrid\Grid\Hydrators\DataGridHydrator;
 use ReflectionClass;
@@ -47,8 +48,11 @@ public function getItems(): array
 
     public function getTotalCount(): int
     {
+        if (empty($this->countFieldName)) {
+            throw new DataGridException("countableFieldName must be set for " . static::class);
+        }
         $countQueryBuilder = clone($this->builder);
-        $countQueryBuilder->select("count(article.id)");
+        $countQueryBuilder->select("count({$this->countFieldName})");
         $countQueryBuilder->setMaxResults(null);
         $countQueryBuilder->setFirstResult(null);
         $countQueryBuilder->resetDQLPart('groupBy');

diff --git a/src/Grid/Providers/RepositoryDataProvider.php b/src/Grid/Providers/RepositoryDataProvider.php
@@ -54,7 +54,7 @@ public function getTotalCount(): int
     /**
      * @return Criteria
      */
-    protected function getCriteria()
+    public function getCriteria()
     {
         return $this->criteria ?? ($this->criteria = Criteria::create());
     }

diff --git a/tests/BaseCase.php b/tests/BaseCase.php
@@ -3,6 +3,7 @@
 namespace Pfilsx\DataGrid\tests;
 
 use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
+use Doctrine\Common\Persistence\ObjectManager;
 use Doctrine\ORM\AbstractQuery;
 use Doctrine\ORM\QueryBuilder;
 use Pfilsx\DataGrid\Grid\Columns\AbstractColumn;
@@ -101,6 +102,30 @@ private function createDoctrineMock()
                     ->willReturn($self->createQueryBuilderMock());
                 return $mock;
             }));
+        $mock->expects($this->any())
+            ->method('getManager')
+            ->will($this->returnCallback(function ($param) use ($self) {
+                $mock = $self->createMock(ObjectManager::class);
+                $mock->expects($this->any())
+                    ->method('getClassMetadata')
+                    ->willReturn(new class
+                    {
+                        public function getIdentifier()
+                        {
+                            return ['id'];
+                        }
+                    });
+                $mock->expects($this->any())
+                    ->method('getRepository')
+                    ->will($this->returnCallback(function ($param) use ($self) {
+                        $mock = $self->createMock(ServiceEntityRepository::class);
+                        $mock->expects($this->any())
+                            ->method('createQueryBuilder')
+                            ->willReturn($self->createQueryBuilderMock());
+                        return $mock;
+                    }));
+                return $mock;
+            }));
         return $mock;
     }
 

diff --git a/tests/DataGridBuilderTest.php b/tests/DataGridBuilderTest.php
@@ -4,14 +4,17 @@
 namespace Pfilsx\DataGrid\tests;
 
 
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
 use InvalidArgumentException;
+use Pfilsx\DataGrid\Grid\Columns\AbstractColumn;
 use Pfilsx\DataGrid\Grid\Columns\ActionColumn;
 use Pfilsx\DataGrid\Grid\Columns\BooleanColumn;
 use Pfilsx\DataGrid\Grid\Columns\DataColumn;
 use Pfilsx\DataGrid\Grid\Columns\DateColumn;
 use Pfilsx\DataGrid\Grid\Columns\ImageColumn;
 use Pfilsx\DataGrid\Grid\Columns\SerialColumn;
 use Pfilsx\DataGrid\Grid\DataGridBuilder;
+use Pfilsx\DataGrid\Grid\Providers\DataProvider;
 
 class DataGridBuilderTest extends BaseCase
 {
@@ -31,6 +34,8 @@ protected function setUp(): void
     {
         parent::setUp();
         $this->builder = new DataGridBuilder($this->containerArray);
+        $provider = DataProvider::create($this->createMock(ServiceEntityRepository::class), $this->containerArray['doctrine']);
+        $this->builder->setProvider($provider);
     }
 
     public function testWrongColumnClass(): void
@@ -63,10 +68,14 @@ public function testAddColumn()
         $this->assertInstanceOf(ImageColumn::class, $this->builder->getColumns()[3]);
 
         $this->builder->addColumn(self::DATE_COLUMN, [
-            'attribute' => 'creationDate'
+            'attribute' => 'creationDate',
+            'filter' => [
+                'class' => 'Pfilsx\DataGrid\Grid\Filters\DateFilter'
+            ]
         ]);
         $this->assertCount(5, $this->builder->getColumns());
         $this->assertInstanceOf(DateColumn::class, $this->builder->getColumns()[4]);
+        $this->assertTrue($this->builder->hasFilters());
 
         $this->builder->addColumn(self::ACTION_COLUMN, [
             'pathPrefix' => 'category_'
@@ -90,10 +99,58 @@ public function testSetTemplate($builder): void
     public function testSetPagination(): void
     {
         $this->builder->enablePagination(['limit' => 10]);
-        $this->assertTrue($this->builder->getOptions()['pagination']);
-        $this->assertEquals(10, $this->builder->getOptions()['paginationOptions']['limit']);
+        $this->assertTrue($this->builder->hasPagination());
+        $this->assertEquals(10, $this->builder->getPager()->getLimit());
 
         $this->builder->enablePagination(false);
-        $this->assertFalse($this->builder->getOptions()['pagination']);
+        $this->assertFalse($this->builder->hasPagination());
+    }
+
+    /**
+     * @depends testAddColumn
+     * @param DataGridBuilder $builder
+     */
+    public function testSetSort($builder): void
+    {
+        $builder->setSort('creationDate', 'DESC');
+        foreach ($builder->getColumns() as $column) {
+            /**
+             * @var $column AbstractColumn
+             */
+            if ($column->hasSort()) {
+                if ($column->getAttribute() == 'creationDate') {
+                    $this->assertEquals('DESC', $column->getSort());
+                } else {
+                    $this->assertTrue($column->getSort());
+                }
+            } else {
+                $this->assertFalse($column->getSort());
+            }
+        }
+    }
+
+    public function testSetCountFieldName(): void
+    {
+        $this->builder->setCountFieldName('id');
+        $this->assertEquals('id', $this->builder->getProvider()->getCountFieldName());
+    }
+
+    /**
+     * @depends testAddColumn
+     * @param DataGridBuilder $builder
+     */
+    public function testSetFiltersValues($builder): void
+    {
+        $builder->setFiltersValues(['creationDate' => '01.01.1990']);
+        foreach ($builder->getColumns() as $column) {
+            /**
+             * @var $column AbstractColumn
+             */
+            if ($column->hasFilter()) {
+                $this->assertEquals('01.01.1990', $column->getFilterValue());
+            } else {
+                $this->assertNull($column->getFilterValue());
+            }
+        }
     }
 }
diff --git a/tests/DataGridFiltersBuilderTest.php b/tests/DataGridFiltersBuilderTest.php
@@ -3,9 +3,11 @@
 
 namespace Pfilsx\DataGrid\tests;
 
+use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
 use Doctrine\Common\Collections\Criteria;
 use Doctrine\Common\Collections\Expr\Expression;
 use Pfilsx\DataGrid\Grid\DataGridFiltersBuilder;
+use Pfilsx\DataGrid\Grid\Providers\DataProvider;
 
 class DataGridFiltersBuilderTest extends BaseCase
 {
@@ -17,86 +19,88 @@ class DataGridFiltersBuilderTest extends BaseCase
     protected function setUp(): void
     {
         parent::setUp();
-        $this->builder = new DataGridFiltersBuilder($this->containerArray);
+        $this->builder = new DataGridFiltersBuilder();
+        $provider = DataProvider::create($this->createMock(ServiceEntityRepository::class), $this->containerArray['doctrine']);
+        $this->builder->setProvider($provider);
     }
 
     public function testAddEqualFilterOnEmptyData(): void
     {
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
         $this->builder->addEqualFilter('id');
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
     }
 
     public function testAddEqualFilter(): void
     {
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
         $this->builder->setParams(['id' => '1']);
         $this->builder->addEqualFilter('id');
-        $this->assertInstanceOf(Expression::class, $this->builder->getCriteria()->getWhereExpression());
+        $this->assertInstanceOf(Expression::class, $this->builder->getProvider()->getCriteria()->getWhereExpression());
     }
 
     public function testAddEqualFilterNull(): void
     {
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
         $this->builder->setParams(['id' => null]);
         $this->builder->addEqualFilter('id');
-        $this->assertInstanceOf(Expression::class, $this->builder->getCriteria()->getWhereExpression());
+        $this->assertInstanceOf(Expression::class, $this->builder->getProvider()->getCriteria()->getWhereExpression());
     }
 
     public function testAddLikeFilterOnEmptyData(): void
     {
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
         $this->builder->addLikeFilter('id');
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
     }
 
     public function testAddLikeFilter(): void
     {
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
         $this->builder->setParams(['id' => '1']);
         $this->builder->addLikeFilter('id');
-        $this->assertInstanceOf(Expression::class, $this->builder->getCriteria()->getWhereExpression());
+        $this->assertInstanceOf(Expression::class, $this->builder->getProvider()->getCriteria()->getWhereExpression());
     }
 
     public function testAddRelationFilterOnEmptyData(): void
     {
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
         $this->builder->addRelationFilter('fid', 'App\Entity\TestEntity');
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
     }
 
     public function testAddRelationFilter(): void
     {
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
         $this->builder->setParams(['fid' => '1']);
         $this->builder->addRelationFilter('fid', 'App\Entity\TestEntity');
-        $this->assertInstanceOf(Expression::class, $this->builder->getCriteria()->getWhereExpression());
+        $this->assertInstanceOf(Expression::class, $this->builder->getProvider()->getCriteria()->getWhereExpression());
     }
 
     public function testAddCustomFilterOnEmptyData(): void
     {
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
         $this->builder->addCustomFilter('id', function ($criteria, $attr, $value) {
             $criteria->andWhere(Criteria::expr()->eq($attr, $value));
         });
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
     }
 
     public function testAddCustomFilter(): void
     {
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
         $this->builder->setParams(['id' => '1']);
         $this->builder->addCustomFilter('id', function ($criteria, $attr, $value) {
             $criteria->andWhere(Criteria::expr()->eq($attr, $value));
         });
-        $this->assertInstanceOf(Expression::class, $this->builder->getCriteria()->getWhereExpression());
+        $this->assertInstanceOf(Expression::class, $this->builder->getProvider()->getCriteria()->getWhereExpression());
     }
 
     public function testAddDateFilterOnEmptyData(): void
     {
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
         $this->builder->addDateFilter('id');
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
     }
 
     /**
@@ -105,10 +109,10 @@ public function testAddDateFilterOnEmptyData(): void
      */
     public function testAddDateFilter($comparison): void
     {
-        $this->assertNull($this->builder->getCriteria()->getWhereExpression());
+        $this->assertNull($this->builder->getProvider()->getCriteria()->getWhereExpression());
         $this->builder->setParams(['date' => '01-01-1990']);
         $this->builder->addDateFilter('date', $comparison);
-        $this->assertInstanceOf(Expression::class, $this->builder->getCriteria()->getWhereExpression());
+        $this->assertInstanceOf(Expression::class, $this->builder->getProvider()->getCriteria()->getWhereExpression());
     }