Remove the "OddNumber" and "EveneNUmber" rules. As they are both extremely similar classes, avoid duplication by combining both rules into a single "NumberPartity" class.

Author: ultrono

README.md

@@ -48,13 +48,12 @@ Alternatively use the rule directly with a [Laravel form request object](https:/
 - [`Base64EncodedString`](#base64encodedstring)
 - [`Coordinate`](#coordinate)
 - [`DomainRestrictedEmail`](#domainrestrictedemail)
-- [`EvenNumber`](#evennumber)
 - [`ExcludesHtml`](#excludeshtml)
 - [`HexColourCode`](#hexcolourcode)
 - [`Honorific`](#honorific)
 - [`IncludesHtml`](#includeshtml)
 - [`NoWhitespace`](#nowhitespace)
-- [`OddNumber`](#oddnumber)
+- [`NumberParity`](#numberparity)
 - [`StringContains`](#stringcontains)
 - [`StrongPassword`](#strongpassword)
 - [`TitleCase`](#titlecase)
@@ -93,10 +92,6 @@ $request->validate([
 
 The validation message will include the list of whitelisted domains based upon the provided configuration.
 
-### `EvenNumber`
-
-Ensure the passed attribute is an even number.
-
 ### `ExcludesHtml`
 
 Ensure the passed attribute does not contain HTML.
@@ -133,9 +128,39 @@ Ensure the passed attribute contains HTML.
 
 Ensure the passed attribute contains no whitespace.
 
-### `OddNumber`
+### `NumberParity`
+
+Validate the number parity.
+
+An odd number:
+
+```php
+use F9Web\ValidationRules\Rules\NumberParity;
+
+// ...
+
+$request->validate([
+    'amount' => [
+        'required', 
+        (new NumberParity())->odd(),
+    ],
+]);
+``` 
+
+An even number:
+
+```php
+use F9Web\ValidationRules\Rules\NumberParity;
+
+// ...
 
-Ensure the passed attribute is an odd number.
+$request->validate([
+    'amount' => [
+        'required', 
+        (new NumberParity())->even(),
+    ],
+]);
+``` 
 
 ### `StringContains`
 

resources/lang/en/messages.php

@@ -3,8 +3,6 @@
 return [
     'uppercase'               => 'The :attribute field must only contain uppercase characters',
     'title-case'              => 'The :attribute must be in title case form',
-    'even-number'             => 'The :attribute must be an even number',
-    'odd-number'              => 'The :attribute must be an odd number',
     'domain-restricted-email' => 'The :attribute must be an email address ending with any of the following :plural: :domains',
     'excludes-html'           => 'The :attribute contains html',
     'includes-html'           => 'The :attribute must contain html',
@@ -29,4 +27,8 @@
     ],
     'u-k-mobile-phone'        => 'The :attribute must be a valid UK mobile number',
     'base64-encoded-string'   => 'The :attribute must be a valid base64 encoded string',
+    'number-parity'           => [
+        'even' => 'The :attribute must be an even number',
+        'odd'  => 'The :attribute must be an odd number',
+    ],
 ];

src/Exceptions/NumberParityException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace F9Web\ValidationRules\Exceptions;
+
+use InvalidArgumentException;
+
+class NumberParityException extends InvalidArgumentException
+{
+}

src/Rules/EvenNumber.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace F9Web\ValidationRules\Rules;
+
+use F9Web\ValidationRules\Exceptions\NumberParityException;
+use F9Web\ValidationRules\Rule;
+use function __;
+use function filter_var;
+
+class NumberParity extends Rule
+{
+    /** @var null|string */
+    protected $mode = null;
+
+    /**
+     * @param  string  $attribute
+     * @param  mixed  $value
+     * @return bool
+     * @throws NumberParityException
+     */
+    public function passes($attribute, $value): bool
+    {
+        $this->setAttribute($attribute);
+
+        if (filter_var($value, FILTER_VALIDATE_INT) === false) {
+            return false;
+        }
+
+        if (null === $this->mode) {
+            throw new NumberParityException('Ensure the "odd()" or "even()" methods are called');
+        }
+
+        return $this->mode === 'odd'
+            ? (int) $value % 2 !== 0
+            : (int) $value % 2 === 0;
+    }
+
+    /**
+     * @return $this
+     */
+    public function odd(): self
+    {
+        $this->mode = 'odd';
+
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function even(): self
+    {
+        $this->mode = 'even';
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function message(): string
+    {
+        return __(
+            'f9web-validation-rules::messages.'.$this->getMessageKey().'.'.$this->mode,
+            [
+                'attribute' => $this->getAttribute(),
+            ]
+        );
+    }
+}

src/Rules/NumberParity.php

@@ -0,0 +1,109 @@
+<?php
+
+declare(strict_types=1);
+
+namespace F9Web\ValidationRules\Tests;
+
+use F9Web\ValidationRules\Exceptions\NumberParityException;
+use F9Web\ValidationRules\Rules\NumberParity;
+use stdClass;
+
+class NumberParityTest extends TestCase
+{
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->rule = new NumberParity();
+    }
+
+    /** @test */
+    public function it_throws_an_exception_when_no_mode_is_defined()
+    {
+        $this->expectException(NumberParityException::class);
+        $this->expectExceptionMessage('Ensure the "odd()" or "even()" methods are called');
+
+        $this->rule->passes('field', 1);
+    }
+
+    /**
+     * @test
+     * @dataProvider evenNumbersDataProvider
+     * @param  mixed  $value
+     * @param  bool  $shouldBeValid
+     */
+    public function it_validates_even_numbers($value, bool $shouldBeValid)
+    {
+        $this->rule->even();
+
+        $result = $this->rule->passes('field', $value);
+
+        $this->{$shouldBeValid ? 'assertTrue' : 'assertFalse'}($result);
+    }
+
+    /**
+     * @test
+     * @dataProvider oddNumbersDataProvider
+     * @param  mixed  $value
+     * @param  bool  $shouldBeValid
+     */
+    public function it_validates_odd_numbers($value, bool $shouldBeValid)
+    {
+        $this->rule->odd();
+
+        $result = $this->rule->passes('field', $value);
+
+        $this->{$shouldBeValid ? 'assertTrue' : 'assertFalse'}($result);
+    }
+
+    /** @test */
+    public function it_passes_relevant_data_to_the_validation_message()
+    {
+        $this->rule->even();
+        $this->rule->passes('quantity', 'abc');
+        $this->assertEquals('The quantity must be an even number', $this->rule->message());
+
+        $this->rule->odd();
+        $this->assertEquals('The quantity must be an odd number', $this->rule->message());
+    }
+
+    /**
+     * @return array|\string[][]
+     */
+    public function evenNumbersDataProvider(): array
+    {
+        return [
+            ['1', false],
+            ['2', true],
+            ['100', true],
+            [-4, true],
+            [0, true],
+            [2.8, false],
+            [82, true],
+            [178, true],
+            ['232323', false],
+            [new stdClass, false],
+            [['123'], false],
+        ];
+    }
+
+    /**
+     * @return array|\string[][]
+     */
+    public function oddNumbersDataProvider(): array
+    {
+        return [
+            ['1', true],
+            ['2', false],
+            ['100', false],
+            [2.8, false],
+            [10, false],
+            ['232323', true],
+            ['-5', true],
+            [-5, true],
+            [3, true],
+            [29, true],
+            [73, true],
+        ];
+    }
+}