Version 0.16 (#55)

.github/workflows/testing.yml

@@ -0,0 +1,20 @@
+name: Testing
+
+on: [push]
+
+jobs:
+  build-test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: php-actions/composer@v6
+      with:
+        php_extensions: dom fileinfo filter libxml xmlreader zip gd
+    - uses: php-actions/phpstan@v3
+    - uses: php-actions/phpunit@v3
+      with:
+        php_extensions: xdebug dom fileinfo filter libxml xmlreader zip gd
+        args: --coverage-text
+      env:
+        XDEBUG_MODE: coverage

.gitignore

@@ -2,6 +2,7 @@
 /venv
 /composer.lock
 /.php-cs-fixer.cache
+/.phpunit.cache
 /.phpunit.result.cache
 /.idea
 /.vscode

CHANGELOG.md

@@ -1,3 +1,14 @@
+# 0.16
+
+- **[Feature]** French translation (https://github.com/Kreyu/data-table-bundle/pull/53)
+- **[Feature]** Doctrine ORM expression transformers with built-in `lower`, `upper` and `trim` options (https://github.com/Kreyu/data-table-bundle/issues/50)
+- **[Feature]** Filter handler events
+- **[Docs]** New documentation, written using [VitePress](https://vitepress.dev/)
+
+# 0.15
+
+- **[Feature]** Integration with AssetMapper (https://github.com/Kreyu/data-table-bundle/issues/42)
+
 # 0.14
 
 - **[Feature]** Data table events
@@ -22,7 +33,7 @@
 Internally, the columns, filters and exporters are now utilizing the builder pattern similar to data tables.
 Please note that this is a **breaking change** for applications using internal bundle classes!
 
-For a list of all breaking changes and deprecations, see the [upgrade guide](docs/upgrade-guide/0.14.md).
+For a list of all breaking changes and deprecations, see the [upgrade guide](../../../docs/upgrade-guide/0.14.md).
 
 # 0.13
 

composer.json

@@ -31,11 +31,19 @@
         "phpoffice/phpspreadsheet": "^1.28",
         "doctrine/orm": "^2.15",
         "doctrine/doctrine-bundle": "^2.9",
-        "phpstan/phpstan": "^1.10"
+        "phpstan/phpstan": "^1.10",
+        "phpunit/phpunit": "^10.4",
+        "dg/bypass-finals": "dev-master",
+        "openspout/openspout": "^4.23"
     },
     "autoload": {
         "psr-4": {
             "Kreyu\\Bundle\\DataTableBundle\\": "src"
         }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Kreyu\\Bundle\\DataTableBundle\\Tests\\": "tests"
+        }
     }
 }

docs/.gitignore

@@ -0,0 +1,3 @@
+node_modules/
+.vitepress/cache/
+.vitepress/dist/

docs/.vitepress/config.mts

@@ -0,0 +1,175 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: 'DataTableBundle',
+  description: 'Streamlines creation process of the data tables',
+  srcDir: './src',
+  head: [
+    ['link', { rel: 'icon', type: 'image/png', href: '/logo.png' }],
+  ],
+  themeConfig: {
+    logo: '/logo.png',
+    externalLinkIcon: true,
+    outline: 'deep',
+
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Documentation', link: '/docs/introduction', activeMatch: '/docs/' },
+      { text: 'Reference', link: '/reference/types/data-table', activeMatch: '/reference/' },
+    ],
+
+    sidebar: {
+      '/docs/': [
+        {
+          text: 'Getting started',
+          items: [
+            { text: 'Introduction', link: '/docs/introduction' },
+            { text: 'Installation', link: '/docs/installation' },
+          ]
+        },
+        {
+          text: 'Components',
+          items: [
+            { text: 'Columns', link: '/docs/components/columns' },
+            { text: 'Filters', link: '/docs/components/filters' },
+            { text: 'Actions', link: '/docs/components/actions' },
+            { text: 'Exporters', link: '/docs/components/exporters' },
+          ]
+        },
+        {
+          text: 'Features',
+          items: [
+            { text: 'Sorting', link: '/docs/features/sorting' },
+            { text: 'Filtering', link: '/docs/features/filtering' },
+            { text: 'Exporting', link: '/docs/features/exporting' },
+            { text: 'Pagination', link: '/docs/features/pagination' },
+            { text: 'Personalization', link: '/docs/features/personalization' },
+            { text: 'Persistence', link: '/docs/features/persistence' },
+            { text: 'Theming', link: '/docs/features/theming' },
+            { text: 'Asynchronicity', link: '/docs/features/asynchronicity' },
+            { text: 'Extensibility', link: '/docs/features/extensibility' },
+          ]
+        },
+        {
+          text: 'Integrations',
+          items: [
+            {
+              text: 'Doctrine ORM',
+              collapsed: true,
+              items: [
+                { text: 'Expression transformers', link: '/docs/integrations/doctrine-orm/expression-transformers' },
+                { text: 'Events', link: '/docs/integrations/doctrine-orm/events' }
+              ],
+            },
+          ]
+        },
+        { text: 'Troubleshooting', link: '/docs/troubleshooting' },
+        { text: 'Contributing', link: '/docs/contributing' },
+      ],
+      '/reference/': [
+        {
+          text: 'Types',
+          items: [
+            {
+              text: 'DataTable',
+              link: '/reference/types/data-table'
+            },
+            {
+              text: 'Column',
+              link: '/reference/types/column',
+              collapsed: true,
+              items: [
+                { text: 'Text', link: '/reference/types/column/text' },
+                { text: 'Number', link: '/reference/types/column/number' },
+                { text: 'Money', link: '/reference/types/column/money' },
+                { text: 'Boolean', link: '/reference/types/column/boolean' },
+                { text: 'Link', link: '/reference/types/column/link' },
+                { text: 'Date', link: '/reference/types/column/date' },
+                { text: 'DateTime', link: '/reference/types/column/date-time' },
+                { text: 'DatePeriod', link: '/reference/types/column/date-period' },
+                { text: 'Collection', link: '/reference/types/column/collection' },
+                { text: 'Template', link: '/reference/types/column/template' },
+                { text: 'Actions', link: '/reference/types/column/actions' },
+                { text: 'Checkbox', link: '/reference/types/column/checkbox' },
+                { text: 'Column', link: '/reference/types/column/column' },
+              ]
+            },
+            {
+              text: 'Filter',
+              link: '/reference/types/filter',
+              collapsed: true,
+              items: [
+                {
+                  text: 'Doctrine ORM',
+                  collapsed: false,
+                  items: [
+                    { text: 'String', link: '/reference/types/filter/doctrine-orm/string' },
+                    { text: 'Numeric', link: '/reference/types/filter/doctrine-orm/numeric' },
+                    { text: 'Boolean', link: '/reference/types/filter/doctrine-orm/boolean' },
+                    { text: 'Date', link: '/reference/types/filter/doctrine-orm/date' },
+                    { text: 'DateTime', link: '/reference/types/filter/doctrine-orm/date-time' },
+                    { text: 'DateRange', link: '/reference/types/filter/doctrine-orm/date-range' },
+                    { text: 'Entity', link: '/reference/types/filter/doctrine-orm/entity' },
+                    { text: 'DoctrineOrm', link: '/reference/types/filter/doctrine-orm/doctrine-orm' },
+                  ],
+                },
+                { text: 'Callback', link: '/reference/types/filter/callback' },
+                { text: 'Search', link: '/reference/types/filter/search' },
+                { text: 'Filter', link: '/reference/types/filter/filter' },
+              ],
+            },
+            {
+              text: 'Action',
+              link: '/reference/types/action',
+              collapsed: true,
+              items: [
+                { text: 'Link', link: '/reference/types/action/link' },
+                { text: 'Button', link: '/reference/types/action/button' },
+                { text: 'Form', link: '/reference/types/action/form' },
+                { text: 'Action', link: '/reference/types/action/action' },
+              ],
+            },
+            {
+              text: 'Exporter',
+              link: '/reference/types/exporter',
+              collapsed: true,
+              items: [
+                {
+                  text: 'PhpSpreadsheet',
+                  collapsed: false,
+                  items: [
+                    { text: 'Csv', link: '/reference/types/exporter/php-spreadsheet/csv' },
+                    { text: 'Xls', link: '/reference/types/exporter/php-spreadsheet/xls' },
+                    { text: 'Xlsx', link: '/reference/types/exporter/php-spreadsheet/xlsx' },
+                    { text: 'Ods', link: '/reference/types/exporter/php-spreadsheet/ods' },
+                    { text: 'Pdf', link: '/reference/types/exporter/php-spreadsheet/pdf' },
+                    { text: 'Html', link: '/reference/types/exporter/php-spreadsheet/html' },
+                  ],
+                },
+                {
+                  text: 'OpenSpout',
+                  collapsed: false,
+                  items: [
+                    { text: 'Csv', link: '/reference/types/exporter/open-spout/csv' },
+                    { text: 'Xlsx', link: '/reference/types/exporter/open-spout/xlsx' },
+                    { text: 'Ods', link: '/reference/types/exporter/open-spout/ods' },
+                  ],
+                },
+                { text: 'Callback', link: '/reference/types/exporter/callback' },
+                { text: 'Exporter', link: '/reference/types/exporter/exporter' },
+              ],
+            },
+          ]
+        },
+        { text: 'Configuration', link: '/reference/configuration' },
+        { text: 'Twig', link: '/reference/twig' },
+      ],
+    },
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/kreyu/data-table-bundle' }
+    ]
+  }
+})

docs/.vitepress/theme/index.js

@@ -0,0 +1,4 @@
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+
+export default DefaultTheme

docs/.vitepress/theme/style.css

@@ -0,0 +1,30 @@
+.VPContent.is-home {
+    display: flex;
+    align-items: center;
+    justify-content: center;
+}
+
+:root {
+    --vp-button-brand-bg: #7986CB;
+    --vp-button-brand-hover-bg: #9FA8DA;
+
+    --vp-c-brand-1: #7986CB;
+    --vp-c-brand-2: #9FA8DA;
+
+    --vp-home-hero-name-color: transparent;
+    --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #32bffc 10%, #7986CB);
+
+    --vp-home-hero-image-background-image: -webkit-linear-gradient(120deg, rgba(68, 113, 210, 1), 30%, rgba(50, 191, 252, 1));
+}
+
+@media (min-width: 640px) {
+    :root {
+        --vp-home-hero-image-filter: blur(56px);
+    }
+}
+
+@media (min-width: 960px) {
+    :root {
+        --vp-home-hero-image-filter: blur(65px);
+    }
+}

docs/README.md

@@ -0,0 +1,7 @@
+# Documentation
+
+To start the development server, run following commands:
+
+```shell
+npm install && npm run docs:dev
+```