Update for Atk 4.0

.github/release-drafter.yml

@@ -10,4 +10,4 @@ categories:
       - "Documentation :books:"
 template: |
   ## What’s Changed
-  $CHANGES
+  $CHANGES

.github/workflows/build-docs.yml

@@ -13,4 +13,3 @@ jobs:
         uses: release-drafter/release-drafter@v5
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-

.github/workflows/build-release.yml

@@ -53,4 +53,4 @@ jobs:
         with:
           branch: ${{ github.ref }}.gen
           force: true
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+          github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test-unit.yml

@@ -24,7 +24,7 @@ jobs:
             type: 'StaticAnalysis'
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Configure PHP
         run: |
@@ -62,6 +62,8 @@ jobs:
         run: |
           if [ "$(find demos/ -name '*.php' -print0 | xargs -0 grep -L "namespace Atk4\\\\Outbox\\\\Demos[;\\\\]" | tee /dev/fd/2)" ]; then echo 'All demos/ files must have namespace declared' && (exit 1); fi
           vendor/bin/php-cs-fixer fix --dry-run --using-cache=no --diff --verbose
+          composer config --unset version && composer config --unset require-release
+          composer validate --strict --no-check-lock && composer normalize --dry-run --no-check-lock
 
       - name: Run Static Analysis (only for StaticAnalysis)
         if: matrix.type == 'StaticAnalysis'
@@ -77,7 +79,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['7.4', '8.0', '8.1']
+        php: ['7.4', '8.0', '8.1', '8.2']
         type: ['Phpunit', 'Phpunit Lowest']
         include:
           - php: '8.1' # TODO replace with 'latest' once it represents at least PHP 8.1
@@ -104,13 +106,12 @@ jobs:
           ACCEPT_EULA: Y
           SA_PASSWORD: atk4_pass
       oracle:
-        image: gvenzl/oracle-xe:18
+        image: gvenzl/oracle-xe:18-slim-faststart
         env:
           ORACLE_PASSWORD: atk4_pass
-        options: --health-cmd healthcheck.sh --health-interval=10s --health-timeout=5s --health-retries=10
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Configure PHP
         run: |
@@ -145,7 +146,8 @@ jobs:
           php -r '(new PDO("mysql:host=mysql", "root", "atk4_pass_root"))->exec("ALTER USER '"'"'atk4_test_user'"'"'@'"'"'%'"'"' WITH MAX_USER_CONNECTIONS 5");'
           php -r '(new PDO("mysql:host=mariadb", "root", "atk4_pass_root"))->exec("ALTER USER '"'"'atk4_test_user'"'"'@'"'"'%'"'"' WITH MAX_USER_CONNECTIONS 5");'
           php -r '(new PDO("pgsql:host=postgres;dbname=atk4_test", "atk4_test_user", "atk4_pass"))->exec("ALTER ROLE atk4_test_user CONNECTION LIMIT 1");'
-          if [ -n "$LOG_COVERAGE" ]; then mkdir coverage && cp tools/CoverageUtil.php demos; fi
+          /usr/lib/oracle/setup.sh
+          if [ -n "$LOG_COVERAGE" ]; then mkdir coverage; fi
 
       - name: "Run tests: SQLite"
         run: |
@@ -154,6 +156,7 @@ jobs:
           if [ -n "$LOG_COVERAGE" ]; then mv coverage/phpunit.cov coverage/phpunit-sqlite.cov; fi
 
       - name: "Run tests: MySQL"
+        if: success() || failure()
         env:
           DB_DSN: "mysql:host=mysql;dbname=atk4_test"
           DB_USER: atk4_test_user
@@ -164,7 +167,8 @@ jobs:
           php -d opcache.enable_cli=1 vendor/bin/phpunit --exclude-group none $(if [ -n "$LOG_COVERAGE" ]; then echo --coverage-text; else echo --no-coverage; fi) -v
           if [ -n "$LOG_COVERAGE" ]; then mv coverage/phpunit.cov coverage/phpunit-mysql.cov; fi
 
-      - name: "Run tests: MariaDB"
+      - name: "Run tests: MariaDB (only for cron)"
+        if: (success() || failure()) && github.event_name == 'schedule'
         env:
           DB_DSN: "mysql:host=mariadb;dbname=atk4_test"
           DB_USER: atk4_test_user
@@ -175,7 +179,8 @@ jobs:
           php -d opcache.enable_cli=1 vendor/bin/phpunit --exclude-group none $(if [ -n "$LOG_COVERAGE" ]; then echo --coverage-text; else echo --no-coverage; fi) -v
           if [ -n "$LOG_COVERAGE" ]; then mv coverage/phpunit.cov coverage/phpunit-mariadb.cov; fi
 
-      - name: "Run tests: PostgreSQL"
+      - name: "Run tests: PostgreSQL (only for cron)"
+        if: (success() || failure()) && github.event_name == 'schedule'
         env:
           DB_DSN: "pgsql:host=postgres;dbname=atk4_test"
           DB_USER: atk4_test_user
@@ -186,9 +191,10 @@ jobs:
           php -d opcache.enable_cli=1 vendor/bin/phpunit --exclude-group none $(if [ -n "$LOG_COVERAGE" ]; then echo --coverage-text; else echo --no-coverage; fi) -v
           if [ -n "$LOG_COVERAGE" ]; then mv coverage/phpunit.cov coverage/phpunit-postgres.cov; fi
 
-      - name: "Run tests: MSSQL"
+      - name: "Run tests: MSSQL (only for cron)"
+        if: (success() || failure()) && github.event_name == 'schedule'
         env:
-          DB_DSN: "sqlsrv:host=mssql;dbname=master"
+          DB_DSN: "sqlsrv:host=mssql;dbname=master;driverOptions[TrustServerCertificate]=1"
           DB_USER: sa
           DB_PASSWORD: atk4_pass
         run: |
@@ -197,7 +203,8 @@ jobs:
           php -d opcache.enable_cli=1 vendor/bin/phpunit --exclude-group none $(if [ -n "$LOG_COVERAGE" ]; then echo --coverage-text; else echo --no-coverage; fi) -v
           if [ -n "$LOG_COVERAGE" ]; then mv coverage/phpunit.cov coverage/phpunit-mssql.cov; fi
 
-      - name: "Run tests: Oracle"
+      - name: "Run tests: Oracle (only for cron)"
+        if: (success() || failure()) && github.event_name == 'schedule'
         env:
           DB_DSN: "oci:dbname=oracle/xe"
           DB_USER: system

.gitignore

@@ -7,3 +7,4 @@
 /demos/db.php
 /demos/_demo-data/db.sqlite
 /demos/_demo-data/db.sqlite-journal
+/demos/_db.php

.php-cs-fixer.dist.php

@@ -2,17 +2,15 @@
 
 $finder = PhpCsFixer\Finder::create()
     ->in([__DIR__])
-    ->exclude([
-        'vendor',
-    ]);
+    ->exclude(['vendor']);
 
-$config = new \PhpCsFixer\Config();
-$config->setRiskyAllowed(true)
+return (new PhpCsFixer\Config())
+    ->setRiskyAllowed(true)
     ->setRules([
         '@PhpCsFixer' => true,
-        '@PhpCsFixer:risky' =>true,
-        '@PHP71Migration:risky' => true,
-        '@PHP73Migration' => true,
+        '@PhpCsFixer:risky' => true,
+        '@PHP74Migration:risky' => true,
+        '@PHP74Migration' => true,
 
         // required by PSR-12
         'concat_space' => [
@@ -23,7 +21,7 @@
         'phpdoc_types' => [
             // keep enabled, but without "alias" group to not fix
             // "Callback" to "callback" in phpdoc
-            'groups' => ['simple', 'meta']
+            'groups' => ['simple', 'meta'],
         ],
         'phpdoc_types_order' => [
             'null_adjustment' => 'always_last',
@@ -34,10 +32,8 @@
             'equal' => false,
             'identical' => false,
         ],
+        'native_constant_invocation' => true,
         'native_function_invocation' => false,
-        'non_printable_character' => [
-            'use_escape_sequences_in_strings' => true,
-        ],
         'void_return' => false,
         'blank_line_before_statement' => [
             'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'exit'],
@@ -48,22 +44,20 @@
         'no_superfluous_elseif' => false,
         'ordered_class_elements' => false,
         'php_unit_internal_class' => false,
-        'php_unit_test_case_static_method_calls' => [
-            'call_type' => 'this',
-        ],
         'php_unit_test_class_requires_covers' => false,
         'phpdoc_add_missing_param_annotation' => false,
         'return_assignment' => false,
         'comment_to_phpdoc' => false,
-        'list_syntax' => ['syntax' => 'short'],
         'general_phpdoc_annotation_remove' => [
             'annotations' => ['author', 'copyright', 'throws'],
         ],
         'nullable_type_declaration_for_default_null_value' => [
             'use_nullable_type_declaration' => false,
         ],
+
+        // fn => without curly brackets is less readable,
+        // also prevent bounding of unwanted variables for GC
+        'use_arrow_functions' => false,
     ])
     ->setFinder($finder)
-    ->setCacheFile(__DIR__ . '/.php_cs.cache');
-
-return $config;
+    ->setCacheFile(sys_get_temp_dir() . '/php-cs-fixer.' . md5(__DIR__) . '.cache');

composer.json

@@ -14,15 +14,15 @@
         }
     ],
     "require": {
-        "php": ">=7.4 <8.2",
-        "atk4/data": "dev-develop",
-        "atk4/ui": "dev-develop",
+        "php": "< 8.3 >=7.4",
+        "atk4/data": "~4.0.0",
+        "atk4/ui": "~4.0.0",
         "phpmailer/phpmailer": "^v6.5.3"
     },
     "require-release": {
-        "php": ">=7.4 <8.2",
-        "atk4/data": "~3.2.0",
-        "atk4/ui": "~3.2.0",
+        "php": ">=7.4 < 8.3",
+        "atk4/data": "~4.0.0",
+        "atk4/ui": "~4.0.0",
         "phpmailer/phpmailer": "^v6.5.3"
     },
     "require-dev": {
@@ -48,6 +48,10 @@
         }
     },
     "config": {
+        "allow-plugins": {
+            "ergebnis/composer-normalize": true,
+            "phpstan/extension-installer": true
+        },
         "sort-packages": true
     }
 }

demos/_demo-data/create-db.php

@@ -17,9 +17,10 @@
 if (!file_exists($sqliteFile)) {
     new Persistence\Sql('sqlite:' . $sqliteFile);
 }
+
 unset($sqliteFile);
 
-/** @var Persistence\Sql $db */
+/** @var Persistence|Persistence\Sql $db */
 require_once __DIR__ . '/../init-db.php';
 
 echo 'GITHUB_JOB : ' . getenv('GITHUB_JOB') . "\n\n";

demos/_includes/App.php

@@ -4,71 +4,7 @@
 
 namespace Atk4\Outbox\Demos;
 
-use Atk4\Outbox\Model\Mail;
-use Atk4\Outbox\Model\MailTemplate;
-use Atk4\Ui\Layout;
-use Atk4\Ui\Loader;
-
-/**
- * Example implementation of your Authenticated application.
- */
 class App extends \Atk4\Ui\App
 {
-    public $title = 'Demo App';
-
-    protected function init(): void
-    {
-        parent::init();
-
-        $this->initLayout([Layout\Admin::class]);
-
-        $loader = Loader::addTo($this);
-        $loader->set(function (Loader $l) {
-            $route = $l->getApp()->stickyGet('route');
-            $route = empty($route) ? 'mail' : $route;
-
-            switch ($route) {
-                case 'mail':
-                    $grid = \Atk4\Ui\Grid::addTo($l);
-
-                    $model = new Mail($this->db);
-                    $model->getField('html')->system = true;
-                    $model->addExpression('time', $model->refLink('response')->action('field', ['timestamp']));
-                    $model->setOrder('id', 'DESC');
-
-                    $grid->setModel($model);
-
-                    break;
-                case 'template':
-                    $crud = \Atk4\Ui\Crud::addTo($l, [
-                        'displayFields' => [
-                            'identifier',
-                            'subject',
-                        ],
-                        'addFields' => [
-                            'identifier',
-                            'subject',
-                            'text',
-                            'html',
-                        ],
-                        'editFields' => [
-                            'identifier',
-                            'subject',
-                            'text',
-                            'html',
-                        ],
-                    ]);
-
-                    $crud->setModel(new MailTemplate($this->db));
-
-                    break;
-            }
-        });
-
-        /** @var Layout\Admin $layout */
-        $layout = $this->layout;
-
-        $layout->menuLeft->addItem(['Mail Tracking', 'icon' => 'envelope'])->on('click', $loader->jsLoad(['route' => 'mail']));
-        $layout->menuLeft->addItem(['Template Admin', 'icon' => 'cogs'])->on('click', $loader->jsLoad(['route' => 'template']));
-    }
+    public $title = 'Outbox Demo App';
 }

demos/db.default.php

@@ -16,5 +16,6 @@
 if (!file_exists($sqliteFile)) {
     throw new \Exception('Sqlite database does not exist, create it first.');
 }
+
 $db = new Persistence\Sql('sqlite:' . $sqliteFile);
 unset($sqliteFile);