NEW: PHP 8 upgrade.

silverstripe-terraformers · Jun 23, 2022 · 2bae9f6 · 2bae9f6
1 parent ef24800
commit 2bae9f6
Show file tree

Hide file tree

Showing 19 changed files with 77 additions and 209 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,10 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  ci:
+    uses: silverstripe/gha-ci/.github/workflows/ci.yml@v1
diff --git a/.travis.yml b/.travis.yml
diff --git a/composer.json b/composer.json
@@ -23,15 +23,15 @@
         "issues": "http://github.com/ichaber/silverstripe-swiftype/issues"
     },
     "require": {
-        "php": "^7.1",
-        "silverstripe/vendor-plugin": "^1",
+        "php": "^7.4 || ^8.0",
+        "silverstripe/vendor-plugin": "^1.6",
         "silverstripe/framework": "^4",
         "silverstripe/cms": "^4",
-        "guzzlehttp/guzzle": "^6.3.0",
-        "guzzlehttp/psr7": "^1.4.2"
+        "guzzlehttp/guzzle": "^7",
+        "guzzlehttp/psr7": "^2"
     },
     "require-dev": {
-        "phpunit/phpunit": "^5.7"
+        "silverstripe/recipe-testing": "^2"
     },
     "autoload": {
         "psr-4": {
@@ -43,5 +43,12 @@
         "installer-name": "silverstripe-swiftype"
     },
     "prefer-stable": true,
-    "minimum-stability": "dev"
+    "minimum-stability": "dev",
+    "config": {
+        "allow-plugins": {
+            "composer/installers": true,
+            "silverstripe/recipe-plugin": true,
+            "silverstripe/vendor-plugin": true
+        }
+    }
 }
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="SilverStripe">
+    <description>CodeSniffer ruleset for SilverStripe coding conventions.</description>
+
+    <file>src</file>
+    <file>tests</file>
+
+    <rule ref="Generic.Arrays.DisallowLongArraySyntax" />
+
+    <!-- base rules are PSR-2 -->
+    <rule ref="PSR2" >
+        <!-- Current exclusions -->
+        <exclude name="PSR1.Methods.CamelCapsMethodName" />
+        <exclude name="PSR1.Files.SideEffects.FoundWithSymbols" />
+        <exclude name="PSR2.Classes.PropertyDeclaration" />
+        <exclude name="PSR2.ControlStructures.SwitchDeclaration" /> <!-- causes php notice while linting -->
+        <exclude name="PSR2.ControlStructures.SwitchDeclaration.WrongOpenercase" />
+        <exclude name="PSR2.ControlStructures.SwitchDeclaration.WrongOpenerdefault" />
+        <exclude name="PSR2.ControlStructures.SwitchDeclaration.TerminatingComment" />
+        <exclude name="PSR2.Methods.MethodDeclaration.Underscore" />
+        <exclude name="Squiz.Scope.MethodScope" />
+        <exclude name="Squiz.Classes.ValidClassName.NotCamelCaps" />
+        <exclude name="Generic.Files.LineLength.TooLong" />
+        <exclude name="PEAR.Functions.ValidDefaultValue.NotAtEnd" />
+    </rule>
+</ruleset>
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,13 +1,17 @@
-<phpunit bootstrap="vendor/silverstripe/cms/tests/bootstrap.php" colors="true">
-    <testsuite name="Default">
-        <directory>tests/php/</directory>
-    </testsuite>
-    <filter>
-        <whitelist addUncoveredFilesFromWhitelist="true">
+<?xml version="1.0"?>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/silverstripe/cms/tests/bootstrap.php"
+         colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+    <coverage includeUncoveredFiles="true">
+        <include>
             <directory suffix=".php">src/</directory>
-            <exclude>
-                <directory suffix=".php">tests/</directory>
-            </exclude>
-        </whitelist>
-    </filter>
+        </include>
+        <exclude>
+            <directory suffix=".php">tests/</directory>
+        </exclude>
+    </coverage>
+    <testsuites>
+        <testsuite name="Default">
+            <directory>tests/</directory>
+        </testsuite>
+    </testsuites>
 </phpunit>
diff --git a/src/Extensions/SwiftypeMetaTagContentExtension.php b/src/Extensions/SwiftypeMetaTagContentExtension.php
@@ -9,9 +9,6 @@
 use SilverStripe\ORM\FieldType\DBField;
 
 /**
- * Class SwiftypeMetaTagContentExtension
- *
- * @package Ichaber\SSSwiftype\Extensions
  * @property DataObject|$this $owner
  */
 class SwiftypeMetaTagContentExtension extends DataExtension

diff --git a/src/Extensions/SwiftypeSiteConfigFieldsExtension.php b/src/Extensions/SwiftypeSiteConfigFieldsExtension.php
@@ -11,9 +11,6 @@
 /**
  * Some default things to set up
  *
- * Class SwiftypeSiteConfigFieldsExtension
- *
- * @package Ichaber\SSSwiftype\Extensions
  * @property bool $SwiftypeEnabled
  * @property string $SwiftypeAccessKey
  * @property string $SwiftypeAPIKey
@@ -39,8 +36,6 @@ class SwiftypeSiteConfigFieldsExtension extends DataExtension
      * Settings and CMS form fields for CMS the admin/settings area
      *
      * @codeCoverageIgnore
-     * @param FieldList $fields
-     * @return void
      */
     public function updateCMSFields(FieldList $fields): void
     {

diff --git a/src/Extensions/SwiftypeSiteTreeCrawlerExtension.php b/src/Extensions/SwiftypeSiteTreeCrawlerExtension.php
@@ -10,9 +10,6 @@
 use SilverStripe\Versioned\Versioned;
 
 /**
- * Class SwiftypeSiteTreeCrawlerExtension
- *
- * @package Ichaber\SSSwiftype\Extensions
  * @property SiteTree|$this $owner
  */
 class SwiftypeSiteTreeCrawlerExtension extends SiteTreeExtension
@@ -26,16 +23,11 @@ class SwiftypeSiteTreeCrawlerExtension extends SiteTreeExtension
      */
     private $urlsToCrawl = [];
 
-    /**
-     * @param array $urls
-     */
-    public function setUrlsToCrawl(array $urls) {
+    public function setUrlsToCrawl(array $urls)
+    {
         $this->urlsToCrawl = $urls;
     }
 
-    /**
-     * @return array
-     */
     public function getUrlsToCrawl(): array
     {
         return $this->urlsToCrawl;
@@ -56,7 +48,6 @@ public function onBeforeWrite(): void
      * an unpublish)
      *
      * @param SiteTree|mixed $original
-     * @return void
      */
     public function onAfterPublish(&$original): void
     {
@@ -162,7 +153,7 @@ public function collateUrls(): void
         $urls = $this->getUrlsToCrawl();
 
         // Set us to a LIVE stage/reading_mode
-        $this->withVersionContext(function() use (&$urls) {
+        $this->withVersionContext(function () use (&$urls) {
             /** @var SiteTree $owner */
             $owner = $this->getOwner();
             $key = $this->getOwnerKey();
@@ -225,15 +216,11 @@ protected function processCollatedUrls(): void
         }
 
         // Force the reindexing of each URL we collated
-        foreach ($urls[$key] as $url)  {
+        foreach ($urls[$key] as $url) {
             $this->forceSwiftypeIndex($url);
         }
     }
 
-    /**
-     * @param string $updateUrl
-     * @return bool
-     */
     protected function forceSwiftypeIndex(string $updateUrl): bool
     {
         // We don't reindex dev environments
@@ -246,9 +233,6 @@ protected function forceSwiftypeIndex(string $updateUrl): bool
         return $crawler->send($updateUrl);
     }
 
-    /**
-     * @return string
-     */
     protected function getOwnerKey(): ?string
     {
         $owner = $this->owner;
@@ -269,12 +253,10 @@ protected function getOwnerKey(): ?string
      * The main function is to suppress the ?stage=Live querystring. LeftAndMain will set the default
      * reading mode to 'DRAFT' when initialising so to counter this we need to re-set the default
      * reading mode back to LIVE
-     *
-     * @param callable $callback
      */
     private function withVersionContext(callable $callback): void
     {
-        Versioned::withVersionedMode(static function() use ($callback) {
+        Versioned::withVersionedMode(static function () use ($callback) {
             // Grab our current stage and reading mode
             $originalDefaultReadingMode = Versioned::get_default_reading_mode();
             $originalReadingMode = Versioned::get_reading_mode();

diff --git a/src/MetaTags/SwiftypeMetaTag.php b/src/MetaTags/SwiftypeMetaTag.php
@@ -8,9 +8,6 @@
 use SilverStripe\ORM\FieldType\DBDatetime;
 
 /**
- * Class SwiftypeMetaTag
- *
- * @package Ichaber\SSSwiftype\MetaTags
  * @see _config/model.yml for DateFormat definition
  * @see _config/model.yml for field_name override example
  */
@@ -33,10 +30,6 @@ abstract class SwiftypeMetaTag implements SwiftypeMetaTagInterface
      */
     protected $fieldType;
 
-    /**
-     * @param DataObject $dataObject
-     * @return null|string
-     */
     public function getMetaTagString(DataObject $dataObject): ?string
     {
         // Can't do anything if no tag name was specified
@@ -61,7 +54,6 @@ public function getMetaTagString(DataObject $dataObject): ?string
     }
 
     /**
-     * @param DataObject $dataObject
      * @return string|int|null
      */
     protected function getFieldValue(DataObject $dataObject)
@@ -111,12 +103,6 @@ protected function getFieldValue(DataObject $dataObject)
         return null;
     }
 
-    /**
-     * @param string $name
-     * @param string $fieldType
-     * @param string $value
-     * @return string
-     */
     protected function generateMetaTagsString(string $name, string $fieldType, string $value): string
     {
         return sprintf(

diff --git a/src/MetaTags/SwiftypeMetaTagDescription.php b/src/MetaTags/SwiftypeMetaTagDescription.php
@@ -2,11 +2,6 @@
 
 namespace Ichaber\SSSwiftype\MetaTags;
 
-/**
- * Class SwiftypeMetaTagDescription
- *
- * @package Ichaber\SSSwiftype\MetaTags
- */
 class SwiftypeMetaTagDescription extends SwiftypeMetaTag
 {
     /**

diff --git a/src/MetaTags/SwiftypeMetaTagInterface.php b/src/MetaTags/SwiftypeMetaTagInterface.php
@@ -11,16 +11,8 @@
  * and I would just get php errors any time I tried to instantiate a MetaTag class.
  *
  * Moving them into the same namespace was the only way I was able to move forward without going down a rabbit hole.
- *
- * Interface SwiftypeMetaTagInterface
- *
- * @package Ichaber\SSSwiftype\Interfaces
  */
 interface SwiftypeMetaTagInterface
 {
-    /**
-     * @param DataObject $dataObject
-     * @return string|null
-     */
     public function getMetaTagString(DataObject $dataObject): ?string;
 }
diff --git a/src/MetaTags/SwiftypeMetaTagPublishedAt.php b/src/MetaTags/SwiftypeMetaTagPublishedAt.php
@@ -2,11 +2,6 @@
 
 namespace Ichaber\SSSwiftype\MetaTags;
 
-/**
- * Class SwiftypeMetaTagPublishedAt
- *
- * @package Ichaber\SSSwiftype\MetaTags
- */
 class SwiftypeMetaTagPublishedAt extends SwiftypeMetaTag
 {
     /**

diff --git a/src/MetaTags/SwiftypeMetaTagRobots.php b/src/MetaTags/SwiftypeMetaTagRobots.php
@@ -6,17 +6,8 @@
 use SilverStripe\Core\Config\Config;
 use SilverStripe\ORM\DataObject;
 
-/**
- * Class SwiftypeMetaTagRobots
- *
- * @package Ichaber\SSSwiftype\MetaTags
- */
 class SwiftypeMetaTagRobots extends SwiftypeMetaTag
 {
-    /**
-     * @param DataObject $dataObject
-     * @return string|null
-     */
     public function getMetaTagString(DataObject $dataObject): ?string
     {
         $value = $this->getFieldValue($dataObject);
@@ -29,7 +20,6 @@ public function getMetaTagString(DataObject $dataObject): ?string
     }
 
     /**
-     * @param DataObject $dataObject
      * @return int|string|null
      */
     protected function getFieldValue(DataObject $dataObject)

diff --git a/src/MetaTags/SwiftypeMetaTagTitle.php b/src/MetaTags/SwiftypeMetaTagTitle.php
@@ -2,11 +2,6 @@
 
 namespace Ichaber\SSSwiftype\MetaTags;
 
-/**
- * Class SwiftypeMetaTagTitle
- *
- * @package Ichaber\SSSwiftype\MetaTags
- */
 class SwiftypeMetaTagTitle extends SwiftypeMetaTag
 {
     /**

diff --git a/src/MetaTags/SwiftypeMetaTagURL.php b/src/MetaTags/SwiftypeMetaTagURL.php
@@ -2,11 +2,6 @@
 
 namespace Ichaber\SSSwiftype\MetaTags;
 
-/**
- * Class SwiftypeMetaTagURL
- *
- * @package Ichaber\SSSwiftype\MetaTags
- */
 class SwiftypeMetaTagURL extends SwiftypeMetaTag
 {
     /**