Merge pull request #4 from karoldabro/feature/update-to-l-11

Update to Laravel 11

Author: karoldabro

.github/workflows/laravel.yml

@@ -37,28 +37,6 @@ jobs:
         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
-
-
-  tests81:
-
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: shivammathur/setup-php@15c43e89cdef867065b0213be354c2841860869e
-        with:
-          php-version: '8.1'
-      - uses: actions/checkout@v3
       - name: Install Dependencies
         run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
       - name: Create Database

CHANGELOG.md

@@ -0,0 +1,25 @@
+# CHANGELOG
+
+## [2.0.0] - 2024-06-16
+
+### Added
+- Support for Laravel 11
+- Changelog
+
+## [1.1.1] - 2024-06-16
+
+### Fixes
+- Publishing assets: config and translations
+
+## [1.1.0] - 2024-06-16
+
+### Added
+- Support for php 8.1
+
+### Removed
+- ide helper library
+
+## [1.0.0] - 2024-06-03
+
+### Added
+- Package to return validation error codes in case of the validation error 

README.md

@@ -23,24 +23,16 @@ This package enhances Laravel's validation error responses (status 422) by addin
   }
 }
 ```
+Error codes allow clients of your API to easily interpret returned validation errors in the way they want or need.
 
 ## Installation
-First install the package using Composer:
-```shell
-composer require kdabrow/validation-codes
-```
-
-Afterward, extend your `Exception\Handler` file with `Kdabrow\ValidationCodes\Handler`.
-```php
-<?php
 
-namespace App\Exceptions;
+First, install the package using Composer:
 
-class Handler extends \Kdabrow\ValidationCodes\Handler
-{
-
-}
-```
+| PHP  | Laravel | Package                                                           | Command                                                  |
+|------|---------|-------------------------------------------------------------------|----------------------------------------------------------|
+| ^8.2 | 11      | 2.0                                                               | ```composer require "kdabrow/validation-codes: ^2.0"```  |
+| ^8.1 | 10      | [1.1](https://github.com/karoldabro/validation-codes/tree/v1.1.0) | ```composer require "kdabrow/validation-codes: ^1.1" ``` |
 
 ## How It Works
 
@@ -62,7 +54,7 @@ You can then change the validation codes corresponding to the given rules in the
 <?php
 
 return [
-    'fallback_error' => 'E0', // This error code is returned while error code isn't found in this file
+    'fallback_error' => 'E0', // This error code is returned when an error code isn't found in this file
     'accepted' => 'E1',
     'accepted_if' => 'E2',
     'active_url' => 'E3',
@@ -103,7 +95,7 @@ class YourCustomValidationRule implements ValidationRule
     {
         // validation logic
     }
-    
+
     public static function getCode(): string
     {
         return 'E10000'; // The validation code to return

composer.json

@@ -1,6 +1,6 @@
 {
 	"name": "kdabrow/validation-codes",
-	"description": "Validation codes",
+	"description": "Validation codes for API",
 	"type": "package",
 	"keywords": [
 		"php",
@@ -17,12 +17,12 @@
 		}
 	],
 	"require": {
-		"php": ">=8.1.0",
-		"illuminate/support": "^10.0",
-		"illuminate/validation": "^10.0"
+		"php": ">=8.2.0",
+		"illuminate/support": "^11.0",
+		"illuminate/validation": "^11.0"
 	},
 	"require-dev": {
-		"orchestra/testbench": "^8.0"
+		"orchestra/testbench": "^9.0"
 	},
 	"autoload": {
 		"psr-4": {

docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   php:
-    image: webdevops/php-dev:8.1
+    image: webdevops/php-dev:8.2
     volumes:
       - ./:/app/
     working_dir: /app

src/Providers/ValidationCodesProvider.php

@@ -3,8 +3,10 @@
 namespace Kdabrow\ValidationCodes\Providers;
 
 use Illuminate\Container\Container;
+use Illuminate\Contracts\Debug\ExceptionHandler;
 use Illuminate\Support\ServiceProvider;
 use Kdabrow\ValidationCodes\Factory;
+use Kdabrow\ValidationCodes\Handler;
 use Kdabrow\ValidationCodes\Validator;
 
 class ValidationCodesProvider extends ServiceProvider
@@ -26,6 +28,8 @@ public function register()
 
 			return $factory;
 		});
+
+		$this->app->singleton(ExceptionHandler::class, Handler::class);
 	}
 
 	public function boot()

src/Validator.php

@@ -110,8 +110,8 @@ protected function validateUsingCustomRule($attribute, $value, $rule)
 
 				$this->codes->add(
 					$attribute,
-					method_exists($ruleClass, 'getCode') ? $ruleClass::getCode($attribute) : $this->fallbackTranslation(), // TODO: change E0 to translation
-				); // TODO: test
+					method_exists($ruleClass, 'getCode') ? $ruleClass::getCode($attribute) : $this->fallbackTranslation(),
+				);
 			}
 		}
 	}
@@ -122,7 +122,7 @@ protected function findErrorCode($attribute, string $rule): string
 
 		$key = $this->getKey($lowerRule);
 
-		if ($key !== ($this->getTranslation($lowerRule))) { // TODO: test
+		if ($key !== ($this->getTranslation($lowerRule))) {
 			return $this->getCustomMessageFromTranslator(
 				in_array($rule, $this->sizeRules)
 					? [$key.".{$this->getAttributeType($attribute)}", $key]
@@ -132,7 +132,7 @@ protected function findErrorCode($attribute, string $rule): string
 
 		return $this->getFromLocalArray(
 			$attribute, $lowerRule, $this->fallbackCodes
-		) ?: $this->fallbackTranslation(); // TODO: test
+		) ?: $this->fallbackTranslation();
 	}
 
 	/**

tests/ApiTest.php

@@ -3,18 +3,19 @@
 namespace Kdabrow\ValidationCodes\Tests;
 
 use Illuminate\Testing\Fluent\AssertableJson;
+use PHPUnit\Framework\Attributes\Test;
 
 class ApiTest extends TestCase
 {
-	/** @test */
+	#[Test]
 	public function response_returns_status_422_validation_error()
 	{
 	    $response = $this->json('POST', '/test');
 
 		$response->assertStatus(422);
 	}
 
-	/** @test */
+	#[Test]
 	public function error_response_contains_validation_errors_key()
 	{
 		$response = $this->json('POST', '/test');
@@ -29,7 +30,7 @@ public function error_response_contains_validation_errors_key()
 		]);
 	}
 
-	/** @test */
+	#[Test]
 	public function error_response_contains_validation_codes_key()
 	{
 		$response = $this->json('POST', '/test');
@@ -39,7 +40,7 @@ public function error_response_contains_validation_codes_key()
 		});
 	}
 
-	/** @test */
+	#[Test]
 	public function error_response_codes_array_contains_field_with_validation_error_code()
 	{
 		$response = $this->json('POST', '/test');
@@ -53,7 +54,7 @@ public function error_response_codes_array_contains_field_with_validation_error_
 		]);
 	}
 
-	/** @test */
+	#[Test]
 	public function response_contains_only_codes_while_configuration_show_only_codes_is_true()
 	{
 		config()->set('validation_codes.show_only_codes', true);
@@ -69,7 +70,7 @@ public function response_contains_only_codes_while_configuration_show_only_codes
 		]);
 	}
 
-	/** @test */
+	#[Test]
 	public function response_contains_multiple_codes()
 	{
 		$response = $this->json('POST', '/test_with_multiple_errors', ["field_1" => "test"]);
@@ -83,7 +84,7 @@ public function response_contains_multiple_codes()
 		]);
 	}
 
-	/** @test */
+	#[Test]
 	public function response_contains_multiple_fields()
 	{
 		$response = $this->json('POST', '/test_with_multiple_fields', ["field_1" => "test"]);
@@ -100,7 +101,7 @@ public function response_contains_multiple_fields()
 		]);
 	}
 
-	/** @test */
+	#[Test]
 	public function response_contains_array_fields()
 	{
 		$response = $this->json('POST', '/test_with_array_fields', ["field_1" => [[]]]);
@@ -117,7 +118,7 @@ public function response_contains_array_fields()
 		]);
 	}
 
-	/** @test */
+	#[Test]
 	public function response_contains_errors_from_custom_validation_rules()
 	{
 		$response = $this->json('POST', '/test_with_custom_validation_rules', ["field_1" => 1]);
@@ -131,7 +132,7 @@ public function response_contains_errors_from_custom_validation_rules()
 		]);
 	}
 
-	/** @test */
+	#[Test]
 	public function response_contains_fallback_error_when_custom_rules_do_not_contain_the_code()
 	{
 		$response = $this->json('POST', '/test_with_custom_validation_rules_without_code', ["field_1" => 1]);
@@ -145,7 +146,7 @@ public function response_contains_fallback_error_when_custom_rules_do_not_contai
 		]);
 	}
 
-	/** @test */
+	#[Test]
 	public function response_returns_fallback_error_when_validation_rule_translation_do_not_exists()
 	{
 		$response = $this->json('POST', '/test_with_not_existing_validation_code', ["field_1" => 1]);
@@ -159,7 +160,7 @@ public function response_returns_fallback_error_when_validation_rule_translation
 		]);
 	}
 
-	/** @test */
+	#[Test]
 	public function response_returns_the_code_when_validation_rule_translation_extends_validator()
 	{
 		$response = $this->json('POST', '/test_with_existing_validation_code', ["field_1" => 1]);

tests/FactoryTest.php

@@ -3,10 +3,11 @@
 namespace Kdabrow\ValidationCodes\Tests;
 
 use Kdabrow\ValidationCodes\Factory;
+use PHPUnit\Framework\Attributes\Test;
 
 class FactoryTest extends TestCase
 {
-	/** @test */
+	#[Test]
 	public function app_resolved_instance_of_the_own_factory()
 	{
 	    $this->assertInstanceOf(

tests/HandlerTest.php

@@ -4,10 +4,11 @@
 
 use Illuminate\Contracts\Debug\ExceptionHandler;
 use Kdabrow\ValidationCodes\Handler;
+use PHPUnit\Framework\Attributes\Test;
 
 class HandlerTest extends TestCase
 {
-	/** @test */
+	#[Test]
 	public function app_resolves_instance_of_our_handler()
 	{
 		$this->assertInstanceOf(