Merge pull request #11 from Astrotomic/issue-10

allow to suppress URL suffix for structured properties

Author: Gummibeer

.github/workflows/run-tests.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [7.1, 7.2, 7.3, 7.4]
+        php: [7.4]
         dependency-version: [prefer-lowest, prefer-stable]
 
     name: P${{ matrix.php }} - ${{ matrix.dependency-version }}

composer.json

@@ -19,8 +19,11 @@
         "astrotomic/php-conditional-proxy": "^0.2.0"
     },
     "require-dev": {
-        "pestphp/pest": "^0.1.5",
-        "spatie/pest-plugin-snapshots": "^0.1.0"
+        "pestphp/pest": "^0.3.0",
+        "spatie/pest-plugin-snapshots": "^0.3.0"
+    },
+    "suggest": {
+        "php": "^7.4"
     },
     "config": {
         "sort-packages": true

src/StructuredProperties/Audio.php

@@ -2,22 +2,10 @@
 
 namespace Astrotomic\OpenGraph\StructuredProperties;
 
-use Astrotomic\OpenGraph\BaseObject;
-
-class Audio extends BaseObject
+class Audio extends StructuredProperty
 {
     protected const PREFIX = 'og:audio';
 
-    public function __construct(string $url)
-    {
-        $this->setProperty(self::PREFIX, 'url', $url);
-    }
-
-    public static function make(string $url)
-    {
-        return new static($url);
-    }
-
     public function secureUrl(string $url)
     {
         $this->setProperty(self::PREFIX, 'secure_url', $url);

src/StructuredProperties/Image.php

@@ -2,22 +2,10 @@
 
 namespace Astrotomic\OpenGraph\StructuredProperties;
 
-use Astrotomic\OpenGraph\BaseObject;
-
-class Image extends BaseObject
+class Image extends StructuredProperty
 {
     protected const PREFIX = 'og:image';
 
-    public function __construct(string $url)
-    {
-        $this->setProperty(self::PREFIX, 'url', $url);
-    }
-
-    public static function make(string $url)
-    {
-        return new static($url);
-    }
-
     public function secureUrl(string $url)
     {
         $this->setProperty(self::PREFIX, 'secure_url', $url);

src/StructuredProperties/StructuredProperty.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Astrotomic\OpenGraph\StructuredProperties;
+
+use Astrotomic\OpenGraph\BaseObject;
+
+abstract class StructuredProperty extends BaseObject
+{
+    public function __construct(string $url, bool $withUrlSuffix = true)
+    {
+        if ($withUrlSuffix) {
+            $this->setProperty(static::PREFIX, 'url', $url);
+        } else {
+            $prefix = explode(':', static::PREFIX, 2);
+            $this->setProperty($prefix[0], $prefix[1], $url);
+        }
+    }
+
+    public static function make(string $url, bool $withUrlSuffix = true)
+    {
+        return new static($url, $withUrlSuffix);
+    }
+}

src/StructuredProperties/Video.php

@@ -2,22 +2,10 @@
 
 namespace Astrotomic\OpenGraph\StructuredProperties;
 
-use Astrotomic\OpenGraph\BaseObject;
-
-class Video extends BaseObject
+class Video extends StructuredProperty
 {
     protected const PREFIX = 'og:video';
 
-    public function __construct(string $url)
-    {
-        $this->setProperty(self::PREFIX, 'url', $url);
-    }
-
-    public static function make(string $url)
-    {
-        return new static($url);
-    }
-
     public function secureUrl(string $url)
     {
         $this->setProperty(self::PREFIX, 'secure_url', $url);

tests/GlobalTypesTest.php

@@ -1,10 +1,12 @@
 <?php
 
 use Astrotomic\OpenGraph\StructuredProperties\Audio;
+use Astrotomic\OpenGraph\StructuredProperties\Image;
 use Astrotomic\OpenGraph\Types\Article;
 use Astrotomic\OpenGraph\Types\Book;
 use Astrotomic\OpenGraph\Types\Profile;
 use Astrotomic\OpenGraph\Types\Website;
+use function Spatie\Snapshots\{assertMatchesHtmlSnapshot};
 
 it('can generate website tags', function () {
     $og = Website::make('Title | Example')
@@ -35,6 +37,30 @@ public function __toString()
     assertMatchesHtmlSnapshot((string) $og);
 })->group('global', 'website');
 
+it('can generate website tags with structured image', function () {
+    $og = Website::make('Title | Example')
+        ->url('http://www.example.com')
+        ->description('Description')
+        ->locale('en_US')
+        ->alternateLocale('en_GB')
+        ->siteName('Example')
+        ->image(Image::make('http://www.example.com/image1.jpg')->mimeType('image/jpeg'));
+
+    assertMatchesHtmlSnapshot((string) $og);
+})->group('global', 'website');
+
+it('can generate website tags with structured image without url suffix', function () {
+    $og = Website::make('Title | Example')
+        ->url('http://www.example.com')
+        ->description('Description')
+        ->locale('en_US')
+        ->alternateLocale('en_GB')
+        ->siteName('Example')
+        ->image(Image::make('http://www.example.com/image1.jpg', false)->mimeType('image/jpeg'));
+
+    assertMatchesHtmlSnapshot((string) $og);
+})->group('global', 'website');
+
 it('can generate website tags with conditional callbacks', function () {
     $og = Website::make('Title | Example')
         ->url('http://www.example.com')

tests/MusicTypesTest.php

@@ -4,6 +4,7 @@
 use Astrotomic\OpenGraph\Types\Music\Playlist;
 use Astrotomic\OpenGraph\Types\Music\RadioStation;
 use Astrotomic\OpenGraph\Types\Music\Song;
+use function Spatie\Snapshots\{assertMatchesHtmlSnapshot};
 
 it('can generate song tags', function () {
     $og = Song::make('Title | Example')

tests/TwitterTypesTest.php

@@ -3,6 +3,7 @@
 use Astrotomic\OpenGraph\Types\Twitter\Player;
 use Astrotomic\OpenGraph\Types\Twitter\Summary;
 use Astrotomic\OpenGraph\Types\Twitter\SummaryLargeImage;
+use function Spatie\Snapshots\{assertMatchesHtmlSnapshot};
 
 it('can generate summary tags', function () {
     $og = Summary::make('Title | Example')

tests/VideoTypesTest.php

@@ -6,6 +6,7 @@
 use Astrotomic\OpenGraph\Types\Video\Movie;
 use Astrotomic\OpenGraph\Types\Video\Other;
 use Astrotomic\OpenGraph\Types\Video\TvShow;
+use function Spatie\Snapshots\{assertMatchesHtmlSnapshot};
 
 it('can generate movie tags', function () {
     $og = Movie::make('Title | Example')