Add string validation rules containsUppercase, containsLowercase, containsNumeral

Author: populov

.github/workflows/phpunit.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-versions: [ '7.1', '7.2', '7.3', '7.4' ]
+        php-versions: [ '7.1', '7.2', '7.3', '7.4', '8.0', '8.1' ]
     name: PHP ${{ matrix.php-versions }} - PHPUnit
     steps:
       - name: Checkout
@@ -18,7 +18,7 @@ jobs:
         with:
           php-version: ${{ matrix.php-versions }}
           coverage: xdebug
-          
+
       - name: Check PHP Version
         run: php -v
 
@@ -30,11 +30,11 @@ jobs:
 
       - name: Run test suite
         run: vendor/bin/phpunit --coverage-clover=coverage.xml
-          
+
       - name: Upload Codecov
         uses: codecov/codecov-action@v1
         with:
           file: ./coverage.xml
           flags: unittests
           fail_ci_if_error: false
-          verbose: true
+          verbose: true

CHANGES.md

@@ -1,5 +1,10 @@
 # Changes History
 
+1.2.0
+_____
++ Add String validation rules 'containsUppercase', 'containsLowercase', 'containsNumeral' - useful for password validation
+* Declared compatibility with Laravel 7,8,9
+
 1.1.0
 -----
 Compatibility with Laravel 6

composer.json

@@ -12,9 +12,9 @@
     ],
     "require": {
         "php": ">=7.0",
-        "illuminate/database": "^5.4 || ^6.0",
-        "illuminate/support": "^5.4 || ^6.0",
-        "illuminate/validation": "^5.4 || ^6.0",
+        "illuminate/database": "^5.4 || ^6.0 || ^7.0 || ^8.0 || ^9.0",
+        "illuminate/support": "^5.4 || ^6.0 || ^7.0 || ^8.0 || ^9.0",
+        "illuminate/validation": "^5.4 || ^6.0 || ^7.0 || ^8.0 || ^9.0",
         "saritasa/php-common": "^1.0",
         "propaganistas/laravel-phone": "^3.0 || ^4.0 || ^5.0"
     },

src/Rules/ContainsLowercase.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Saritasa\Laravel\Validation\Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+
+/**
+ * The rule to check for a lowercase letter in a string.
+ */
+class ContainsLowercase implements Rule
+{
+    const REGEX = '/([\p{Ll}]+)/u';
+
+    /**
+     * Determine if the validation rule passes.
+     *
+     * @param mixed $attribute The name of the attribute
+     * @param mixed $value The value of the attribute
+     *
+     * @return boolean
+     */
+    public function passes($attribute, $value): bool
+    {
+        return $attribute && preg_match(self::REGEX, $value);
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message(): string
+    {
+        return 'At least one lowercase letter';
+    }
+}

src/Rules/ContainsNumeral.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Saritasa\Laravel\Validation\Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+
+/**
+ * The rule to check for a digit in a string.
+ */
+class ContainsNumeral implements Rule
+{
+    const REGEX = '/\d/';
+
+    /**
+     * Determine if the validation rule passes.
+     *
+     * @param mixed $attribute The name of the attribute
+     * @param mixed $value The value of the attribute
+     *
+     * @return boolean
+     */
+    public function passes($attribute, $value): bool
+    {
+        return $attribute && preg_match(self::REGEX, $value);
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message(): string
+    {
+        return 'At least one numeral';
+    }
+}

src/Rules/ContainsUppercase.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Saritasa\Laravel\Validation\Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+
+/**
+ * The rule to check for a uppercase letter in a string.
+ */
+class ContainsUppercase implements Rule
+{
+    const REGEX = '/([\p{Lu}]+)/u';
+
+    /**
+     * Determine if the validation rule passes.
+     *
+     * @param mixed $attribute The name of the attribute
+     * @param mixed $value The value of the attribute
+     *
+     * @return boolean
+     */
+    public function passes($attribute, $value): bool
+    {
+        return $attribute && preg_match(self::REGEX, $value);
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message(): string
+    {
+        return 'At least one uppercase letter';
+    }
+}

src/Rules/EnumName.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+use Saritasa\Laravel\Validation\IRule;
+
+class EnumName implements Rule, IRule
+{
+    public function __toString(): string
+    {
+        // TODO: Implement __toString() method.
+    }
+
+    public function passes($attribute, $value)
+    {
+        // TODO: Implement passes() method.
+    }
+
+    public function message()
+    {
+        // TODO: Implement message() method.
+    }
+}

src/StringRuleSet.php

@@ -4,6 +4,9 @@
 
 use Illuminate\Support\Str;
 use Saritasa\Enum;
+use Saritasa\Laravel\Validation\Rules\ContainsLowercase;
+use Saritasa\Laravel\Validation\Rules\ContainsNumeral;
+use Saritasa\Laravel\Validation\Rules\ContainsUppercase;
 
 /**
  * Rules, that are reasonable for strings only
@@ -22,7 +25,7 @@
  */
 class StringRuleSet extends RuleSet
 {
-    const EXPOSED_RULES = ['email', 'regex', 'timezone', 'phoneRegex', 'enum'];
+    const EXPOSED_RULES = ['email', 'regex', 'timezone', 'phoneRegex', 'enum', ];
 
     const TRIVIAL_STRING_RULES = [
         'activeUrl',
@@ -79,6 +82,44 @@ public function enum(string $enumClass): StringRuleSet
         return $this->appendIfNotExists(Rule::in($enumClass::getConstants()));
     }
 
+    public function enumName(string $enumClass): StringRuleSet
+    {
+        if (!is_a($enumClass, Enum::class, true)) {
+            throw new \UnexpectedValueException('Class is not enum');
+        }
+        return $this->appendIfNotExists(Rule::enumName(array_keys($enumClass::getConstants())));
+    }
+
+    /**
+     * The field under validation must contain lowercase letters
+     *
+     * @return StringRuleSet
+     */
+    public function containsLowercase(): StringRuleSet
+    {
+        return $this->regex(ContainsLowercase::REGEX);
+    }
+
+    /**
+     * The field under validation must contain uppercase letters
+     *
+     * @return StringRuleSet
+     */
+    public function containsUppercase(): StringRuleSet
+    {
+        return $this->regex(ContainsUppercase::REGEX);
+    }
+
+    /**
+     * The field under validation must contain numbers
+     *
+     * @return StringRuleSet
+     */
+    public function containsNumeral(): StringRuleSet
+    {
+        return $this->regex(ContainsNumeral::REGEX);
+    }
+
     /**
      * Shortcut method for validating phone with use regex.
      * The method uses E.164 format for validation. (ex: +12345678901)

tests/EnumRulesTest.php

@@ -1,6 +1,5 @@
 <?php
 
-
 use PHPUnit\Framework\TestCase;
 use Saritasa\Laravel\Validation\Rule;
 

tests/StringRulesTest.php

@@ -24,6 +24,24 @@ public function testRegex()
         $this->assertEquals('string|regex:/^\w+[\w-\.]*\w+$/', $rules);
     }
 
+    public function testContainsLowercase()
+    {
+        $rules = Rule::string()->containsUppercase();
+        $this->assertEquals('string|regex:/([\p{Lu}]+)/u', $rules);
+    }
+
+    public function testContainsUppercase()
+    {
+        $rules = Rule::string()->containsUppercase();
+        $this->assertEquals('string|regex:/([\p{Lu}]+)/u', $rules);
+    }
+
+    public function testContainsNumeral()
+    {
+        $rules = Rule::string()->containsNumeral();
+        $this->assertEquals('string|regex:/\d/', $rules);
+    }
+
     public function testPhoneRegex()
     {
         $rules = Rule::string()->phoneRegex();