Merge pull request #1 from karoldabro/wip

Init commit

Author: karoldabro

.gitattributes

@@ -0,0 +1,4 @@
+/tests       export-ignore
+phpunit.xml  export-ignore
+docker-compose.yml export-ignore
+_ide_helper.php export-ignore

.github/workflows/laravel.yml

@@ -0,0 +1,50 @@
+name: tests
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  tests83:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: shivammathur/setup-php@15c43e89cdef867065b0213be354c2841860869e
+        with:
+          php-version: '8.3'
+      - uses: actions/checkout@v3
+      - name: Install Dependencies
+        run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+      - name: Create Database
+        run: |
+          mkdir -p database
+          touch database/database.sqlite
+      - name: Execute tests (Unit and Feature tests) via PHPUnit
+        env:
+          DB_CONNECTION: testing
+          DB_DATABASE: database/database.sqlite
+        run: vendor/bin/phpunit
+
+  tests82:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: shivammathur/setup-php@15c43e89cdef867065b0213be354c2841860869e
+        with:
+          php-version: '8.2'
+      - uses: actions/checkout@v3
+      - name: Install Dependencies
+        run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+      - name: Create Database
+        run: |
+          mkdir -p database
+          touch database/database.sqlite
+      - name: Execute tests (Unit and Feature tests) via PHPUnit
+        env:
+          DB_CONNECTION: testing
+          DB_DATABASE: database/database.sqlite
+        run: vendor/bin/phpunit

.gitignore

@@ -0,0 +1,11 @@
+vendor
+.phpunit.result.cache
+.vscode
+storage/*
+!storage/.gitkeep
+.env
+Makefile
+.gitmodules
+composer.lock
+.idea
+.phpunit.cache

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 karoldabro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,127 @@
-# validation-error-codes
+# Validation Codes for Laravel
+
+This package enhances Laravel's validation error responses (status 422) by adding corresponding validation rule codes. After installation, the response format is as follows:
+
+```json
+{
+  "message": "validation errors",
+  "errors": {
+    "user_id": [
+      "Field user_id is required"
+    ]
+  },
+  "codes": {
+    "user_id": [
+      "E104"
+    ]
+  }
+}
+```
+
+## Installation
+First install the package using Composer:
+```shell
+composer require kdabrow/validation-codes
+```
+
+Afterward, extend your `Exception\Handler` file with `Kdabrow\ValidationCodes\Handler`.
+
+## How It Works
+
+This package extends Laravel's default validation system by overwriting the default Handler to return the correct JSON response.
+
+## Configuration
+
+### Overwriting Validation Codes
+
+To publish the configuration and language files containing the codes, use Laravel's command:
+
+```shell
+php artisan publish --tag=validation_codes
+```
+
+You can then change the validation codes corresponding to the given rules in the published file, which looks like this:
+
+```php
+<?php
+
+return [
+    'fallback_error' => 'E0', // This error code is returned while error code isn't found in this file
+    'accepted' => 'E1',
+    'accepted_if' => 'E2',
+    'active_url' => 'E3',
+    // ...
+];
+```
+
+### Returning Only Validation Codes (Without Messages)
+
+To return only validation codes, set `show_only_codes` to `true` in the `config/validation_codes.php` file. The response will be:
+
+```json
+{
+  "codes": {
+    "user_id": [
+      "E104"
+    ]
+  }
+}
+```
+
+**Caution:** This might be a breaking change for your API.
+
+**Ensure your `Exception\Handler` extends `Kdabrow\ValidationCodes\Handler`.**
+
+### Adding an Error Code to Custom Validation Rules
+
+Add a static method `getCode` to your custom validation rule. For example:
+
+```php
+<?php
+
+use Illuminate\Contracts\Validation\ValidationRule;
+
+class YourCustomValidationRule implements ValidationRule
+{
+    public function validate(string $attribute, mixed $value, \Closure $fail): void
+    {
+        // validation logic
+    }
+    
+    public static function getCode(): string
+    {
+        return 'E10000'; // The validation code to return
+    }
+}
+```
+
+### Adding an Error Code to a Validation Rule that Extends Validator
+
+Add a fourth parameter to the `extend` function:
+
+```php
+<?php
+
+use Illuminate\Support\Facades\Validator;
+use Illuminate\Support\ServiceProvider;
+
+class YourServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        Validator::extend('your_rule', YourRule::class, 'message', 'E10000');
+    }
+}
+```
+
+### Adding an Error Code to an Anonymous Validation Function
+
+This is not supported.
+
+## Testing
+
+To run tests, use the following command:
+
+```shell
+docker compose exec php vendor/bin/phpunit
+```