diff --git a/.github/workflows/tag_meged_pull_request.yml b/.github/workflows/tag_meged_pull_request.yml new file mode 100644 index 0000000..044bba3 --- /dev/null +++ b/.github/workflows/tag_meged_pull_request.yml @@ -0,0 +1,61 @@ +name: Set Tag to Merged Pull Request + +on: + pull_request: + branches: + - main + types: + - closed + +jobs: + set-tag: + name: Get tags, Check and Set tag + runs-on: ubuntu-latest + permissions: + contents: write + + steps: + - name: Set up PHP + uses: shivammathur/setup-php@v2 + with: + php-version: 8.2 + coverage: xdebug + tools: composer:v2 + + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: PHP Version Check + run: php -v + + - name: Validate Composer JSON + run: composer validate + + - name: Get Version From Comopser JSON + id: new-version + run: | + echo version=$(cat composer.json | grep version | head -1 | grep -Po '\d+\.\d+\.\d+') >> $GITHUB_OUTPUT + + - name: Show New Version + run: echo "version=${{ steps.new-version.outputs.version}}" + + - name: Show Tags + run: git tag + + - name: Check If The Version Is Not In The Tag List + run: | + for tag in `git tag` + do + if [ $tag = ${{ steps.new-version.outputs.version }} ]; then + echo "version ${{ steps.new-version.outputs.version }} already exists." + exit 1 + fi + done + echo "[OK.]" + + - name: Set tag + run: | + git tag ${{ steps.new-version.outputs.version }} + git push origin ${{ steps.new-version.outputs.version }} diff --git a/.github/workflows/test_pull_request.yml b/.github/workflows/test_pull_request.yml new file mode 100644 index 0000000..850bb48 --- /dev/null +++ b/.github/workflows/test_pull_request.yml @@ -0,0 +1,150 @@ +name: Test and Static Analysis (Pull Request) + +on: pull_request + +jobs: + check-version-in-composer-json: + name: Check Version + runs-on: ubuntu-latest + + steps: + - name: Set up PHP + uses: shivammathur/setup-php@v2 + with: + php-version: 8.2 + tools: composer:v2 + + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: PHP Version Check + run: php -v + + - name: Validate Composer JSON + run: composer validate + + - name: Get Version From Comopser JSON + id: new-version + run: | + echo version=$(cat composer.json | grep version | head -1 | grep -Po '\d+\.\d+\.\d+') >> $GITHUB_OUTPUT + + - name: Show New Version + run: echo "version=${{ steps.new-version.outputs.version }}" + + - name: Show Tags + run: git tag + + - name: Check If The Version Is Not In The Tag List + run: | + for tag in `git tag` + do + if [ $tag = ${{ steps.new-version.outputs.version }} ]; then + echo "version ${{ steps.new-version.outputs.version }} already exists." + exit 1 + fi + done + echo "OK." + + test-and-static-analysis: + name: Test and Lint + runs-on: ubuntu-latest + strategy: + matrix: + php: ['8.2', '8.3'] + + steps: + - name: Set up PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + coverage: xdebug + tools: composer:v2 + + - name: Set up Node + uses: actions/setup-node@v4 + with: + node-version: '14.x' + + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: PHP Version Check + run: php -v + + - name: Validate Composer JSON + run: composer validate + + - name: Run Composer Install + id: composerinstall + run: composer install --no-interaction + + - name: PHP Lint + run: ./vendor/bin/parallel-lint src tests examples + +# - name: Neon Lint +# run: ./vendor/nette/neon/bin/neon-lint conf + + - name: PHP MD + run: | + ./vendor/bin/phpmd --version + ./vendor/bin/phpmd ./src/ ./examples/ ./tests/ text phpmd.xml + + - name: PHP Code Sniffer + run: | + ./vendor/bin/phpcs --version + ./vendor/bin/phpcs --ignore=vendor --standard=phpcs.xml -s -p . + + - name: PHPStan + run: | + ./vendor/bin/phpstan --version + ./vendor/bin/phpstan analyze -c phpstan.neon + + - name: Unit tests + run: | + mkdir -p build/logs + ./vendor/bin/phpunit --version + echo "Test suite All" + ./vendor/bin/phpunit ./tests/ + + code-coverage: + name: Code coverage + runs-on: ubuntu-latest + strategy: + matrix: + php: ['8.2'] + + steps: + - name: Set up PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php }} + coverage: xdebug + tools: composer:v2 + + - name: Set up Node + uses: actions/setup-node@v4 + with: + node-version: '14.x' + + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Run Composer + run: composer install --no-interaction + + - name: Update PHPUnit for Code Coverage + run: composer require phpunit/phpunit:^11.1 sebastian/version:* --with-all-dependencies + + - name: PHP Lint + run: ./vendor/bin/parallel-lint src tests examples + + - name: Unit tests + run: | + mkdir -p build/logs + XDEBUG_MODE=coverage ./vendor/bin/phpunit ./tests/ --coverage-clover build/logs/clover.xml --coverage-filter=./src/ diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2239292 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +vendor/ +composer.lock +.php-version +build/ +node_modules/ +storage/ diff --git a/PHP_VERSIONS b/PHP_VERSIONS new file mode 100644 index 0000000..9e069ce --- /dev/null +++ b/PHP_VERSIONS @@ -0,0 +1,2 @@ +8.3 +8.2 diff --git a/README.md b/README.md index eff5f67..8e75066 100644 --- a/README.md +++ b/README.md @@ -1 +1,193 @@ -# purephp-validation \ No newline at end of file +# Purephp Validation + +## 1. Features + +`Purephp Validation` is a standalone library to use the [Illuminate\Validation](https://github.com/illuminate/validation) package outside the Laravel framework. + +This library is based on [jeffochoa/validator-factory](https://github.com/jeffochoa/validator-factory), + +This library is customized to use with static calls, like a Laravel Facade: + +```php +$validator = Validator::make( + $data, + $rules, + $messages, + $attributes, +); +``` + +It also supports `Password` rule object and `File` rule object. + +```php +$validator = Validator::make( + data: $data, + rules: [ + 'password' => [ + 'required', + Password::min(8), + ], + 'attachment' => [ + 'required', + File::image(), + ], + ]; +); +``` + +## 2. Contents + +- [1. Features](#1-features) +- 2\. Contents +- [3. Requirements](#3-requirements) +- [4. Installation](#4-installation) +- [5. Usage](#5-usage) + - [5.1. Basic Usage](#51-basic-usage) + - [5.2. Setting Traslations Root Path and Language](#52-setting-translations-root-path-and-language) + - [5.3. Using Passowrd Rule Object](#53-using-password-rule-object) + - [5.4. Using File Rule Object](#54-using-file-rule-object) +- [6. Examples](#6-examples) +- [7. LICENSE](#7-license) + +## 3. Requirements + +- PHP 8.2 or later +- Composer installed + +## 4. Installation + +```bash +composer require macocci7/purephp-validation +``` + +## 5. Usage + +### 5.1. Basic Usage + +First, import `autoload.php` into your code (in `src/` folder) like this: + +```php +require_once __DIR__ . '/../vendor/autoload.php'; +``` + +Then, create a new instance of the `Illuminate\Validation\Validator` as follows: + +```php +use Macocci7\PurephpValidation\ValidatorFactory as Validator; + +$validator = Validator::make( + data: [ + 'name' => 'foo', + 'email' => 'foo@example.com', + 'password' => 'Passw0rd', + ], + rules: [ + 'name' => 'required|string|min:3|max:40', + 'email' => 'required|email:rfc', + 'password' => 'required|string|min:8|max:16', + ], +); +``` + +Now, you can check the validation results: + +```php +if ($validator->fails()) { + var_dump($validator->errors()->message); +} else { + echo "🎊 Passed 🎉" . PHP_EOL; +} +``` + +You can learn more about writing validation rules at the [Laravel Official Documentation](https://laravel.com/docs/11.x/validation#quick-writing-the-validation-logic). + +Here's also an example code for basic usage: [BasicUsage.php](examples/BasicUsage.php) + +### 5.2. Setting Translations Root Path and Language + +You'll probably want to place the `lang` folder somewhere else outside of `vendor/`. + +You can set the Translations Root Path before creating an instance of `Validator`: + +```php +// Set Translations Root Path (optional) +// - The path must end with '/'. +// - 'lang/' folder must be placed under the path. +Validator::translationsRootPath(__DIR__ . '/'); +``` + +Here's an example code for setting Translations Root Path and Language: [SetTranslationsRootPath.php](examples/SetTranslationsRootPath.php) + +You can also set the Language before creating an instance of `Validator`: +```php +// Set lang: 'en' as default (optional) +Validator::lang('ja'); +``` + +Here's an example code for setting Language: [SetLang.php](examples/SetLang.php) + +### 5.3. Using Password Rule Object + +You can validate passwords using Laravel's `Password` rule object. + +```php +use Macocci7\PurephpValidation\Rules\PasswordWrapper as Password; + +$validator = Validator::make( + data: [ 'password' => 'pass' ], + rules: [ + 'password' => [ + 'required', + Password::min(8), + ], + ], +); +``` + +You can learn more about Laravel's `Password` rule object at the [Laravel Official Document](https://laravel.com/docs/11.x/validation#validating-passwords). + +Here's an example code for using `Password` rule object: [ValidatePassword.php](examples/ValidatePassword.php) + +### 5.4. Using File Rule Object + +You can validate files using Laravel's `File` rule object. + +```php +use Macocci7\PurephpValidation\Rules\FileWrapper as File; +use Symfony\Component\HttpFoundation\File\File as SymfonyFile; + +$path = __DIR__ . '/../storage/uploaded/foo.jpg'; + +$validator = Validator::make( + data: [ + 'photo' => new SymfonyFile($path), + ], + rules: [ + 'photo' => [ + 'required', + File::image() + ->max(1024), // kilo bytes + ], + ], +); +``` + +You can learn more about Laravel's `File` rule object at the [Laravel Official Document](https://laravel.com/docs/11.x/validation#validating-files). + +Here's an example code for using Laravel's `File` rule object: [ValidateFile.php](examples/ValidateFile.php) + +## 6. Examples + +- [BasicUsage.php](examples/BasicUsage.php) +- [SetTranslationsRootPath.php](examples/SetTranslationsRootPath.php) +- [SetLang.php](examples/SetLang.php) +- [ValidatePassword.php](examples/ValidatePassword.php) +- [ValidateFile.php](examples/ValidateFile.php) + +## 7. LICENSE + +[MIT](LICENSE) + +*** + +*Copyright 2024 macocci7* diff --git a/bin/CheckVersion.sh b/bin/CheckVersion.sh new file mode 100644 index 0000000..48f03e1 --- /dev/null +++ b/bin/CheckVersion.sh @@ -0,0 +1,35 @@ +#!/usr/bin/bash + +# Script to check +# if the version in composer.json +# is not in git tags + +if [ ! -r composer.json ]; then + echo "composer.json not found." + echo "operation aborted." + exit 1 +fi + +VERSION=$(cat composer.json | grep version | head -1 | grep -Po '\d+\.\d+\.\d+') +printf 'version in composer.json: \033[1;33m%s\033[m\n' $VERSION + + +show_latest_tags() { + echo "The latest $1 tags are:" + for tag in `git tag | sort | tail -$1` + do + printf '\033[93m%s\033[m\n' $tag + done +} + +for tag in `git tag` +do + if [ $tag = $VERSION ]; then + printf '\033[41m Error! version %s already exists in git tags. \033[m\n' $VERSION + show_latest_tags 3 + exit 1 + fi +done +printf '\033[1;102m%s\033[m\n' " OK! versoin $VERSION is not in git tags. " +show_latest_tags 3 +printf '\033[93m%s\033[m\n' "Don't forget to run \`composer update\` before commit." diff --git a/bin/TestAndLint.sh b/bin/TestAndLint.sh new file mode 100644 index 0000000..f8f3e50 --- /dev/null +++ b/bin/TestAndLint.sh @@ -0,0 +1,79 @@ +#!/usr/bin/bash + +# Script to Test and Lint +# - for the repository: macocci7/purephp-validation +# requirement: +# - phpenv/phpenv +# - PHP versions defined in ../PHP_VERSIONS installed + +CMD=phpenv +$CMD -v &> /dev/null +if [ $? -ne 0 ]; then + echo "command [${CMD}] not found!" + exit 1 +fi +echo "-----------------------------------------------------------" +echo "[composer validate]" +composer validate +if [ $? -ne 0 ]; then + echo "Operation aborted." + exit 1 +fi + +test_and_lint() { + echo "===========================================================" + echo "[PHP $1][phpenv local $1]" + phpenv local $1 + if [ $? -ne 0 ]; then + echo "Failed to switch version to $i. skipped." + return 1 + fi + echo "-----------------------------------------------------------" + echo "[PHP $1][php -v]" + php -v + echo "-----------------------------------------------------------" + echo "[PHP $1][parallel-lint]" + ./vendor/bin/parallel-lint src tests examples + echo "-----------------------------------------------------------" + #echo "[PHP $1][neon-lint]" + #./vendor/nette/neon/bin/neon-lint conf + #echo "-----------------------------------------------------------" + echo "[PHP $1][phpcs]" + ./vendor/bin/phpcs --ignore=vendor \ + --standard=phpcs.xml \ + -p \ + -s \ + . + echo "-----------------------------------------------------------" + echo "[PHP $1][phpmd]" + ./vendor/bin/phpmd \ + ./src/ ./examples/ ./tests/ text \ + phpmd.xml + echo "-----------------------------------------------------------" + echo "[PHP $1][phpstan]" + ./vendor/bin/phpstan analyze -c phpstan.neon + echo "-----------------------------------------------------------" + echo "[PHP $1][phpunit]" + ./vendor/bin/phpunit ./tests/ \ + --color=auto + echo "-----------------------------------------------------------" +} + +echo "[[TesAndLint.sh]]" + +SUPPORTED_PHP_VERSIONS=PHP_VERSIONS +if [ ! -f $SUPPORTED_PHP_VERSIONS ]; then + echo "file [$SUPPORTED_PHP_VERSIONS] not found." + echo "operation aborted." + exit 1 +fi +if [ ! -r $SUPPORTED_PHP_VERSIONS ]; then + echo "cannot read file[$SUPPORTED_PHP_VERSIONS]." + echo "operation aborted." + exit 1 +fi +STR_CMD='' +while read version ; do + STR_CMD="$STR_CMD test_and_lint $version;" +done < $SUPPORTED_PHP_VERSIONS +eval $STR_CMD diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..1e9db7a --- /dev/null +++ b/composer.json @@ -0,0 +1,30 @@ +{ + "name": "macocci7/purephp-validation", + "description": "illuminate/validation wrapper for pure php.", + "version": "0.0.1", + "type": "library", + "license": "MIT", + "autoload": { + "psr-4": { + "Macocci7\\PurephpValidation\\": "src/" + } + }, + "authors": [ + { + "name": "macocci7", + "email": "macocci7@yahoo.co.jp" + } + ], + "minimum-stability": "stable", + "require": { + "php": ">=8.2", + "illuminate/validation": "^11.5" + }, + "require-dev": { + "squizlabs/php_codesniffer": "^3.9", + "phpunit/phpunit": "^11.1", + "phpmd/phpmd": "^2.15", + "php-parallel-lint/php-parallel-lint": "^1.4", + "phpstan/phpstan": "^1.10" + } +} diff --git a/examples/BasicUsage.php b/examples/BasicUsage.php new file mode 100644 index 0000000..b233ddb --- /dev/null +++ b/examples/BasicUsage.php @@ -0,0 +1,29 @@ + 'fo', + 'email' => 'foo', + 'password' => 'pass', +]; + +// Valiation Rules +$rules = [ + 'name' => 'required|string|min:3|max:10', + 'email' => 'required|string|email:rfc,dns', + 'password' => 'required|string|min:8|max:16', +]; + +// Validation +$validator = Validator::make($user, $rules); + +// Checking Result +if ($validator->fails()) { + var_dump($validator->errors()->messages()); +} else { + echo "🎊 Passed 🎉" . PHP_EOL; +} diff --git a/examples/SetLang.php b/examples/SetLang.php new file mode 100644 index 0000000..d0ebd1d --- /dev/null +++ b/examples/SetLang.php @@ -0,0 +1,36 @@ + 'fo', + 'email' => 'foo', + 'pionts' => -1, +]; + +// Valiation Rules +$rules = [ + 'name' => 'required|string|min:3|max:10', + 'email' => 'required|string|email:rfc,dns', + 'pionts' => 'required|int|min:1', +]; + +// Set Tranlations Root Path +// - 'lang/' folder must be placed under the path. +Validator::translationsRootPath(__DIR__ . '/'); + +// Set lang: 'en' as default +Validator::lang('ja'); + +// Validation +$validator = Validator::make($user, $rules); + +// Checking result +if ($validator->fails()) { + var_dump($validator->errors()->messages()); +} else { + echo "🎊 Passed 🎉" . PHP_EOL; +} diff --git a/examples/SetTranslationsRootPath.php b/examples/SetTranslationsRootPath.php new file mode 100644 index 0000000..d0ebd1d --- /dev/null +++ b/examples/SetTranslationsRootPath.php @@ -0,0 +1,36 @@ + 'fo', + 'email' => 'foo', + 'pionts' => -1, +]; + +// Valiation Rules +$rules = [ + 'name' => 'required|string|min:3|max:10', + 'email' => 'required|string|email:rfc,dns', + 'pionts' => 'required|int|min:1', +]; + +// Set Tranlations Root Path +// - 'lang/' folder must be placed under the path. +Validator::translationsRootPath(__DIR__ . '/'); + +// Set lang: 'en' as default +Validator::lang('ja'); + +// Validation +$validator = Validator::make($user, $rules); + +// Checking result +if ($validator->fails()) { + var_dump($validator->errors()->messages()); +} else { + echo "🎊 Passed 🎉" . PHP_EOL; +} diff --git a/examples/ValidateFile.php b/examples/ValidateFile.php new file mode 100644 index 0000000..0472234 --- /dev/null +++ b/examples/ValidateFile.php @@ -0,0 +1,62 @@ + basename($path), + 'photo' => new SymfonyFile($path), +]; + +// Rules +$rules = [ + 'filename' => 'required|string|max:255', + 'photo' => [ + 'required', + File::image() + //File::types(['jpg', 'png']) + ->min(10) + ->max(144) + ->dimensions( + Rule::dimensions()->maxWidth(200)->maxHeight(300) + ), + ], +]; + +// Messages +$messages = [ + 'photo.required' => 'I want your :attribute 💖', + 'photo.image' => 'I want :attribute as an image💖', + 'photo.mimes' => ':attribute must be a type of: :values 💖', + 'photo.min' => ':attribute expected to be at least :min KB💖', + 'photo.max' => ':attribute expected to be at most :max KB💖', + 'photo.between' => ':attribute expected to be between :min KB and :max KB💖', + 'photo.dimensions' => ':attribute expected within the size of :max_width x :max_height in pixcels.💖', +]; + +// Attributes +$attributes = [ + 'filename' => 'File Name', + 'photo' => 'Your Photo', +]; + +// Creating an instance +$validator = Validator::make( + data: $input, + rules: $rules, + messages: $messages, + attributes: $attributes +); + +// Checking result +if ($validator->fails()) { + var_dump($validator->errors()->messages()); +} else { + echo "🎊 Passed 🎉" . PHP_EOL; +} diff --git a/examples/ValidatePassword.php b/examples/ValidatePassword.php new file mode 100644 index 0000000..fefb955 --- /dev/null +++ b/examples/ValidatePassword.php @@ -0,0 +1,54 @@ + 'foo bar', + 'email' => 'foo-bar@example.com', + 'password' => 'foo', +]; + +// Valiation Rules +$rules = [ + 'name' => 'required|string|min:3|max:10', + 'email' => 'required|string|email:rfc', + 'password' => [ + 'required', + Password::min(8) + ->max(16) + ->letters() + ->mixedCase() + ->numbers() + ->symbols() + ->uncompromised(), + ], +]; + +// Messages +$messages = [ + 'password.mixed' => 'Password must include at least one uppercase and one lowercase letter.', + 'password.numbers' => 'Password must include at least one number.', + 'password.symbols' => 'Password must include at least one symbol.', +]; + +// Attributes +$attributes = []; + +// Validation +$validator = Validator::make( + data: $user, + rules: $rules, + messages: $messages, + attributes: $attributes +); + +// Checking Result +if ($validator->fails()) { + var_dump($validator->errors()->messages()); +} else { + echo "🎊 Passed 🎉" . PHP_EOL; +} diff --git a/examples/lang/en/validation.php b/examples/lang/en/validation.php new file mode 100644 index 0000000..c2a34e4 --- /dev/null +++ b/examples/lang/en/validation.php @@ -0,0 +1,68 @@ + 'The :attribute must be accepted.', + 'active_url' => 'The :attribute is not a valid URL.', + 'after' => 'The :attribute must be a date after :date.', + 'alpha' => 'The :attribute may only contain letters.', + 'alpha_dash' => 'The :attribute may only contain letters, numbers, and dashes.', + 'alpha_num' => 'The :attribute may only contain letters and numbers.', + 'array' => 'The :attribute must be an array.', + 'before' => 'The :attribute must be a date before :date.', + 'between' => [ + 'numeric' => 'The :attribute must be between :min and :max.', + 'file' => 'The :attribute must be between :min and :max kilobytes.', + 'string' => 'The :attribute must be between :min and :max characters.', + 'array' => 'The :attribute must have between :min and :max items.', + ], + 'boolean' => 'The :attribute field must be true or false.', + 'confirmed' => 'The :attribute confirmation does not match.', + 'date' => 'The :attribute is not a valid date.', + 'date_format' => 'The :attribute does not match the format :format.', + 'different' => 'The :attribute and :other must be different.', + 'digits' => 'The :attribute must be :digits digits.', + 'digits_between' => 'The :attribute must be between :min and :max digits.', + 'email' => 'The :attribute must be a valid email address.', + 'exists' => 'The selected :attribute is invalid.', + 'filled' => 'The :attribute field is required.', + 'image' => 'The :attribute must be an image.', + 'in' => 'The selected :attribute is invalid.', + 'integer' => 'The :attribute must be an integer.', + 'ip' => 'The :attribute must be a valid IP address.', + 'json' => 'The :attribute must be a valid JSON string.', + 'max' => [ + 'numeric' => 'The :attribute may not be greater than :max.', + 'file' => 'The :attribute may not be greater than :max kilobytes.', + 'string' => 'The :attribute may not be greater than :max characters.', + 'array' => 'The :attribute may not have more than :max items.', + ], + 'mimes' => 'The :attribute must be a file of type: :values.', + 'min' => [ + 'numeric' => 'The :attribute must be at least :min.', + 'file' => 'The :attribute must be at least :min kilobytes.', + 'string' => 'The :attribute must be at least :min characters.', + 'array' => 'The :attribute must have at least :min items.', + ], + 'not_in' => 'The selected :attribute is invalid.', + 'numeric' => 'The :attribute must be a number.', + 'present' => 'The :attribute field must be present.', + 'regex' => 'The :attribute format is invalid.', + 'required' => 'The :attribute field is required.', + 'required_if' => 'The :attribute field is required when :other is :value.', + 'required_unless' => 'The :attribute field is required unless :other is in :values.', + 'required_with' => 'The :attribute field is required when :values is present.', + 'required_with_all' => 'The :attribute field is required when :values is present.', + 'required_without' => 'The :attribute field is required when :values is not present.', + 'required_without_all' => 'The :attribute field is required when none of :values are present.', + 'same' => 'The :attribute and :other must match.', + 'size' => [ + 'numeric' => 'The :attribute must be :size.', + 'file' => 'The :attribute must be :size kilobytes.', + 'string' => 'The :attribute must be :size characters.', + 'array' => 'The :attribute must contain :size items.', + ], + 'string' => 'The :attribute must be a string.', + 'timezone' => 'The :attribute must be a valid zone.', + 'unique' => 'The :attribute has already been taken.', + 'url' => 'The :attribute format is invalid.' +]; diff --git a/examples/lang/ja/validation.php b/examples/lang/ja/validation.php new file mode 100644 index 0000000..12407a4 --- /dev/null +++ b/examples/lang/ja/validation.php @@ -0,0 +1,151 @@ + ':attributeを承認してください。', + 'active_url' => ':attributeが有効なURLではありません。', + 'after' => ':attributeには、:dateより後の日付を指定してください。', + 'after_or_equal' => ':attributeには、:date以降の日付を指定してください。', + 'alpha' => ':attributeはアルファベットのみがご利用できます。', + 'alpha_dash' => ':attributeはアルファベットとダッシュ(-)及び下線(_)がご利用できます。', + 'alpha_num' => ':attributeはアルファベット数字がご利用できます。', + 'array' => ':attributeは配列でなくてはなりません。', + 'before' => ':attributeには、:dateより前の日付をご利用ください。', + 'before_or_equal' => ':attributeには、:date以前の日付をご利用ください。', + 'between' => [ + 'numeric' => ':attributeは、:minから:maxの間で指定してください。', + 'file' => ':attributeは、:min kBから、:max kBの間で指定してください。', + 'string' => ':attributeは、:min文字から、:max文字の間で指定してください。', + 'array' => ':attributeは、:min個から:max個の間で指定してください。', + ], + 'boolean' => ':attributeは、trueかfalseを指定してください。', + 'confirmed' => ':attributeと、確認フィールドとが、一致していません。', + 'date' => ':attributeには有効な日付を指定してください。', + 'date_equals' => ':attributeには、:dateと同じ日付けを指定してください。', + 'date_format' => ':attributeは:format形式で指定してください。', + 'different' => ':attributeと:otherには、異なった内容を指定してください。', + 'digits' => ':attributeは:digits桁で指定してください。', + 'digits_between' => ':attributeは:min桁から:max桁の間で指定してください。', + 'dimensions' => ':attributeの図形サイズが正しくありません。', + 'distinct' => ':attributeには異なった値を指定してください。', + 'email' => ':attributeには、有効なメールアドレスを指定してください。', + 'ends_with' => ':attributeには、:valuesのどれかで終わる値を指定してください。', + 'exists' => '選択された:attributeは正しくありません。', + 'file' => ':attributeにはファイルを指定してください。', + 'filled' => ':attributeに値を指定してください。', + 'gt' => [ + 'numeric' => ':attributeには、:valueより大きな値を指定してください。', + 'file' => ':attributeには、:value kBより大きなファイルを指定してください。', + 'string' => ':attributeは、:value文字より長く指定してください。', + 'array' => ':attributeには、:value個より多くのアイテムを指定してください。', + ], + 'gte' => [ + 'numeric' => ':attributeには、:value以上の値を指定してください。', + 'file' => ':attributeには、:value kB以上のファイルを指定してください。', + 'string' => ':attributeは、:value文字以上で指定してください。', + 'array' => ':attributeには、:value個以上のアイテムを指定してください。', + ], + 'image' => ':attributeには画像ファイルを指定してください。', + 'in' => '選択された:attributeは正しくありません。', + 'in_array' => ':attributeには:otherの値を指定してください。', + 'integer' => ':attributeは整数で指定してください。', + 'ip' => ':attributeには、有効なIPアドレスを指定してください。', + 'ipv4' => ':attributeには、有効なIPv4アドレスを指定してください。', + 'ipv6' => ':attributeには、有効なIPv6アドレスを指定してください。', + 'json' => ':attributeには、有効なJSON文字列を指定してください。', + 'lt' => [ + 'numeric' => ':attributeには、:valueより小さな値を指定してください。', + 'file' => ':attributeには、:value kBより小さなファイルを指定してください。', + 'string' => ':attributeは、:value文字より短く指定してください。', + 'array' => ':attributeには、:value個より少ないアイテムを指定してください。', + ], + 'lte' => [ + 'numeric' => ':attributeには、:value以下の値を指定してください。', + 'file' => ':attributeには、:value kB以下のファイルを指定してください。', + 'string' => ':attributeは、:value文字以下で指定してください。', + 'array' => ':attributeには、:value個以下のアイテムを指定してください。', + ], + 'max' => [ + 'numeric' => ':attributeには、:max以下の数字を指定してください。', + 'file' => ':attributeには、:max kB以下のファイルを指定してください。', + 'string' => ':attributeは、:max文字以下で指定してください。', + 'array' => ':attributeは:max個以下指定してください。', + ], + 'mimes' => ':attributeには:valuesタイプのファイルを指定してください。', + 'mimetypes' => ':attributeには:valuesタイプのファイルを指定してください。', + 'min' => [ + 'numeric' => ':attributeには、:min以上の数字を指定してください。', + 'file' => ':attributeには、:min kB以上のファイルを指定してください。', + 'string' => ':attributeは、:min文字以上で指定してください。', + 'array' => ':attributeは:min個以上指定してください。', + ], + 'not_in' => '選択された:attributeは正しくありません。', + 'not_regex' => ':attributeの形式が正しくありません。', + 'numeric' => ':attributeには、数字を指定してください。', + 'password' => '正しいパスワードを指定してください。', + 'present' => ':attributeが存在していません。', + 'regex' => ':attributeに正しい形式を指定してください。', + 'required' => ':attributeは必ず指定してください。', + 'required_if' => ':otherが:valueの場合、:attributeも指定してください。', + 'required_unless' => ':otherが:valuesでない場合、:attributeを指定してください。', + 'required_with' => ':valuesを指定する場合は、:attributeも指定してください。', + 'required_with_all' => ':valuesを指定する場合は、:attributeも指定してください。', + 'required_without' => ':valuesを指定しない場合は、:attributeを指定してください。', + 'required_without_all' => ':valuesのどれも指定しない場合は、:attributeを指定してください。', + 'same' => ':attributeと:otherには同じ値を指定してください。', + 'size' => [ + 'numeric' => ':attributeは:sizeを指定してください。', + 'file' => ':attributeのファイルは、:sizeキロバイトでなくてはなりません。', + 'string' => ':attributeは:size文字で指定してください。', + 'array' => ':attributeは:size個指定してください。', + ], + 'starts_with' => ':attributeには、:valuesのどれかで始まる値を指定してください。', + 'string' => ':attributeは文字列を指定してください。', + 'timezone' => ':attributeには、有効なゾーンを指定してください。', + 'unique' => ':attributeの値は既に存在しています。', + 'uploaded' => ':attributeのアップロードに失敗しました。', + 'url' => ':attributeに正しい形式を指定してください。', + 'uuid' => ':attributeに有効なUUIDを指定してください。', + + /* + |-------------------------------------------------------------------------- + | Custom バリデーション言語行 + |-------------------------------------------------------------------------- + | + | "属性.ルール"の規約でキーを指定することでカスタムバリデーション + | メッセージを定義できます。指定した属性ルールに対する特定の + | カスタム言語行を手早く指定できます。 + | + */ + + 'custom' => [ + '属性名' => [ + 'ルール名' => 'カスタムメッセージ', + ], + ], + + /* + |-------------------------------------------------------------------------- + | カスタムバリデーション属性名 + |-------------------------------------------------------------------------- + | + | 以下の言語行は、例えば"email"の代わりに「メールアドレス」のように、 + | 読み手にフレンドリーな表現でプレースホルダーを置き換えるために指定する + | 言語行です。これはメッセージをよりきれいに表示するために役に立ちます。 + | + */ + + 'attributes' => [], + +]; diff --git a/phpcs.xml b/phpcs.xml new file mode 100644 index 0000000..0f27974 --- /dev/null +++ b/phpcs.xml @@ -0,0 +1,25 @@ + + + The coding standard for PurephpValidation. + + + + + + + + */tests/* + + + */tests/* + + + */tests/* + + + + + diff --git a/phpmd.xml b/phpmd.xml new file mode 100644 index 0000000..279945b --- /dev/null +++ b/phpmd.xml @@ -0,0 +1,16 @@ + + + Custom ruleset PHPMD + + + + + + + + + + + + + diff --git a/phpstan.neon b/phpstan.neon new file mode 100644 index 0000000..79219de --- /dev/null +++ b/phpstan.neon @@ -0,0 +1,10 @@ +parameters: + level: 6 + paths: + - ./src + excludePaths: + - ./src/Rules + treatPhpDocTypesAsCertain: false + #ignoreErrors: + # - '#No error to ignore is reported#' + # - '#is not contravariant with parameter#' diff --git a/src/Rules/FileWrapper.php b/src/Rules/FileWrapper.php new file mode 100644 index 0000000..0a66c3e --- /dev/null +++ b/src/Rules/FileWrapper.php @@ -0,0 +1,45 @@ +messages = []; + + $validator = ValidatorFactory::make( + $this->data, + [$attribute => $this->buildValidationRules()], // @phpstan-ignore-line + $this->validator->customMessages, + $this->validator->customAttributes + ); + + if ($validator->fails()) { + return $this->fail($validator->messages()->all()); + } + + return true; + } + + /** + * Limit the uploaded file to only image types. + * + * @return ImageFileWrapper + */ + public static function image() + { + return new ImageFileWrapper(); + } +} diff --git a/src/Rules/ImageFileWrapper.php b/src/Rules/ImageFileWrapper.php new file mode 100644 index 0000000..6f01b8d --- /dev/null +++ b/src/Rules/ImageFileWrapper.php @@ -0,0 +1,30 @@ +rules('image'); + } + + /** + * The dimension constraints for the uploaded file. + * + * @param \Illuminate\Validation\Rules\Dimensions $dimensions + */ + public function dimensions($dimensions) + { + $this->rules($dimensions); + + return $this; + } +} diff --git a/src/Rules/PasswordWrapper.php b/src/Rules/PasswordWrapper.php new file mode 100644 index 0000000..b347945 --- /dev/null +++ b/src/Rules/PasswordWrapper.php @@ -0,0 +1,83 @@ +messages = []; + + $validator = ValidatorFactory::make( + $this->data, + [$attribute => [ + 'string', + 'min:' . $this->min, + ...($this->max ? ['max:' . $this->max] : []), + ...$this->customRules, + ]], + $this->validator->customMessages, + $this->validator->customAttributes + )->after(function ($validator) use ($attribute, $value) { + if (! is_string($value)) { + return; + } + + if ( + $this->mixedCase + && ! preg_match( + '/(\p{Ll}+.*\p{Lu})|(\p{Lu}+.*\p{Ll})/u', + $value + ) + ) { + $validator->addFailure($attribute, 'password.mixed'); + } + + if ($this->letters && ! preg_match('/\pL/u', $value)) { + $validator->addFailure($attribute, 'password.letters'); + } + + if ( + $this->symbols && ! preg_match('/\p{Z}|\p{S}|\p{P}/u', $value) + ) { + $validator->addFailure($attribute, 'password.symbols'); + } + + if ($this->numbers && ! preg_match('/\pN/u', $value)) { + $validator->addFailure($attribute, 'password.numbers'); + } + }); + + if ($validator->fails()) { + return $this->fail($validator->messages()->all()); + } + + if ( + $this->uncompromised + && ! Container::getInstance() + ->make(UncompromisedVerifier::class) + ->verify([ + 'value' => $value, + 'threshold' => $this->compromisedThreshold, + ]) + ) { + $validator->addFailure($attribute, 'password.uncompromised'); + + return $this->fail($validator->messages()->all()); + } + + return true; + } +} diff --git a/src/ValidatorFactory.php b/src/ValidatorFactory.php new file mode 100644 index 0000000..334824f --- /dev/null +++ b/src/ValidatorFactory.php @@ -0,0 +1,89 @@ + $data + * @param array $rules + * @param array $messages = [] + * @param array $attributes = [] + * @return \Illuminate\Validation\Validator + */ + public static function make( + array $data, + array $rules, + array $messages = [], + array $attributes = [] + ) { + if (strlen(self::$basePath) === 0) { + self::translationsRootPath(); + } + // @phpstan-ignore-next-line + return (new ValidatorWrapper( + lang: self::$lang + )) + ->translationsRootPath(self::$basePath) + ->make($data, $rules, $messages, $attributes); + } +} diff --git a/src/ValidatorWrapper.php b/src/ValidatorWrapper.php new file mode 100644 index 0000000..f3e36aa --- /dev/null +++ b/src/ValidatorWrapper.php @@ -0,0 +1,110 @@ +lang = $lang; + $this->group = $group; + $this->namespace = $namespace; + $this->basePath = $this->getTranslationsRootPath(); + $this->factory = new Factory($this->loadTranslator()); + } + + /** + * Sets tranlations root path + * @param string $path = '' + * @return $this + */ + public function translationsRootPath(string $path = '') + { + if (!empty($path)) { + $this->basePath = $path; + $this->reloadValidatorFactory(); + } + return $this; + } + + /** + * Reloads ValidatorFactory + * @return $this + */ + private function reloadValidatorFactory() + { + $this->factory = new Factory($this->loadTranslator()); + return $this; + } + + /** + * Returns translations root path + * @return string + */ + public function getTranslationsRootPath(): string + { + return __DIR__ . '/'; + } + + /** + * Loads and returns Translator + * @return Translator + */ + public function loadTranslator(): Translator + { + $loader = new FileLoader( + new Filesystem(), + $this->basePath . $this->namespace + ); + $loader->addNamespace( + $this->namespace, + $this->basePath . $this->namespace + ); + $loader->load($this->lang, $this->group, $this->namespace); + return static::$translator = new Translator($loader, $this->lang); + } + + /** + * Method overloading + * @param string $method + * @param array $args + * @return mixed|false + * @see https://www.php.net/manual/en/language.oop5.overloading.php#object.call + */ + public function __call(string $method, array $args) + { + return call_user_func_array([$this->factory, $method], $args); + } +} diff --git a/src/lang/en/validation.php b/src/lang/en/validation.php new file mode 100644 index 0000000..c2a34e4 --- /dev/null +++ b/src/lang/en/validation.php @@ -0,0 +1,68 @@ + 'The :attribute must be accepted.', + 'active_url' => 'The :attribute is not a valid URL.', + 'after' => 'The :attribute must be a date after :date.', + 'alpha' => 'The :attribute may only contain letters.', + 'alpha_dash' => 'The :attribute may only contain letters, numbers, and dashes.', + 'alpha_num' => 'The :attribute may only contain letters and numbers.', + 'array' => 'The :attribute must be an array.', + 'before' => 'The :attribute must be a date before :date.', + 'between' => [ + 'numeric' => 'The :attribute must be between :min and :max.', + 'file' => 'The :attribute must be between :min and :max kilobytes.', + 'string' => 'The :attribute must be between :min and :max characters.', + 'array' => 'The :attribute must have between :min and :max items.', + ], + 'boolean' => 'The :attribute field must be true or false.', + 'confirmed' => 'The :attribute confirmation does not match.', + 'date' => 'The :attribute is not a valid date.', + 'date_format' => 'The :attribute does not match the format :format.', + 'different' => 'The :attribute and :other must be different.', + 'digits' => 'The :attribute must be :digits digits.', + 'digits_between' => 'The :attribute must be between :min and :max digits.', + 'email' => 'The :attribute must be a valid email address.', + 'exists' => 'The selected :attribute is invalid.', + 'filled' => 'The :attribute field is required.', + 'image' => 'The :attribute must be an image.', + 'in' => 'The selected :attribute is invalid.', + 'integer' => 'The :attribute must be an integer.', + 'ip' => 'The :attribute must be a valid IP address.', + 'json' => 'The :attribute must be a valid JSON string.', + 'max' => [ + 'numeric' => 'The :attribute may not be greater than :max.', + 'file' => 'The :attribute may not be greater than :max kilobytes.', + 'string' => 'The :attribute may not be greater than :max characters.', + 'array' => 'The :attribute may not have more than :max items.', + ], + 'mimes' => 'The :attribute must be a file of type: :values.', + 'min' => [ + 'numeric' => 'The :attribute must be at least :min.', + 'file' => 'The :attribute must be at least :min kilobytes.', + 'string' => 'The :attribute must be at least :min characters.', + 'array' => 'The :attribute must have at least :min items.', + ], + 'not_in' => 'The selected :attribute is invalid.', + 'numeric' => 'The :attribute must be a number.', + 'present' => 'The :attribute field must be present.', + 'regex' => 'The :attribute format is invalid.', + 'required' => 'The :attribute field is required.', + 'required_if' => 'The :attribute field is required when :other is :value.', + 'required_unless' => 'The :attribute field is required unless :other is in :values.', + 'required_with' => 'The :attribute field is required when :values is present.', + 'required_with_all' => 'The :attribute field is required when :values is present.', + 'required_without' => 'The :attribute field is required when :values is not present.', + 'required_without_all' => 'The :attribute field is required when none of :values are present.', + 'same' => 'The :attribute and :other must match.', + 'size' => [ + 'numeric' => 'The :attribute must be :size.', + 'file' => 'The :attribute must be :size kilobytes.', + 'string' => 'The :attribute must be :size characters.', + 'array' => 'The :attribute must contain :size items.', + ], + 'string' => 'The :attribute must be a string.', + 'timezone' => 'The :attribute must be a valid zone.', + 'unique' => 'The :attribute has already been taken.', + 'url' => 'The :attribute format is invalid.' +]; diff --git a/src/lang/ja/validation.php b/src/lang/ja/validation.php new file mode 100644 index 0000000..12407a4 --- /dev/null +++ b/src/lang/ja/validation.php @@ -0,0 +1,151 @@ + ':attributeを承認してください。', + 'active_url' => ':attributeが有効なURLではありません。', + 'after' => ':attributeには、:dateより後の日付を指定してください。', + 'after_or_equal' => ':attributeには、:date以降の日付を指定してください。', + 'alpha' => ':attributeはアルファベットのみがご利用できます。', + 'alpha_dash' => ':attributeはアルファベットとダッシュ(-)及び下線(_)がご利用できます。', + 'alpha_num' => ':attributeはアルファベット数字がご利用できます。', + 'array' => ':attributeは配列でなくてはなりません。', + 'before' => ':attributeには、:dateより前の日付をご利用ください。', + 'before_or_equal' => ':attributeには、:date以前の日付をご利用ください。', + 'between' => [ + 'numeric' => ':attributeは、:minから:maxの間で指定してください。', + 'file' => ':attributeは、:min kBから、:max kBの間で指定してください。', + 'string' => ':attributeは、:min文字から、:max文字の間で指定してください。', + 'array' => ':attributeは、:min個から:max個の間で指定してください。', + ], + 'boolean' => ':attributeは、trueかfalseを指定してください。', + 'confirmed' => ':attributeと、確認フィールドとが、一致していません。', + 'date' => ':attributeには有効な日付を指定してください。', + 'date_equals' => ':attributeには、:dateと同じ日付けを指定してください。', + 'date_format' => ':attributeは:format形式で指定してください。', + 'different' => ':attributeと:otherには、異なった内容を指定してください。', + 'digits' => ':attributeは:digits桁で指定してください。', + 'digits_between' => ':attributeは:min桁から:max桁の間で指定してください。', + 'dimensions' => ':attributeの図形サイズが正しくありません。', + 'distinct' => ':attributeには異なった値を指定してください。', + 'email' => ':attributeには、有効なメールアドレスを指定してください。', + 'ends_with' => ':attributeには、:valuesのどれかで終わる値を指定してください。', + 'exists' => '選択された:attributeは正しくありません。', + 'file' => ':attributeにはファイルを指定してください。', + 'filled' => ':attributeに値を指定してください。', + 'gt' => [ + 'numeric' => ':attributeには、:valueより大きな値を指定してください。', + 'file' => ':attributeには、:value kBより大きなファイルを指定してください。', + 'string' => ':attributeは、:value文字より長く指定してください。', + 'array' => ':attributeには、:value個より多くのアイテムを指定してください。', + ], + 'gte' => [ + 'numeric' => ':attributeには、:value以上の値を指定してください。', + 'file' => ':attributeには、:value kB以上のファイルを指定してください。', + 'string' => ':attributeは、:value文字以上で指定してください。', + 'array' => ':attributeには、:value個以上のアイテムを指定してください。', + ], + 'image' => ':attributeには画像ファイルを指定してください。', + 'in' => '選択された:attributeは正しくありません。', + 'in_array' => ':attributeには:otherの値を指定してください。', + 'integer' => ':attributeは整数で指定してください。', + 'ip' => ':attributeには、有効なIPアドレスを指定してください。', + 'ipv4' => ':attributeには、有効なIPv4アドレスを指定してください。', + 'ipv6' => ':attributeには、有効なIPv6アドレスを指定してください。', + 'json' => ':attributeには、有効なJSON文字列を指定してください。', + 'lt' => [ + 'numeric' => ':attributeには、:valueより小さな値を指定してください。', + 'file' => ':attributeには、:value kBより小さなファイルを指定してください。', + 'string' => ':attributeは、:value文字より短く指定してください。', + 'array' => ':attributeには、:value個より少ないアイテムを指定してください。', + ], + 'lte' => [ + 'numeric' => ':attributeには、:value以下の値を指定してください。', + 'file' => ':attributeには、:value kB以下のファイルを指定してください。', + 'string' => ':attributeは、:value文字以下で指定してください。', + 'array' => ':attributeには、:value個以下のアイテムを指定してください。', + ], + 'max' => [ + 'numeric' => ':attributeには、:max以下の数字を指定してください。', + 'file' => ':attributeには、:max kB以下のファイルを指定してください。', + 'string' => ':attributeは、:max文字以下で指定してください。', + 'array' => ':attributeは:max個以下指定してください。', + ], + 'mimes' => ':attributeには:valuesタイプのファイルを指定してください。', + 'mimetypes' => ':attributeには:valuesタイプのファイルを指定してください。', + 'min' => [ + 'numeric' => ':attributeには、:min以上の数字を指定してください。', + 'file' => ':attributeには、:min kB以上のファイルを指定してください。', + 'string' => ':attributeは、:min文字以上で指定してください。', + 'array' => ':attributeは:min個以上指定してください。', + ], + 'not_in' => '選択された:attributeは正しくありません。', + 'not_regex' => ':attributeの形式が正しくありません。', + 'numeric' => ':attributeには、数字を指定してください。', + 'password' => '正しいパスワードを指定してください。', + 'present' => ':attributeが存在していません。', + 'regex' => ':attributeに正しい形式を指定してください。', + 'required' => ':attributeは必ず指定してください。', + 'required_if' => ':otherが:valueの場合、:attributeも指定してください。', + 'required_unless' => ':otherが:valuesでない場合、:attributeを指定してください。', + 'required_with' => ':valuesを指定する場合は、:attributeも指定してください。', + 'required_with_all' => ':valuesを指定する場合は、:attributeも指定してください。', + 'required_without' => ':valuesを指定しない場合は、:attributeを指定してください。', + 'required_without_all' => ':valuesのどれも指定しない場合は、:attributeを指定してください。', + 'same' => ':attributeと:otherには同じ値を指定してください。', + 'size' => [ + 'numeric' => ':attributeは:sizeを指定してください。', + 'file' => ':attributeのファイルは、:sizeキロバイトでなくてはなりません。', + 'string' => ':attributeは:size文字で指定してください。', + 'array' => ':attributeは:size個指定してください。', + ], + 'starts_with' => ':attributeには、:valuesのどれかで始まる値を指定してください。', + 'string' => ':attributeは文字列を指定してください。', + 'timezone' => ':attributeには、有効なゾーンを指定してください。', + 'unique' => ':attributeの値は既に存在しています。', + 'uploaded' => ':attributeのアップロードに失敗しました。', + 'url' => ':attributeに正しい形式を指定してください。', + 'uuid' => ':attributeに有効なUUIDを指定してください。', + + /* + |-------------------------------------------------------------------------- + | Custom バリデーション言語行 + |-------------------------------------------------------------------------- + | + | "属性.ルール"の規約でキーを指定することでカスタムバリデーション + | メッセージを定義できます。指定した属性ルールに対する特定の + | カスタム言語行を手早く指定できます。 + | + */ + + 'custom' => [ + '属性名' => [ + 'ルール名' => 'カスタムメッセージ', + ], + ], + + /* + |-------------------------------------------------------------------------- + | カスタムバリデーション属性名 + |-------------------------------------------------------------------------- + | + | 以下の言語行は、例えば"email"の代わりに「メールアドレス」のように、 + | 読み手にフレンドリーな表現でプレースホルダーを置き換えるために指定する + | 言語行です。これはメッセージをよりきれいに表示するために役に立ちます。 + | + */ + + 'attributes' => [], + +]; diff --git a/tests/Rules/FileWrapperTest.php b/tests/Rules/FileWrapperTest.php new file mode 100644 index 0000000..c71573f --- /dev/null +++ b/tests/Rules/FileWrapperTest.php @@ -0,0 +1,133 @@ + [ + 'data' => ['photo' => new SymfonyFile($jpeg)], + 'rules' => [ + 'photo' => [ + FileWrapper::image() + ->min(40) + ->dimensions( + Rule::dimensions()->maxWidth(200)->maxHeight(300) + ) + ], + ], + 'messages' => [], + 'attributes' => [], + ], + 'expected' => [ + 'fails' => true, + 'messages' => [ + 'photo' => [ + 'The photo must be at least 40 kilobytes.', + 'validation.dimensions', + ], + ], + ], + ], + [ + 'input' => [ + 'data' => ['photo' => new SymfonyFile($jpeg)], + 'rules' => [ + 'photo' => [ + FileWrapper::types(['png', 'gif']) + ->max(30) + ], + ], + 'messages' => [], + 'attributes' => [], + ], + 'expected' => [ + 'fails' => true, + 'messages' => [ + 'photo' => [ + 'The photo must be a file of type: png, gif.', + 'The photo may not be greater than 30 kilobytes.', + ], + ], + ], + ], + [ + 'input' => [ + 'data' => ['photo' => new SymfonyFile($text)], + 'rules' => [ + 'photo' => [ + FileWrapper::image() + ->min(20) + ->max(30), + ], + ], + 'messages' => [], + 'attributes' => [], + ], + 'expected' => [ + 'fails' => true, + 'messages' => [ + 'photo' => [ + 'The photo must be between 20 and 30 kilobytes.', + 'The photo must be an image.', + ], + ], + ], + ], + [ + 'input' => [ + 'data' => ['photo' => new SymfonyFile($jpeg)], + 'rules' => [ + 'photo' => [ + FileWrapper::image() + ->min(20) + ->max(1024) + ->dimensions( + Rule::dimensions()->maxWidth(1024)->maxHeight(768) + ), + ], + ], + 'messages' => [], + 'attributes' => [], + ], + 'expected' => [ + 'fails' => false, + 'messages' => [ + ], + ], + ], + ]; + } + + #[DataProvider('provide_file_rules_can_work_correctly')] + public function test_file_rules_can_work_correctly(array $input, array $expected): void + { + $validator = ValidatorFactory::make( + $input['data'], + $input['rules'], + $input['messages'], + $input['attributes'], + ); + $this->assertSame($expected['fails'], $validator->fails()); + if ($validator->fails()) { + $this->assertSame($expected['messages'], $validator->errors()->messages()); + } + } +} diff --git a/tests/Rules/PasswordWrapperTest.php b/tests/Rules/PasswordWrapperTest.php new file mode 100644 index 0000000..56eb27b --- /dev/null +++ b/tests/Rules/PasswordWrapperTest.php @@ -0,0 +1,107 @@ + [ + 'data' => [ + 'password' => 'passwor', + ], + 'rules' => [ + 'password' => [PasswordWrapper::min(8)], + ], + ], + 'expected' => [ + 'fails' => true, + 'messages' => [ + 'password' => ['The password must be at least 8 characters.'], + ], + ], + ], + [ + 'input' => [ + 'data' => [ + 'password' => 'password', + ], + 'rules' => [ + 'password' => [PasswordWrapper::min(8)->max(16)], + ], + ], + 'expected' => [ + 'fails' => false, + 'messages' => [ + ], + ], + ], + [ + 'input' => [ + 'data' => [ + 'password' => 'passwordpasswordpassword', + ], + 'rules' => [ + 'password' => [PasswordWrapper::min(8)->max(16)], + ], + ], + 'expected' => [ + 'fails' => true, + 'messages' => [ + 'password' => ['The password may not be greater than 16 characters.'], + ], + ], + ], + [ + 'input' => [ + 'data' => [ + 'password' => 'password', + ], + 'rules' => [ + 'password' => [ + PasswordWrapper::min(8) + ->max(16) + ->letters() + ->mixedCase() + ->numbers() + ->symbols() + ->uncompromised(), + ], + ], + ], + 'expected' => [ + 'fails' => true, + 'messages' => [ + 'password' => [ + 'validation.password.mixed', + 'validation.password.symbols', + 'validation.password.numbers', + ], + ], + ], + ], + ]; + } + + #[DataProvider('provide_password_rule_can_work_correctly')] + public function test_password_rule_can_work_correctly(array $input, array $expected): void + { + $validator = ValidatorFactory::make($input['data'], $input['rules']); + $this->assertSame($expected['fails'], $validator->fails()); + if ($validator->fails()) { + $this->assertSame($expected['messages'], $validator->errors()->messages()); + } + } +} diff --git a/tests/Rules/input/dummy.txt b/tests/Rules/input/dummy.txt new file mode 100644 index 0000000..d2d2e46 --- /dev/null +++ b/tests/Rules/input/dummy.txt @@ -0,0 +1 @@ +This file is just for testing. diff --git a/tests/Rules/input/image.jpg b/tests/Rules/input/image.jpg new file mode 100644 index 0000000..374e78a Binary files /dev/null and b/tests/Rules/input/image.jpg differ diff --git a/tests/ValidatorFactoryTest.php b/tests/ValidatorFactoryTest.php new file mode 100644 index 0000000..f6870d0 --- /dev/null +++ b/tests/ValidatorFactoryTest.php @@ -0,0 +1,254 @@ + [ 'path' => __DIR__ . '/../src/' ], + 'example' => [ 'path' => __DIR__ . '/../example/' ], + ]; + } + + #[DataProvider('provide_translationsRootPath_can_set_path_correctly')] + public function test_translationsRootPath_can_set_path_correctly(string $path): void + { + ValidatorFactory::translationsRootPath($path); + $r = new \ReflectionClass(ValidatorFactory::class); + $p = $r->getProperty('basePath'); + $p->setAccessible(true); + $this->assertSame(realpath($path) . '/', $p->getValue()); + } + + public static function provide_lang_can_set_lang_correctly(): array + { + return [ + [ 'lang' => 'en', ], + [ 'lang' => 'ja', ], + ]; + } + + #[DataProvider('provide_lang_can_set_lang_correctly')] + public function test_lang_can_set_lang_correctly($lang): void + { + ValidatorFactory::translationsRootPath(); + ValidatorFactory::lang($lang); + $this->assertSame($lang, ValidatorFactory::lang()); + } + + /** + * @SuppressWarnings(PHPMD.ExcessiveMethodLength) + */ + public static function provide_make_can_make_validator_correctly(): array + { + $rules = [ + 'id' => 'required|int|min:1', + 'name' => 'required|string|min:3|max:10', + 'email' => 'required|string|email:rfc,dns', + ]; + return [ + [ + 'input' => [ + 'lang' => 'en', + 'data' => [ + 'id' => 'a', + 'name' => null, + 'email' => '', + ], + 'rules' => $rules, + 'messages' => [], + 'attributes' => [], + ], + 'expected' => [ + 'fails' => true, + 'errors' => [ + 'id' => ['The id must be an integer.'], + 'name' => ['The name field is required.'], + 'email' => ['The email field is required.'], + ], + ], + ], + [ + 'input' => [ + 'lang' => 'en', + 'data' => [ + 'id' => 0, + 'name' => 'ho', + 'email' => 'hoge', + ], + 'rules' => $rules, + 'messages' => [], + 'attributes' => [], + ], + 'expected' => [ + 'fails' => true, + 'errors' => [ + 'id' => ['The id must be at least 1.'], + 'name' => ['The name must be at least 3 characters.'], + 'email' => ['The email must be a valid email address.'], + ], + ], + ], + [ + 'input' => [ + 'lang' => 'en', + 'data' => [ + 'id' => 1, + 'name' => 'hogehogehog', + 'email' => 'hoge@gmail.com', + ], + 'rules' => $rules, + 'messages' => [], + 'attributes' => [], + ], + 'expected' => [ + 'fails' => true, + 'errors' => [ + 'name' => ['The name may not be greater than 10 characters.'], + ], + ], + ], + [ + 'input' => [ + 'lang' => 'en', + 'data' => [ + 'id' => 1, + 'name' => 'hogehogeho', + 'email' => 'hoge@gmail.com', + ], + 'rules' => $rules, + 'messages' => [], + 'attributes' => [], + ], + 'expected' => [ + 'fails' => false, + 'errors' => [], + ], + ], + [ + 'input' => [ + 'lang' => 'ja', + 'data' => [ + 'id' => 'a', + 'name' => null, + 'email' => '', + ], + 'rules' => $rules, + 'messages' => [], + 'attributes' => [], + ], + 'expected' => [ + 'fails' => true, + 'errors' => [ + 'id' => ['idは整数で指定してください。'], + 'name' => ['nameは必ず指定してください。'], + 'email' => ['emailは必ず指定してください。'], + ], + ], + ], + [ + 'input' => [ + 'lang' => 'ja', + 'data' => [ + 'id' => 0, + 'name' => 'ho', + 'email' => 'hoge', + ], + 'rules' => $rules, + 'messages' => [], + 'attributes' => [], + ], + 'expected' => [ + 'fails' => true, + 'errors' => [ + 'id' => ['idには、1以上の数字を指定してください。'], + 'name' => ['nameは、3文字以上で指定してください。'], + 'email' => ['emailには、有効なメールアドレスを指定してください。'], + ], + ], + ], + [ + 'input' => [ + 'lang' => 'ja', + 'data' => [ + 'id' => 1, + 'name' => 'hogehogehog', + 'email' => 'hoge@gmail.com', + ], + 'rules' => $rules, + 'messages' => [], + 'attributes' => [], + ], + 'expected' => [ + 'fails' => true, + 'errors' => [ + 'name' => ['nameは、10文字以下で指定してください。'], + ], + ], + ], + [ + 'input' => [ + 'lang' => 'ja', + 'data' => [ + 'id' => 0, + 'name' => 'ho', + 'email' => 'hoge', + ], + 'rules' => $rules, + 'messages' => [ + 'id.min' => '❤ :attribute は :min 以上の整数でなければなりません。', + 'name.min' => '❤ :attribute は :min 以上でなければなりません。', + 'email' => '❤ :attribute は有効なメールアドレスでなければなりません。', + ], + 'attributes' => [ + 'id' => '🔥ユーザーID🔥', + 'name' => '✨お名前✨', + 'email' => '📧メールアドレス📭', + ], + ], + 'expected' => [ + 'fails' => true, + 'errors' => [ + 'id' => ['❤ 🔥ユーザーID🔥 は 1 以上の整数でなければなりません。'], + 'name' => ['❤ ✨お名前✨ は 3 以上でなければなりません。'], + 'email' => ['❤ 📧メールアドレス📭 は有効なメールアドレスでなければなりません。'], + ], + ], + ], + ]; + } + + #[DataProvider('provide_make_can_make_validator_correctly')] + public function test_make_can_make_validator_correctly(array $input, array $expected): void + { + ValidatorFactory::lang($input['lang']); + $validator = ValidatorFactory::make( + $input['data'], + $input['rules'], + $input['messages'], + $input['attributes'], + ); + $this->assertSame( + \Illuminate\Validation\Validator::class, + $validator::class + ); + $this->assertSame($expected['fails'], $validator->fails()); + if ($validator->fails()) { + $this->assertSame( + $expected['errors'], + $validator->errors()->messages() + ); + } + } +}