Merge pull request #23 from simonhamp/add-watermark

Add watermark support

Author: simonhamp

src/Interfaces/Layout.php

@@ -24,4 +24,6 @@ public function render(Config $config): Image;
     public function title(): string;
 
     public function url(): ?string;
+
+    public function watermark(): ?string;
 }

src/Layout/AbstractLayout.php

@@ -75,6 +75,11 @@ public function url(): ?string
         return parse_url($this->config->url, PHP_URL_HOST) ?? $this->config->url;
     }
 
+    public function watermark(): ?string
+    {
+        return $this->config->watermark ?? null;
+    }
+
     /**
      * The area within the canvas that we should be rendering content. This is just a convenience object to help layout
      * of other features and is not normally rendered (it's not added to the $features list)

src/Layout/Layouts/Avatar.php

@@ -43,6 +43,18 @@ public function features(): void
                 anchor: Position::MiddleTop,
             )
         );
+
+        if ($watermark = $this->watermark()) {
+            $this->addFeature((new PictureBox())
+                ->path($watermark)
+                ->box(100, 100)
+                ->position(
+                    x: 1180,
+                    y: 610,
+                    anchor: Position::BottomRight
+                )
+            );
+        }
     }
 
     public function url(): string

src/Layout/Layouts/GitHubBasic.php

@@ -4,6 +4,7 @@
 
 use SimonHamp\TheOg\BorderPosition;
 use SimonHamp\TheOg\Layout\AbstractLayout;
+use SimonHamp\TheOg\Layout\PictureBox;
 use SimonHamp\TheOg\Layout\Position;
 use SimonHamp\TheOg\Layout\TextBox;
 
@@ -90,5 +91,18 @@ public function features(): void
                 )
             );
         }
+
+        if ($watermark = $this->watermark()) {
+            $this->addFeature((new PictureBox())
+                ->path($watermark)
+                ->box(100, 100)
+                ->position(
+                    x: 0,
+                    y: 0,
+                    relativeTo: fn () => $this->mountArea()->anchor(Position::BottomRight),
+                    anchor: Position::BottomRight
+                )
+            );
+        }
     }
 }

src/Layout/Layouts/Standard.php

@@ -4,6 +4,7 @@
 
 use SimonHamp\TheOg\BorderPosition;
 use SimonHamp\TheOg\Layout\AbstractLayout;
+use SimonHamp\TheOg\Layout\PictureBox;
 use SimonHamp\TheOg\Layout\Position;
 use SimonHamp\TheOg\Layout\TextBox;
 
@@ -89,6 +90,19 @@ public function features(): void
                 )
             );
         }
+
+        if ($watermark = $this->watermark()) {
+            $this->addFeature((new PictureBox())
+                ->path($watermark)
+                ->box(100, 100)
+                ->position(
+                    x: 0,
+                    y: 0,
+                    relativeTo: fn () => $this->mountArea()->anchor(Position::BottomRight),
+                    anchor: Position::BottomRight
+                )
+            );
+        }
     }
 
     // XXX: This feels weird... maybe it should happen in the theme? Or let the content decide?

src/Layout/Layouts/TwoUp.php

@@ -67,6 +67,18 @@ public function features(): void
                     anchor: Position::BottomRight,
                 )
             );
+
+            if ($watermark = $this->watermark()) {
+                $this->addFeature((new PictureBox())
+                    ->path($watermark)
+                    ->box(100, 100)
+                    ->position(
+                        x: 20,
+                        y: 610,
+                        anchor: Position::BottomLeft
+                    )
+                );
+            }
         }
 
         if ($url = $this->url()) {

tests/Integration/ImageTest.php

@@ -52,6 +52,15 @@ public static function snapshotImages(): iterable
             'more-text-features',
         ];
 
+        yield 'with watermark' => [
+            (new Image())
+                ->url('https://example.com/blog/some-blog-post-url')
+                ->title('Some blog post title that is quite big and quite long')
+                ->description('Some slightly smaller but potentially much longer subtext. It could be really long so we might need to trim it completely after many words')
+                ->watermark(__DIR__.'/../resources/logo.png'),
+            'with-watermark',
+        ];
+
         yield 'different theme' => [
             (new Image())
                 ->theme(Theme::Dark)
@@ -109,7 +118,8 @@ public static function snapshotImages(): iterable
                 ->layout(new GitHubBasic)
                 ->url('username/repo')
                 ->title('An awesome package')
-                ->background(BuiltInBackground::CloudyDay, 0.8),
+                ->background(BuiltInBackground::CloudyDay, 0.8)
+                ->watermark(__DIR__.'/../resources/logo.png'),
             'githubbasic-layout',
         ];
 
@@ -126,7 +136,8 @@ public static function snapshotImages(): iterable
                 ->url('https://my-ecommerce-store.com/')
                 ->title('This layout is great for eCommerce!')
                 ->callToAction('Buy Now →')
-                ->background(BuiltInBackground::CloudyDay, 0.8),
+                ->background(BuiltInBackground::CloudyDay, 0.8)
+                ->watermark(__DIR__.'/../resources/logo.png'),
             'twoup-layout',
         ];
 
@@ -177,7 +188,8 @@ public static function snapshotImages(): iterable
                 ->layout(new Avatar)
                 ->accentColor('#003')
                 ->picture('https://i.pravatar.cc/300?img=10')
-                ->title('Simone Hampstead'),
+                ->title('Simone Hampstead')
+                ->watermark(__DIR__.'/../resources/logo.png'),
             'avatar-layout',
         ];
     }