Fix UI 5.0.0 compatibility and tests (#111)

* composer changes * use create app trait from ui for tests * demo fixes * actual compatibility fixes * do not ignore phpstan errors * Update build-release.yml * Update test-unit.yml * rollback phpstan ignores * cant get rid of @var nicely, so they stay * create custom test models and add test for them * cleanup magic * set to be compatible with 5.0.0 * Address suggestions * switch back to dev-develop * force 5.0.0 * Update composer.json Co-authored-by: Michael Voříšek <[email protected]> * downgrade phpunit * Update test-unit.yml * Update test-unit.yml * Update test-unit.yml * oh, no filter ? * Update test-unit.yml * switch back to dev-develop --------- Co-authored-by: Michael Voříšek <[email protected]>
atk4 · Mar 25, 2024 · 4432822 · 4432822
1 parent 69f1a8a
commit 4432822
Show file tree

Hide file tree

Showing 23 changed files with 265 additions and 208 deletions.
diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml
@@ -12,7 +12,7 @@ jobs:
     container:
       image: ghcr.io/mvorisek/image-php:latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: ${{ github.ref }}
 

diff --git a/.github/workflows/test-unit.yml b/.github/workflows/test-unit.yml
diff --git a/composer.json b/composer.json
@@ -33,19 +33,19 @@
     },
     "require-release": {
         "php": ">=7.4 <8.4",
-        "atk4/ui": "~5.1.0"
+        "atk4/ui": "~5.0.0"
     },
     "require-dev": {
         "atk4/behat-mink-selenium2-driver": "^1.6.2",
         "behat/mink-extension": "^2.3.1",
         "ergebnis/composer-normalize": "^2.13",
-        "johnkary/phpunit-speedtrap": "^3.3",
+        "ergebnis/phpunit-slow-test-detector": "^2.9",
         "friendsofphp/php-cs-fixer": "^3.0",
         "phpstan/extension-installer": "^1.1",
         "phpstan/phpstan": "^1.0",
         "phpstan/phpstan-deprecation-rules": "^1.0",
         "phpstan/phpstan-strict-rules": "^1.3",
-        "phpunit/phpunit": "^9.5.5 || ^10.0"
+        "phpunit/phpunit": "^9.5.5"
     },
     "conflict": {
         "behat/behat": "<3.9",
@@ -63,7 +63,10 @@
     "autoload-dev": {
         "psr-4": {
             "Atk4\\Login\\Tests\\": "tests/"
-        }
+        },
+        "files": [
+            "vendor/atk4/ui/tests/CreateAppTrait.php"
+        ]
     },
     "config": {
         "allow-plugins": {

diff --git a/demos/_includes/App.php b/demos/_includes/App.php
@@ -16,6 +16,9 @@ class App extends \Atk4\Ui\App
 
     public $title = 'Demo App';
 
+    /** @var Layout\Admin */
+    public $layout; // @phpstan-ignore-line
+
     public function init(): void
     {
         $this->initLayout([Layout\Admin::class]);

diff --git a/demos/admin-setup.php b/demos/admin-setup.php
@@ -11,6 +11,7 @@
 use Atk4\Ui\Button;
 use Atk4\Ui\Console;
 use Atk4\Ui\Header;
+use Atk4\Ui\Js\JsBlock;
 use Atk4\Ui\Message;
 use Atk4\Ui\View;
 
@@ -106,8 +107,8 @@
 // button to execute migration
 $b = Button::addTo($v, ['Run migration', 'icon' => 'check']);
 $b->on('click', static function () use ($c1, $b) {
-    return [
+    return new JsBlock([
         $c1->jsExecute(),
         $b->js()->hide(),
-    ];
+    ]);
 });
diff --git a/demos/db.default.php b/demos/db.default.php
@@ -4,6 +4,7 @@
 
 namespace Atk4\Login\Demos;
 
+use Atk4\Core\Exception;
 use Atk4\Data\Persistence;
 
 // to use MySQL database:
@@ -14,7 +15,7 @@
 
 $sqliteFile = __DIR__ . '/_demo-data/db.sqlite';
 if (!file_exists($sqliteFile)) {
-    throw new \Exception('Sqlite database does not exist, create it first');
+    throw new Exception('Sqlite database does not exist, create it first. Call _demo-data/create-db.php file from console.');
 }
 $db = new Persistence\Sql('sqlite:' . $sqliteFile);
 unset($sqliteFile);
diff --git a/demos/index.php b/demos/index.php
@@ -7,6 +7,7 @@
 use Atk4\Ui\Button;
 use Atk4\Ui\Header;
 use Atk4\Ui\Message;
+use Atk4\Ui\Text;
 use Atk4\Ui\View;
 
 /** @var App $app */
@@ -21,12 +22,13 @@
 // Info
 if ($app->auth->isLoggedIn()) {
     $a = Message::addTo($app, ['type' => 'info'])->set('Currently logged in: ' . $app->auth->user->getTitle());
-    Button::addTo($a, ['Logout', 'icon' => 'sign out'])->link([$app->auth->pageDashboard, 'logout' => true]);
+    Button::addTo($a, ['Logout', 'icon' => 'sign out'])->link([$app->auth->pageDashboard, 'logout' => 1]);
 } else {
     $a = Message::addTo($app, ['type' => 'info'])->set('Currently there is no user logged in');
     Button::addTo($a, ['Login', 'icon' => 'key'])->link(['form-login']);
 }
 
 // Addon description
-$v = View::addTo($app, ['ui' => 'segment']);
-$v->set('Here goes small description of this addon');
+Text::addTo(View::addTo($app, ['ui' => 'segment']))
+    ->addParagraph('ATK UI implements a high-level User Interface for Web App - such as Admin System. One of the most common things for the Admin system is a log-in screen.')
+    ->addParagraph('Although you can implement log-in form easily, this add-on does everything for you.');
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -15,39 +15,35 @@ parameters:
         - '~^Only booleans are allowed in .+, .+ given( on the (left|right) side)?\.~'
 
         # TODO these rules are generated, this ignores should be fixed in the code
-        -
-          message: '~^Access to an undefined property Atk4\\Ui\\Layout::\$menuLeft\.$~'
-          count: 5
-          path: demos/_includes/App.php
-        -
-          message: '~^Call to an undefined method Atk4\\Ui\\Form\\Control::addAction\(\)\.$~'
-          count: 1
-          path: src/Form/Login.php
-        -
-          message: '~^Call to an undefined method Atk4\\Ui\\Form\\Control::setInputAttr\(\)\.$~'
-          count: 2
-          path: src/Form/Register.php
-        -
-          message: '~^Call to an undefined method Atk4\\Data\\Reference\\HasOne::addTitle\(\)\.$~'
-          count: 1
-          path: src/Model/AccessRule.php
-        -
-          message: '~^Call to an undefined method Atk4\\Data\\Reference\\HasOne::addTitle\(\)\.$~'
-          count: 1
-          path: src/Model/User.php
-        -
-          message: '~^Call to an undefined method Atk4\\Ui\\Table\\Column::addModal\(\)\.$~'
-          count: 1
-          path: src/RoleAdmin.php
-        -
-          message: '~^Call to an undefined method Atk4\\Ui\\Table\\Column::addModal\(\)\.$~'
-          count: 1
-          path: src/UserAdmin.php
-        -
-          message: '~^Call to an undefined method Atk4\\Ui\\Form\\Control::addAction\(\)\.$~'
-          count: 1
-          path: src/UserAdmin.php
-        -
-          message: '~^Call to an undefined method Atk4\\Ui\\View::jsHide\(\)\.$~'
-          count: 1
-          path: src/UserAdmin.php
+        #-
+        #  message: '~^Call to an undefined method Atk4\\Ui\\Form\\Control::addAction\(\)\.$~'
+        #  count: 1
+        #  path: src/Form/Login.php
+        #-
+        #  message: '~^Call to an undefined method Atk4\\Ui\\Form\\Control::setInputAttr\(\)\.$~'
+        #  count: 2
+        #  path: src/Form/Register.php
+        #-
+        #  message: '~^Call to an undefined method Atk4\\Data\\Reference\\HasOne::addTitle\(\)\.$~'
+        #  count: 1
+        #  path: src/Model/AccessRule.php
+        #-
+        #  message: '~^Call to an undefined method Atk4\\Data\\Reference\\HasOne::addTitle\(\)\.$~'
+        #  count: 1
+        #  path: src/Model/User.php
+        #-
+        #  message: '~^Call to an undefined method Atk4\\Ui\\Table\\Column::addModal\(\)\.$~'
+        #  count: 1
+        #  path: src/RoleAdmin.php
+        #-
+        #  message: '~^Call to an undefined method Atk4\\Ui\\Table\\Column::addModal\(\)\.$~'
+        #  count: 1
+        #  path: src/UserAdmin.php
+        #-
+        #  message: '~^Call to an undefined method Atk4\\Ui\\Form\\Control::addAction\(\)\.$~'
+        #  count: 1
+        #  path: src/UserAdmin.php
+        #-
+        #  message: '~^Call to an undefined method Atk4\\Ui\\View::jsHide\(\)\.$~'
+        #  count: 1
+        #  path: src/UserAdmin.php
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -9,9 +9,15 @@
             <directory>tests</directory>
         </testsuite>
     </testsuites>
-    <listeners>
-        <listener class="JohnKary\PHPUnit\Listener\SpeedTrapListener" />
-    </listeners>
+    <extensions>
+        <bootstrap class="Ergebnis\PHPUnit\SlowTestDetector\Extension" />
+    </extensions>
+    <source>
+        <include>
+            <directory>src</directory>
+            <directory>tests</directory>
+        </include>
+    </source>
     <coverage>
         <include>
             <directory>src</directory>

diff --git a/src/Auth.php b/src/Auth.php
@@ -276,7 +276,7 @@ public function addUserMenu(): void
                 $menu->addItem(['Preferences', 'icon' => 'user'], $userPage->getUrl());
             }
 
-            $menu->addItem(['Logout', 'icon' => 'sign out'], [$this->pageDashboard, 'logout' => true]);
+            $menu->addItem(['Logout', 'icon' => 'sign out'], [$this->pageDashboard, 'logout' => 1]);
         }
     }
 
@@ -302,7 +302,6 @@ public function displayLoginForm(array $seed = []): void
     {
         $app = $this->getApp();
 
-        $app->catchRunawayCallbacks = false;
         $app->html = null;
         $app->initLayout([Narrow::class]);
         $app->title .= ' - Login Required';

diff --git a/src/Feature/SetupUserModelTrait.php b/src/Feature/SetupUserModelTrait.php
@@ -4,6 +4,8 @@
 
 namespace Atk4\Login\Feature;
 
+// use Atk4\Data\Persistence; // for 5.1.0 compatibility
+
 trait SetupUserModelTrait
 {
     use UniqueFieldValueTrait;
@@ -19,7 +21,11 @@ public function setupUserModel(): void
         // all AccessRules for all user roles
         // @TODO in future when there can be multiple, then merge them together
         $this->hasMany('AccessRules', [
-            'model' => static function (self $m) {
+            // for 5.1.0 compatibility
+            // 'model' => function (Persistence $p, array $defaults = []) {
+            //    return $this->ref('role_id')->ref('AccessRules');
+            // }
+            'model' => static function ($m) {
                 return $m->ref('role_id')->ref('AccessRules');
             },
             'ourField' => 'role_id',

diff --git a/src/Form/Control/GenericDropdown.php b/src/Form/Control/GenericDropdown.php
@@ -14,7 +14,7 @@
 abstract class GenericDropdown extends Form\Control\Dropdown
 {
     /** @var bool Dropdown with multiselect */
-    public $isMultiple = true;
+    public $multiple = true;
 
     /**
      * Get AccessRule->model and initialize it.

diff --git a/src/Form/Register.php b/src/Form/Register.php
@@ -8,13 +8,17 @@
 use Atk4\Data\Model;
 use Atk4\Login\Auth;
 use Atk4\Ui\Form;
+use Atk4\Ui\Form\Control;
 
 /**
  * Register form view.
  */
 class Register extends Form
 {
-    /** @var Auth object */
+    /** @var array Page to redirect after succesful creating of user */
+    public $linkSuccess = [null];
+
+    /** @var Auth|null object */
     public $auth;
 
     #[\Override]
@@ -25,6 +29,12 @@ protected function init(): void
         $this->buttonSave->set('Register');
         $this->buttonSave->addClass('large fluid');
         $this->buttonSave->iconRight = 'right arrow';
+
+        if ($this->linkSuccess !== [null]) {
+            $this->onHook(self::HOOK_DISPLAY_SUCCESS, function () {
+                return $this->getApp()->jsRedirect($this->linkSuccess);
+            });
+        }
     }
 
     #[\Override]
@@ -34,10 +44,14 @@ public function setModel(Model $user, array $fields = null): void
 
         $this->addControl('name', [], ['required' => true]);
         $this->addControl('email', [], ['required' => true]);
-        $this->addControl('password', [], ['type' => 'string', 'required' => true])
-            ->setInputAttr('autocomplete', 'new-password');
-        $this->addControl('password2', [], ['type' => 'string', 'neverPersist' => true, 'required' => true, 'caption' => 'Repeat Password'])
-            ->setInputAttr('autocomplete', 'new-password');
+
+        /** @var Control\Input */
+        $p1 = $this->addControl('password', [Control\Password::class], ['type' => 'string', 'required' => true]);
+        $p1->setInputAttr('autocomplete', 'new-password');
+
+        /** @var Control\Input */
+        $p2 = $this->addControl('password2', [Control\Password::class], ['type' => 'string', 'neverPersist' => true, 'required' => true, 'caption' => 'Repeat Password']);
+        $p2->setInputAttr('autocomplete', 'new-password');
 
         // on form submit save new user in persistence
         $this->onSubmit(function (self $form) {

diff --git a/src/Model/AccessRule.php b/src/Model/AccessRule.php
@@ -18,14 +18,17 @@ class AccessRule extends Model
     public $table = 'login_access_rule';
     public $caption = 'Access Rule';
 
+    /** @var array<mixed> Default Role model. */
+    protected array $roleModelSeed = [Role::class];
+
     #[\Override]
     protected function init(): void
     {
         parent::init();
 
         /** @var HasOneSql */
         $r = $this->hasOne('role_id', [
-            'model' => [Role::class],
+            'model' => $this->roleModelSeed,
             'ourField' => 'role_id',
             'theirField' => 'id',
             'caption' => 'Role',

diff --git a/src/Model/Role.php b/src/Model/Role.php
@@ -14,6 +14,12 @@ class Role extends Model
     public $table = 'login_role';
     public $caption = 'Role';
 
+    /** @var array<mixed> Default User model. */
+    protected array $userModelSeed = [User::class];
+
+    /** @var array<mixed> Default AccessRule model. */
+    protected array $accessRuleModelSeed = [AccessRule::class];
+
     #[\Override]
     protected function init(): void
     {
@@ -22,12 +28,12 @@ protected function init(): void
         $this->addField('name');
 
         $this->hasMany('Users', [
-            'model' => [User::class],
+            'model' => $this->userModelSeed,
             'ourField' => 'id',
             'theirField' => 'role_id',
         ]);
         $this->hasMany('AccessRules', [
-            'model' => [AccessRule::class],
+            'model' => $this->accessRuleModelSeed,
             'ourField' => 'id',
             'theirField' => 'role_id',
         ]);

diff --git a/src/Model/User.php b/src/Model/User.php
@@ -11,6 +11,7 @@
 use Atk4\Login\Feature\SendEmailActionTrait;
 use Atk4\Login\Feature\SetupUserModelTrait;
 use Atk4\Login\Feature\SignupTrait;
+use Atk4\Ui\Form\Control\Password;
 
 class User extends Model
 {
@@ -22,19 +23,22 @@ class User extends Model
     public $table = 'login_user';
     public $caption = 'User';
 
+    /** @var array<mixed> Default Role model. */
+    protected array $roleModelSeed = [Role::class];
+
     #[\Override]
     protected function init(): void
     {
         parent::init();
 
         $this->addField('name');
-        $this->addField('email');
-        $this->addField('password', [PasswordField::class]);
+        $this->addField('email', ['caption' => 'Email/Login']);
+        $this->addField('password', [PasswordField::class, 'ui' => ['form' => [Password::class]]]);
 
         // currently user can have only one role. In future it should be n:n relation
         /** @var HasOneSql */
         $r = $this->hasOne('role_id', [
-            'model' => [Role::class],
+            'model' => $this->roleModelSeed,
             'ourField' => 'role_id',
             'theirField' => 'id',
             'caption' => 'Role',