Merge pull request #23 from programmatordev/1.x

1.x

Author: andrepimpao

.gitignore

@@ -0,0 +1,8 @@
+/composer.lock
+/composer.phar
+/phpunit.xml
+/.phpunit.result.cache
+/vendor/
+/logs/
+/.idea
+/index.php

README.md

@@ -1 +1,72 @@
-# yet-another-php-validator
+# Yet Another PHP Validator
+
+PHP validator focused on validating development code with expressive error messages.
+
+> **Note**
+> This library is not in version 1.x mainly because there are few available rules.
+> Hopefully, that will change in the near future.
+
+## Requirements
+
+- PHP 8.1 or higher.
+
+## Installation
+
+You can install the library via [Composer](https://getcomposer.org/):
+
+```bash
+composer require programmatordev/yet-another-php-validator
+```
+
+To use the library, use Composer's [autoload](https://getcomposer.org/doc/01-basic-usage.md#autoloading):
+
+```php
+require_once 'vendor/autoload.php';
+```
+
+## Basic Usage
+
+Simple usage looks like:
+
+```php
+use ProgrammatorDev\YetAnotherPhpValidator\Rule;
+use ProgrammatorDev\YetAnotherPhpValidator\Validator;
+
+// Do this...
+$validator = Validator::notBlank()->greaterThanOrEqual(18);
+
+// Or this...
+$validator = new Validator(
+    new Rule\NotBlank(), 
+    new Rule\GreaterThanOrEqual(18)
+);
+
+// Validate with these:
+$validator->validate(16); // returns bool: false
+$validator->assert(16, 'Age'); // throws exception: The "Age" value should be greater than or equal to "18", "16" given.
+```
+
+## Documentation
+
+- [Get Started](docs/01-get-started.md)
+- [Usage](docs/02-usage.md)
+  - [Usage](docs/02-usage.md#usage)
+  - [Methods](docs/02-usage.md#methods)
+  - [Error Handling](docs/02-usage.md#error-handling)
+  - [Custom Error Messages](docs/02-usage.md#custom-error-messages)
+- [Rules](docs/03-rules.md)
+- [Custom Rules](docs/04-custom-rules.md)
+
+## Contributing
+
+Any form of contribution to improve this library (including requests) will be welcome and appreciated.
+Make sure to open a pull request or issue.
+
+## Acknowledgments
+
+This library is inspired by [respect/validation](https://github.com/Respect/Validation) and [symfony/validator](https://github.com/symfony/validator).
+
+## License
+
+This project is licensed under the MIT license.
+Please see the [LICENSE](LICENSE) file distributed with this source code for further information regarding copyright and licensing.

composer.json

@@ -0,0 +1,35 @@
+{
+    "name": "programmatordev/yet-another-php-validator",
+    "description": "PHP validator focused on validating development code with expressive error messages",
+    "type": "library",
+    "keywords": ["PHP", "PHP8", "Validator", "Validation"],
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "André Pimpão",
+            "email": "a.pimpao@programmator.dev",
+            "homepage": "https://programmator.dev/"
+        }
+    ],
+    "require": {
+        "php": ">=8.1"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^10.0",
+        "symfony/var-dumper": "^6.3"
+    },
+    "autoload": {
+        "psr-4": {
+            "ProgrammatorDev\\YetAnotherPhpValidator\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "ProgrammatorDev\\YetAnotherPhpValidator\\Test\\": "tests/"
+        }
+    },
+    "config": {
+        "optimize-autoloader": true,
+        "sort-packages": true
+    }
+}

docs/01-get-started.md

@@ -0,0 +1,45 @@
+# Get Started
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Basic Usage](#basic-usage)
+
+## Requirements
+
+- PHP 8.1 or higher.
+
+## Installation
+
+You can install the library via [Composer](https://getcomposer.org/):
+
+```bash
+composer require programmatordev/yet-another-php-validator
+```
+
+To use the library, use Composer's [autoload](https://getcomposer.org/doc/01-basic-usage.md#autoloading):
+
+```php
+require_once 'vendor/autoload.php';
+```
+
+## Basic Usage
+
+Simple usage looks like:
+
+```php
+use ProgrammatorDev\YetAnotherPhpValidator\Rule;
+use ProgrammatorDev\YetAnotherPhpValidator\Validator;
+
+// Do this...
+$validator = Validator::notBlank()->greaterThanOrEqual(18);
+
+// Or this...
+$validator = new Validator(
+    new Rule\NotBlank(), 
+    new Rule\GreaterThanOrEqual(18)
+);
+
+// Validate with these:
+$validator->validate(16); // returns bool: false
+$validator->assert(16, 'Age'); // throws exception: The "Age" value should be greater than or equal to "18", "16" given.
+```