Merge branch 'master' into ci

Author: weaverryan

.github/workflows/ci.yml

@@ -14,6 +14,9 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v2.0.0
 
+      - name: Validate Composer
+        run: composer validate --no-check-lock
+
       - name: Install dependencies
         run: composer install --prefer-dist --no-progress --no-suggest
 

composer.json

@@ -1,4 +1,6 @@
 {
+    "name": "symfonycasts/reset-password-bundle",
+    "description": "Symfony bundle that adds password reset functionality.",
     "type": "symfony-bundle",
     "license": "MIT",
     "minimum-stability": "dev",

src/ResetPasswordHelper.php

@@ -29,16 +29,8 @@ class ResetPasswordHelper implements ResetPasswordHelperInterface
      */
     private const SELECTOR_LENGTH = 20;
 
-    /**
-     * @var ResetPasswordTokenGenerator
-     */
     private $tokenGenerator;
-
     private $resetPasswordCleaner;
-
-    /**
-     * @var ResetPasswordRequestRepositoryInterface
-     */
     private $repository;
 
     /**
@@ -61,7 +53,7 @@ public function __construct(ResetPasswordTokenGenerator $generator, ResetPasswor
     }
 
     /**
-     * Generates a new password reset token, persists it & returns the token that can be emailed to the user.
+     * {@inheritdoc}
      *
      * Some of the cryptographic strategies were taken from
      * https://paragonie.com/blog/2017/02/split-tokens-token-based-authentication-protocols-without-side-channels
@@ -97,9 +89,7 @@ public function generateResetToken(object $user): ResetPasswordToken
     }
 
     /**
-     * Validate a PasswordResetRequest and fetch user from persistence.
-     *
-     * @param string $fullToken selector + non-hashed verifier token
+     * {@inheritdoc}
      *
      * @throws ExpiredResetPasswordTokenException
      * @throws InvalidResetPasswordTokenException
@@ -138,9 +128,7 @@ public function validateTokenAndFetchUser(string $fullToken): object
     }
 
     /**
-     * Remove a single PasswordResetRequest object from persistence.
-     *
-     * @param string $fullToken selector + non-hashed verifier token
+     * {@inheritdoc}
      *
      * @throws InvalidResetPasswordTokenException
      */

tests/UnitTests/Generator/ResetPasswordTokenGeneratorTest.php

@@ -9,6 +9,7 @@
 
 namespace SymfonyCasts\Bundle\ResetPassword\Tests\UnitTests\Generator;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use SymfonyCasts\Bundle\ResetPassword\Generator\ResetPasswordRandomGenerator;
 use SymfonyCasts\Bundle\ResetPassword\Generator\ResetPasswordTokenGenerator;
@@ -20,12 +21,12 @@
 class ResetPasswordTokenGeneratorTest extends TestCase
 {
     /**
-     * @var \PHPUnit\Framework\MockObject\MockObject|ResetPasswordRandomGenerator
+     * @var MockObject|ResetPasswordRandomGenerator
      */
     private $mockRandomGenerator;
 
     /**
-     * @var \PHPUnit\Framework\MockObject\MockObject|\DateTimeImmutable
+     * @var MockObject|\DateTimeImmutable
      */
     private $mockExpiresAt;
 
@@ -109,9 +110,6 @@ public function testHashedTokenIsCreatedUsingOptionVerifierParam(): void
 
     private function getTokenGenerator(): ResetPasswordTokenGenerator
     {
-        return new ResetPasswordTokenGenerator(
-            'key',
-            $this->mockRandomGenerator
-        );
+        return new ResetPasswordTokenGenerator('key', $this->mockRandomGenerator);
     }
 }

tests/UnitTests/ResetPasswordHelperTest.php

@@ -9,6 +9,7 @@
 
 namespace SymfonyCasts\Bundle\ResetPassword\Tests\UnitTests;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use SymfonyCasts\Bundle\ResetPassword\Exception\ExpiredResetPasswordTokenException;
 use SymfonyCasts\Bundle\ResetPassword\Exception\InvalidResetPasswordTokenException;
@@ -27,22 +28,22 @@
 class ResetPasswordHelperTest extends TestCase
 {
     /**
-     * @var \PHPUnit\Framework\MockObject\MockObject|ResetPasswordRequestRepositoryInterface
+     * @var MockObject|ResetPasswordRequestRepositoryInterface
      */
     private $mockRepo;
 
     /**
-     * @var \PHPUnit\Framework\MockObject\MockObject|ResetPasswordTokenGenerator
+     * @var MockObject|ResetPasswordTokenGenerator
      */
     private $mockTokenGenerator;
 
     /**
-     * @var \PHPUnit\Framework\MockObject\MockObject|ResetPasswordRequestInterface
+     * @var MockObject|ResetPasswordRequestInterface
      */
     private $mockResetRequest;
 
     /**
-     * @var \PHPUnit\Framework\MockObject\MockObject|ResetPasswordCleaner
+     * @var MockObject|ResetPasswordCleaner
      */
     private $mockCleaner;
 
@@ -51,11 +52,6 @@ class ResetPasswordHelperTest extends TestCase
      */
     private $randomToken;
 
-    /**
-     * @var object
-     */
-    private $mockUser;
-
     /**
      * {@inheritdoc}
      */
@@ -66,18 +62,6 @@ protected function setUp(): void
         $this->mockCleaner = $this->createMock(ResetPasswordCleaner::class);
         $this->mockResetRequest = $this->createMock(ResetPasswordRequestInterface::class);
         $this->randomToken = \bin2hex(\random_bytes(20));
-        $this->mockUser = new class() {};
-    }
-
-    private function getPasswordResetHelper(): ResetPasswordHelper
-    {
-        return new ResetPasswordHelper(
-            $this->mockTokenGenerator,
-            $this->mockCleaner,
-            $this->mockRepo,
-            99999999,
-            99999999
-        );
     }
 
     /**
@@ -98,12 +82,13 @@ public function testHasUserThrottlingReturnsFalseWithNoLastRequestDate(): void
         ;
 
         $this->mockRepo
+            ->expects($this->once())
             ->method('createResetPasswordRequest')
             ->willReturn(new ResetPasswordTestFixtureRequest())
         ;
 
         $helper = $this->getPasswordResetHelper();
-        $helper->generateResetToken($this->mockUser);
+        $helper->generateResetToken(new \stdClass());
     }
 
     /**
@@ -131,12 +116,13 @@ public function testHasUserThrottlingReturnsFalseIfNotBeforeThrottleTime(): void
         ;
 
         $this->mockRepo
+            ->expects($this->once())
             ->method('createResetPasswordRequest')
             ->willReturn(new ResetPasswordTestFixtureRequest())
         ;
 
         $helper = $this->getPasswordResetHelper();
-        $helper->generateResetToken($this->mockUser);
+        $helper->generateResetToken(new \stdClass());
     }
 
     public function testExceptionThrownIfRequestBeforeThrottleLimit(): void
@@ -157,7 +143,7 @@ public function testExceptionThrownIfRequestBeforeThrottleLimit(): void
         $this->expectException(TooManyPasswordRequestsException::class);
 
         $helper = $this->getPasswordResetHelper();
-        $helper->generateResetToken($this->mockUser);
+        $helper->generateResetToken(new \stdClass());
     }
 
     public function testRemoveResetRequestThrowsExceptionWithEmptyToken(): void
@@ -184,6 +170,7 @@ public function testRemoveResetRequestRetrievesTokenFromRepository(): void
     public function testRemoveResetRequestCallsRepositoryToRemoveResetRequestObject(): void
     {
         $this->mockRepo
+            ->expects($this->once())
             ->method('findResetPasswordRequest')
             ->willReturn($this->mockResetRequest)
         ;
@@ -252,7 +239,7 @@ public function testValidateTokenFetchesUserIfTokenNotExpired(): void
         $this->mockResetRequest
             ->expects($this->once())
             ->method('getUser')
-            ->willReturn($this->mockUser)
+            ->willReturn(new \stdClass())
         ;
 
         $this->mockResetRequest
@@ -283,7 +270,7 @@ public function testValidateTokenThrowsExceptionIfTokenAndVerifierDoNotMatch():
         $this->mockResetRequest
             ->expects($this->once())
             ->method('getUser')
-            ->willReturn($this->mockUser)
+            ->willReturn(new \stdClass())
         ;
 
         $this->mockResetRequest
@@ -306,26 +293,36 @@ public function testValidateTokenThrowsExceptionIfTokenAndVerifierDoNotMatch():
 
     public function testGenerateResetTokenCallsGarbageCollector(): void
     {
-        $this->setMockCleanerExpectations();
+        $this->mockCleaner
+            ->expects($this->once())
+            ->method('handleGarbageCollection')
+        ;
 
         $helper = $this->getPasswordResetHelper();
-        $helper->generateResetToken($this->mockUser);
+        $helper->generateResetToken(new \stdClass());
     }
 
     public function testGarbageCollectorCalledDuringValidation(): void
     {
-        $this->setMockCleanerExpectations();
+        $this->mockCleaner
+            ->expects($this->once())
+            ->method('handleGarbageCollection')
+        ;
+
         $this->expectException(InvalidResetPasswordTokenException::class);
 
         $helper = $this->getPasswordResetHelper();
         $helper->validateTokenAndFetchUser($this->randomToken);
     }
 
-    private function setMockCleanerExpectations(): void
+    private function getPasswordResetHelper(): ResetPasswordHelper
     {
-        $this->mockCleaner
-            ->expects($this->once())
-            ->method('handleGarbageCollection')
-        ;
+        return new ResetPasswordHelper(
+            $this->mockTokenGenerator,
+            $this->mockCleaner,
+            $this->mockRepo,
+            99999999,
+            99999999
+        );
     }
 }