Initial Commit

Author: johanrosenson

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true

.gitattributes

@@ -0,0 +1,8 @@
+*.md    diff=markdown
+*.php   diff=php
+
+/.editorconfig      export-ignore
+/.gitignore         export-ignore
+/.gitattributes     export-ignore
+/phpunit.xml.dist   export-ignore
+/tests              export-ignore

.gitignore

@@ -0,0 +1,4 @@
+/vendor
+composer.lock
+.phpunit.result.cache
+.DS_Store

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Johan Rosenson
+
+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

@@ -0,0 +1,63 @@
+<p align="center">
+    <a href="https://packagist.org/packages/devlop/laravel-failed-validation-response"><img src="https://img.shields.io/packagist/v/devlop/laravel-failed-validation-response" alt="Latest Stable Version"></a>
+    <a href="https://github.com/devlop/laravel-failed-validation-response/blob/master/LICENSE.md"><img src="https://img.shields.io/packagist/l/devlop/laravel-failed-validation-response" alt="License"></a>
+</p>
+
+# Laravel Failed Validation Response
+
+Trait for [Laravel FormRequests](https://laravel.com/docs/8.x/validation#form-request-validation)
+to enable the use of custom responses for failed validation (or authorization) attempts.
+
+# Installation
+
+```bash
+composer require devlop/laravel-failed-validation-response
+```
+
+# Usage
+
+```php
+use Devlop\Laravel\Validation\FailedValidationResponse;
+use Illuminate\Contracts\Validation\Validator;
+use Illuminate\Foundation\Http\FormRequest;
+use Symfony\Component\HttpFoundation\Response;
+
+class DemoRequest extends FormRequest
+{
+    use FailedValidationResponse;
+
+    // ... Your normal FormRequest logic.
+
+    /**
+     * Get the response for a failed validation attempt.
+     *
+     * @param  Validator  $validator
+     * @return Response|null
+     */
+    public function failedValidationResponse(Validator $validator) : ?Response
+    {
+        // Implement this method to use a custom response on validation failure.
+        // Do not implement this method to instead use the default behaviour.
+
+        // Example:
+        return redirect()->to('/');
+    }
+
+    /**
+     * Get the response for a failed authorization attempt.
+     *
+     * @param  Validator  $validator
+     * @return Response|null
+     */
+    public function failedAuthorizationResponse(Validator $validator) : ?Response
+    {
+        // Implement this method to use a custom response on authorization failure.
+        // Do not implement this method to instead use the default behaviour.
+
+        // Example:
+        return response()->json([
+            'reason' => 'you are not allowed to that!',
+        ], 401);
+    }
+}
+```

composer.json

@@ -0,0 +1,37 @@
+{
+    "name": "devlop/laravel-failed-validation-response",
+    "description": "Trait for Laravel FormRequest to enable the use of custom responses for failed validation attempts.",
+    "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Johan Rosenson",
+            "email": "johan@devlop.se"
+        }
+    ],
+    "require": {
+        "php": "^7.4|^8.0",
+        "laravel/framework": "^8.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9.5",
+        "symfony/var-dumper": "^5.2"
+    },
+    "autoload": {
+        "psr-4": {
+            "Devlop\\Laravel\\Validation\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Devlop\\Laravel\\Validation\\Tests\\": "tests/"
+        }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "extra": {
+        "branch-alias": {
+            "dev-master": "1.x-dev"
+        }
+    }
+}

phpunit.xml.dist

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         verbose="true">
+    <testsuites>
+        <testsuite name="devlop/laravel-failed-validation-response Test Suite">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </coverage>
+</phpunit>

src/FailedValidationResponse.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Devlop\Laravel\Validation;
+
+use Illuminate\Contracts\Validation\Validator;
+use Illuminate\Http\Exceptions\HttpResponseException;
+use Illuminate\Validation\ValidationException;
+use Symfony\Component\HttpFoundation\Response;
+
+trait FailedValidationResponse
+{
+    /**
+     * Handle a failed validation attempt.
+     *
+     * @param  Validator  $validator
+     * @return void
+     *
+     * @throws ValidationException
+     */
+    protected function failedValidation(Validator $validator)
+    {
+        $response = $this->failedValidationResponse($validator);
+
+        if ($response) {
+            throw new ValidationException($validator, $response);
+        }
+
+        parent::failedValidation();
+    }
+
+    /**
+     * Get the response for a failed validation attempt.
+     *
+     * @param  Validator  $validator
+     * @return Response|null
+     */
+    protected function failedValidationResponse(Validator $validator) : ?Response
+    {
+        // Implement this method to use a custom response on validation failure.
+        // Do not implement this method to instead use the default behaviour.
+
+        return null;
+    }
+
+    /**
+     * Handle a failed authorization attempt.
+     *
+     * @return void
+     *
+     * @throws HttpResponseException
+     * @throws \Illuminate\Validation\UnauthorizedException
+     */
+    protected function failedAuthorization()
+    {
+        $response = $this->failedAuthorizationResponse();
+
+        if ($response) {
+            throw new HttpResponseException($response);
+        }
+
+        // No custom response available, fall back to the default behaviour.
+        parent::failedAuthorization();
+    }
+
+    /**
+     * Get the response for a failed authorization attempt.
+     *
+     * @return Response|null
+     */
+    protected function failedAuthorizationResponse() : ?Response
+    {
+        // Implement this method to use a custom response on authorization failure.
+        // Do not implement this method to instead use the default behaviour.
+
+        return null;
+    }
+}

tests/FailedValidationResponseTest.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Devlop\Laravel\Validation\Tests;
+
+use PHPUnit\Framework\TestCase;
+
+final class FailedValidationResponseTest extends TestCase
+{
+    public function test_placeholder() : void
+    {
+        $this->markTestIncomplete('This test has not been implemented yet.');
+    }
+}