Merge pull request #581 from flightphp/fix/bug-with-multiple-view-renders

fadrian06 · web-flow · commit 39ac87c54bd5 · 2024-06-03T11:18:17.000-04:00
Fix/bug with multiple view renders
diff --git a/flight/template/View.php b/flight/template/View.php
@@ -20,6 +20,8 @@ class View
     /** File extension. */
     public string $extension = '.php';
 
+    public bool $preserveVars = true;
+
     /**
      * View variables.
      *
@@ -114,12 +116,16 @@ public function render(string $file, ?array $data = null): void
             throw new \Exception("Template file not found: {$normalized_path}.");
         }
 
-        if (\is_array($data)) {
-            $this->vars = \array_merge($this->vars, $data);
-        }
-
         \extract($this->vars);
 
+        if (\is_array($data) === true) {
+            \extract($data);
+
+            if ($this->preserveVars === true) {
+                $this->vars = \array_merge($this->vars, $data);
+            }
+        }
+
         include $this->template;
     }
 
diff --git a/tests/FlightTest.php b/tests/FlightTest.php
@@ -22,6 +22,7 @@ protected function setUp(): void
         $_REQUEST = [];
         Flight::init();
         Flight::setEngine(new Engine());
+        Flight::set('flight.views.path', __DIR__ . '/views');
     }
 
     protected function tearDown(): void
@@ -354,4 +355,43 @@ public function after()
 
         $this->expectOutputString('Thisisaroutewithhtml');
     }
+
+    /** @dataProvider \tests\ViewTest::renderDataProvider */
+    public function testDoesNotPreserveVarsWhenFlagIsDisabled(
+        string $output,
+        array $renderParams,
+        string $regexp
+    ): void
+    {
+        Flight::view()->preserveVars = false;
+
+        $this->expectOutputString($output);
+        Flight::render(...$renderParams);
+
+        set_error_handler(function (int $code, string $message) use ($regexp): void {
+            $this->assertMatchesRegularExpression($regexp, $message);
+        });
+
+        Flight::render($renderParams[0]);
+
+        restore_error_handler();
+    }
+
+    public function testKeepThePreviousStateOfOneViewComponentByDefault(): void
+    {
+        $this->expectOutputString(<<<html
+        <div>Hi</div>
+        <div>Hi</div>
+
+        <input type="number" />
+
+        <input type="number" />
+
+        html);
+
+        Flight::render('myComponent', ['prop' => 'Hi']);
+        Flight::render('myComponent');
+        Flight::render('input', ['type' => 'number']);
+        Flight::render('input');
+    }
 }
diff --git a/tests/ViewTest.php b/tests/ViewTest.php
@@ -152,4 +152,84 @@ public static function normalizePath(string $path, string $separator = DIRECTORY
             $viewMock::normalizePath('C:/xampp/htdocs/libs/Flight\core\index.php', '°')
         );
     }
+
+    /** @dataProvider renderDataProvider */
+    public function testDoesNotPreserveVarsWhenFlagIsDisabled(
+        string $output,
+        array $renderParams,
+        string $regexp
+    ): void {
+        $this->view->preserveVars = false;
+
+        $this->expectOutputString($output);
+        $this->view->render(...$renderParams);
+
+        set_error_handler(function (int $code, string $message) use ($regexp): void {
+            $this->assertMatchesRegularExpression($regexp, $message);
+        });
+
+        $this->view->render($renderParams[0]);
+
+        restore_error_handler();
+    }
+
+    public function testKeepThePreviousStateOfOneViewComponentByDefault(): void
+    {
+        $this->expectOutputString(<<<html
+        <div>Hi</div>
+        <div>Hi</div>
+
+        <input type="number" />
+
+        <input type="number" />
+
+        html);
+
+        $this->view->render('myComponent', ['prop' => 'Hi']);
+        $this->view->render('myComponent');
+        $this->view->render('input', ['type' => 'number']);
+        $this->view->render('input');
+    }
+
+    public function testKeepThePreviousStateOfDataSettedBySetMethod(): void
+    {
+        $this->view->preserveVars = false;
+
+        $this->view->set('prop', 'bar');
+
+        $this->expectOutputString(<<<html
+        <div>qux</div>
+        <div>bar</div>
+
+        html);
+
+        $this->view->render('myComponent', ['prop' => 'qux']);
+        $this->view->render('myComponent');
+    }
+
+    public static function renderDataProvider(): array
+    {
+        return [
+            [
+                <<<html
+                <div>Hi</div>
+                <div></div>
+
+                html,
+                ['myComponent', ['prop' => 'Hi']],
+                '/^Undefined variable:? \$?prop$/'
+            ],
+            [
+                <<<html
+
+                <input type="number" />
+
+                <input type="text" />
+
+                html,
+                ['input', ['type' => 'number']],
+                '/^.*$/'
+            ],
+        ];
+    }
 }
diff --git a/tests/views/input.php b/tests/views/input.php
@@ -0,0 +1,7 @@
+<?php
+
+$type ??= 'text';
+
+?>
+
+<input type="<?= $type ?>" />
diff --git a/tests/views/myComponent.php b/tests/views/myComponent.php
@@ -0,0 +1 @@
+<div><?= $prop ?></div>

-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +<?php
++
 +$type ??= 'text';
++
 +?>
++
 +<input type="<?= $type ?>" />