Merge pull request #46 from laravel/storage

Test it can import storage routes

Author: joetannenbaum

src/GenerateCommand.php

@@ -78,7 +78,9 @@ public function handle()
         if (! $this->option('skip-routes')) {
             $this->files->deleteDirectory($this->base());
 
-            $named = $routes->filter(fn (Route $route) => $route->name() && ! Str::endsWith($route->name(), '.'))->groupBy(fn (Route $route) => $route->name());
+            $named = $routes->filter(
+                fn (Route $route) => $route->name() && ! Str::endsWith($route->name(), '.') && ! Str::startsWith($route->name(), 'generated::')
+            )->groupBy(fn (Route $route) => $route->name());
 
             $named->each($this->writeNamedFile(...));
             $named->undot()->each($this->writeBarrelFiles(...));
@@ -98,7 +100,9 @@ private function appendContent($path, $content): void
     {
         $this->content[$path] ??= [];
 
-        $this->content[$path][] = $content;
+        if (! in_array($content, $this->content[$path])) {
+            $this->content[$path][] = $content;
+        }
     }
 
     private function prependContent($path, $content): void
@@ -112,7 +116,6 @@ private function writeContent(): void
     {
         foreach ($this->content as $path => $content) {
             $this->files->ensureDirectoryExists(dirname($path));
-
             $this->files->put($path, TypeScript::cleanUp(implode(PHP_EOL, $content)));
         }
 
@@ -193,25 +196,15 @@ private function writeControllerMethodExport(Route $route, string $path): void
 
     private function writeNamedFile(Collection $routes, string $namespace): void
     {
-        $path = join_paths($this->base(), ...explode('.', $namespace)).'.ts';
+        $parts = explode('.', $namespace);
+        array_pop($parts);
+        $parts[] = 'index';
+
+        $path = join_paths($this->base(), ...$parts).'.ts';
 
         $this->appendCommonImports($routes, $path, $namespace);
 
         $routes->each(fn (Route $route) => $this->writeNamedMethodExport($route, $path));
-
-        $imports = $routes->map(fn (Route $route) => $route->namedMethod())->implode(', ');
-
-        $basename = basename($path, '.ts');
-
-        $base = TypeScript::safeMethod($basename, 'Route');
-
-        if ($base !== $imports) {
-            $this->appendContent($path, "const {$base} = { {$imports} }\n");
-        }
-
-        if ($base !== 'index') {
-            $this->appendContent($path, "export default {$base}");
-        }
     }
 
     private function appendCommonImports(Collection $routes, string $path, string $namespace): void
@@ -224,7 +217,7 @@ private function appendCommonImports(Collection $routes, string $path, string $n
 
         $importBase = str_repeat('/..', substr_count($namespace, '.') + 1);
 
-        $this->appendContent($path, 'import { '.implode(', ', $imports)." } from '.{$importBase}/wayfinder'\n");
+        $this->appendContent($path, 'import { '.implode(', ', $imports)." } from '.{$importBase}/wayfinder'".PHP_EOL);
     }
 
     private function writeNamedMethodExport(Route $route, string $path): void
@@ -255,13 +248,25 @@ private function writeBarrelFiles(array|Collection $children, string $parent): v
 
         $indexPath = join_paths($this->base(), $parent, 'index.ts');
 
-        $childKeys = $children->keys()->mapWithKeys(fn ($child) => [$normalizeToCamelCase($child) => $child]);
+        $childKeys = $children->keys()->mapWithKeys(fn ($child) => [
+            $child => [
+                'safe' => TypeScript::safeMethod($normalizeToCamelCase($child), 'Method'),
+                'normalized' => $normalizeToCamelCase($child),
+            ],
+        ]);
 
-        $imports = $childKeys->filter(fn ($child, $key) => $key !== 'index')->map(fn ($child, $key) => "import {$key} from './{$child}'")->implode(PHP_EOL);
+        if (! ($this->content[$indexPath] ?? false)) {
+            $imports = $childKeys->filter(fn ($_, $key) => $key !== 'index')->map(fn ($alias, $key) => "import {$alias['safe']} from './{$key}'")->implode(PHP_EOL);
+        } else {
+            $keysWithGrandkids = $children->filter(fn ($grandChildren) => ! array_is_list(collect($grandChildren)->all()));
+            $imports = $childKeys->only($keysWithGrandkids->keys())->map(fn ($alias, $key) => "import {$alias['safe']} from './{$key}'")->implode(PHP_EOL);
+        }
 
-        $this->prependContent($indexPath, $imports);
+        if ($imports) {
+            $this->prependContent($indexPath, $imports);
+        }
 
-        $keys = $childKeys->keys()->map(fn ($key) => str_repeat(' ', 4).$key)->implode(', '.PHP_EOL);
+        $keys = $childKeys->map(fn ($alias, $key) => str_repeat(' ', 4).implode(': ', array_unique([$alias['normalized'], $alias['safe']])))->implode(', '.PHP_EOL);
 
         $varExport = $normalizeToCamelCase(Str::afterLast($parent, DIRECTORY_SEPARATOR));
 

testbench.yaml

@@ -1,5 +1,5 @@
 providers:
-  # - Workbench\App\Providers\WorkbenchServiceProvider
+  - App\Providers\WorkbenchServiceProvider
 
 workbench:
   start: '/'

tests/DisallowedMethodNames.test.ts

@@ -3,7 +3,7 @@ import DisallowedMethodNameController, {
     deleteMethod,
     method404,
 } from "../workbench/resources/js/actions/App/Http/Controllers/DisallowedMethodNameController";
-import route404 from "../workbench/resources/js/routes/disallowed/404";
+import disallowed from "../workbench/resources/js/routes/disallowed";
 
 test("will append `method` to invalid methods", () => {
     expect(method404.url()).toBe("/disallowed/404");
@@ -15,5 +15,5 @@ test("will append `method` to invalid methods", () => {
 });
 
 test("will append `method` to invalid methods", () => {
-    expect(route404.method404.url()).toBe("/disallowed/404");
+    expect(disallowed[404].url()).toBe("/disallowed/404");
 });

tests/EmptyRoute.test.ts

@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import { home } from "../workbench/resources/js/routes/home";
+import { home } from "../workbench/resources/js/routes";
 
 it("doesn't add a / to an empty route", () => {
     expect(home.url()).toBe("/");

tests/NamedRoutes.test.ts

@@ -1,5 +1,5 @@
 import { expect, it } from "vitest";
-import edit from "../workbench/resources/js/routes/posts/edit";
+import { edit } from "../workbench/resources/js/routes/posts";
 
 it("exports named routes", () => {
     expect(edit.url(1)).toBe("/posts/1/edit");

tests/StorageRoute.test.ts

@@ -0,0 +1,9 @@
+import { expect, it } from "vitest";
+import storage from "../workbench/resources/js/routes/storage";
+
+it("can import storage routes", () => {
+    expect(storage.export("file-name")).toEqual({
+        url: "/storage/file-name",
+        method: "get",
+    });
+});

workbench/app/Providers/WorkbenchServiceProvider.php

@@ -2,6 +2,7 @@
 
 namespace App\Providers;
 
+use Illuminate\Support\Facades\Config;
 use Illuminate\Support\ServiceProvider;
 
 class WorkbenchServiceProvider extends ServiceProvider
@@ -11,7 +12,14 @@ class WorkbenchServiceProvider extends ServiceProvider
      */
     public function register(): void
     {
-        //
+        Config::set([
+            'filesystems.disks.export' => [
+                'driver' => 'local',
+                'root' => database_path('data/exports'),
+                'serve' => true,
+                'throw' => false,
+            ],
+        ]);
     }
 
     /**