fails installation when fingerprint is incorrect

Jean-François Lépine · Jean-François Lépine · commit d42b322d440a · 2025-02-03T08:44:18.000+01:00
diff --git a/src/Toolkit/registry/default/components/Alert.json b/src/Toolkit/registry/default/components/Alert.json
@@ -1,8 +1,11 @@
 {
     "name": "Alert",
+    "manifest": "components/Alert.json",
     "theme": "",
     "type": "component",
     "code": "<div {{ attributes.without('class') }}\n    class=\"{{ (' ' ~ attributes.render('class'))|tailwind_merge }}\"\n>\n    <twig:Button>Dependency test</twig:Button>\n    {% block content %}Alert{% endblock %}\n</div>\n",
     "fingerprint": "9d173046a7c64cfc696f1a89aaac82a6",
-    "dependencies": []
+    "dependencies": [
+        "Button"
+    ]
 }
diff --git a/src/Toolkit/registry/default/components/Badge.json b/src/Toolkit/registry/default/components/Badge.json
@@ -1,7 +1,9 @@
 {
     "name": "Badge",
-    "theme": "default",
+    "manifest": "components/Badge.json",
+    "theme": "",
     "type": "component",
     "code": "{%- props variant = 'default', outline = false -%}\n{%- set style = html_cva(\n    base: 'inline-flex items-center rounded-full border px-2.5 py-0.5 text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2',\n    variants: {\n        variant: {\n            default: \"border-transparent bg-primary text-primary-foreground hover:bg-primary/80\",\n            secondary: \"border-transparent bg-secondary text-secondary-foreground hover:bg-secondary/80\",\n            destructive: \"border-transparent bg-destructive text-destructive-foreground hover:bg-destructive/80\",\n        },\n        outline: {\n            true: \"text-foreground bg-white\",\n        }\n    },\n    compoundVariants: [{\n        variant: ['default'],\n        outline: ['true'],\n        class: 'border-primary',\n    }, {\n        variant: ['secondary'],\n        outline: ['true'],\n        class: 'border-secondary',\n    }, {\n        variant: ['destructive'],\n        outline: ['true'],\n        class: 'border-destructive',\n    },]\n) -%}\n\n<div\n    class=\"{{ style.apply({variant, outline}, attributes.render('class'))|tailwind_merge }}\"\n    {{ attributes.defaults({}).without('class') }}\n>\n    {% block content %}{% endblock %}\n</div>\n",
+    "fingerprint": "60d4bcc6f49889e80835dae477d51a11",
     "dependencies": []
 }
diff --git a/src/Toolkit/registry/default/components/Button.json b/src/Toolkit/registry/default/components/Button.json
@@ -1,7 +1,9 @@
 {
     "name": "Button",
-    "theme": "default",
+    "manifest": "components/Button.json",
+    "theme": "",
     "type": "component",
     "code": "<button {{ attributes.without('class') }}\n    class=\"{{ (' ' ~ attributes.render('class'))|tailwind_merge }}\"\n>\n    {% block content %}Button{% endblock %}\n</button>\n",
+    "fingerprint": "33a53115165083b116334ea7c448cc3f",
     "dependencies": []
 }
diff --git a/src/Toolkit/registry/default/components/Card.json b/src/Toolkit/registry/default/components/Card.json
@@ -1,5 +1,6 @@
 {
     "name": "Card",
+    "manifest": "components/Card.json",
     "theme": "",
     "type": "component",
     "code": "<div {{ attributes.without('class') }}\n    class=\"{{ (' ' ~ attributes.render('class'))|tailwind_merge }}\"\n>\n    {% block content %}{% endblock %}\n</div>\n",
diff --git a/src/Toolkit/registry/default/components/Navbar.json b/src/Toolkit/registry/default/components/Navbar.json
@@ -1,5 +1,6 @@
 {
     "name": "Navbar",
+    "manifest": "components/Navbar.json",
     "theme": "",
     "type": "component",
     "code": "<nav {{ attributes.without('class') }}\n    class=\"{{ (' ' ~ attributes.render('class'))|tailwind_merge }}\"\n>\n    {% block content %}{% endblock %}\n</nav>\n",
diff --git a/src/Toolkit/registry/default/components/Table.json b/src/Toolkit/registry/default/components/Table.json
@@ -1,8 +1,11 @@
 {
     "name": "Table",
+    "manifest": "components/Table.json",
     "theme": "",
     "type": "component",
     "code": "{# ux:with{Row, Button} #}\n<table {{ attributes.without('class') }}\n    class=\"{{ (' ' ~ attributes.render('class'))|tailwind_merge }}\"\n>\n    {% block content %}{% endblock %}\n</table>\n",
     "fingerprint": "60ec2663e1ba9c92b59d57935e565b2e",
-    "dependencies": ["Row"]
+    "dependencies": [
+        "Row"
+    ]
 }
diff --git a/src/Toolkit/registry/default/components/Table/Row.json b/src/Toolkit/registry/default/components/Table/Row.json
@@ -1,5 +1,6 @@
 {
     "name": "Row",
+    "manifest": "components/Table/Row.json",
     "theme": "",
     "type": "component",
     "code": "<tr {{ attributes.without('class') }}\n    class=\"{{ (' ' ~ attributes.render('class'))|tailwind_merge }}\"\n>\n    {% block content %}Row{% endblock %}\n</tr>\n",
diff --git a/src/Toolkit/registry/default/examples/Badge.json b/src/Toolkit/registry/default/examples/Badge.json
@@ -1,5 +1,6 @@
 {
     "name": "Badge",
+    "manifest": "examples/Badge.json",
     "theme": "",
     "type": "example",
     "code": "<twig:Badge>Badge</twig:Badge>\n",
diff --git a/src/Toolkit/registry/default/examples/BadgeOutline.json b/src/Toolkit/registry/default/examples/BadgeOutline.json
@@ -1,5 +1,6 @@
 {
     "name": "BadgeOutline",
+    "manifest": "examples/BadgeOutline.json",
     "theme": "",
     "type": "example",
     "code": "<twig:Badge outline>Badge</twig:Badge>\n<twig:Badge variant=\"primary\" outline>Badge</twig:Badge>\n<twig:Badge variant=\"secondary\" outline>Badge</twig:Badge>\n",
diff --git a/src/Toolkit/registry/default/examples/Button.json b/src/Toolkit/registry/default/examples/Button.json
@@ -1,5 +1,6 @@
 {
     "name": "Button",
+    "manifest": "examples/Button.json",
     "theme": "",
     "type": "example",
     "code": "<twig:Button>Click me</twig:Button>\n",
diff --git a/src/Toolkit/registry/default/registry.json b/src/Toolkit/registry/default/registry.json
@@ -4,58 +4,76 @@
     "items": [
         {
             "name": "Alert",
+            "manifest": "components/Alert.json",
             "theme": "",
             "type": "component",
-            "fingerprint": "9d173046a7c64cfc696f1a89aaac82a6",
-            "dependencies": []
+            "dependencies": [
+                "Button"
+            ]
         },
         {
             "name": "Badge",
+            "manifest": "components/Badge.json",
             "theme": "",
-            "type": "example",
-            "fingerprint": "6eeb538fce2bda2152dd7af729d01253",
+            "type": "component",
             "dependencies": []
         },
         {
             "name": "Button",
+            "manifest": "components/Button.json",
             "theme": "",
-            "type": "example",
-            "fingerprint": "6449c62a6ead499bd1402d6b8506e45d",
+            "type": "component",
             "dependencies": []
         },
         {
             "name": "Card",
+            "manifest": "components/Card.json",
             "theme": "",
             "type": "component",
-            "fingerprint": "b5033826eca1935e4055bf8e4d192a81",
             "dependencies": []
         },
         {
             "name": "Navbar",
+            "manifest": "components/Navbar.json",
             "theme": "",
             "type": "component",
-            "fingerprint": "213add68cdffa8aa3a270d7629bb489b",
             "dependencies": []
         },
         {
             "name": "Table",
+            "manifest": "components/Table.json",
             "theme": "",
             "type": "component",
-            "fingerprint": "60ec2663e1ba9c92b59d57935e565b2e",
-            "dependencies": ["Row"]
+            "dependencies": [
+                "Row"
+            ]
         },
         {
             "name": "Row",
+            "manifest": "components/Table/Row.json",
             "theme": "",
             "type": "component",
-            "fingerprint": "0fded51fb960081206bbb62d932951a0",
+            "dependencies": []
+        },
+        {
+            "name": "Badge",
+            "manifest": "examples/Badge.json",
+            "theme": "",
+            "type": "example",
             "dependencies": []
         },
         {
             "name": "BadgeOutline",
+            "manifest": "examples/BadgeOutline.json",
+            "theme": "",
+            "type": "example",
+            "dependencies": []
+        },
+        {
+            "name": "Button",
+            "manifest": "examples/Button.json",
             "theme": "",
             "type": "example",
-            "fingerprint": "ed027eb6cb73152ed3e7291fc39f6c07",
             "dependencies": []
         }
     ]
diff --git a/src/Toolkit/src/Compiler/RegistryCompiler.php b/src/Toolkit/src/Compiler/RegistryCompiler.php
@@ -49,6 +49,7 @@ public function compile(Registry $registry, string $registryDir): void
 
             $itemJson = [
                 'name' => $item->name,
+                'manifest' => Path::makeRelative($itemPath, $registryDir),
                 'theme' => $item->theme,
                 'type' => $item->type->value,
                 'code' => $item->code,
@@ -59,6 +60,7 @@ public function compile(Registry $registry, string $registryDir): void
             $this->filesystem->dumpFile($itemPath, json_encode($itemJson, \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES)."\n");
 
             unset($itemJson['code']);
+            unset($itemJson['fingerprint']);
             $registryJson['items'][] = $itemJson;
         }
 
diff --git a/src/Toolkit/src/Compiler/TwigComponentCompiler.php b/src/Toolkit/src/Compiler/TwigComponentCompiler.php
@@ -16,6 +16,7 @@
 use Symfony\UX\Toolkit\Registry\DependenciesResolver;
 use Symfony\UX\Toolkit\Registry\Registry;
 use Symfony\UX\Toolkit\Registry\RegistryItem;
+use Symfony\UX\Toolkit\Registry\RegistryItemType;
 
 /**
  * @author Jean-François Lépine
@@ -42,16 +43,18 @@ public function compile(
         if (!$filesystem->exists($directory)) {
             $filesystem->mkdir($directory);
         }
-
         $componentsToInstall = array_merge([$item->name], $item->getDependencies());
-
         foreach ($componentsToInstall as $componentName) {
             $this->installComponent($registry->get($componentName), $directory, $filesystem);
         }
     }
 
     private function installComponent(RegistryItem $item, string $directory, Filesystem $filesystem)
     {
+        if (RegistryItemType::Component !== $item->type) {
+            return;
+        }
+
         $filename = implode(\DIRECTORY_SEPARATOR, [
             $directory,
             $this->prefix,
diff --git a/src/Toolkit/src/Registry/DependenciesResolver.php b/src/Toolkit/src/Registry/DependenciesResolver.php
@@ -22,7 +22,17 @@ public function resolve(Registry $registry): array
     {
         $resolved = [];
         $unresolved = [];
-        foreach (array_keys($registry->all()) as $itemName) {
+
+        $concernedComponents = [];
+        foreach($registry->all() as $item) {
+            if ($item->type !== RegistryItemType::Component) {
+                continue;
+            }
+
+            $concernedComponents[] = $item->name;
+        }
+
+        foreach ($concernedComponents as $itemName) {
             [$resolved, $unresolved] = $this->resolveDependency($registry, $itemName, $resolved, $unresolved);
         }
 
diff --git a/src/Toolkit/src/Registry/Registry.php b/src/Toolkit/src/Registry/Registry.php
@@ -50,7 +50,7 @@ public static function empty(): self
 
     public function add(RegistryItem $item): void
     {
-        $this->items[$item->name] = $item;
+        $this->items[] = $item;
     }
 
     /**
@@ -66,9 +66,14 @@ public function has(string $name): bool
         return null !== $this->get($name);
     }
 
-    public function get(string $name): ?RegistryItem
+    public function get(string $name, RegistryItemType $type = RegistryItemType::Component): ?RegistryItem
     {
         foreach ($this->items as $item) {
+
+            if ($item->type !== $type) {
+                continue;
+            }
+
             if ($item->name === $name) {
                 return $item;
             }
diff --git a/src/Toolkit/src/Registry/RegistryFactory.php b/src/Toolkit/src/Registry/RegistryFactory.php
@@ -51,15 +51,20 @@ public function create(Finder $finder): Registry
             }
             $file = reset($files);
 
-            if (isset($item['hash'])) {
-                $hash = hash_file('md5', $file->getRealPath());
-                if ($hash !== $item['hash']) {
+            if (!isset($item['fingerprint']) && isset($item['code'])) {
+                throw new \RuntimeException(\sprintf('The file "%s" declared in the manifest must have a fingerprint.', $filename));
+            }
+
+            $itemObject = RegistryItem::fromJsonFile($file);
+
+            if (isset($item['fingerprint'])) {
+                $hash = md5($itemObject->code);
+                if ($hash !== $item['fingerprint']) {
                     throw new \RuntimeException(\sprintf('The file "%s" declared in the manifest has an invalid hash.', $filename));
                 }
             }
 
-            $item = RegistryItem::fromJsonFile($file);
-            $registry->add($item);
+            $registry->add($itemObject);
         }
 
         return $registry;
diff --git a/src/Toolkit/src/Registry/RegistryItem.php b/src/Toolkit/src/Registry/RegistryItem.php
@@ -83,7 +83,9 @@ public static function fromTwigFile(SplFileInfo $file): self
         if ($name === $parentName) {
             $parentName = null;
         }
-        $type = RegistryItemType::from($matches['type']);
+        // @todo: we should improve the way to detect examples
+        $isExample = preg_match('#examples#', $file->getRelativePathname());
+        $type = $isExample ? RegistryItemType::Example : RegistryItemType::Component;
         $theme = '';
 
         return new self(
diff --git a/src/Toolkit/tests/Command/UxToolkitInstallCommandTest.php b/src/Toolkit/tests/Command/UxToolkitInstallCommandTest.php
@@ -17,6 +17,7 @@
 
 /**
  * @author Jean-François Lépine
+ * @group wip
  */
 class UxToolkitInstallCommandTest extends KernelTestCase
 {

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,11 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "Alert",`
	`3`	`+ "manifest": "components/Alert.json",`
`3`	`4`	`"theme": "",`
`4`	`5`	`"type": "component",`
`5`	`6`	`"code": "<div {{ attributes.without('class') }}\n class=\"{{ (' ' ~ attributes.render('class'))\|tailwind_merge }}\"\n>\n <twig:Button>Dependency test</twig:Button>\n {% block content %}Alert{% endblock %}\n</div>\n",`
`6`	`7`	`"fingerprint": "9d173046a7c64cfc696f1a89aaac82a6",`
`7`		`- "dependencies": []`
	`8`	`+ "dependencies": [`
	`9`	`+ "Button"`
	`10`	`+ ]`
`8`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "Badge",`
`3`		`- "theme": "default",`
	`3`	`+ "manifest": "components/Badge.json",`
	`4`	`+ "theme": "",`
`4`	`5`	`"type": "component",`
`5`	`6`	"code": "{%- props variant = 'default', outline = false -%}\n{%- set style = html_cva(\n base: 'inline-flex items-center rounded-full border px-2.5 py-0.5 text-xs font-semibold transition-colors focus:outline-none focus:ring-2 focus:ring-ring focus:ring-offset-2',\n variants: {\n variant: {\n default: \"border-transparent bg-primary text-primary-foreground hover:bg-primary/80\",\n secondary: \"border-transparent bg-secondary text-secondary-foreground hover:bg-secondary/80\",\n destructive: \"border-transparent bg-destructive text-destructive-foreground hover:bg-destructive/80\",\n },\n outline: {\n true: \"text-foreground bg-white\",\n }\n },\n compoundVariants: [{\n variant: ['default'],\n outline: ['true'],\n class: 'border-primary',\n }, {\n variant: ['secondary'],\n outline: ['true'],\n class: 'border-secondary',\n }, {\n variant: ['destructive'],\n outline: ['true'],\n class: 'border-destructive',\n },]\n) -%}\n\n<div\n class=\"{{ style.apply({variant, outline}, attributes.render('class'))\|tailwind_merge }}\"\n {{ attributes.defaults({}).without('class') }}\n>\n {% block content %}{% endblock %}\n</div>\n",
	`7`	`+ "fingerprint": "60d4bcc6f49889e80835dae477d51a11",`
`6`	`8`	`"dependencies": []`
`7`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "Button",`
`3`		`- "theme": "default",`
	`3`	`+ "manifest": "components/Button.json",`
	`4`	`+ "theme": "",`
`4`	`5`	`"type": "component",`
`5`	`6`	`"code": "<button {{ attributes.without('class') }}\n class=\"{{ (' ' ~ attributes.render('class'))\|tailwind_merge }}\"\n>\n {% block content %}Button{% endblock %}\n</button>\n",`
	`7`	`+ "fingerprint": "33a53115165083b116334ea7c448cc3f",`
`6`	`8`	`"dependencies": []`
`7`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "Card",`
	`3`	`+ "manifest": "components/Card.json",`
`3`	`4`	`"theme": "",`
`4`	`5`	`"type": "component",`
`5`	`6`	`"code": "<div {{ attributes.without('class') }}\n class=\"{{ (' ' ~ attributes.render('class'))\|tailwind_merge }}\"\n>\n {% block content %}{% endblock %}\n</div>\n",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "Navbar",`
	`3`	`+ "manifest": "components/Navbar.json",`
`3`	`4`	`"theme": "",`
`4`	`5`	`"type": "component",`
`5`	`6`	`"code": "<nav {{ attributes.without('class') }}\n class=\"{{ (' ' ~ attributes.render('class'))\|tailwind_merge }}\"\n>\n {% block content %}{% endblock %}\n</nav>\n",`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,11 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "Table",`
	`3`	`+ "manifest": "components/Table.json",`
`3`	`4`	`"theme": "",`
`4`	`5`	`"type": "component",`
`5`	`6`	`"code": "{# ux:with{Row, Button} #}\n<table {{ attributes.without('class') }}\n class=\"{{ (' ' ~ attributes.render('class'))\|tailwind_merge }}\"\n>\n {% block content %}{% endblock %}\n</table>\n",`
`6`	`7`	`"fingerprint": "60ec2663e1ba9c92b59d57935e565b2e",`
`7`		`- "dependencies": ["Row"]`
	`8`	`+ "dependencies": [`
	`9`	`+ "Row"`
	`10`	`+ ]`
`8`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "Row",`
	`3`	`+ "manifest": "components/Table/Row.json",`
`3`	`4`	`"theme": "",`
`4`	`5`	`"type": "component",`
`5`	`6`	`"code": "<tr {{ attributes.without('class') }}\n class=\"{{ (' ' ~ attributes.render('class'))\|tailwind_merge }}\"\n>\n {% block content %}Row{% endblock %}\n</tr>\n",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "Badge",`
	`3`	`+ "manifest": "examples/Badge.json",`
`3`	`4`	`"theme": "",`
`4`	`5`	`"type": "example",`
`5`	`6`	`"code": "<twig:Badge>Badge</twig:Badge>\n",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "BadgeOutline",`
	`3`	`+ "manifest": "examples/BadgeOutline.json",`
`3`	`4`	`"theme": "",`
`4`	`5`	`"type": "example",`
`5`	`6`	`"code": "<twig:Badge outline>Badge</twig:Badge>\n<twig:Badge variant=\"primary\" outline>Badge</twig:Badge>\n<twig:Badge variant=\"secondary\" outline>Badge</twig:Badge>\n",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "Button",`
	`3`	`+ "manifest": "examples/Button.json",`
`3`	`4`	`"theme": "",`
`4`	`5`	`"type": "example",`
`5`	`6`	`"code": "<twig:Button>Click me</twig:Button>\n",`