Update image factory to specify the file causing the exception

hydephp · Oct 28, 2023 · 4454cea · 4454cea
1 parent 8be4c36
commit 4454cea
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/packages/framework/src/Framework/Factories/BlogPostDataFactory.php b/packages/framework/src/Framework/Factories/BlogPostDataFactory.php
@@ -41,10 +41,13 @@ class BlogPostDataFactory extends Concerns\PageDataFactory implements BlogPostSc
     protected readonly ?PostAuthor $author;
     protected readonly ?FeaturedImage $image;
 
+    private readonly string $filePath;
+
     public function __construct(CoreDataObject $pageData)
     {
         $this->matter = $pageData->matter;
         $this->markdown = $pageData->markdown;
+        $this->filePath = $pageData->sourcePath;
 
         $this->description = $this->makeDescription();
         $this->category = $this->makeCategory();
@@ -98,7 +101,7 @@ protected function makeAuthor(): ?PostAuthor
     protected function makeImage(): ?FeaturedImage
     {
         if ($this->getMatter('image')) {
-            return FeaturedImageFactory::make($this->matter);
+            return FeaturedImageFactory::make($this->matter, $this->filePath);
         }
 
         return null;

diff --git a/packages/framework/src/Framework/Factories/FeaturedImageFactory.php b/packages/framework/src/Framework/Factories/FeaturedImageFactory.php
@@ -30,6 +30,7 @@ class FeaturedImageFactory extends Concerns\PageDataFactory implements FeaturedI
 
     public function __construct(
         private readonly FrontMatter $matter,
+        private readonly ?string $filePath = null,
     ) {
         $this->source = $this->makeSource();
         $this->altText = $this->getStringMatter('image.altText');
@@ -58,19 +59,17 @@ public function toArray(): array
         ];
     }
 
-    public static function make(FrontMatter $matter): FeaturedImage
+    public static function make(FrontMatter $matter, ?string $filePath = null): FeaturedImage
     {
-        return new FeaturedImage(...(new static($matter))->toArray());
+        return new FeaturedImage(...(new static($matter, $filePath))->toArray());
     }
 
     protected function makeSource(): string
     {
         $value = $this->getStringMatter('image') ?? $this->getStringMatter('image.source');
 
         if (empty($value)) {
-            // Todo, we might want to add a note about which file caused the error.
-            // We could also check for these before calling the factory, and just ignore the image if it's not valid.
-            throw new RuntimeException('No featured image source was found');
+            throw new RuntimeException(sprintf('No featured image source was found in "%s"', $this->filePath ?? 'unknown file'));
         }
 
         if (FeaturedImage::isRemote($value)) {