Add ability to build FormRequest with GetValue instance

Author: pionl

composer.json

@@ -16,6 +16,7 @@
         "ext-simplexml": "*",
         "laravel/framework": "^9.25",
         "nikic/php-parser": "v4.14.0",
+        "orchestra/testbench": "^7.7",
         "phpstan/phpstan": "1.8.2",
         "phpstan/phpstan-deprecation-rules": "1.0.0",
         "phpstan/phpstan-phpunit": "1.1.1",

docs/content/en/index.md

@@ -427,49 +427,7 @@ $getValueArray = $factory->array([]);
 $getValueXml = $factory->xml(new SimpleXMLElement('<root />'));
 ```
 
-### Laravel
-
-We have implemented helper functions that pulls array data from Laravel requests:
-
-- `$this->getValueFactory->request($request);` - Initializes `ArrayData` with FormRequest and uses only **validated**
-  array data.
-- `$this->getValueFactory->requestAll($request);` - Initializes `ArrayData` with **all values** from the requests
-
-```php
-class TestAction {
-       
-    public function __construct(private readonly \Wrkflow\GetValue\GetValueFactory $getValueFactory) {}
-    
-    public function execute(\Illuminate\Http\Request $request): strin {
-        return $this->getValueFactory
-            ->request($request)
-            ->getRequiredString('test');
-    }
-}
-
-// 1. Dependency injection, 2. 
-$test = app(TestAction::class)->execute();
-```
-
-### Dependency injection
-
-To change the implementation using dependency injection just bind contracts below in your framework container:
-
-- `Wrkflow\GetValue\Contracts\TransformerStrategy $transformerStrategy`
-- `Wrkflow\GetValue\Contracts\ExceptionBuilderContract $exceptionBuilder`
-
-*Example for Laravel:*
-
-```php
-class MyServiceProvider extends ServiceProvider {
-    public function register (): void {
-        parent::register();
-        
-        $this->app->bind(Wrkflow\GetValue\Contracts\TransformerStrategy::class, MyTransformerStrategy::class);
-        $this->app->bind(Wrkflow\GetValue\Contracts\ExceptionBuilderContract::class, MyExceptionBuilder::class);
-    }
-}
-```
+Example for [Laravel](/laravel)
 
 ## Exceptions
 

docs/content/en/laravel.md

@@ -0,0 +1,74 @@
+---
+title: Laravel
+subtitle: ''
+position: 4
+---
+# GetValueFormRequest
+
+Allows you access `GetValue` instance within your `FormRequest` by extending `GetValueFormRequest`.
+
+```php
+class TestFormRequest extends GetValueFormRequest
+{
+    final public const KeyTest = 'test';
+
+    public function rules(): array
+    {
+        return [
+            self::KeyTest => ['sometimes', 'string'],
+        ];
+    }
+
+    public function getTest(): ?string
+    {
+        return $this->data->getString(self::KeyTest);
+    }
+}
+```
+
+Get value instance uses only validated data.
+
+
+# GetValueFactory
+
+We have implemented helper functions that pulls array data from Laravel requests:
+
+- `$this->getValueFactory->request($request);` - Initializes `ArrayData` with FormRequest and uses only **validated**
+  array data.
+- `$this->getValueFactory->requestAll($request);` - Initializes `ArrayData` with **all values** from the requests
+
+```php
+class TestAction {
+       
+    public function __construct(private readonly \Wrkflow\GetValue\GetValueFactory $getValueFactory) {}
+    
+    public function execute(\Illuminate\Http\Request $request): strin {
+        return $this->getValueFactory
+            ->request($request)
+            ->getRequiredString('test');
+    }
+}
+
+// 1. Dependency injection, 2. 
+$test = app(TestAction::class)->execute();
+```
+
+### Dependency injection
+
+To change the implementation using dependency injection just bind contracts below in your framework container:
+
+- `Wrkflow\GetValue\Contracts\TransformerStrategy $transformerStrategy`
+- `Wrkflow\GetValue\Contracts\ExceptionBuilderContract $exceptionBuilder`
+
+*Example for Laravel:*
+
+```php
+class MyServiceProvider extends ServiceProvider {
+    public function register (): void {
+        parent::register();
+        
+        $this->app->bind(Wrkflow\GetValue\Contracts\TransformerStrategy::class, MyTransformerStrategy::class);
+        $this->app->bind(Wrkflow\GetValue\Contracts\ExceptionBuilderContract::class, MyExceptionBuilder::class);
+    }
+}
+```

ecs.php

@@ -4,7 +4,6 @@
 
 use PhpCsFixer\Fixer\ControlStructure\YodaStyleFixer;
 use Symplify\EasyCodingStandard\Config\ECSConfig;
-use Symplify\EasyCodingStandard\ValueObject\Option;
 use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
 
 return static function (ECSConfig $containerConfigurator): void {
@@ -15,12 +14,9 @@
 
     $parameters = $containerConfigurator->parameters();
 
-    $parameters->set(Option::PARALLEL, true);
-
-    $parameters->set(
-        Option::PATHS,
+    $containerConfigurator->parallel();
+    $containerConfigurator->paths(
         [__DIR__ . '/src', __DIR__ . '/tests', __DIR__ . '/ecs.php', __DIR__ . '/rector.php']
     );
-
-    $parameters->set(Option::SKIP, [YodaStyleFixer::class]);
+    $containerConfigurator->skip([YodaStyleFixer::class]);
 };

phpunit.xml

@@ -23,4 +23,8 @@
             <directory suffix="Test.php">./tests</directory>
         </testsuite>
     </testsuites>
+    <php>
+        <env name="DB_CONNECTION" value="testing"/>
+        <env name="APP_KEY" value="base64:2fl+Ktvkfl+Fuz4Qp/A75G2RTiWVA/ZoKZvp6fiiM10="/>
+    </php>
 </phpunit>

src/Laravel/GetValueFormRequest.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wrkflow\GetValue\Laravel;
+
+use Illuminate\Foundation\Http\FormRequest;
+use Wrkflow\GetValue\GetValue;
+use Wrkflow\GetValue\GetValueFactory;
+
+class GetValueFormRequest extends FormRequest
+{
+    protected GetValue $data;
+
+    protected function passedValidation()
+    {
+        parent::passedValidation();
+
+        /** @var GetValueFactory $getValueFactory */
+        $getValueFactory = $this->container->make(GetValueFactory::class);
+
+        $this->data = $getValueFactory->request($this);
+    }
+}

tests/Laravel/AbstractLaravelTestCase.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wrkflow\GetValueTests\Laravel;
+
+use Orchestra\Testbench\TestCase as BaseTestCase;
+
+class AbstractLaravelTestCase extends BaseTestCase
+{
+}

tests/Laravel/GetValueFormRequestTest.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wrkflow\GetValueTests\Laravel;
+
+use Illuminate\Http\Request;
+
+class GetValueFormRequestTest extends AbstractLaravelTestCase
+{
+    public function testNoValue(): void
+    {
+        /** @var TestFormRequest $request */
+        $request = $this->app->make(TestFormRequest::class);
+        $this->assertNull($request->getTest());
+    }
+
+    public function testHasValue(): void
+    {
+        /** @var Request $appRequest */
+        $appRequest = $this->app['request'];
+        $appRequest->initialize(request: [
+            'test' => 'Works',
+        ]);
+        $appRequest->setMethod('POST'); // Use request data
+
+        $request = $this->app->make(TestFormRequest::class);
+        $this->assertEquals('Works', $request->getTest());
+    }
+}

tests/Laravel/TestFormRequest.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Wrkflow\GetValueTests\Laravel;
+
+use Wrkflow\GetValue\Laravel\GetValueFormRequest;
+
+class TestFormRequest extends GetValueFormRequest
+{
+    final public const KeyTest = 'test';
+
+    public function rules(): array
+    {
+        return [
+            self::KeyTest => ['sometimes', 'string'],
+        ];
+    }
+
+    public function getTest(): ?string
+    {
+        return $this->data->getString(self::KeyTest);
+    }
+}