integration tests and custom prefixes

laravel · Dec 16, 2022 · 1ff0379 · 1ff0379
1 parent 5a1eb8b
commit 1ff0379
Show file tree

Hide file tree

Showing 8 changed files with 90 additions and 12 deletions.
diff --git a/src/Illuminate/View/Compilers/BladeCompiler.php b/src/Illuminate/View/Compilers/BladeCompiler.php
@@ -693,15 +693,22 @@ public function getClassComponentAliases()
      * Register a new anonymous component path.
      *
      * @param  string  $path
+     * @param  string|null  $prefix
      * @return void
      */
-    public function anonymousComponentPath(string $path)
+    public function anonymousComponentPath(string $path, string $prefix = null)
     {
-        $this->anonymousComponentPaths[] = $path;
+        $prefixHash = md5($prefix ?: $path);
+
+        $this->anonymousComponentPaths[] = [
+            'path' => $path,
+            'prefix' => $prefix,
+            'prefixHash' => $prefixHash,
+        ];
 
         Container::getInstance()
                 ->make(ViewFactory::class)
-                ->addNamespace(md5($path), $path);
+                ->addNamespace($prefixHash, $path);
     }
 
     /**

diff --git a/src/Illuminate/View/Compilers/ComponentTagCompiler.php b/src/Illuminate/View/Compilers/ComponentTagCompiler.php
@@ -314,15 +314,22 @@ public function componentClass(string $component)
      */
     protected function guessAnonymousComponentUsingPaths(Factory $viewFactory, string $component)
     {
-        if (str_contains($component, ViewFinderInterface::HINT_PATH_DELIMITER)) {
-            return;
-        }
+        $delimiter = ViewFinderInterface::HINT_PATH_DELIMITER;
 
         foreach ($this->blade->getAnonymousComponentPaths() as $path) {
             try {
+                if (str_contains($component, $delimiter) &&
+                    ! str_starts_with($component, $path['prefix'].$delimiter)) {
+                    continue;
+                }
+
+                $formattedComponent = str_starts_with($component, $path['prefix'].$delimiter)
+                        ? Str::after($component, $delimiter)
+                        : $component;
+
                 if (! is_null($guess = match (true) {
-                    $viewFactory->exists($guess = md5($path).ViewFinderInterface::HINT_PATH_DELIMITER.$component) => $guess,
-                    $viewFactory->exists($guess = md5($path).ViewFinderInterface::HINT_PATH_DELIMITER.$component.'.index') => $guess,
+                    $viewFactory->exists($guess = $path['prefixHash'].$delimiter.$formattedComponent) => $guess,
+                    $viewFactory->exists($guess = $path['prefixHash'].$delimiter.$formattedComponent.'.index') => $guess,
                     default => null,
                 })) {
                     return $guess;

diff --git a/tests/Integration/View/BladeAnonymousComponentTest.php b/tests/Integration/View/BladeAnonymousComponentTest.php
@@ -0,0 +1,48 @@
+<?php
+
+namespace Illuminate\Tests\Integration\View;
+
+use Illuminate\Support\Facades\Blade;
+use Illuminate\Support\Facades\View;
+use InvalidArgumentException;
+use Orchestra\Testbench\TestCase;
+
+class BladeAnonymousComponentTest extends TestCase
+{
+    public function test_anonymous_components_with_custom_paths_can_be_rendered()
+    {
+        Blade::anonymousComponentPath(__DIR__.'/anonymous-components-1', 'layouts');
+        Blade::anonymousComponentPath(__DIR__.'/anonymous-components-2');
+
+        $view = View::make('page')->render();
+
+        $this->assertTrue(str_contains($view, 'Panel content.'));
+        $this->assertTrue(str_contains($view, 'class="app-layout"'));
+        $this->assertTrue(str_contains($view, 'class="danger-button"'));
+    }
+
+    public function test_anonymous_components_with_custom_paths_cant_be_rendered_as_normal_views()
+    {
+        $this->expectException(InvalidArgumentException::class);
+
+        Blade::anonymousComponentPath(__DIR__.'/anonymous-components-1', 'layouts');
+        Blade::anonymousComponentPath(__DIR__.'/anonymous-components-2');
+
+        $view = View::make('layouts::app')->render();
+    }
+
+    public function test_anonymous_components_with_custom_paths_cant_be_rendered_as_normal_views_even_with_no_prefix()
+    {
+        $this->expectException(InvalidArgumentException::class);
+
+        Blade::anonymousComponentPath(__DIR__.'/anonymous-components-1', 'layouts');
+        Blade::anonymousComponentPath(__DIR__.'/anonymous-components-2');
+
+        $view = View::make('panel')->render();
+    }
+
+    protected function getEnvironmentSetUp($app)
+    {
+        $app['config']->set('view.paths', [__DIR__.'/anonymous-components-templates']);
+    }
+}
diff --git a/tests/Integration/View/anonymous-components-1/app.blade.php b/tests/Integration/View/anonymous-components-1/app.blade.php
@@ -0,0 +1,3 @@
+<div class="app-layout">
+    {{ $slot }}
+</div>
diff --git a/tests/Integration/View/anonymous-components-2/buttons/danger.blade.php b/tests/Integration/View/anonymous-components-2/buttons/danger.blade.php
@@ -0,0 +1,3 @@
+<div class="danger-button">
+    Danger button.
+</div>
diff --git a/tests/Integration/View/anonymous-components-2/panel.blade.php b/tests/Integration/View/anonymous-components-2/panel.blade.php
@@ -0,0 +1,3 @@
+<div class="panel">
+    {{ $slot }}
+</div>
diff --git a/tests/Integration/View/anonymous-components-templates/page.blade.php b/tests/Integration/View/anonymous-components-templates/page.blade.php
@@ -0,0 +1,7 @@
+<x-layouts::app>
+    <x-panel>
+        Panel content.
+
+        <x-buttons.danger />
+    </x-panel>
+</x-layouts::app>
diff --git a/tests/View/Blade/BladeComponentTagCompilerTest.php b/tests/View/Blade/BladeComponentTagCompilerTest.php
@@ -585,14 +585,14 @@ public function testClasslessComponentsWithAnonymousComponentPath()
         $blade = m::mock(BladeCompiler::class)->makePartial();
 
         $blade->shouldReceive('getAnonymousComponentPaths')->once()->andReturn([
-            'test-directory',
+            ['path' => 'test-directory', 'prefix' => null, 'prefixHash' => md5('test-directory')],
         ]);
 
         $compiler = $this->compiler([], [], $blade);
 
         $result = $compiler->compileTags('<x-panel />');
 
-        $this->assertSame("##BEGIN-COMPONENT-CLASS##@component('Illuminate\View\AnonymousComponent', 'panel', ['view' => '8ee975052836fdc7da2267cf8a580b80::panel.index','data' => []])
+        $this->assertSame("##BEGIN-COMPONENT-CLASS##@component('Illuminate\View\AnonymousComponent', 'panel', ['view' => '".md5('test-directory')."::panel.index','data' => []])
 <?php if (isset(\$attributes) && \$attributes instanceof Illuminate\View\ComponentAttributeBag && \$constructor = (new ReflectionClass(Illuminate\View\AnonymousComponent::class))->getConstructor()): ?>
 <?php \$attributes = \$attributes->except(collect(\$constructor->getParameters())->map->getName()->all()); ?>
 <?php endif; ?>
@@ -618,14 +618,14 @@ public function testClasslessIndexComponentsWithAnonymousComponentPath()
         $blade = m::mock(BladeCompiler::class)->makePartial();
 
         $blade->shouldReceive('getAnonymousComponentPaths')->once()->andReturn([
-            'test-directory',
+            ['path' => 'test-directory', 'prefix' => null, 'prefixHash' => md5('test-directory')],
         ]);
 
         $compiler = $this->compiler([], [], $blade);
 
         $result = $compiler->compileTags('<x-panel />');
 
-        $this->assertSame("##BEGIN-COMPONENT-CLASS##@component('Illuminate\View\AnonymousComponent', 'panel', ['view' => '8ee975052836fdc7da2267cf8a580b80::panel','data' => []])
+        $this->assertSame("##BEGIN-COMPONENT-CLASS##@component('Illuminate\View\AnonymousComponent', 'panel', ['view' => '".md5('test-directory')."::panel','data' => []])
 <?php if (isset(\$attributes) && \$attributes instanceof Illuminate\View\ComponentAttributeBag && \$constructor = (new ReflectionClass(Illuminate\View\AnonymousComponent::class))->getConstructor()): ?>
 <?php \$attributes = \$attributes->except(collect(\$constructor->getParameters())->map->getName()->all()); ?>
 <?php endif; ?>