fix: relative thumbnails in Twig (#187)

* feat: imgproxy in Twig * feat: imgproxy in Twig * feat: imgproxy in Twig
sigwinhq · Dec 11, 2023 · 8d37ffb · 8d37ffb
1 parent d7f6400
commit 8d37ffb
Show file tree

Hide file tree

Showing 12 changed files with 76 additions and 15 deletions.
diff --git a/psalm.baseline.xml b/psalm.baseline.xml
@@ -427,12 +427,19 @@
       <code><![CDATA[$GLOBALS['YASSG_BASEDIR']]]></code>
       <code><![CDATA[$context['_path']]]></code>
     </MixedArgument>
+    <MixedAssignment>
+      <code><![CDATA[$context['_path']]]></code>
+      <code><![CDATA[$context['_path']]]></code>
+      <code>$item</code>
+    </MixedAssignment>
+    <MixedPropertyFetch>
+      <code><![CDATA[$options['self']->__path]]></code>
+    </MixedPropertyFetch>
     <PossiblyNullArgument>
       <code><![CDATA[$this->imgproxyUrl]]></code>
     </PossiblyNullArgument>
     <PossiblyUndefinedStringArrayOffset>
       <code><![CDATA[$GLOBALS['YASSG_BASEDIR']]]></code>
-      <code><![CDATA[$context['_path']]]></code>
     </PossiblyUndefinedStringArrayOffset>
     <UnusedClass>
       <code>ThumbnailExtension</code>
@@ -632,12 +639,19 @@
       <code>$locale</code>
       <code>$locale</code>
     </MixedArgument>
+    <MixedArgumentTypeCoercion>
+      <code>$key</code>
+    </MixedArgumentTypeCoercion>
     <MixedArrayOffset>
       <code><![CDATA[$this->cache[$this->class][$locale]]]></code>
     </MixedArrayOffset>
     <MixedAssignment>
       <code>$locale</code>
       <code>$locale</code>
+      <code>$metadata[$key]</code>
+      <code>$object</code>
+      <code>$value</code>
+      <code>$value</code>
     </MixedAssignment>
     <MixedInferredReturnType>
       <code>T</code>
@@ -649,6 +663,7 @@
       <code><![CDATA[$this->denormalizer->denormalize($data, $this->class, null, $context + [
                 AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => false,
             ])]]></code>
+      <code>$object</code>
     </MixedReturnStatement>
     <PossiblyUndefinedStringArrayOffset>
       <code>$context[LocaleContext::LOCALE]</code>

diff --git a/src/Bridge/Twig/Extension/ThumbnailExtension.php b/src/Bridge/Twig/Extension/ThumbnailExtension.php
@@ -29,12 +29,30 @@ public function getFunctions(): array
         return [
             new TwigFunction('yassg_thumbnail', function (array $context, string $path, array $options = []): string {
                 if (str_starts_with($path, './')) {
+                    if (! isset($context['_path'])) {
+                        if (isset($options['self'])) {
+                            $context['_path'] = $options['self']->__path;
+                        } else {
+                            $candidates = [];
+                            foreach ($context as $item) {
+                                if (\is_object($item) && property_exists($item, '__path')) {
+                                    $candidates[] = $item;
+                                }
+                            }
+                            if (\count($candidates) !== 1) {
+                                throw new \RuntimeException('Cannot use yassg_thumbnail() without a single Locatable object in context, pass {self: object} as the second argument');
+                            }
+                            $context['_path'] = $candidates[0]->__path;
+                        }
+                    }
+
                     $newPath = realpath(\dirname($context['_path']).'/'.$path);
                     if ($newPath === false) {
                         throw new \RuntimeException('Invalid thumbnail path '.$path);
                     }
                     $path = $newPath;
                 }
+                unset($options['self']);
 
                 $filter = '';
                 if ($options !== []) {

diff --git a/src/Decoder/AssetQueueFileDecoder.php b/src/Decoder/AssetQueueFileDecoder.php
@@ -29,15 +29,14 @@ public function supports(\SplFileInfo $file): bool
 
     public function decode(\SplFileInfo $file): array
     {
-        /** @var array{"@assets"?: list<AssetCopy|AssetFetch>} $decoded */
+        /** @var array{"__assets"?: list<AssetCopy|AssetFetch>} $decoded */
         $decoded = $this->decoder->decode($file);
 
-        if (isset($decoded['@assets'])) {
-            foreach ($decoded['@assets'] as $thumbnail) {
-                $this->queue->add($thumbnail);
+        if (isset($decoded['__assets'])) {
+            foreach ($decoded['__assets'] as $asset) {
+                $this->queue->add($asset);
             }
         }
-        unset($decoded['@assets']);
 
         return $decoded;
     }

diff --git a/src/Decoder/MarkdownFileDecoder.php b/src/Decoder/MarkdownFileDecoder.php
@@ -72,7 +72,7 @@ public function decode(\SplFileInfo $file): array
             $metadata = $result->getFrontMatter();
         }
         $metadata['body'] = $result->getContent();
-        $metadata['@assets'] = $assets;
+        $metadata['__assets'] = $assets;
 
         return $metadata;
     }

diff --git a/src/Storage/DenormalizingStorage.php b/src/Storage/DenormalizingStorage.php
@@ -103,9 +103,26 @@ private function fetch(string $locale, string $id, array|object $item, array $co
     private function denormalize(string $id, array $data, array $context): object
     {
         try {
-            return $this->denormalizer->denormalize($data, $this->class, null, $context + [
+            $metadata = [];
+            foreach ($data as $key => $value) {
+                if (str_starts_with($key, '__')) {
+                    $metadata[$key] = $value;
+                    unset($data[$key]);
+                }
+            }
+            $object = $this->denormalizer->denormalize($data, $this->class, null, $context + [
                 AbstractNormalizer::ALLOW_EXTRA_ATTRIBUTES => false,
             ]);
+
+            // attach metadata to the object as dynamic properties
+            foreach ($metadata as $key => $value) {
+                /**
+                 * @phpstan-ignore-next-line
+                 */
+                $object->{$key} = $value;
+            }
+
+            return $object;
         } catch (ExtraAttributesException $extraAttributesException) {
             throw UnexpectedAttributeException::newSelf($id, $extraAttributesException->getMessage());
         }

diff --git a/src/Storage/FilesystemStorage.php b/src/Storage/FilesystemStorage.php
@@ -115,6 +115,9 @@ private function decode(\SplFileInfo $file): array
             throw new \RuntimeException(sprintf('Decoder does not know how to decode %1$s file', $file->getRealPath()));
         }
 
-        return $this->decoder->decode($file);
+        $decoded = $this->decoder->decode($file);
+        $decoded['__path'] = $file->getRealPath();
+
+        return $decoded;
     }
 }
diff --git a/tests/functional/site/fixtures/content/articles/images/200ad8764a311b8ca90c5271eaf73efb b/tests/functional/site/fixtures/content/articles/images/200ad8764a311b8ca90c5271eaf73efb
diff --git a/tests/functional/site/fixtures/en/articles/1/index.html b/tests/functional/site/fixtures/en/articles/1/index.html
@@ -16,9 +16,10 @@
             <div class="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10 prose">
                 <h1>Articles</h1>
                                     <h2><a href="https://example.com/sub/dir/another/en/article/images/">Images!</a></h2>
-                    <p>20.07.2022. 12:35</p>
+                                        <p><img src="/sub/dir/another/content/articles/images/200ad8764a311b8ca90c5271eaf73efb"></p>
+                                        <p>20.07.2022. 12:35</p>
                                     <h2><a href="https://example.com/sub/dir/another/en/article/lists/">Lists!</a></h2>
-                    <p>19.07.2022. 12:13</p>
+                                        <p>19.07.2022. 12:13</p>
 
                 <ul>
                                     <li>

diff --git a/tests/functional/site/fixtures/en/articles/2/index.html b/tests/functional/site/fixtures/en/articles/2/index.html
@@ -16,9 +16,9 @@
             <div class="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10 prose">
                 <h1>Articles</h1>
                                     <h2><a href="https://example.com/sub/dir/another/en/article/titles/">Titles!</a></h2>
-                    <p>19.07.2022. 12:11</p>
+                                        <p>19.07.2022. 12:11</p>
                                     <h2><a href="https://example.com/sub/dir/another/en/article/paragraphs/">Paragraphs!</a></h2>
-                    <p>19.07.2022. 12:09</p>
+                                        <p>19.07.2022. 12:09</p>
 
                 <ul>
                                     <li>

diff --git a/tests/functional/site/fixtures/en/articles/3/index.html b/tests/functional/site/fixtures/en/articles/3/index.html
@@ -16,7 +16,7 @@
             <div class="bg-white py-8 px-4 shadow sm:rounded-lg sm:px-10 prose">
                 <h1>Articles</h1>
                                     <h2><a href="https://example.com/sub/dir/another/en/article/hello-world/">Hello World!</a></h2>
-                    <p>18.07.2022. 12:44</p>
+                                        <p>18.07.2022. 12:44</p>
 
                 <ul>
                                     <li>

diff --git a/tests/functional/site/src/Model/Article.php b/tests/functional/site/src/Model/Article.php
@@ -20,8 +20,13 @@ final class Article
     public string $title;
     public string $slug;
     public string $body;
-    public string $image;
+    public ?string $image = null;
 
     #[Context(['datetime_format' => 'Y-m-d H:i:s'])]
     public \DateTimeInterface $publishedAt;
+
+    public function getImage(): ?string
+    {
+        return $this->image;
+    }
 }
diff --git a/tests/functional/site/templates/pages/articles.html.twig b/tests/functional/site/templates/pages/articles.html.twig
@@ -13,6 +13,9 @@
                 <h1>Articles</h1>
                 {% for article in articles %}
                     <h2><a href="{{ url('article', {slug: article.slug}) }}">{{ article.title }}</a></h2>
+                    {% if article.image %}
+                    <p><img src="{{ yassg_thumbnail(article.image, {width: 120, self: article}) }}"></p>
+                    {% endif %}
                     <p>{{ article.publishedAt|date('d.m.Y. H:i') }}</p>
                 {% endfor %}