DB: use 'boolean' database fields

This patch allows Myth:Auth to support all three of SQLite, MariaDB and
PostgreSQL.

- change 'tinyint' to 'boolean' on the migration,
- switch 0/1 to true/false coherently throughout the code.

Fix lonnieezell#324

src/Authentication/AuthenticationBase.php

@@ -216,7 +216,7 @@ public function recordLoginAttempt(string $email, string $ipAddress=null, int $u
             'email' => $email,
             'user_id' => $userID,
             'date' => date('Y-m-d H:i:s'),
-            'success' => (int)$success
+            'success' => (bool)$success
         ]);
     }
 

src/Database/Migrations/2017-11-20-223112_create_auth_tables.php

@@ -20,8 +20,8 @@ public function up()
             'activate_hash'    => ['type' => 'varchar', 'constraint' => 255, 'null' => true],
             'status'           => ['type' => 'varchar', 'constraint' => 255, 'null' => true],
             'status_message'   => ['type' => 'varchar', 'constraint' => 255, 'null' => true],
-            'active'           => ['type' => 'tinyint', 'constraint' => 1, 'null' => 0, 'default' => 0],
-            'force_pass_reset' => ['type' => 'tinyint', 'constraint' => 1, 'null' => 0, 'default' => 0],
+            'active'           => ['type' => 'boolean',  'null' => false, 'default' => false],
+            'force_pass_reset' => ['type' => 'boolean',  'null' => false, 'default' => false],
             'created_at'       => ['type' => 'datetime', 'null' => true],
             'updated_at'       => ['type' => 'datetime', 'null' => true],
             'deleted_at'       => ['type' => 'datetime', 'null' => true],
@@ -42,7 +42,7 @@ public function up()
             'email'      => ['type' => 'varchar', 'constraint' => 255, 'null' => true],
             'user_id'    => ['type' => 'int', 'constraint' => 11, 'unsigned' => true, 'null' => true], // Only for successful logins
             'date'       => ['type' => 'datetime'],
-            'success'    => ['type' => 'tinyint', 'constraint' => 1],
+            'success'    => ['type' => 'boolean'],
         ]);
         $this->forge->addKey('id', true);
         $this->forge->addKey('email');

src/Entities/Cast/BooleanCast.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Myth\Auth\Entities\Cast;
+
+use CodeIgniter\Entity\Cast\BaseCast;
+
+/**
+ * Class BooleanCast
+ */
+class BooleanCast extends BaseCast
+{
+    /**
+     * {@inheritDoc}
+     */
+    public static function get($value, array $params = []): bool
+    {
+        // PostgreSQL (via PDO, etc.) returns (string)'f' or 't' for boolean
+        // fields
+        return (bool) $value && $value !== 'f';
+    }
+}

src/Entities/User.php

@@ -3,6 +3,7 @@
 use CodeIgniter\Entity;
 use Myth\Auth\Authorization\GroupModel;
 use Myth\Auth\Authorization\PermissionModel;
+use Myth\Auth\Entities\Cast\BooleanCast;
 use Myth\Auth\Password;
 
 class User extends Entity
@@ -29,8 +30,15 @@ class User extends Entity
      * when they are accessed.
      */
     protected $casts = [
-        'active'           => 'boolean',
-        'force_pass_reset' => 'boolean',
+        'active'           => 'booleanAuthMyth',
+        'force_pass_reset' => 'booleanAuthMyth',
+    ];
+
+    /**
+     * Registering our custom casting handler
+     */
+    protected $castHandlers = [
+        'booleanAuthMyth' => BooleanCast::class,
     ];
 
     /**
@@ -81,7 +89,7 @@ public function setPassword(string $password)
     public function forcePasswordReset()
     {
         $this->generateResetHash();
-        $this->attributes['force_pass_reset'] = 1;
+        $this->attributes['force_pass_reset'] = true;
 
         return $this;
     }
@@ -121,7 +129,7 @@ public function generateActivateHash()
      */
     public function activate()
     {
-        $this->attributes['active'] = 1;
+        $this->attributes['active'] = true;
         $this->attributes['activate_hash'] = null;
 
         return $this;
@@ -134,7 +142,7 @@ public function activate()
      */
     public function deactivate()
     {
-        $this->attributes['active'] = 0;
+        $this->attributes['active'] = false;
 
         return $this;
     }

tests/authentication/AuthenticationBaseTest.php

@@ -56,7 +56,7 @@ public function testLoginByID()
         $this->seeInDatabase('auth_logins', [
             'email' => $user->email,
             'user_id' => $user->id,
-            'success' => 1
+            'success' => true,
         ]);
     }
 
@@ -70,7 +70,7 @@ public function testLoginSuccessNoRemember()
         $this->seeInDatabase('auth_logins', [
             'email' => $user->email,
             'user_id' => $user->id,
-            'success' => 1
+            'success' => true,
         ]);
 
         $this->assertEquals(4, $_SESSION['logged_in']);
@@ -99,7 +99,7 @@ public function testLoginSuccessAndRemember()
         $this->seeInDatabase('auth_logins', [
             'email' => $user->email,
             'user_id' => $user->id,
-            'success' => 1
+            'success' => true,
         ]);
 
         $this->assertEquals($user->id, $_SESSION['logged_in']);

tests/controllers/LoginTest.php

@@ -58,7 +58,7 @@ public function testAttemptLoginSuccess()
             'username' => 'Joe Cool',
             'email' => '[email protected]',
             'password' => 'xaH96AhjglK',
-            'active' => 1,
+            'active' => true,
         ];
         $this->createUser($user);
 
@@ -98,7 +98,7 @@ public function testAttemptLoginSuccessWithRememberMe()
             'username' => 'Joe Cool',
             'email' => '[email protected]',
             'password' => 'xaH96AhjglK',
-            'active' => 1,
+            'active' => true,
         ];
         $this->createUser($user);
 

tests/unit/AuthenticationBaseLoginTest.php

@@ -40,7 +40,7 @@ public function testRecordLoginAttemptSuccess()
             'email' => '[email protected]',
             'user_id' => 12,
             'date' => date('Y-m-d H:i:s'),
-            'success' => 0
+            'success' => false,
         ]))->andReturn(true);
 
         $this->assertTrue($this->auth->recordLoginAttempt($credentials['email'], '0.0.0.0', 12, false));