Add support for Silverstripe 5

silverstripe-terraformers · Feb 14, 2023 · 42f146e · 42f146e
1 parent 2bae9f6
commit 42f146e
Show file tree

Hide file tree

Showing 16 changed files with 55 additions and 140 deletions.
diff --git a/composer.json b/composer.json
@@ -16,22 +16,19 @@
         },
         {
             "name": "Chris Penny",
-            "email": "cpenny@silverstripe.com"
+            "email": "chris.penny@gmail.com"
         }
     ],
     "support": {
         "issues": "http://github.com/ichaber/silverstripe-swiftype/issues"
     },
     "require": {
-        "php": "^7.4 || ^8.0",
-        "silverstripe/vendor-plugin": "^1.6",
-        "silverstripe/framework": "^4",
-        "silverstripe/cms": "^4",
-        "guzzlehttp/guzzle": "^7",
-        "guzzlehttp/psr7": "^2"
+        "php": "^8.1",
+        "silverstripe/cms": "^5",
+        "guzzlehttp/guzzle": "^7.5"
     },
     "require-dev": {
-        "silverstripe/recipe-testing": "^2"
+        "silverstripe/recipe-testing": "^3"
     },
     "autoload": {
         "psr-4": {

diff --git a/src/Extensions/SwiftypeSiteConfigFieldsExtension.php b/src/Extensions/SwiftypeSiteConfigFieldsExtension.php
@@ -20,10 +20,7 @@
  */
 class SwiftypeSiteConfigFieldsExtension extends DataExtension
 {
-    /**
-     * @var array $db
-     */
-    private static $db = [
+    private static array $db = [
         'SwiftypeEnabled' => 'Boolean',
         'SwiftypeAccessKey' => 'Varchar(255)',
         'SwiftypeAPIKey' => 'Varchar(255)',

diff --git a/src/Extensions/SwiftypeSiteTreeCrawlerExtension.php b/src/Extensions/SwiftypeSiteTreeCrawlerExtension.php
@@ -18,10 +18,8 @@ class SwiftypeSiteTreeCrawlerExtension extends SiteTreeExtension
      * Urls to crawl
      *
      * array keyed by getOwnerKey
-     *
-     * @var array
      */
-    private $urlsToCrawl = [];
+    private array $urlsToCrawl = [];
 
     public function setUrlsToCrawl(array $urls)
     {

diff --git a/src/MetaTags/SwiftypeMetaTag.php b/src/MetaTags/SwiftypeMetaTag.php
@@ -15,20 +15,11 @@ abstract class SwiftypeMetaTag implements SwiftypeMetaTagInterface
 {
     use Configurable;
 
-    /**
-     * @var string|null
-     */
-    protected $name;
+    protected ?string $name;
 
-    /**
-     * @var string|null
-     */
-    protected $fieldName;
+    protected ?string $fieldName;
 
-    /**
-     * @var string|null
-     */
-    protected $fieldType;
+    protected ?string $fieldType;
 
     public function getMetaTagString(DataObject $dataObject): ?string
     {

diff --git a/src/MetaTags/SwiftypeMetaTagDescription.php b/src/MetaTags/SwiftypeMetaTagDescription.php
@@ -4,18 +4,9 @@
 
 class SwiftypeMetaTagDescription extends SwiftypeMetaTag
 {
-    /**
-     * @var string
-     */
-    protected $name = 'description';
+    protected ?string $name = 'description';
 
-    /**
-     * @var string
-     */
-    protected $fieldName = 'MetaDescription';
+    protected ?string $fieldName = 'MetaDescription';
 
-    /**
-     * @var string
-     */
-    protected $fieldType = 'text';
+    protected ?string $fieldType = 'text';
 }
diff --git a/src/MetaTags/SwiftypeMetaTagPublishedAt.php b/src/MetaTags/SwiftypeMetaTagPublishedAt.php
@@ -4,18 +4,9 @@
 
 class SwiftypeMetaTagPublishedAt extends SwiftypeMetaTag
 {
-    /**
-     * @var string
-     */
-    protected $name = 'published_at';
+    protected ?string $name = 'published_at';
 
-    /**
-     * @var string
-     */
-    protected $fieldName = 'LastEdited';
+    protected ?string $fieldName = 'LastEdited';
 
-    /**
-     * @var string
-     */
-    protected $fieldType = 'date';
+    protected ?string $fieldType = 'date';
 }
diff --git a/src/MetaTags/SwiftypeMetaTagTitle.php b/src/MetaTags/SwiftypeMetaTagTitle.php
@@ -4,18 +4,9 @@
 
 class SwiftypeMetaTagTitle extends SwiftypeMetaTag
 {
-    /**
-     * @var string
-     */
-    protected $name = 'title';
+    protected ?string $name = 'title';
 
-    /**
-     * @var string
-     */
-    protected $fieldName = 'Title';
+    protected ?string $fieldName = 'Title';
 
-    /**
-     * @var string
-     */
-    protected $fieldType = 'string';
+    protected ?string $fieldType = 'string';
 }
diff --git a/src/MetaTags/SwiftypeMetaTagURL.php b/src/MetaTags/SwiftypeMetaTagURL.php
@@ -4,18 +4,9 @@
 
 class SwiftypeMetaTagURL extends SwiftypeMetaTag
 {
-    /**
-     * @var string
-     */
-    protected $name = 'url';
+    protected ?string $name = 'url';
 
-    /**
-     * @var string|null
-     */
-    protected $fieldName = 'Link';
+    protected ?string $fieldName = 'Link';
 
-    /**
-     * @var string
-     */
-    protected $fieldType = 'enum';
+    protected ?string $fieldType = 'enum';
 }
diff --git a/tests/php/Extensions/SwiftypeMetaTagContentExtensionTest.php b/tests/php/Extensions/SwiftypeMetaTagContentExtensionTest.php
@@ -14,11 +14,6 @@
 use SilverStripe\ORM\FieldType\DBDatetime;
 use SilverStripe\ORM\FieldType\DBHTMLText;
 
-/**
- * Class SwiftypeMetaTagContentExtensionTest
- *
- * @package Ichaber\SSSwiftype\Tests\Extensions
- */
 class SwiftypeMetaTagContentExtensionTest extends SapphireTest
 {
     /**
@@ -41,7 +36,7 @@ public function setUp(): void
      */
     public function testMetaTagOutput(): void
     {
-        Config::inst()->update(
+        Config::modify()->set(
             SwiftypeSiteTree::class,
             'swiftype_meta_tag_classes',
             [
@@ -60,7 +55,7 @@ public function testMetaTagOutput(): void
         $mock = file_get_contents(__DIR__ . '/../Mock/TagsOutput.html');
         $mock = trim(preg_replace("/\s+/S", '', $mock));
 
-        // Remove formatting from output output
+        // Remove formatting from output
         $output = trim(preg_replace("/\s+/S", '', $page->getSwiftypeMetaTags()->getValue()));
 
         $this->assertEquals($mock, $output);

diff --git a/tests/php/Extensions/SwiftypeSiteTreeCrawlerExtensionTest.php b/tests/php/Extensions/SwiftypeSiteTreeCrawlerExtensionTest.php
@@ -9,11 +9,6 @@
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Dev\SapphireTest;
 
-/**
- * Class SwiftypeMetaTagContentExtensionTest
- *
- * @package Ichaber\SSSwiftype\Tests\Extensions
- */
 class SwiftypeSiteTreeCrawlerExtensionTest extends SapphireTest
 {
     /**
@@ -37,7 +32,7 @@ public function setUp(): void
     public function testUrlsToCrawlPublished(): void
     {
         // Set our config to not clear caches after un/publish, so that we can easily fetch the Urls for our test
-        Config::inst()->update(
+        Config::modify()->set(
             SwiftypeSiteTreeCrawlerExtension::class,
             'clear_cache_disabled',
             true
@@ -81,7 +76,7 @@ public function testUrlsToCrawlPublished(): void
     public function testUrlsToCrawlUnpublished(): void
     {
         // Set our config to not clear caches after un/publish, so that we can easily fetch the Urls for our test
-        Config::inst()->update(
+        Config::modify()->set(
             SwiftypeSiteTreeCrawlerExtension::class,
             'clear_cache_disabled',
             true
@@ -130,7 +125,7 @@ public function testUrlsToCrawlUnpublished(): void
     public function testUrlsToCrawlSegmentChanged(): void
     {
         // Set our config to not clear caches after un/publish, so that we can easily fetch the Urls for our test
-        Config::inst()->update(
+        Config::modify()->set(
             SwiftypeSiteTreeCrawlerExtension::class,
             'clear_cache_disabled',
             true

diff --git a/tests/php/Fake/SwiftypeSiteTree.php b/tests/php/Fake/SwiftypeSiteTree.php
@@ -9,9 +9,6 @@
 use SilverStripe\Dev\TestOnly;
 
 /**
- * Class SwiftypeSiteTree
- *
- * @package Ichaber\SSSwiftype\Tests\Fake
  * @mixin SwiftypeMetaTagContentExtension
  * @mixin SwiftypeSiteTreeCrawlerExtension
  */

diff --git a/tests/php/MetaTags/SwiftypeMetaTagPublishedAtTest.php b/tests/php/MetaTags/SwiftypeMetaTagPublishedAtTest.php
@@ -9,11 +9,6 @@
 use SilverStripe\Dev\SapphireTest;
 use SilverStripe\ORM\FieldType\DBDatetime;
 
-/**
- * Class SwiftypeMetaTagPublishedAtTest
- *
- * @package Ichaber\SSSwiftype\Tests\MetaTags
- */
 class SwiftypeMetaTagPublishedAtTest extends SapphireTest
 {
     /**
@@ -36,8 +31,8 @@ public function setUp(): void
      */
     public function testMetaTagOutput(): void
     {
-        Config::inst()->update(SwiftypeSiteTree::class, 'swiftype_meta_tag_classes', [SwiftypeMetaTagPublishedAt::class]);
-        Config::inst()->update(SwiftypeMetaTagPublishedAt::class, 'date_format', 'YYYY-MM-dd');
+        Config::modify()->set(SwiftypeSiteTree::class, 'swiftype_meta_tag_classes', [SwiftypeMetaTagPublishedAt::class]);
+        Config::modify()->set(SwiftypeMetaTagPublishedAt::class, 'date_format', 'YYYY-MM-dd');
 
         /** @var SwiftypeSiteTree $page */
         $page = $this->objFromFixture(SwiftypeSiteTree::class, 'page1');
@@ -48,7 +43,7 @@ public function testMetaTagOutput(): void
         $mock = str_replace('http://', '', $mock);
         $mock = str_replace('https://', '', $mock);
 
-        // Remove formatting from output output
+        // Remove formatting from output
         $output = trim(preg_replace("/\s+/S", '', $page->getSwiftypeMetaTags()->getValue()));
         $output = str_replace('http://', '', $output);
         $output = str_replace('https://', '', $output);