Merge a7eba65 into af3d397

composer.json

@@ -22,6 +22,7 @@
 		"php": "^7.3 || ^8.0"
 	},
 	"require-dev": {
+		"agungsugiarto/codeigniter4-authentication": "dev-master",
 		"codeigniter4/codeigniter4": "dev-develop",
 		"lonnieezell/codigniter-shield": "dev-develop",
 		"myth/auth": "dev-develop",
@@ -41,6 +42,10 @@
 		}
 	},
 	"repositories": [
+		{
+			"type": "vcs",
+			"url": "https://github.com/agungsugiarto/codeigniter4-authentication"
+		},
 		{
 			"type": "vcs",
 			"url": "https://github.com/codeigniter4/CodeIgniter4"

src/Entities/FluentEntity.php

@@ -0,0 +1,76 @@
+<?php namespace Tatter\Users\Entities;
+
+use Fluent\Auth\Entities\User;
+use Tatter\Users\UserEntity;
+
+/**
+ * Fluent User Entity
+ */
+class FluentEntity extends User implements UserEntity
+{
+	/**
+	 * Returns the name of the column used to
+	 * uniquely identify this user, typically 'id'.
+	 *
+	 * @return string
+	 */
+	public function getIdentifier(): string
+	{
+		return $this->getAuthIdColumn();
+	}
+
+	/**
+	 * Returns the value for the identifier,
+	 * or `null` for "uncreated" users.
+	 *
+	 * @return string|int|null
+	 */
+	public function getId()
+	{
+		return $this->getAuthId();
+	}
+
+	/**
+	 * Returns the email address.
+	 *
+	 * @return string|null
+	 */
+	public function getEmail(): ?string
+	{
+		return $this->getAuthEmail();
+	}
+
+	/**
+	 * Returns the username.
+	 *
+	 * @return string|null
+	 */
+	public function getUsername(): ?string
+	{
+		return $this->attributes['username'] ?? null;
+	}
+
+	/**
+	 * Returns the name for this user.
+	 * If names are stored as parts "first",
+	 * "middle", "last" they should be
+	 * concatenated with spaces.
+	 *
+	 * @return string|null
+	 */
+	public function getName(): ?string
+	{
+		return null;
+	}
+
+	/**
+	 * Returns whether this user is eligible
+	 * for authentication.
+	 *
+	 * @return bool
+	 */
+	public function isActive(): bool
+	{
+		return empty($this->attributes['deleted_at']);
+	}
+}

src/Entities/MythEntity.php

@@ -1,13 +1,13 @@
 <?php namespace Tatter\Users\Entities;
 
 use Myth\Auth\Entities\User;
-use Tatter\Users\UserEntity;
-use RuntimeException;
+use Tatter\Users\Interfaces\HasGroup;
+use Tatter\Users\Interfaces\HasPermission;
 
 /**
  * Myth User Entity
  */
-class MythEntity extends User implements UserEntity
+class MythEntity extends User implements HasGroup, HasPermission
 {
 	/**
 	 * Returns the name of the column used to
@@ -61,7 +61,7 @@ public function getUsername(): ?string
 	 */
 	public function getName(): ?string
 	{
-		throw new RuntimeException('That attribute is not supported.');
+		return null;
 	}
 
 	/**
@@ -74,4 +74,30 @@ public function isActive(): bool
 	{
 		return $this->isActivated();
 	}
+
+	/**
+	 * Returns whether this user is a
+	 * member of the given group.
+	 *
+	 * @param string $group The group name
+	 *
+	 * @return bool
+	 */
+	public function hasGroup(string $group): bool
+	{
+		return in_array(strtolower($group), $this->getRoles());
+	}
+
+	/**
+	 * Returns whether this user has
+	 * a certain permission.
+	 *
+	 * @param string $permission The permission name
+	 *
+	 * @return bool
+	 */
+	public function hasPermission(string $permission): bool
+	{
+		return $this->can($permission);
+	}
 }

src/Entities/ShieldEntity.php

@@ -2,7 +2,6 @@
 
 use Sparks\Shield\Entities\User;
 use Tatter\Users\UserEntity;
-use RuntimeException;
 
 /**
  * Shield User Entity
@@ -61,7 +60,7 @@ public function getUsername(): ?string
 	 */
 	public function getName(): ?string
 	{
-		throw new RuntimeException('That attribute is not supported.');
+		return null;
 	}
 
 	/**

src/Factories/FluentFactory.php

@@ -0,0 +1,61 @@
+<?php namespace Tatter\Users\Factories;
+
+use Fluent\Auth\Models\UserModel;
+use Tatter\Users\Entities\FluentEntity;
+use Tatter\Users\UserEntity;
+use Tatter\Users\UserFactory;
+
+/**
+ * Fluent User Factory
+ */
+class FluentFactory extends UserModel implements UserFactory
+{
+	/**
+	 * The format that the results should be returned as.
+	 *
+	 * @var string
+	 */
+    protected $returnType = FluentEntity::class;
+
+	/**
+	 * Locates a user by its primary identifier.
+	 *
+	 * @param string|int $id
+	 *
+	 * @return FluentEntity|null
+	 */
+	public function findById($id): ?UserEntity
+	{
+		/** @var FluentEntity|null $result */
+		$result = parent::findById($id);
+		return $result;
+	}
+
+	/**
+	 * Locates a user by its email.
+	 *
+	 * @param string $email
+	 *
+	 * @return FluentEntity|null
+	 */
+	public function findByEmail(string $email): ?UserEntity
+	{
+		/** @var FluentEntity|null $result */
+		$result = $this->findByCredentials(['email' => $email]);
+		return $result;
+	}
+
+	/**
+	 * Locates a user by its username.
+	 *
+	 * @param string $username
+	 *
+	 * @return FluentEntity|null
+	 */
+	public function findByUsername(string $username): ?UserEntity
+	{
+		/** @var FluentEntity|null $result */
+		$result = $this->findByCredentials(['username' => $username]);
+		return $result;
+	}
+}

src/Interfaces/HasGroup.php

@@ -0,0 +1,22 @@
+<?php namespace Tatter\Users\Interfaces;
+
+use Tatter\Users\UserEntity;
+
+/**
+ * Has Group Interface
+ *
+ * User extension for entities that
+ * can verify group membership.
+ */
+interface HasGroup extends UserEntity
+{
+	/**
+	 * Returns whether this user is a
+	 * member of the given group.
+	 *
+	 * @param string $group The group name
+	 *
+	 * @return bool
+	 */
+	public function hasGroup(string $group): bool;
+}

src/Interfaces/HasPermission.php

@@ -0,0 +1,22 @@
+<?php namespace Tatter\Users\Interfaces;
+
+use Tatter\Users\UserEntity;
+
+/**
+ * Has Permission Interface
+ *
+ * User extension for entities that
+ * can test a designated permission.
+ */
+interface HasPermission extends UserEntity
+{
+	/**
+	 * Returns whether this user has
+	 * a certain permission.
+	 *
+	 * @param string $permission The permission name
+	 *
+	 * @return bool
+	 */
+	public function hasPermission(string $permission): bool;
+}

src/UserProvider.php

@@ -10,13 +10,14 @@ class UserProvider
 {
 	/**
 	 * Known factories. Keys are the
-	 * class to check for to validate.
+	 * class to check availability.
 	 *
 	 * @var array<string,string>
 	 */
 	protected static $factories = [
 		'Myth\Auth\Models\UserModel'     => Factories\MythFactory::class,
 		'Sparks\Shield\Models\UserModel' => Factories\ShieldFactory::class,
+		'Fluent\Auth\Models\UserModel'   => Factories\FluentFactory::class,
 	];
 
 	/**

tests/unit/EntityTest.php

@@ -27,19 +27,16 @@ public function testEntityMethods($class)
 		$this->assertEquals($this->data['id'], $entity->getId());
 		$this->assertEquals($this->data['email'], $entity->getEmail());
 		$this->assertEquals($this->data['username'], $entity->getUsername());
-		$this->assertEquals(true, $entity->isActive());
-
-		$this->expectException('RuntimeException');
-		$this->expectExceptionMessage('That attribute is not supported.');
-
-		$entity->getName();
+		$this->assertTrue($entity->isActive());
+		$this->assertNull($entity->getName());
 	}
 
 	public function entityProvider(): array
 	{
 		return [
 			['Tatter\Users\Entities\MythEntity'],
 			['Tatter\Users\Entities\ShieldEntity'],
+			['Tatter\Users\Entities\FluentEntity'],
 		];
 	}
 }

tests/unit/FluentFactoryTest.php

@@ -0,0 +1,12 @@
+<?php
+
+use Fluent\Auth\Models\UserModel;
+use Tatter\Users\Factories\FluentFactory;
+use Tests\Support\FactoryTestCase;
+
+class FluentFactoryTest extends FactoryTestCase
+{
+	protected $namespace = 'Fluent\Auth';
+	protected $class     = FluentFactory::class;
+	protected $faker     = UserModel::class;
+}

tests/unit/ProviderTest.php

@@ -10,6 +10,7 @@ public function testGetFactories()
 		$expected = [
 			'Myth\Auth\Models\UserModel'     => 'Tatter\Users\Factories\MythFactory',
 			'Sparks\Shield\Models\UserModel' => 'Tatter\Users\Factories\ShieldFactory',
+			'Fluent\Auth\Models\UserModel'   => 'Tatter\Users\Factories\FluentFactory',
 		];
 
 		$this->assertSame($expected, UserProvider::getFactories());
@@ -30,6 +31,7 @@ public function testAddFactory()
 			'foo'                            => 'bar',
 			'Myth\Auth\Models\UserModel'     => 'Tatter\Users\Factories\MythFactory',
 			'Sparks\Shield\Models\UserModel' => 'Tatter\Users\Factories\ShieldFactory',
+			'Fluent\Auth\Models\UserModel'   => 'Tatter\Users\Factories\FluentFactory',
 		];
 
 		UserProvider::addFactory('foo', 'bar');