Add slug rule

Author: natanfelles

guide/index.rst

@@ -252,6 +252,7 @@ The available rules are:
 - `optional`_
 - `regex`_
 - `required`_
+- `slug`_
 - `specialChar`_
 - `string`_
 - `timezone`_
@@ -775,6 +776,15 @@ The field is required.
 
     required
 
+slug
+####
+
+The field requires a valid slug.
+
+.. code-block::
+
+    slug
+
 specialChar
 ###########
 

src/Languages/en/validation.php

@@ -59,4 +59,5 @@
     'int' => 'The {field} field requires an integer.',
     'object' => 'The {field} field requires an object.',
     'string' => 'The {field} field requires a string.',
+    'slug' => 'The {field} field requires a valid slug.',
 ];

src/Languages/es/validation.php

@@ -59,4 +59,5 @@
     'int' => 'El campo {field} requiere un número entero.',
     'object' => 'El campo {field} requiere un objeto.',
     'string' => 'El campo {field} requiere un texto.',
+    'slug' => 'El campo {field} requiere una slug válida.',
 ];

src/Languages/pt-br/validation.php

@@ -59,4 +59,5 @@
     'int' => 'O campo {field} requer um número inteiro.',
     'object' => 'O campo {field} requer um objeto.',
     'string' => 'O campo {field} requer uma string.',
+    'slug' => 'O campo {field} requer uma slug válida.',
 ];

src/Traits/Validator.php

@@ -486,6 +486,19 @@ public function string() : static
         return $this;
     }
 
+    /**
+     * Validates slug.
+     *
+     * @since 2.6
+     *
+     * @return static
+     */
+    public function slug() : static
+    {
+        $this->rules[] = 'slug';
+        return $this;
+    }
+
     /**
      * Validates special characters.
      *

src/Validator.php

@@ -688,6 +688,22 @@ public static function string(string $field, array $data) : bool
         return \is_string(ArraySimple::value($field, $data));
     }
 
+    /**
+     * Validates slug.
+     *
+     * @param string $field
+     * @param array<string,mixed> $data
+     *
+     * @since 2.6
+     *
+     * @return bool
+     */
+    public static function slug(string $field, array $data) : bool
+    {
+        $data = static::getData($field, $data);
+        return $data !== null && \preg_match('/^([a-z0-9_-]+)$/', $data) === 1;
+    }
+
     /**
      * Validates special characters.
      *

tests/RulesTest.php

@@ -351,6 +351,11 @@ public function testRuleString() : void
         self::assertRule('string', $this->rules->string());
     }
 
+    public function testRuleSlug() : void
+    {
+        self::assertRule('slug', $this->rules->slug());
+    }
+
     protected static function assertRule(string $rule, Rules $rules) : void
     {
         self::assertSame($rule, (string) $rules);

tests/ValidatorTest.php

@@ -372,6 +372,29 @@ public function testString() : void
         self::assertTrue(Validator::string('string', $this->array));
     }
 
+    public function testSlug() : void
+    {
+        $data = [
+            'a' => 'abc-123',
+            'b' => '123-abc',
+            'c' => '--__',
+            'd' => ' ',
+            'e' => 'coração',
+            'f' => 'foo@bar',
+            'g' => 'a 1',
+            'h' => '',
+        ];
+        self::assertTrue(Validator::slug('a', $data));
+        self::assertTrue(Validator::slug('b', $data));
+        self::assertTrue(Validator::slug('c', $data));
+        self::assertFalse(Validator::slug('d', $data));
+        self::assertFalse(Validator::slug('e', $data));
+        self::assertFalse(Validator::slug('f', $data));
+        self::assertFalse(Validator::slug('g', $data));
+        self::assertFalse(Validator::slug('h', $data));
+        self::assertFalse(Validator::slug('undefined', $data));
+    }
+
     public function testSpecialChar() : void
     {
         $data = [