add email assertions

Author: Gummibeer

composer.json

@@ -20,6 +20,7 @@
         "phpunit/phpunit": "^9.1"
     },
     "require-dev": {
+        "egulias/email-validator": "^2.1 || ^3.0",
         "giggsey/libphonenumber-for-php": "^8.12",
         "hashids/hashids": "^4.0",
         "league/iso3166": "^2.1 || ^3.0",
@@ -28,6 +29,7 @@
         "vinkla/hashids": "^9.0"
     },
     "suggest": {
+        "egulias/email-validator": "\\Astrotomic\\PhpunitAssertions\\EmailAssertions (^2.1 || ^3.0)",
         "giggsey/libphonenumber-for-php": "\\Astrotomic\\PhpunitAssertions\\PhoneNumberAssertions (^8.12)",
         "hashids/hashids": "\\Astrotomic\\PhpunitAssertions\\HashidAssertions (^4.0)",
         "league/iso3166": "\\Astrotomic\\PhpunitAssertions\\CountryAssertions (^2.1 || ^3.0)",
@@ -48,5 +50,12 @@
         }
     },
     "minimum-stability": "dev",
-    "prefer-stable": true
+    "prefer-stable": true,
+    "scripts": {
+        "post-autoload-dump": [
+            "@composer validate --strict --ansi --no-interaction --quiet",
+            "@composer normalize --ansi --no-interaction --quiet",
+            "@composer thanks --ansi --no-interaction --quiet"
+        ]
+    }
 }

src/EmailAssertions.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Astrotomic\PhpunitAssertions;
+
+use Egulias\EmailValidator\EmailValidator;
+use Egulias\EmailValidator\Validation\RFCValidation;
+use PHPUnit\Framework\Assert as PHPUnit;
+
+trait EmailAssertions
+{
+    public static function assertValidLoose($actual): void
+    {
+        PHPUnit::assertIsString($actual);
+        PHPUnit::assertNotFalse(filter_var($actual, FILTER_VALIDATE_EMAIL));
+    }
+
+    public static function assertValidStrict($actual): void
+    {
+        PHPUnit::assertIsString($actual);
+        PHPUnit::assertTrue((new EmailValidator())->isValid($actual, new RFCValidation()));
+    }
+
+    public static function assertSameDomain(string $expected, $actual): void
+    {
+        PHPUnit::assertIsString($actual);
+        [, $domain] = explode('@', $actual, 2);
+        PHPUnit::assertSame($expected, $domain);
+    }
+
+    public static function assertSameLocalPart(string $expected, $actual): void
+    {
+        PHPUnit::assertIsString($actual);
+        [$localPart] = explode('@', $actual, 2);
+        PHPUnit::assertSame($expected, $localPart);
+    }
+}

tests/EmailAssertionsTest.php

@@ -0,0 +1,46 @@
+<?php
+
+namespace Astrotomic\PhpunitAssertions\Tests;
+
+use Astrotomic\PhpunitAssertions\EmailAssertions;
+
+final class EmailAssertionsTest extends TestCase
+{
+    /**
+     * @test
+     * @dataProvider hundredTimes
+     */
+    public static function it_can_validate_loose(): void
+    {
+        EmailAssertions::assertValidLoose(self::randomString().'@email.com');
+    }
+
+    /**
+     * @test
+     * @dataProvider hundredTimes
+     */
+    public static function it_can_validate_strict(): void
+    {
+        EmailAssertions::assertValidStrict(self::randomString().'@email.com');
+    }
+
+    /**
+     * @test
+     * @dataProvider hundredTimes
+     */
+    public static function it_can_validate_same_domain(): void
+    {
+        EmailAssertions::assertSameDomain('email.com', self::randomString().'@email.com');
+    }
+
+    /**
+     * @test
+     * @dataProvider hundredTimes
+     */
+    public static function it_can_validate_same_local_part(): void
+    {
+        $localPart = self::randomString();
+
+        EmailAssertions::assertSameLocalPart($localPart, $localPart.'@email.com');
+    }
+}