wip merge props

NeoIsRecursive · NeoIsRecursive · commit db12b5b8754b · 2025-02-23T17:17:31.000+01:00
diff --git a/composer.json b/composer.json
@@ -26,6 +26,7 @@
     }
   ],
   "require": {
+    "php": "^8.4",
     "tempest/framework": "dev-main"
   },
   "config": {
diff --git a/composer.lock b/composer.lock
diff --git a/src/Concerns/IsMergeableProp.php b/src/Concerns/IsMergeableProp.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NeoIsRecursive\Inertia\Concerns;
+
+use NeoIsRecursive\Inertia\Contracts\MergeableProp;
+
+/**
+ * @implements MergeableProp
+ */
+trait IsMergeableProp
+{
+    public function merge(): self
+    {
+        $this->shouldMerge = true;
+
+        return $this;
+    }
+}
diff --git a/src/Contracts/MergeableProp.php b/src/Contracts/MergeableProp.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NeoIsRecursive\Inertia\Contracts;
+
+interface MergeableProp
+{
+    public bool $shouldMerge { get; }
+
+    public function merge(): self;
+}
diff --git a/src/Http/InertiaResponse.php b/src/Http/InertiaResponse.php
@@ -3,6 +3,7 @@
 namespace NeoIsRecursive\Inertia\Http;
 
 use Closure;
+use NeoIsRecursive\Inertia\Contracts\MergeableProp;
 use NeoIsRecursive\Inertia\Props\AlwaysProp;
 use NeoIsRecursive\Inertia\Props\LazyProp;
 use NeoIsRecursive\Inertia\Support\Header;
@@ -11,6 +12,7 @@
 use Tempest\Router\IsResponse;
 use Tempest\Router\Request;
 use Tempest\Router\Response;
+use Tempest\Support\ArrayHelper;
 
 use function Tempest\invoke;
 use function Tempest\Support\arr;
@@ -26,24 +28,31 @@ public function __construct(
         string $rootView,
         string $version,
     ) {
+
         $alwaysProps = $this->resolveAlwaysProps(props: $props);
-        $props = $this->resolvePartialProps(request: $request, component: $page, props: $props);
+        $partialProps = $this->resolvePartialProps(request: $request, component: $page, props: $props);
+        $mergeProps = $this->resolveMergeProps($props, $request);
 
         $props = $this->evaluateProps(
-            props: array_merge($props, $alwaysProps),
+            props: array_merge(
+                $alwaysProps,
+                $partialProps,
+                $mergeProps
+            ),
             request: $request,
             unpackDotProps: true
         );
 
         $page = [
             'component' => $page,
             'props' => $props,
-            'url' => $request->getUri(),
+            'url' => $request->uri,
             'version' => $version,
+            'mergeProps' => array_keys($mergeProps),
         ];
 
 
-        if (array_key_exists(Header::INERTIA, $request->getHeaders()) && $request->getHeaders()[Header::INERTIA] == 'true') {
+        if (array_key_exists(Header::INERTIA, $request->headers) && $request->headers[Header::INERTIA] == 'true') {
             $this->status = Status::OK;
 
             $this->body = $page;
@@ -69,7 +78,7 @@ private function resolveAlwaysProps(array $props): array
 
     private function resolvePartialProps(Request $request, string $component, array $props): array
     {
-        $headers = $request->getHeaders();
+        $headers = $request->headers;
 
         $partialHeader = $headers[Header::PARTIAL_COMPONENT] ?? null;
 
@@ -84,9 +93,9 @@ private function resolvePartialProps(Request $request, string $component, array
         $only = array_filter(explode(',', $headers[Header::PARTIAL_ONLY] ?? ''));
         $except = array_filter(explode(',', $headers[Header::PARTIAL_EXCEPT] ?? ''));
 
-        $props = $only ? array_intersect_key($props, array_flip((array) $only)) : $props;
+        $props = $only ? array_intersect_key($props, array_flip($only)) : $props;
 
-        if ($except) {
+        if (count($except) > 0) {
             foreach ($except as $key) {
                 unset($props[$key]);
             }
@@ -95,7 +104,20 @@ private function resolvePartialProps(Request $request, string $component, array
         return $props;
     }
 
-    public function evaluateProps(array $props, Request $request, bool $unpackDotProps = true): array
+    public static function resolveMergeProps(array $props, Request $request): array
+    {
+        $resetProps = arr(explode(',', $request->headers[Header::RESET] ?? ''));
+        $mergeProps = arr($props)
+            ->filter(fn($prop) => $prop instanceof MergeableProp && $prop->shouldMerge)
+            ->filter(
+                fn($_, $key) => ! $resetProps->contains($key)
+            )
+            ->keys();
+
+        return $mergeProps->toArray();
+    }
+
+    public static function evaluateProps(array $props, Request $request, bool $unpackDotProps = true): array
     {
         foreach ($props as $key => $value) {
             if ($value instanceof Closure) {
@@ -110,8 +132,12 @@ public function evaluateProps(array $props, Request $request, bool $unpackDotPro
                 $value = $value();
             }
 
+            if ($value instanceof ArrayHelper) {
+                $value = $value->toArray();
+            }
+
             if (is_array($value)) {
-                $value = $this->evaluateProps($value, $request, false);
+                $value = self::evaluateProps($value, $request, false);
             }
 
             if ($unpackDotProps && str_contains($key, '.')) {
diff --git a/src/Http/Middleware.php b/src/Http/Middleware.php
@@ -33,19 +33,19 @@ public function __invoke(Request $request, HttpMiddlewareCallable $next): Respon
 
         $response->addHeader('Vary', Header::INERTIA);
 
-        if (!array_key_exists(Header::INERTIA, $request->getHeaders())) {
+        if (!array_key_exists(Header::INERTIA, $request->headers)) {
             return $response;
         }
 
-        $versionHeaderValue = $request->getHeaders()[Header::VERSION] ?? '';
+        $versionHeaderValue = $request->headers[Header::VERSION] ?? '';
 
-        if ($request->getMethod() === Method::GET && $versionHeaderValue !== $this->inertia->version) {
+        if ($request->method === Method::GET && $versionHeaderValue !== $this->inertia->version) {
             // TODO: reflash session data
 
-            return $this->inertia->location($request->getUri());
+            return $this->inertia->location($request->uri);
         }
 
-        if ($response->getStatus() === Status::FOUND && in_array($request->getMethod(), [Method::POST, Method::PUT, Method::PATCH])) {
+        if ($response->status === Status::FOUND && in_array($request->method, [Method::POST, Method::PUT, Method::PATCH])) {
             // TODO: set status to 303
             // return new GenericResponse(
             //     status: Status::SEE_OTHER,
diff --git a/src/Inertia.php b/src/Inertia.php
@@ -53,7 +53,7 @@ public function render(string $page, array $props = []): InertiaResponse
 
     public function location(string|Redirect $url): Response
     {
-        $isInertiaRequest = isset($this->container->get(Request::class)->getHeaders()[Header::INERTIA]);
+        $isInertiaRequest = isset($this->container->get(Request::class)->headers[Header::INERTIA]);
 
         if ($isInertiaRequest) {
             if ($url instanceof Redirect) {
diff --git a/src/Props/AlwaysProp.php b/src/Props/AlwaysProp.php
@@ -3,14 +3,21 @@
 namespace NeoIsRecursive\Inertia\Props;
 
 use Closure;
+use NeoIsRecursive\Inertia\Concerns\IsMergeableProp;
+use NeoIsRecursive\Inertia\Contracts\MergeableProp;
 use Tempest\Reflection\FunctionReflector;
 use Tempest\Reflection\MethodReflector;
 
 use function Tempest\invoke;
 
-final readonly class AlwaysProp
+final class AlwaysProp implements MergeableProp
 {
-    public function __construct(public MethodReflector|FunctionReflector|string|Closure $value) {}
+    use IsMergeableProp;
+
+    public function __construct(
+        public readonly MethodReflector|FunctionReflector|string|Closure|array $value,
+        public private(set) bool $shouldMerge = false
+    ) {}
 
     public function __invoke()
     {
diff --git a/src/Props/DeferredProp.php b/src/Props/DeferredProp.php
@@ -0,0 +1,26 @@
+<?php
+
+namespace NeoIsRecursive\Inertia\Props;
+
+use Closure;
+use NeoIsRecursive\Inertia\Concerns\IsMergeableProp;
+use NeoIsRecursive\Inertia\Contracts\MergeableProp;
+use Tempest\Reflection\FunctionReflector;
+use Tempest\Reflection\MethodReflector;
+
+use function Tempest\invoke;
+
+final class DeferredProp implements MergeableProp
+{
+    use IsMergeableProp;
+
+    public function __construct(
+        public MethodReflector|FunctionReflector|string|array|Closure $callback,
+        public private(set) bool $shouldMerge = false
+    ) {}
+
+    public function __invoke()
+    {
+        return invoke($this->callback);
+    }
+}
diff --git a/src/Props/LazyProp.php b/src/Props/LazyProp.php
@@ -3,12 +3,21 @@
 namespace NeoIsRecursive\Inertia\Props;
 
 use Closure;
+use NeoIsRecursive\Inertia\Concerns\IsMergeableProp;
+use NeoIsRecursive\Inertia\Contracts\MergeableProp;
+use Tempest\Reflection\FunctionReflector;
+use Tempest\Reflection\MethodReflector;
 
 use function Tempest\invoke;
 
-final readonly class LazyProp
+final class LazyProp implements MergeableProp
 {
-    public function __construct(public Closure $callback) {}
+    use IsMergeableProp;
+
+    public function __construct(
+        public MethodReflector|FunctionReflector|string|array|Closure $callback,
+        public private(set) bool $shouldMerge = false
+    ) {}
 
     public function __invoke()
     {
diff --git a/src/Support/Header.php b/src/Support/Header.php
@@ -11,4 +11,5 @@ class Header
     public const PARTIAL_COMPONENT = 'x-inertia-partial-component';
     public const PARTIAL_ONLY = 'x-inertia-partial-data';
     public const PARTIAL_EXCEPT = 'x-inertia-partial-except';
+    public const RESET = 'X-Inertia-Reset';
 }
diff --git a/src/Views/InertiaBaseView.php b/src/Views/InertiaBaseView.php
@@ -26,17 +26,4 @@ public function renderInertiaElement(string $id): string
 
         return $template;
     }
-
-    public function reactRefresh(): string
-    {
-        return <<<'html'
-        <script type="module">
-            import RefreshRuntime from 'http://localhost:5173/@react-refresh'
-            RefreshRuntime.injectIntoGlobalHook(window)
-            window.$RefreshReg$ = () => {}
-            window.$RefreshSig$ = () => (type) => type
-            window.__vite_plugin_react_preamble_installed__ = true
-        </script>
-        html;
-    }
 }
diff --git a/tests/Integration/InertiaTest.php b/tests/Integration/InertiaTest.php
@@ -32,7 +32,7 @@ public function test_location_response_for_inertia_requests(): void
         $response = $factory->location('https://inertiajs.com');
 
         $this->assertInstanceOf(Response::class, $response);
-        $this->assertEquals(Status::CONFLICT, $response->getStatus());
+        $this->assertEquals(Status::CONFLICT, $response->status);
         $this->assertEquals('https://inertiajs.com', $response->getHeader(Header::LOCATION)->values[0]);
     }
 
@@ -43,7 +43,7 @@ public function test_location_response_for_non_inertia_requests(): void
         $response = $factory->location('https://inertiajs.com');
 
         $this->assertInstanceOf(Redirect::class, $response);
-        $this->assertEquals(Status::FOUND, $response->getStatus());
+        $this->assertEquals(Status::FOUND, $response->status);
         $this->assertEquals('https://inertiajs.com', $response->getHeader('Location')->values[0]);
     }
 
@@ -56,7 +56,7 @@ public function test_location_response_for_inertia_requests_using_redirect_respo
         $response = $factory->location($redirect);
 
         $this->assertInstanceOf(Response::class, $response);
-        $this->assertEquals(Status::CONFLICT, $response->getStatus());
+        $this->assertEquals(Status::CONFLICT, $response->status);
         $this->assertEquals('https://inertiajs.com', $response->getHeader(Header::LOCATION)->values[0]);
     }
 
@@ -66,7 +66,7 @@ public function test_location_response_for_non_inertia_requests_using_redirect_r
         $response = $this->createFactory()->location($redirect);
 
         $this->assertInstanceOf(Redirect::class, $response);
-        $this->assertEquals(Status::FOUND, $response->getStatus());
+        $this->assertEquals(Status::FOUND, $response->status);
         $this->assertEquals('https://inertiajs.com', $response->getHeader('Location')->values[0]);
     }
 
@@ -75,7 +75,7 @@ public function test_location_redirects_are_not_modified(): void
         $response = $this->createFactory()->location('/foo');
 
         $this->assertInstanceOf(Redirect::class, $response);
-        $this->assertEquals(Status::FOUND, $response->getStatus());
+        $this->assertEquals(Status::FOUND, $response->status);
         $this->assertEquals('/foo', $response->getHeader('Location')->values[0]);
     }
 
@@ -86,7 +86,7 @@ public function test_location_response_for_non_inertia_requests_using_redirect_r
         $response = $this->createFactory()->location($redirect);
 
         $this->assertInstanceOf(Redirect::class, $response);
-        $this->assertEquals(Status::FOUND, $response->getStatus());
+        $this->assertEquals(Status::FOUND, $response->status);
         $this->assertEquals('https://inertiajs.com', $response->getHeader('Location')->values[0]);
         // $this->assertSame(get(Session::class), $response->());
         // $this->assertSame($request, $response->getRequest());
@@ -109,7 +109,8 @@ public function test_shared_data_can_be_shared_from_anywhere(): void
             ],
             'url' => uri([TestController::class, 'testCanSharePropsFromAnyWhere']),
             'version' => $version,
-        ], $response->getBody());
+            'mergeProps' => [],
+        ], $response->body);
     }
 
     public function test_can_flush_shared_data(): void
diff --git a/tests/Integration/MergePropTest.php b/tests/Integration/MergePropTest.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace NeoIsRecursive\Inertia\Tests\Integration;
+
+use NeoIsRecursive\Inertia\Props\AlwaysProp;
+use NeoIsRecursive\Inertia\Tests\TestCase;
+use Tempest\Router\Request;
+
+class MergePropTest extends TestCase
+{
+    public function test_can_invoke_with_a_callback(): void
+    {
+        $mergeProp = new AlwaysProp(fn() =>  'A merge prop value')->merge();
+
+        $this->assertSame('A merge prop value', $mergeProp());
+    }
+
+    public function test_can_invoke_with_a_non_callback(): void
+    {
+        $mergeProp = new AlwaysProp(['key' => 'value'])->merge();
+
+        $this->assertSame(['key' => 'value'], $mergeProp());
+    }
+
+    public function test_can_resolve_bindings_when_invoked(): void
+    {
+        $mergeProp = new AlwaysProp(
+            fn(Request $request) => $request
+        )->merge();
+
+        $this->assertInstanceOf(Request::class, $mergeProp());
+    }
+}
diff --git a/tests/Integration/ResponseTest.php b/tests/Integration/ResponseTest.php
diff --git a/tests/TestCase.php b/tests/TestCase.php

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@`
`26`	`26`	`}`
`27`	`27`	`],`
`28`	`28`	`"require": {`
	`29`	`+ "php": "^8.4",`
`29`	`30`	`"tempest/framework": "dev-main"`
`30`	`31`	`},`
`31`	`32`	`"config": {`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public function render(string $page, array $props = []): InertiaResponse`
`53`	`53`
`54`	`54`	`public function location(string\|Redirect $url): Response`
`55`	`55`	`{`
`56`		`- $isInertiaRequest = isset($this->container->get(Request::class)->getHeaders()[Header::INERTIA]);`
	`56`	`+ $isInertiaRequest = isset($this->container->get(Request::class)->headers[Header::INERTIA]);`
`57`	`57`
`58`	`58`	`if ($isInertiaRequest) {`
`59`	`59`	`if ($url instanceof Redirect) {`