Add Enum rule

Author: populov

CHANGES.md

@@ -1,5 +1,9 @@
 # Changes History
 
+1.0.10
+------
+Enum rule. See
+
 1.0.9
 -----
 Enable Laravel's package discovery https://laravel.com/docs/5.5/packages#package-discovery

src/GenericRuleSet.php

@@ -13,13 +13,18 @@
  * @method GenericRuleSet unique(string $table, string $column, \Closure $closure = null) Get a unique constraint builder instance.
  *
  * @method StringRuleSet activeUrl() The field under validation must have a valid A or AAAA record according to the dns_get_record PHP function.
+ * @method StringRuleSet alpha() The field under validation must be entirely alphabetic characters.
+ * @method StringRuleSet alphaDash() The field under validation may have alpha-numeric characters, as well as dashes and underscores.
+ * @method StringRuleSet alphaNum() The field under validation must be entirely alpha-numeric characters.
  * @method StringRuleSet email() The field under validation must be formatted as an e-mail address.
  * @method StringRuleSet ip() The field under validation must be an IP address.
  * @method StringRuleSet ipv4() The field under validation must be an IPv4 address.
  * @method StringRuleSet ipv6() The field under validation must be an IPv6 address.
  * @method StringRuleSet json() The field under validation must be a valid JSON string.
  * @method StringRuleSet timezone() The field under validation must be a valid timezone identifier according to the timezone_identifiers_list PHP function
  * @method StringRuleSet url() The field under validation must be a valid URL.
+ * @method StringRuleSet enum(string $enumClass) Field under validation must match one of values of specified Enum
+
  * @method FileRuleSet mimetypes(string ...$types) The file under validation must match one of the given MIME types. To determine the MIME type of the uploaded file, the file's contents will be read and the framework will attempt to guess the MIME type, which may be different from the client provided MIME type.
  * @method FileRuleSet mimes(string ...$extensions) The file under validation must have a MIME type corresponding to one of the listed extensions.
  *

src/Rule.php

@@ -48,6 +48,7 @@
  * @method static StringRuleSet url() The field under validation must be a valid URL.
  * @method static StringRuleSet regex(string $pattern, bool $ignoreCase = false) The field under validation must match the given regular expression.
  * @method static StringRuleSet phoneRegex() Shortcut method for validating phone with use regex.
+ * @method static StringRuleSet enum(string $enumClass) Field under validation must match one of values of specified Enum
 
  * @method static FileRuleSet mimetypes(string ...$types) The file under validation must match one of the given MIME types. To determine the MIME type of the uploaded file, the file's contents will be read and the framework will attempt to guess the MIME type, which may be different from the client provided MIME type.
  * @method static FileRuleSet mimes(string ...$extensions) The file under validation must have a MIME type corresponding to one of the listed extensions.
@@ -144,7 +145,7 @@ public static function image($constraints = []): ImageRuleSet
      *
      * @return PhoneRuleSet
      */
-    public static function phone()
+    public static function phone(): PhoneRuleSet
     {
         return new PhoneRuleSet();
     }

src/StringRuleSet.php

@@ -3,6 +3,7 @@
 namespace Saritasa\Laravel\Validation;
 
 use Illuminate\Support\Str;
+use Saritasa\Enum;
 
 /**
  * Rules, that are reasonable for strings only
@@ -21,7 +22,7 @@
  */
 class StringRuleSet extends RuleSet
 {
-    const EXPOSED_RULES = ['email', 'regex', 'timezone', 'phoneRegex'];
+    const EXPOSED_RULES = ['email', 'regex', 'timezone', 'phoneRegex', 'enum'];
 
     const TRIVIAL_STRING_RULES = [
         'activeUrl',
@@ -44,6 +45,7 @@ public function __construct(array $rules = [])
 
     /**
      * The field under validation must match the given regular expression.
+     *
      * @param string $pattern
      * @param bool $ignoreCase
      * @return StringRuleSet
@@ -59,6 +61,21 @@ public function regex(string $pattern, bool $ignoreCase = false): StringRuleSet
         return $this->appendIfNotExists("regex:$pattern");
     }
 
+    /**
+     * Field under validation must match one of values of specified Enum
+     * @see https://github.com/Saritasa/php-common#enum
+     *
+     * @param string $enumClass Enumeration to validate against
+     * @return StringRuleSet
+     */
+    public function enum(string $enumClass): StringRuleSet
+    {
+        if (!is_a($enumClass, Enum::class, true)) {
+            throw new \UnexpectedValueException('Class is not enum');
+        }
+        return $this->appendIfNotExists(Rule::in($enumClass::getConstants()));
+    }
+
     /**
      * Shortcut method for validating phone with use regex.
      * The method uses E.164 format for validation. (ex: +12345678901)

tests/EnumRulesTest.php

@@ -0,0 +1,27 @@
+<?php
+
+
+use PHPUnit\Framework\TestCase;
+use Saritasa\Laravel\Validation\Rule;
+
+/**
+ * Check Enum rules
+ * @see https://github.com/Saritasa/php-common#enum
+ */
+class EnumRulesTest extends TestCase
+{
+    /**
+     * Basic usage
+     */
+    public function testEnum()
+    {
+        $rules = Rule::enum(\Saritasa\Enums\Gender::class)->toString();
+        $this->assertEquals('string|in:"Male","Female"', $rules);
+    }
+
+    public function testNonExistingEnum()
+    {
+        $this->expectException(\UnexpectedValueException::class);
+        Rule::enum("bullshit");
+    }
+}

tests/RuleTest.php

@@ -5,6 +5,7 @@
 use Illuminate\Support\Str;
 use PHPUnit\Framework\TestCase;
 use Saritasa\Enums\Gender;
+use Saritasa\Exceptions\NotImplementedException;
 use Saritasa\Laravel\Validation\Rule;
 use Saritasa\Laravel\Validation\RuleSet;
 
@@ -105,4 +106,14 @@ public function testMixed()
         $rules = Rule::requiredWithout('facebook_token')->confirmed();
         $this->assertEquals('required_without:facebook_token|confirmed',  $rules);
     }
+
+
+    /**
+     * Requesting non-registered rule should throw "Not Implemented" exception
+     */
+    public function testNonExistent()
+    {
+        $this->expectException(NotImplementedException::class);
+        Rule::nonExistent();
+    }
 }