Merge pull request #185 from kenjis/feat-toolbar

feat: add debug toolbar

Author: lonnieezell

src/Collectors/Auth.php

@@ -0,0 +1,104 @@
+<?php
+
+namespace CodeIgniter\Shield\Collectors;
+
+use CodeIgniter\Debug\Toolbar\Collectors\BaseCollector;
+use CodeIgniter\Shield\Auth as ShieldAuth;
+
+/**
+ * Debug Toolbar Collector for Auth
+ */
+class Auth extends BaseCollector
+{
+    /**
+     * Whether this collector has data that can
+     * be displayed in the Timeline.
+     *
+     * @var bool
+     */
+    protected $hasTimeline = false;
+
+    /**
+     * Whether this collector needs to display
+     * content in a tab or not.
+     *
+     * @var bool
+     */
+    protected $hasTabContent = true;
+
+    /**
+     * Whether this collector has data that
+     * should be shown in the Vars tab.
+     *
+     * @var bool
+     */
+    protected $hasVarData = false;
+
+    /**
+     * The 'title' of this Collector.
+     * Used to name things in the toolbar HTML.
+     *
+     * @var string
+     */
+    protected $title = 'Auth';
+
+    private ShieldAuth $auth;
+
+    public function __construct()
+    {
+        $this->auth = service('auth');
+    }
+
+    /**
+     * Returns any information that should be shown next to the title.
+     */
+    public function getTitleDetails(): string
+    {
+        return get_class($this->auth->getAuthenticator());
+    }
+
+    /**
+     * Returns the data of this collector to be formatted in the toolbar
+     */
+    public function display(): string
+    {
+        if ($this->auth->loggedIn()) {
+            $user   = $this->auth->user();
+            $groups = $user->getGroups();
+
+            $groupsForUser = implode(', ', $groups);
+
+            $html = '<h3>Current User</h3>';
+            $html .= '<table><tbody>';
+            $html .= "<tr><td style='width:150px;'>User ID</td><td>#{$user->id}</td></tr>";
+            $html .= "<tr><td>Username</td><td>{$user->username}</td></tr>";
+            $html .= "<tr><td>Email</td><td>{$user->email}</td></tr>";
+            $html .= "<tr><td>Groups</td><td>{$groupsForUser}</td></tr>";
+            $html .= '</tbody></table>';
+        } else {
+            $html = '<p>Not logged in.</p>';
+        }
+
+        return $html;
+    }
+
+    /**
+     * Gets the "badge" value for the button.
+     *
+     * @return int|string|null ID of the current User, or null when not logged in
+     */
+    public function getBadgeValue()
+    {
+        return $this->auth->loggedIn() ? $this->auth->id() : null;
+    }
+
+    /**
+     * Display the icon.
+     *
+     * Icon from https://icons8.com - 1em package
+     */
+    public function icon(): string
+    {
+        return 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAADLSURBVEhL5ZRLCsIwGAa7UkE9gd5HUfEoekxxJx7AhXoCca/fhESkJiQxBHwMDG3S/9EmJc0n0JMruZVXK/fMdWQRY7mXt4A7OZJvwZu74hRayIEc2nv3jGtXZrOWrnifiRY0OkhiWK5sWGeS52bkZymJ2ZhRJmwmySxLCL6CmIsZZUIixkiNezCRR+kSUyWH3Cgn6SuQIk2iuOBckvN+t8FMnq1TJloUN3jefN9mhvJeCAVWb8CyUDj0vxc3iPFHDaofFdUPu2+iae7nYJMCY/1bpAAAAABJRU5ErkJggg==';
+    }
+}

src/Config/Registrar.php

@@ -3,6 +3,7 @@
 namespace CodeIgniter\Shield\Config;
 
 use CodeIgniter\Shield\Authentication\Passwords\ValidationRules as PasswordRules;
+use CodeIgniter\Shield\Collectors\Auth;
 use CodeIgniter\Shield\Filters\AuthRates;
 use CodeIgniter\Shield\Filters\ChainAuth;
 use CodeIgniter\Shield\Filters\SessionAuth;
@@ -37,4 +38,13 @@ public static function Validation(): array
             ],
         ];
     }
+
+    public static function Toolbar(): array
+    {
+        return [
+            'collectors' => [
+                Auth::class,
+            ],
+        ];
+    }
 }

tests/Collectors/AuthTest.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace Tests\Collectors;
+
+use CodeIgniter\Shield\Authentication\Authenticators\Session;
+use CodeIgniter\Shield\Collectors\Auth;
+use CodeIgniter\Shield\Entities\User;
+use CodeIgniter\Shield\Models\UserModel;
+use CodeIgniter\Test\DatabaseTestTrait;
+use Tests\Support\TestCase;
+
+/**
+ * @internal
+ */
+final class AuthTest extends TestCase
+{
+    use DatabaseTestTrait;
+
+    protected $namespace;
+    protected $refresh = true;
+    private User $user;
+    private Auth $collector;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->user = fake(UserModel::class, ['username' => 'John Smith']);
+
+        $this->collector = new Auth();
+    }
+
+    public function testDisplayNotLoggedIn()
+    {
+        $output = $this->collector->display();
+
+        $this->assertStringContainsString('Not logged in', $output);
+    }
+
+    public function testtestDisplayLoggedIn()
+    {
+        /** @var Session $authenticator */
+        $authenticator = service('auth')->getAuthenticator();
+        $authenticator->login($this->user);
+        $this->user->addGroup('admin', 'beta');
+
+        $output = $this->collector->display();
+
+        $this->assertStringContainsString('Current Use', $output);
+        $this->assertStringContainsString('<td>Username</td><td>John Smith</td>', $output);
+        $this->assertStringContainsString('<td>Groups</td><td>admin, beta</td>', $output);
+    }
+
+    public function testGetTitleDetails()
+    {
+        $output = $this->collector->getTitleDetails();
+
+        $this->assertStringContainsString(Session::class, $output);
+    }
+
+    public function testGetBadgeValueReturnsUserId()
+    {
+        /** @var Session $authenticator */
+        $authenticator = service('auth')->getAuthenticator();
+        $authenticator->login($this->user);
+
+        $output = (string) $this->collector->getBadgeValue();
+
+        $this->assertStringContainsString('1', $output);
+    }
+}

tests/_support/FakeUser.php

@@ -7,12 +7,9 @@
 
 trait FakeUser
 {
-    /**
-     * @var User
-     */
-    private $user;
+    private User $user;
 
-    protected function setUpFakeUser()
+    protected function setUpFakeUser(): void
     {
         $this->user = fake(UserModel::class);
     }