update abordage/og-images

abordage · Jun 3, 2022 · 5a1553f · 5a1553f
1 parent 0ea13cb
commit 5a1553f
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -100,14 +100,19 @@ $opengraph = OpenGraphImages::make($text)->save($path);
 ## Usage
 
 ```php
-// for <og:image> (default, facebook and other)
+// for <og:image>
 OpenGraphImages::make($text)->save($path);
+// or
+OpenGraphImages::make($text, 'opengraph')->save($path);
 
 // for <twitter:image>
-OpenGraphImages::makeTwitter($text)->save($path);
+OpenGraphImages::make($text, 'twitter')->save($path);
 
 // for <vk:image>
-OpenGraphImages::makeVk($text)->save($path);
+OpenGraphImages::make($text, 'vk')->save($path);
+
+// custom size
+OpenGraphImages::makeCustom($text, 600, 400)->save($path);
 ```
 
 After generation, you need to somehow organize the relationship of images with a specific page (for example, attach to a
@@ -155,19 +160,31 @@ $imageBlob = OpenGraphImages::make($page->title)->get();
 $page->addMediaFromString($imageBlob)
      ->usingFileName(\Str::slug($page->title) . '.png')
      ->toMediaCollection('opengraph');
+```
 
-// for twitter
-$imageBlob = OpenGraphImages::makeTwitter($page->title)->get();
-$page->addMediaFromString($imageBlob)
-     ->usingFileName(\Str::slug($page->title) . '.png')
-     ->toMediaCollection('twitter');
+Multiple images:
+
+```php
+$page = new Page();
+$page->title = 'Your awesome title';
+$page->save();
+
+$presets = ['opengraph', 'twitter', 'vk'];
+foreach ($presets as $preset){
+    // generate image and attach to model
+    $imageBlob = OpenGraphImages::make($page->title, $preset)->get();
+    $page->addMediaFromString($imageBlob)
+         ->usingFileName(\Str::slug($page->title) . '-' . $preset . '.png')
+         ->toMediaCollection($preset);
+}
 ```
 
 Now you can get the link for the og:image meta tag as follows:
 
 ```php
 $ogImageUrl = $page->getFirstMediaUrl('opengraph');
 $twitterImageUrl = $page->getFirstMediaUrl('twitter');
+$vkImageUrl = $page->getFirstMediaUrl('vk');
 ```
 
 ## Configuration
@@ -315,21 +332,22 @@ $config = [
 
 ## API Reference
 
-| Method                                                     | Returns | Added in |
-|------------------------------------------------------------|:-------:|:--------:|
-| `make(string $text, int $width = 1200, int $height = 630)` |  self   |  0.1.0   |
-| `makeTwitter(string $text)`                                |  self   |  0.1.0   |
-| `makeVk(string $text)`                                     |  self   |  0.1.0   |
-| `get()`                                                    | string  |  0.1.0   |
-| `save(string $path)`                                       | boolean |  0.1.0   |
+| Method                                                           | Returns | Added in | Changed in |
+|------------------------------------------------------------------|:-------:|:--------:|:----------:|
+| `make(string $text, string $preset = 'opengraph')`               |  self   |  0.1.0   |   0.2.0    |
+| `makeCustom(string $text, int $width = 1200, int $height = 630)` |  self   |  0.2.0   |     -      |
+| `get()`                                                          | string  |  0.1.0   |     -      |
+| `save(string $path)`                                             | boolean |  0.1.0   |     -      |
 
 ### Images aspect ratios
 
-| Method                                              | Aspect ratios       |     Docs      |
-|-----------------------------------------------------|:--------------------|:-------------:|
-| `make(string $text)`                                | 1200 x 630 (1.91:1) |   [fb][fb]    |
-| `makeTwitter(string $text)`                         | 1200 x 600 (2:1)    | [twitter][tw] |
-| `makeVk(string $text)`                              | 1200 x 536 (2.2:1)  |   [vk][vk]    |
+| Preset                            | Aspect ratios       |     Docs      |
+|-----------------------------------|:--------------------|:-------------:|
+| `make(string $text)`              | 1200 x 630 (1.91:1) |               |
+| `make(string $text, 'opengraph')` | 1200 x 630 (1.91:1) |               |
+| `make(string $text, 'facebook')`  | 1200 x 630 (1.91:1) |   [fb][fb]    |
+| `make(string $text, 'twitter')`   | 1200 x 600 (2:1)    | [twitter][tw] |
+| `make(string $text, 'vk')`        | 1200 x 536 (2.2:1)  |   [vk][vk]    |
 
 [fb]: https://developers.facebook.com/docs/sharing/webmasters/images/
 [tw]: https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/summary-card-with-large-image

diff --git a/composer.json b/composer.json
@@ -21,7 +21,7 @@
     "require": {
         "php": ">=7.4",
         "ext-imagick": "*",
-        "abordage/og-images": "^0.1.1",
+        "abordage/og-images": "^0.2.1",
         "illuminate/support": "^8.0 || ^9.0"
     },
     "require-dev": {

diff --git a/tests/OpenGraphImagesTest.php b/tests/OpenGraphImagesTest.php
@@ -31,26 +31,31 @@ public function testMake(string $text): void
         $result = $this->openGraphImages->make($text);
         $this->assertInstanceOf(OpenGraphImages::class, $result);
         $this->assertEquals('image/png', $this->getMimeTypeFromString($result->get()));
-    }
 
-    /**
-     * @dataProvider textProvider
-     */
-    public function testMakeTwitter(string $text): void
-    {
-        $result = $this->openGraphImages->makeTwitter($text);
-        $this->assertInstanceOf(OpenGraphImages::class, $result);
-        $this->assertEquals('image/png', $this->getMimeTypeFromString($result->get()));
+        $presets = ['opengraph', 'facebook', 'twitter', 'vk'];
+        foreach ($presets as $preset) {
+            $result = $this->openGraphImages->make($text, $preset);
+            $this->assertInstanceOf(OpenGraphImages::class, $result);
+            $this->assertEquals('image/png', $this->getMimeTypeFromString($result->get()));
+        }
     }
 
     /**
      * @dataProvider textProvider
      */
-    public function testMakeVk(string $text): void
+    public function testMakeCustom(string $text): void
     {
-        $result = $this->openGraphImages->makeVk($text);
-        $this->assertInstanceOf(OpenGraphImages::class, $result);
-        $this->assertEquals('image/png', $this->getMimeTypeFromString($result->get()));
+        $sizesCollection = [
+            [500, 500],
+            [600, 400],
+        ];
+
+        foreach ($sizesCollection as $sizes) {
+            [$width, $height] = $sizes;
+            $result = $this->openGraphImages->makeCustom($text, $width, $height);
+            $this->assertInstanceOf(OpenGraphImages::class, $result);
+            $this->assertEquals('image/png', $this->getMimeTypeFromString($result->get()));
+        }
     }
 
     /**