iterate

Author: Kocal

src/Toolkit/schema-kit-recipe-v1.json

@@ -45,6 +45,21 @@
                                 "description": "Package name and optional version constraint (e.g., 'vendor/package:^1.0')"
                             }
                         }
+                    },
+                    {
+                        "description": "A dependency on a Recipe",
+                        "type": "object",
+                        "required": ["type", "name"],
+                        "properties": {
+                            "type": {
+                                "type": "string",
+                                "enum": ["recipe"]
+                            },
+                            "name": {
+                                "type": "string",
+                                "description": "The name of the Recipe this component depends on, e.g., 'Button'"
+                            }
+                        }
                     }
                 ]
             }

src/Toolkit/src/Command/CreateKitCommand.php

@@ -105,17 +105,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 </button>
 TWIG
         );
-        $this->filesystem->dumpFile('Button/examples/Default.html.twig', <<<TWIG
-            <twig:Button>
-                Click me
-            </twig:Button>
-            TWIG,
-        );
-        $this->filesystem->dumpFile('Button/examples/With Variants.html.twig', <<<TWIG
-            <twig:Button variant="default">Default</twig:Button>
-            <twig:Button variant="secondary">Secondary</twig:Button>
-            TWIG,
-        );
 
         $this->filesystem->dumpFile('Button/manifest.json', json_encode([
             '$schema' => '../vendor/symfony/ux-toolkit/schema-kit-recipe-v1.json',

src/Toolkit/src/Command/InstallComponentCommand.php

@@ -136,7 +136,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $recipe = $kit->getRecipe(name: $componentName, type: RecipeType::Component);
         } elseif (null === $recipe = $kit->getRecipe($componentName, type: RecipeType::Component)) {
             // Suggest alternatives if component does not exist
-            $message = \sprintf('The component "%s" does not exist.', $componentName);
+            $message = \sprintf('The recipe "%s" does not exist.', $componentName);
 
             $alternativeRecipes = $this->getAlternativeRecipes($kit, $componentName);
             $alternativeComponentsCount = \count($alternativeRecipes);

src/Toolkit/src/File.php

@@ -28,11 +28,11 @@ public function __construct(
         public readonly string $destinationRelativePathName,
     ) {
         if (!Path::isRelative($this->sourceRelativePathName)) {
-            throw new \InvalidArgumentException(\sprintf('The path "%s" must be relative.', $this->sourceRelativePathName));
+            throw new \InvalidArgumentException(\sprintf('The source path "%s" must be relative.', $this->sourceRelativePathName));
         }
 
         if (!Path::isRelative($this->destinationRelativePathName)) {
-            throw new \InvalidArgumentException(\sprintf('The path name "%s" must be relative.', $this->destinationRelativePathName));
+            throw new \InvalidArgumentException(\sprintf('The destination path "%s" must be relative.', $this->destinationRelativePathName));
         }
     }
 

src/Toolkit/src/Installer/PoolResolver.php

@@ -34,25 +34,25 @@ public function resolveForRecipe(Kit $kit, Recipe $recipe): Pool
         $visitedRecipes = new \SplObjectStorage();
 
         while (!empty($recipesStack)) {
-            $currentComponent = array_pop($recipesStack);
+            $currentRecipe = array_pop($recipesStack);
 
             // Skip circular references
-            if ($visitedRecipes->contains($currentComponent)) {
+            if ($visitedRecipes->contains($currentRecipe)) {
                 continue;
             }
 
-            $visitedRecipes->attach($currentComponent);
+            $visitedRecipes->attach($currentRecipe);
 
-            foreach ($recipe->getFiles() as $file) {
-                $pool->addFile($recipe, $file);
+            foreach ($currentRecipe->getFiles() as $file) {
+                $pool->addFile($currentRecipe, $file);
             }
 
-            foreach ($recipe->manifest->dependencies as $dependency) {
+            foreach ($currentRecipe->manifest->dependencies as $dependency) {
                 if ($dependency instanceof PhpPackageDependency) {
                     $pool->addPhpPackageDependency($dependency);
                 } elseif ($dependency instanceof RecipeDependency) {
                     if (null === $recipeDependency = $kit->getRecipe($dependency->name)) {
-                        throw new \LogicException(\sprintf('The recipe "%s" has a dependency on unregistered recipe "%s".', $recipe->manifest->name, $dependency->name));
+                        throw new \LogicException(\sprintf('The recipe "%s" has a dependency on unregistered recipe "%s".', $currentRecipe->manifest->name, $dependency->name));
                     }
 
                     $recipesStack[] = $recipeDependency;

src/Toolkit/src/Kit/KitContextRunner.php

@@ -58,8 +58,7 @@ private function contextualizeServicesForKit(Kit $kit): callable
         $initialTwigLoader = $this->twig->getLoader();
         $loaders = [];
         foreach ($kit->getRecipes(type: RecipeType::Component) as $recipe) {
-            // TODO: We assume that components are in the "templates/components" directory
-            $loaders[] = new FilesystemLoader(Path::join($recipe->absolutePath, 'templates/components'));
+            $loaders[] = new FilesystemLoader($recipe->absolutePath);
         }
         $this->twig->setLoader(new ChainLoader([...$loaders, $initialTwigLoader]));
 

src/Toolkit/src/Kit/KitManifest.php

@@ -13,6 +13,9 @@
 
 use Symfony\UX\Toolkit\Assert;
 
+/**
+ * @author Hugo Alliaume <[email protected]>
+ */
 final class KitManifest
 {
     public function __construct(

src/Toolkit/src/Recipe/Recipe.php

@@ -35,29 +35,16 @@ public function __construct(
     }
 
     /**
-     * @return list<File>
+     * @return iterable<File>
      */
     public function getFiles(): iterable
     {
         foreach ($this->manifest->copyFiles as $source => $destination) {
-            $finder = (new Finder())->in(Path::join($this->absolutePath, $source))->files();
+            $finder = (new Finder())->in(Path::join($this->absolutePath, $source))->sortByName()->files();
 
             foreach ($finder as $file) {
                 yield new File(Path::join($source, $file->getRelativePathname()), Path::join($destination, $file->getRelativePathname()));
             }
         }
     }
-
-    public function getFilesExample(): iterable
-    {
-        if ($this->manifest->examplesDir === null) {
-            return [];
-        }
-
-        $finder = (new Finder())->in(Path::join($this->absolutePath, $this->manifest->examplesDir))->name('*.html.twig')->files();
-
-        foreach ($finder as $file) {
-            yield $file->getRelativePathname() => $file->getContents();
-        }
-    }
 }

src/Toolkit/src/Recipe/RecipeManifest.php

@@ -14,6 +14,7 @@
 use Symfony\Component\Filesystem\Path;
 use Symfony\UX\Toolkit\Dependency\DependencyInterface;
 use Symfony\UX\Toolkit\Dependency\PhpPackageDependency;
+use Symfony\UX\Toolkit\Dependency\RecipeDependency;
 use Symfony\UX\Toolkit\Dependency\Version;
 
 /**
@@ -27,15 +28,13 @@ final class RecipeManifest
      * @param non-empty-string                          $name
      * @param non-empty-string                          $description
      * @param array<non-empty-string, non-empty-string> $copyFiles
-     * @param non-empty-string|null                     $examplesDir
      * @param list<DependencyInterface>                 $dependencies
      */
     public function __construct(
         public readonly RecipeType $type,
         public readonly string $name,
         public readonly string $description,
         public readonly array $copyFiles,
-        public readonly ?string $examplesDir = null,
         public readonly array $dependencies = [],
     ) {
         foreach ($this->copyFiles as $source => $destination) {
@@ -46,10 +45,6 @@ public function __construct(
                 throw new \InvalidArgumentException(\sprintf('Copy file destination "%s" must be a relative path.', $destination));
             }
         }
-
-        if (null !== $this->examplesDir && !Path::isRelative($this->examplesDir)) {
-            throw new \InvalidArgumentException(\sprintf('Examples directory "%s" must be a relative path.', $this->examplesDir));
-        }
     }
 
     /**
@@ -68,25 +63,33 @@ public static function fromJson(string $json): self
             if (!isset($dependency['type'])) {
                 throw new \InvalidArgumentException(\sprintf('The dependency type is missing for dependency #%d, add "type" key.', $i));
             }
+
             if ('php' === $dependency['type']) {
-                $package = $dependency['package'] ?? throw new \InvalidArgumentException(\sprintf('The package name is missing for dependency #%d.', $i));
+                $package = $dependency['package'] ?? throw new \InvalidArgumentException(\sprintf('The package name is missing for dependency #%d, add "package" key.', $i));
                 if (str_contains($package, ':')) {
                     [$name, $version] = explode(':', $package, 2);
                     $dependencies[] = new PhpPackageDependency($name, new Version($version));
                 } else {
                     $dependencies[] = new PhpPackageDependency($package);
                 }
+            } else if ('recipe' === $dependency['type']) {
+                $name = $dependency['name'] ?? throw new \InvalidArgumentException(\sprintf('The recipe name is missing for dependency #%d, add "name" key.', $i));
+                $dependencies[] = new RecipeDependency($name);
             } else {
                 throw new \InvalidArgumentException(\sprintf('The dependency type "%s" is not supported.', $dependency['type']));
             }
         }
 
+        $type = $data['type'] ?? throw new \InvalidArgumentException('Property "type" is required.');
+        if (null === $type = RecipeType::tryFrom($type)) {
+            throw new \InvalidArgumentException(\sprintf('The recipe type "%s" is not supported.', $data['type']));
+        }
+
         return new self(
-            type: RecipeType::from($data['type'] ?? throw new \InvalidArgumentException('Property "type" is required.')),
+            type: $type,
             name: $data['name'] ?? throw new \InvalidArgumentException('Property "name" is required.'),
             description: $data['description'] ?? throw new \InvalidArgumentException('Property "description" is required.'),
             copyFiles: $data['copy-files'] ?? throw new \InvalidArgumentException('Property "copy-files" is required.'),
-            examplesDir: $data['examples-dir'] ?? null,
             dependencies: $dependencies,
         );
     }

src/Toolkit/src/Registry/LocalRegistry.php

@@ -54,7 +54,7 @@ public function getKit(string $kitName): Kit
     public static function getAvailableKitsName(): array
     {
         $availableKitsName = [];
-        $finder = (new Finder())->directories()->in(self::$kitsDir)->depth(0);
+        $finder = (new Finder())->directories()->in(self::$kitsDir)->sortByName()->depth(0);
 
         foreach ($finder as $directory) {
             $kitName = $directory->getRelativePathname();