From 357dded3c2a4bc9c8d9d24903583a339bd46256b Mon Sep 17 00:00:00 2001
From: mpyw <ryosuke_i_628@yahoo.co.jp>
Date: Fri, 27 Dec 2019 15:38:38 +0900
Subject: [PATCH] Feat: Add NoRememberTokenAuthenticatable (#4)

---
 README.md                                     |  22 ++++
 src/Concerns/HasEloquentPassword.php          |  21 ++++
 src/NoRememberTokenAuthenticatable.php        |  13 ++
 src/StrictNoRememberTokenAuthenticatable.php  |  13 ++
 .../NoRememberTokenAuthenticatableTest.php    | 112 ++++++++++++++++++
 5 files changed, 181 insertions(+)
 create mode 100644 src/Concerns/HasEloquentPassword.php
 create mode 100644 src/NoRememberTokenAuthenticatable.php
 create mode 100644 src/StrictNoRememberTokenAuthenticatable.php
 create mode 100644 tests/Unit/NoRememberTokenAuthenticatableTest.php

diff --git a/README.md b/README.md
index 9a99f56..72ded47 100644
--- a/README.md
+++ b/README.md
@@ -17,6 +17,28 @@ Null Guard for Laravel. Designed for Middleware-based authentication and testing
 composer require mpyw/null-auth
 ```
 
+## Features
+
+### `NullAuthenticatable` family
+
+| Trait | ID | Password | Remember Token |
+|:---|:---:|:---:|:---:|
+| `GenericNullAuthenticatable`<br>`GenericStrictNullAuthenticatable` | ❗️ | ❌| ❌|
+| `NullAuthenticatable`<br>`StrictNullAuthenticatable` | ✅| ❌| ❌|
+| `NoRememberTokenAuthenticatable`<br>`StrictNoRememberTokenAuthenticatable` | ✅| ✅| ❌|
+
+- ❗️shows containing abstract methods.
+- `Strict` classes throw `LogicException` on bad function calls.
+
+### `NullGuard`
+
+- `NullGuard::user()` always returns Authenticatable already set by `NullGuard::setUser()`.
+- `NullGuard::unsetUser()` can unset user.
+
+### `NullUserProvider`
+
+- All methods do nothing and always returns falsy value.
+
 ## Usage
 
 ### Basic Usage
diff --git a/src/Concerns/HasEloquentPassword.php b/src/Concerns/HasEloquentPassword.php
new file mode 100644
index 0000000..757ec7e
--- /dev/null
+++ b/src/Concerns/HasEloquentPassword.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Mpyw\NullAuth\Concerns;
+
+/**
+ * Trait HasEloquentPassword
+ *
+ * @mixin \Illuminate\Database\Eloquent\Model
+ */
+trait HasEloquentPassword
+{
+    /**
+     * Get the unique identifier for the user.
+     *
+     * @return mixed
+     */
+    public function getAuthPassword()
+    {
+        return $this->getAttribute('password');
+    }
+}
diff --git a/src/NoRememberTokenAuthenticatable.php b/src/NoRememberTokenAuthenticatable.php
new file mode 100644
index 0000000..7078578
--- /dev/null
+++ b/src/NoRememberTokenAuthenticatable.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Mpyw\NullAuth;
+
+use Mpyw\NullAuth\Concerns\HasEloquentPassword;
+
+trait NoRememberTokenAuthenticatable
+{
+    use NullAuthenticatable,
+        HasEloquentPassword {
+        HasEloquentPassword::getAuthPassword insteadof NullAuthenticatable;
+    }
+}
diff --git a/src/StrictNoRememberTokenAuthenticatable.php b/src/StrictNoRememberTokenAuthenticatable.php
new file mode 100644
index 0000000..b1c6b19
--- /dev/null
+++ b/src/StrictNoRememberTokenAuthenticatable.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace Mpyw\NullAuth;
+
+use Mpyw\NullAuth\Concerns\HasEloquentPassword;
+
+trait StrictNoRememberTokenAuthenticatable
+{
+    use StrictNullAuthenticatable,
+        HasEloquentPassword {
+        HasEloquentPassword::getAuthPassword insteadof StrictNullAuthenticatable;
+    }
+}
diff --git a/tests/Unit/NoRememberTokenAuthenticatableTest.php b/tests/Unit/NoRememberTokenAuthenticatableTest.php
new file mode 100644
index 0000000..db1acf6
--- /dev/null
+++ b/tests/Unit/NoRememberTokenAuthenticatableTest.php
@@ -0,0 +1,112 @@
+<?php
+
+namespace Mpyw\NullAuth\Tests\Unit;
+
+use Illuminate\Auth\GenericUser;
+use LogicException;
+use Mpyw\NullAuth\NoRememberTokenAuthenticatable;
+use Mpyw\NullAuth\StrictNoRememberTokenAuthenticatable;
+use Mpyw\NullAuth\Tests\TestCase;
+
+class NoRememberTokenAuthenticatableTest extends TestCase
+{
+    /**
+     * @var array
+     */
+    protected $attributes;
+
+    /**
+     * @var \Illuminate\Auth\GenericUser|\Mpyw\NullAuth\NoRememberTokenAuthenticatable
+     */
+    protected $user;
+
+    /**
+     * @var \Illuminate\Auth\GenericUser|\Mpyw\NullAuth\NoRememberTokenAuthenticatable
+     */
+    protected $strict;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->attributes = [
+            'id' => 123,
+            'password' => 'foo',
+            'remember_token' => 'xxx',
+        ];
+
+        $this->user = new class($this->attributes) extends GenericUser {
+            use NoRememberTokenAuthenticatable;
+
+            public function getKeyName()
+            {
+                return 'id';
+            }
+
+            public function getAttribute(string $key)
+            {
+                return $this->attributes[$key];
+            }
+        };
+
+        $this->strict = new class($this->attributes) extends GenericUser {
+            use StrictNoRememberTokenAuthenticatable;
+
+            public function getKeyName()
+            {
+                return 'id';
+            }
+
+            public function getAttribute(string $key)
+            {
+                return $this->attributes[$key];
+            }
+        };
+    }
+
+    public function testGetAuthIdentifierName(): void
+    {
+        $this->assertSame('id', $this->user->getAuthIdentifierName());
+        $this->assertSame('id', $this->strict->getAuthIdentifierName());
+    }
+
+    public function testGetAuthIdentifier(): void
+    {
+        $this->assertSame(123, $this->user->getAuthIdentifier());
+        $this->assertSame(123, $this->strict->getAuthIdentifier());
+    }
+
+    public function testGetAuthPassword(): void
+    {
+        $this->assertSame('foo', $this->user->getAuthPassword());
+        $this->assertSame('foo', $this->strict->getAuthPassword());
+    }
+
+    public function testGetRememberToken(): void
+    {
+        $this->assertSame('', $this->user->getRememberToken());
+
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('Not implemented');
+        $this->strict->getRememberToken();
+    }
+
+    public function testSetRememberToken(): void
+    {
+        $this->user->setRememberToken('yyy');
+        $this->assertSame('xxx', $this->user->remember_token);
+
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('Not implemented');
+        $this->strict->setRememberToken('yyy');
+    }
+
+    public function testGetRememberTokenName(): void
+    {
+        $this->assertSame('', $this->user->getRememberTokenName());
+
+        $this->expectException(LogicException::class);
+        $this->expectExceptionMessage('Not implemented');
+        $this->strict->getRememberTokenName();
+    }
+}