added tests

Author: janatjak

.gitattributes

@@ -0,0 +1 @@
+/tests export-ignore

.gitignore

@@ -1,3 +1,4 @@
 /.idea
+/var
 /vendor
 /composer.lock

.travis.yml

@@ -6,10 +6,13 @@ cache:
 
 php:
     - 7.1
+    - 7.2
+    - 7.3
 
 install:
     - composer install --no-interaction --prefer-dist
 
 script:
-    - php vendor/bin/phpstan analyse ./src --level 7
-    - php vendor/bin/phpcs --standard=PSR12 --ignore=./src/Resources ./src
+    - php vendor/bin/phpstan analyse ./src ./tests --level 7
+    - php vendor/bin/phpcs --standard=PSR12 --ignore=./src/Resources ./src ./tests
+    - php vendor/bin/phpunit

README.md

@@ -0,0 +1,22 @@
+FreezyBee/DataGridBundle
+========================
+
+[![Build Status](https://travis-ci.org/FreezyBee/DataGridBundle.svg?branch=master)](https://travis-ci.org/FreezyBee/DataGridBundle)
+[![Coverage Status](https://coveralls.io/repos/github/FreezyBee/DataGridBundle/badge.svg?branch=master)](https://coveralls.io/github/FreezyBee/DataGridBundle)
+
+
+Requirements
+------------
+
+FreezyBee/DataGridBundle requires PHP 7.1 or higher
+
+- [DataTables](https://datatables.net)
+- [flatpickr](https://flatpickr.js.org)
+
+
+Installation
+------------
+
+```sh
+composer require freezy-bee/datagrid-bundle
+```

composer.json

@@ -14,21 +14,33 @@
       "FreezyBee\\DataGridBundle\\": "src"
     }
   },
+  "autoload-dev": {
+    "psr-4": {
+      "FreezyBee\\DataGridBundle\\Tests\\": "tests"
+    }
+  },
   "require": {
     "php": "^7.1",
+    "ext-json": "*",
     "doctrine/orm": "^2.6",
     "symfony/config": "^4.0",
     "symfony/dependency-injection": "^4.0",
-    "symfony/http-kernel": "^4.0",
     "symfony/property-access": "^4.0",
     "symfony/templating": "^4.0",
+    "symfony/yaml": "^4.0",
     "twig/twig": "^2.0"
   },
   "config": {
     "sort-packages": true
   },
   "require-dev": {
+    "doctrine/doctrine-bundle": "^1.10",
     "phpstan/phpstan-shim": "^0.11",
-    "squizlabs/php_codesniffer": "^3.4"
+    "phpunit/phpunit": "^7.5",
+    "squizlabs/php_codesniffer": "^3.4",
+    "symfony/framework-bundle": "^4.2",
+    "symfony/panther": "^0.2",
+    "symfony/phpunit-bridge": "^4.2",
+    "symfony/twig-bundle": "^4.2"
   }
 }

phpunit.xml

@@ -0,0 +1,15 @@
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/|version|/phpunit.xsd"
+        bootstrap="./tests/bootstrap.php"
+    >
+    <php>
+        <env name="KERNEL_CLASS" value="FreezyBee\DataGridBundle\Tests\App\Kernel"/>
+    </php>
+
+    <testsuites>
+        <testsuite name="My Test Suite">
+            <directory>./tests/*</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

src/Column/ActionColumn.php

@@ -37,4 +37,12 @@ public function getActions(): array
     {
         return $this->actions;
     }
+
+    /**
+     * @return bool
+     */
+    public function hasActions(): bool
+    {
+        return count($this->actions) > 0;
+    }
 }

src/Controller/DataGridController.php

@@ -7,7 +7,6 @@
 use FreezyBee\DataGridBundle\DataGridFactory;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\Routing\Annotation\Route;
 
 /**
  * @author Jakub Janata <[email protected]>
@@ -26,7 +25,6 @@ public function __construct(DataGridFactory $dataGridFactory)
     }
 
     /**
-     * @Route("/api/grid/{name}", name="datagrid_ajax")
      * @param string $name
      * @param Request $request
      * @return JsonResponse

src/DataGrid.php

@@ -5,7 +5,6 @@
 namespace FreezyBee\DataGridBundle;
 
 use FreezyBee\DataGridBundle\Column\ActionColumn;
-use FreezyBee\DataGridBundle\Column\Column;
 use FreezyBee\DataGridBundle\DataSource\DataSourceInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
@@ -22,33 +21,27 @@ class DataGrid
     /** @var DataSourceInterface */
     private $dataSource;
 
-    /** @var Column[] */
-    private $columns;
-
-    /** @var ActionColumn|null */
-    private $actionColumn;
+    /** @var DataGridConfig */
+    private $config;
 
     /** @var string */
     private $name;
 
     /**
      * @param EngineInterface $engine
      * @param DataSourceInterface $dataSource
-     * @param array $columns
-     * @param ActionColumn|null $actionColumn
+     * @param DataGridConfig $config
      * @param string $name
      */
     public function __construct(
         EngineInterface $engine,
         DataSourceInterface $dataSource,
-        array $columns,
-        ?ActionColumn $actionColumn,
+        DataGridConfig $config,
         string $name
     ) {
         $this->engine = $engine;
         $this->dataSource = $dataSource;
-        $this->columns = $columns;
-        $this->actionColumn = $actionColumn;
+        $this->config = $config;
         $this->name = $name;
     }
 
@@ -65,13 +58,13 @@ public function ajax(Request $request): JsonResponse
         // sort
         $orderByIndex = $query['order'][0]['column'] ?? null;
         if ($orderByIndex !== null) {
-            $this->dataSource->applySort($this->columns[$orderByIndex], $query['order'][0]['dir']);
+            $this->dataSource->applySort($this->config->getColumns()[$orderByIndex], $query['order'][0]['dir']);
         }
 
         // filters
         foreach ($query['columns'] as $index => $ajaxColumn) {
             $value = $ajaxColumn['search']['value'];
-            $column = $this->columns[$index] ?? null;
+            $column = $this->config->getColumns()[$index] ?? null;
 
             if ($value !== '' && $column !== null && $column->isFilterable()) {
                 $this->dataSource->applyFilter($column, $value);
@@ -88,17 +81,17 @@ public function ajax(Request $request): JsonResponse
         $data = [];
         foreach ($items as $item) {
             $row = [];
-            foreach ($this->columns as $column) {
+            foreach ($this->config->getColumns() as $column) {
                 if ($column instanceof ActionColumn) {
                     continue;
                 }
                 $row[] = $column->renderContent($item, $this->engine);
             }
 
-            if ($this->actionColumn !== null) {
+            if ($this->config->getActionColumn()->hasActions()) {
                 $row[] = $this->engine->render('@FreezyBeeDataGrid/action.html.twig', [
                     'item' => $item,
-                    'actions' => $this->actionColumn->getActions()
+                    'actions' => $this->config->getActionColumn()->getActions()
                 ]);
             }
             $data[] = $row;
@@ -117,10 +110,20 @@ public function ajax(Request $request): JsonResponse
      */
     public function render(): string
     {
+        $sortIndex = 0;
+        if ($this->config->getDefaultSortColumnName() !== null) {
+            $sortIndex = array_search($this->config->getDefaultSortColumnName(), $this->config->getColumns(), true);
+        }
+
         return $this->engine->render('@FreezyBeeDataGrid/grid.html.twig', [
             'name' => $this->name,
-            'columns' => $this->columns,
-            'actionColumn' => $this->actionColumn
+            'columns' => $this->config->getColumns(),
+            'actionColumn' => $this->config->getActionColumn(),
+            'default' => [
+                'perPage' => $this->config->getDefaultPerPage(), $this->config->getColumns(),
+                'sortIndex' => $sortIndex,
+                'sortDir' => $this->config->getDefaultSortColumnDirection() ?? 'desc',
+            ]
         ]);
     }
 }

src/DataGridBuilder.php

@@ -26,6 +26,15 @@ class DataGridBuilder
     /** @var ActionColumn */
     private $actionColumn;
 
+    /** @var string|null */
+    private $defaultSortColumnName;
+
+    /** @var string|null */
+    private $defaultSortColumnDirection;
+
+    /** @var int */
+    private $defaultPerPage = 10;
+
     /**
      */
     public function __construct()
@@ -43,13 +52,6 @@ public function setDataSource($dataSource): self
         return $this;
     }
 
-    /**
-     * @return array|QueryBuilder|null
-     */
-    public function getDataSource()
-    {
-        return $this->dataSource;
-    }
 
     /**
      * @param string $name
@@ -97,27 +99,50 @@ public function addAction(string $route, string $label, array $params = []): Act
     }
 
     /**
+     * @param string $name
      * @param Column $column
      * @return Column
      */
-    public function add(Column $column): Column
+    public function add(string $name, Column $column): Column
     {
         return $this->columns[] = $column;
     }
 
     /**
-     * @return Column[]
+     * @param string $name
+     * @param string $direction
+     * @return DataGridBuilder
+     */
+    public function setDefaultSort(string $name, string $direction): self
+    {
+        $this->defaultSortColumnName = $name;
+        $this->defaultSortColumnDirection = $direction;
+        return $this;
+    }
+
+    /**
+     * @param int $defaultPerPage
+     * @return DataGridBuilder
      */
-    public function getColumns(): array
+    public function setDefaultPerPage(int $defaultPerPage): self
     {
-        return $this->columns;
+        $this->defaultPerPage = $defaultPerPage;
+        return $this;
     }
 
     /**
-     * @return ActionColumn
+     * @internal
+     * @return DataGridConfig
      */
-    public function getActionColumn(): ActionColumn
+    public function generateConfig(): DataGridConfig
     {
-        return $this->actionColumn;
+        return new DataGridConfig(
+            $this->dataSource,
+            $this->columns,
+            $this->actionColumn,
+            $this->defaultSortColumnName,
+            $this->defaultSortColumnDirection,
+            $this->defaultPerPage
+        );
     }
 }