[8.x] Consume Blade Directive (#39100)

* initial pass at consume directive

* rename method

* Track render data for consume

* Add more variety to tests

* formatting

* Update tests

* Handle flushComponents

* rename to aware

* formatting

* formatting

Co-authored-by: Taylor Otwell <[email protected]>

Author: inxilpro

src/Illuminate/View/Compilers/Concerns/CompilesComponents.php

@@ -161,6 +161,20 @@ protected function compileProps($expression)
 <?php unset(\$__defined_vars); ?>";
     }
 
+    /**
+     * Compile the aware statement into valid PHP.
+     *
+     * @param  string  $expression
+     * @return string
+     */
+    protected function compileAware($expression)
+    {
+        return "<?php foreach ({$expression} as \$__key => \$__value) {
+    \$__consumeVariable = is_string(\$__key) ? \$__key : \$__value;
+    \$\$__consumeVariable = is_string(\$__key) ? \$__env->getConsumableComponentData(\$__key, \$__value) : \$__env->getConsumableComponentData(\$__value);
+} ?>";
+    }
+
     /**
      * Sanitize the given component attribute value.
      *

src/Illuminate/View/Concerns/ManagesComponents.php

@@ -24,6 +24,13 @@ trait ManagesComponents
      */
     protected $componentData = [];
 
+    /**
+     * The component data for the component that is currently being rendered.
+     *
+     * @var array
+     */
+    protected $currentComponentData = [];
+
     /**
      * The slot contents for the component.
      *
@@ -81,16 +88,23 @@ public function renderComponent()
     {
         $view = array_pop($this->componentStack);
 
-        $data = $this->componentData();
-
-        $view = value($view, $data);
+        $this->currentComponentData = array_merge(
+            $previousComponentData = $this->currentComponentData,
+            $data = $this->componentData()
+        );
 
-        if ($view instanceof View) {
-            return $view->with($data)->render();
-        } elseif ($view instanceof Htmlable) {
-            return $view->toHtml();
-        } else {
-            return $this->make($view, $data)->render();
+        try {
+            $view = value($view, $data);
+
+            if ($view instanceof View) {
+                return $view->with($data)->render();
+            } elseif ($view instanceof Htmlable) {
+                return $view->toHtml();
+            } else {
+                return $this->make($view, $data)->render();
+            }
+        } finally {
+            $this->currentComponentData = $previousComponentData;
         }
     }
 
@@ -115,6 +129,36 @@ protected function componentData()
         );
     }
 
+    /**
+     * Get an item from the component data that exists above the current component.
+     *
+     * @param  string  $key
+     * @param  mixed  $default
+     * @return mixed|null
+     */
+    public function getConsumableComponentData($key, $default = null)
+    {
+        if (array_key_exists($key, $this->currentComponentData)) {
+            return $this->currentComponentData[$key];
+        }
+
+        $currentComponent = count($this->componentStack);
+
+        if ($currentComponent === 0) {
+            return value($default);
+        }
+
+        for ($i = $currentComponent - 1; $i >= 0; $i--) {
+            $data = $this->componentData[$i] ?? [];
+
+            if (array_key_exists($key, $data)) {
+                return $data[$key];
+            }
+        }
+
+        return value($default);
+    }
+
     /**
      * Start the slot rendering process.
      *
@@ -173,5 +217,6 @@ protected function flushComponents()
     {
         $this->componentStack = [];
         $this->componentData = [];
+        $this->currentComponentData = [];
     }
 }

tests/Integration/View/BladeTest.php

@@ -76,6 +76,32 @@ public function tested_nested_anonymous_attribute_proxying_works_correctly()
         $this->assertSame('<input class="disabled-class" foo="bar" type="text" disabled />', trim($view));
     }
 
+    public function test_consume_defaults()
+    {
+        $view = View::make('consume')->render();
+
+        $this->assertSame('<h1>Menu</h1>
+<div>Slot: A, Color: orange, Default: foo</div>
+<div>Slot: B, Color: red, Default: foo</div>
+<div>Slot: C, Color: blue, Default: foo</div>
+<div>Slot: D, Color: red, Default: foo</div>
+<div>Slot: E, Color: red, Default: foo</div>
+<div>Slot: F, Color: yellow, Default: foo</div>', trim($view));
+    }
+
+    public function test_consume_with_props()
+    {
+        $view = View::make('consume', ['color' => 'rebeccapurple'])->render();
+
+        $this->assertSame('<h1>Menu</h1>
+<div>Slot: A, Color: orange, Default: foo</div>
+<div>Slot: B, Color: rebeccapurple, Default: foo</div>
+<div>Slot: C, Color: blue, Default: foo</div>
+<div>Slot: D, Color: rebeccapurple, Default: foo</div>
+<div>Slot: E, Color: rebeccapurple, Default: foo</div>
+<div>Slot: F, Color: yellow, Default: foo</div>', trim($view));
+    }
+
     protected function getEnvironmentSetUp($app)
     {
         $app['config']->set('view.paths', [__DIR__.'/templates']);

tests/Integration/View/templates/components/menu-item.blade.php

@@ -0,0 +1,2 @@
+@aware(['color' => 'red', 'default' => 'foo'])
+<div>Slot: {{ $slot }}, Color: {{ $color }}, Default: {{ $default }}</div>

tests/Integration/View/templates/components/menu.blade.php

@@ -0,0 +1,6 @@
+<h1>Menu</h1>
+<x-menu-item color="orange">A</x-menu-item>
+<x-menu-item>B</x-menu-item>
+{{ $slot }}
+<x-menu-item>E</x-menu-item>
+<x-menu-item color="yellow">F</x-menu-item>

tests/Integration/View/templates/consume.blade.php

@@ -0,0 +1,15 @@
+@isset($color)
+
+<x-menu :color="$color">
+<x-menu-item color="blue">C</x-menu-item>
+<x-menu-item>D</x-menu-item>
+</x-menu>
+
+@else
+
+<x-menu>
+<x-menu-item color="blue">C</x-menu-item>
+<x-menu-item>D</x-menu-item>
+</x-menu>
+
+@endisset