From b9b14c2c490e4d8ffc88ce72b0e5838ee2fcf24a Mon Sep 17 00:00:00 2001
From: v1p3r75 <elfriedv16@gmail.com>
Date: Thu, 16 Nov 2023 20:55:45 +0100
Subject: [PATCH] Added Email Rule

---
 phpunit.xml                   | 18 ++++++++++
 src/LangManager.php           |  2 ++
 src/Rules/EmailRule.php       | 64 +++++++++++++++++++++++++++++++++++
 tests/Feature/ExampleTest.php |  8 +++++
 tests/Pest.php                | 45 ++++++++++++++++++++++++
 tests/TestCase.php            | 10 ++++++
 tests/Unit/ExampleTest.php    | 14 ++++++++
 7 files changed, 161 insertions(+)
 create mode 100644 phpunit.xml
 create mode 100644 src/Rules/EmailRule.php
 create mode 100644 tests/Feature/ExampleTest.php
 create mode 100644 tests/Pest.php
 create mode 100644 tests/TestCase.php
 create mode 100644 tests/Unit/ExampleTest.php

diff --git a/phpunit.xml b/phpunit.xml
new file mode 100644
index 0000000..7d0904f
--- /dev/null
+++ b/phpunit.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+>
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <source>
+        <include>
+            <directory suffix=".php">./app</directory>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </source>
+</phpunit>
diff --git a/src/LangManager.php b/src/LangManager.php
index f7892dc..6131160 100644
--- a/src/LangManager.php
+++ b/src/LangManager.php
@@ -27,6 +27,7 @@ class LangManager
             'validation.string_rule' => "Le champ :attribute doit être une chaîne de caractères.",
             'validation.required_rule' => "Le champ :attribute est requis.",
             'validation.max_length_rule' => "Le champ :attribute ne doit pas dépasser :max caractères.",
+            'validation.email_rule' => "Le champ :attribute doit être un e-mail."
         ],
         'en' => [
             // English translations
@@ -36,6 +37,7 @@ class LangManager
             'validation.string_rule' => "The :attribute field must be a string.",
             'validation.required_rule' => "The :attribute field is required.",
             'validation.max_length_rule' => "The :attribute field must not exceed :max characters.",
+            'validation.email_rule' => "The :attribute field must be a email.",
         ],
     ];
 
diff --git a/src/Rules/EmailRule.php b/src/Rules/EmailRule.php
new file mode 100644
index 0000000..3ebb6f1
--- /dev/null
+++ b/src/Rules/EmailRule.php
@@ -0,0 +1,64 @@
+<?php
+
+/**
+ * Email - A validation rule implementation for checking if a field is a valid email
+ *
+ * @package BlakvGhost\PHPValidator\Rules
+ * @author Fortunatus KIDJE (v1p3r75)
+ * @github https://github.com/v1p3r75
+ */
+
+namespace BlakvGhost\PHPValidator\Rules;
+
+use BlakvGhost\PHPValidator\LangManager;
+
+class EmailRule implements RuleInterface
+{
+    /**
+     * Name of the field being validated.
+     *
+     * @var string
+     */
+    protected $field;
+
+    /**
+     * Constructor of the RequiredRule class.
+     *
+     * @param array $parameters Parameters for the rule, if any.
+     */
+    public function __construct(protected array $parameters)
+    {
+        // No specific logic needed in the constructor for this rule.
+    }
+
+    /**
+     * Check if the given field is a valid email.
+     *
+     * @param string $field Name of the field being validated.
+     * @param mixed $value Value of the field being validated.
+     * @param array $data All validation data.
+     * @return bool True if the field is required and not empty, false otherwise.
+     */
+    public function passes(string $field, $value, array $data): bool
+    {
+        // Set the field property for use in the message method.
+        $this->field = $field;
+
+        // Check if the field is set in the data and not empty.
+        return (bool)filter_var($value, FILTER_VALIDATE_EMAIL);
+    }
+
+    /**
+     * Get the validation error message for the required rule.
+     *
+     * @return string Validation error message.
+     */
+    public function message(): string
+    {
+        
+        // Use LangManager to get a translated validation error message.
+        return LangManager::getTranslation('validation.email_rule', [
+            'attribute' => $this->field,
+        ]);
+    }
+}
\ No newline at end of file
diff --git a/tests/Feature/ExampleTest.php b/tests/Feature/ExampleTest.php
new file mode 100644
index 0000000..711d83e
--- /dev/null
+++ b/tests/Feature/ExampleTest.php
@@ -0,0 +1,8 @@
+<?php
+
+use BlakvGhost\PHPValidator\Rules\EmailRule;
+use BlakvGhost\PHPValidator\Rules\StringRule;
+
+it('validates string rule successfully')
+    ->does(fn () => (new EmailRule([]))->passes('name', 'John', []))
+    ->assertTrue();
\ No newline at end of file
diff --git a/tests/Pest.php b/tests/Pest.php
new file mode 100644
index 0000000..5949c61
--- /dev/null
+++ b/tests/Pest.php
@@ -0,0 +1,45 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| Test Case
+|--------------------------------------------------------------------------
+|
+| The closure you provide to your test functions is always bound to a specific PHPUnit test
+| case class. By default, that class is "PHPUnit\Framework\TestCase". Of course, you may
+| need to change it using the "uses()" function to bind a different classes or traits.
+|
+*/
+
+// uses(Tests\TestCase::class)->in('Feature');
+
+/*
+|--------------------------------------------------------------------------
+| Expectations
+|--------------------------------------------------------------------------
+|
+| When you're writing tests, you often need to check that values meet certain conditions. The
+| "expect()" function gives you access to a set of "expectations" methods that you can use
+| to assert different things. Of course, you may extend the Expectation API at any time.
+|
+*/
+
+expect()->extend('toBeOne', function () {
+    return $this->toBe(1);
+});
+
+/*
+|--------------------------------------------------------------------------
+| Functions
+|--------------------------------------------------------------------------
+|
+| While Pest is very powerful out-of-the-box, you may have some testing code specific to your
+| project that you don't want to repeat in every file. Here you can also expose helpers as
+| global functions to help you to reduce the number of lines of code in your test files.
+|
+*/
+
+function something()
+{
+    // ..
+}
diff --git a/tests/TestCase.php b/tests/TestCase.php
new file mode 100644
index 0000000..cfb05b6
--- /dev/null
+++ b/tests/TestCase.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace Tests;
+
+use PHPUnit\Framework\TestCase as BaseTestCase;
+
+abstract class TestCase extends BaseTestCase
+{
+    //
+}
diff --git a/tests/Unit/ExampleTest.php b/tests/Unit/ExampleTest.php
new file mode 100644
index 0000000..0e88a22
--- /dev/null
+++ b/tests/Unit/ExampleTest.php
@@ -0,0 +1,14 @@
+<?php
+use BlakvGhost\PHPValidator\Rules\EmailRule;
+use BlakvGhost\PHPValidator\Rules\RequiredRule;
+use function PHPUnit\Framework\assertTrue;
+
+it('should validate email successfully', function() {
+
+    $result = new EmailRule([]);
+    
+    //($result);
+
+    assertTrue(true);
+
+});
\ No newline at end of file