Add the when method for optional validation

Author: onursimsek

src/Attributes/Precondition.php

@@ -23,6 +23,10 @@ public function __construct(string $validator)
 
     public function validate(Request $request): bool
     {
+        if (! $this->validator->when($request)) {
+            return true;
+        }
+
         if (empty($this->validator->parameter($request))) {
             $this->validator->preProcess();
 

src/Contracts/PreconditionValidator.php

@@ -8,7 +8,15 @@
 
 interface PreconditionValidator
 {
+    public function when(Request $request): bool;
+
+    public function preProcess(): void;
+
     public function parameter(Request $request);
 
     public function __invoke(Request $request): bool;
+
+    public function getRequiredMessage(): string;
+
+    public function getFailedMessage(): string;
 }

src/Validators/PreconditionValidator.php

@@ -4,16 +4,17 @@
 
 namespace OnurSimsek\Precondition\Validators;
 
+use Illuminate\Http\Request;
 use OnurSimsek\Precondition\Contracts\PreconditionValidator as PreconditionValidatorContract;
 
 abstract class PreconditionValidator implements PreconditionValidatorContract
 {
-    final public function getRequiredMessage()
+    final public function getRequiredMessage(): string
     {
         return isset($this->messages()['required']) ? $this->messages()['required'] : config('precondition.required_message');
     }
 
-    final public function getFailedMessage()
+    final public function getFailedMessage(): string
     {
         return isset($this->messages()['failed']) ? $this->messages()['failed'] : config('precondition.failed_message');
     }
@@ -33,4 +34,9 @@ public function preProcess(): void
     {
         //
     }
+
+    public function when(Request $request): bool
+    {
+        return true;
+    }
 }

tests/Unit/Attributes/PreconditionTest.php

@@ -11,6 +11,7 @@
 use OnurSimsek\Precondition\Exceptions\PreconditionRequiredException;
 use OnurSimsek\Precondition\Tests\TestCase;
 use OnurSimsek\Precondition\Tests\Unit\Fixtures\LostUpdateValidator;
+use OnurSimsek\Precondition\Tests\Unit\Fixtures\PrivateArticleValidator;
 use PHPUnit\Framework\Attributes\Test;
 
 class PreconditionTest extends TestCase
@@ -81,4 +82,50 @@ public function it_can_be_validate_a_proper_request()
 
         self::assertTrue($this->precondition->validate($request));
     }
+
+    #[Test]
+    public function it_can_be_validate_sometimes()
+    {
+        $precondition = new Precondition(PrivateArticleValidator::class);
+
+        $article = new \stdClass();
+        $article->is_private = false;
+
+        $request = $this->getMockBuilder(Request::class)->getMock();
+        $request->expects($this->any())
+            ->method('route')
+            ->with('article')
+            ->willReturn($article);
+
+        self::assertTrue($precondition->validate($request));
+
+        // Private article required exception test
+        $article->is_private = true;
+        self::expectException(PreconditionRequiredException::class);
+        $precondition->validate($request);
+
+        // Private article validation failed exception test
+        $request->expects($this->exactly(2))
+            ->method('header')
+            ->with('X-Article-Secret-Code')
+            ->willReturn(1234);
+
+        $article->is_private = true;
+        $article->secret_code = 4321;
+
+        self::expectException(PreconditionFailedException::class);
+        $precondition->validate($request);
+
+        // Private article validate test
+        $secret = 1234;
+        $request->expects($this->exactly(2))
+            ->method('header')
+            ->with('X-Article-Secret-Code')
+            ->willReturn($secret);
+
+        $article->is_private = true;
+        $article->secret_code = $secret;
+
+        self::assertTrue($precondition->validate($request));
+    }
 }

tests/Unit/Fixtures/PrivateArticleValidator.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OnurSimsek\Precondition\Tests\Unit\Fixtures;
+
+use Illuminate\Http\Request;
+use OnurSimsek\Precondition\Validators\PreconditionValidator;
+
+class PrivateArticleValidator extends PreconditionValidator
+{
+    public function when(Request $request): bool
+    {
+        return $request->route('article')->is_private;
+    }
+
+    public function parameter(Request $request)
+    {
+        return $request->header('X-Article-Secret-Code');
+    }
+
+    public function __invoke(Request $request): bool
+    {
+        return $this->parameter($request) == $request->route('article')->secret_code;
+    }
+}