#42: PHP 8.1 compatibility fixes, unit tests updates, codebase cleanu…

…p with PHPCS, improved error handling, several minor fixes
swiftotter · Oct 6, 2022 · d780e6d · d780e6d
1 parent 3442bc9
commit d780e6d
Show file tree

Hide file tree

Showing 97 changed files with 1,304 additions and 2,774 deletions.
diff --git a/.driver/commands.yaml b/.driver/commands.yaml
@@ -1,6 +1,4 @@
 commands:
-  pipeline:
-    class: \Driver\Pipeline\Command
   connect:
     class: \Driver\Engines\MySql
   check-filesystem:

diff --git a/.driver/connections.yaml b/.driver/connections.yaml
@@ -3,5 +3,6 @@ connections:
     instance-type: db.t3.medium
     engine: MySQL
     storage-type: gp2
+    region: us-east-2
 
 # TODO: fix merging so that the other keys overwrite this.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@ composer.lock
 /vagrant/
 .DS_Store
 sample/
+.phpunit.result.cache
diff --git a/composer.json b/composer.json
@@ -6,19 +6,18 @@
     "require": {
         "php": "^7.4|^8.0",
         "ext-pdo": "*",
-        "php-di/php-di": "^6.0",
         "aws/aws-sdk-php": "^3.19",
-        "symfony/yaml": ">=2.3",
-        "ericpoe/haystack": "^1.0",
         "guzzlehttp/guzzle": "^6.2|^7.0",
+        "php-di/php-di": "^6.0",
         "psr/log": "^1.0",
         "symfony/console": "^4.4",
-        "symfony/event-dispatcher": "^4.0"
+        "symfony/event-dispatcher": "^4.0",
+        "symfony/yaml": ">=2.3"
     },
     "require-dev": {
-        "squizlabs/php_codesniffer": "^2.7",
-        "phpunit/phpunit": "^5.6",
-        "phpunit/dbunit": "^2.0"
+        "phpunit/phpunit": "^9.5",
+        "slevomat/coding-standard": "^8.5",
+        "squizlabs/php_codesniffer": "^3.7"
     },
     "bin": ["bin/driver"],
     "autoload": {

diff --git a/phpcs.xml b/phpcs.xml
@@ -0,0 +1,40 @@
+<?xml version="1.0"?>
+<ruleset name="SwiftOtter.Driver">
+    <file>src</file>
+    <rule ref="PSR12"/>
+    <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint">
+        <severity>7</severity>
+        <type>warning</type>
+    </rule>
+    <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint">
+        <severity>7</severity>
+        <type>warning</type>
+    </rule>
+    <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint">
+        <severity>7</severity>
+        <type>warning</type>
+    </rule>
+    <rule ref="SlevomatCodingStandard.TypeHints.UselessConstantTypeHint">
+        <severity>7</severity>
+        <type>warning</type>
+    </rule>
+    <rule ref="SlevomatCodingStandard.TypeHints.DeclareStrictTypes">
+        <severity>7</severity>
+        <type>warning</type>
+        <properties>
+            <property name="newlinesCountBetweenOpenTagAndDeclare" value="2"/>
+            <property name="newlinesCountAfterDeclare" value="2"/>
+            <property name="spacesCountAroundEqualsSign" value="0"/>
+        </properties>
+    </rule>
+    <rule ref="Squiz.NamingConventions.ValidVariableName">
+        <severity>7</severity>
+        <type>warning</type>
+        <exclude name="Squiz.NamingConventions.ValidVariableName.PrivateNoUnderscore" />
+    </rule>
+    <rule ref="Squiz.NamingConventions.ValidFunctionName">
+        <severity>7</severity>
+        <type>warning</type>
+        <exclude name="Squiz.NamingConventions.ValidFunctionName.PrivateNoUnderscore" />
+    </rule>
+</ruleset>
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,10 +1,9 @@
-<phpunit
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xml:noNamespaceSchemaLocation="http://schema.phpunit.de/4.5/phpunit.xsd"
-    bootstrap="phpunit.bootstrap.php">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+         bootstrap="phpunit.bootstrap.php">
     <testsuites>
         <testsuite name="Unit Tests">
             <directory>src/Tests/Unit/**</directory>
         </testsuite>
     </testsuites>
-</phpunit>
+</phpunit>
diff --git a/src/Commands/CleanupInterface.php b/src/Commands/CleanupInterface.php
@@ -1,21 +1,6 @@
 <?php
-/**
- * SwiftOtter_Base is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * SwiftOtter_Base is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * You should have received a copy of the GNU General Public License
- * along with SwiftOtter_Base. If not, see <http://www.gnu.org/licenses/>.
- *
- * @author Joseph Maxwell
- * @copyright SwiftOtter Studios, 11/5/16
- * @package default
- **/
+
+declare(strict_types=1);
 
 namespace Driver\Commands;
 
@@ -24,9 +9,5 @@
 
 interface CleanupInterface
 {
-    /**
-     * @param TransportInterface $transport
-     * @return TransportInterface
-     */
-    public function cleanup(TransportInterface $transport, EnvironmentInterface $environment);
-}
+    public function cleanup(TransportInterface $transport, EnvironmentInterface $environment): TransportInterface;
+}
diff --git a/src/Commands/CommandInterface.php b/src/Commands/CommandInterface.php
@@ -1,21 +1,6 @@
 <?php
-/**
- * SwiftOtter_Base is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * SwiftOtter_Base is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * You should have received a copy of the GNU General Public License
- * along with SwiftOtter_Base. If not, see <http://www.gnu.org/licenses/>.
- *
- * @author Joseph Maxwell
- * @copyright SwiftOtter Studios, 11/5/16
- * @package default
- **/
+
+declare(strict_types=1);
 
 namespace Driver\Commands;
 
@@ -24,11 +9,8 @@
 
 interface CommandInterface
 {
-    /**
-     * @param TransportInterface $transport
-     * @return TransportInterface
-     */
-    public function go(TransportInterface $transport, EnvironmentInterface $environment);
+    public function go(TransportInterface $transport, EnvironmentInterface $environment): TransportInterface;
 
-    public function getProperties();
+    // phpcs:ignore SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingTraversableTypeHintSpecification
+    public function getProperties(): array;
 }
diff --git a/src/Commands/Environment/Setup.php b/src/Commands/Environment/Setup.php
@@ -1,21 +1,6 @@
 <?php
-/**
- * SwiftOtter_Base is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * SwiftOtter_Base is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * You should have received a copy of the GNU General Public License
- * along with SwiftOtter_Base. If not, see <http://www.gnu.org/licenses/>.
- *
- * @author Joseph Maxwell
- * @copyright SwiftOtter Studios, 12/10/16
- * @package default
- **/
+
+declare(strict_types=1);
 
 namespace Driver\Commands\Environment;
 
@@ -26,22 +11,25 @@
 
 class Setup extends Command implements CommandInterface
 {
-    private $properties;
+    // phpcs:ignore SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingTraversableTypeHintSpecification
+    private array $properties;
 
-    public function __construct($properties = [])
+    // phpcs:ignore SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification
+    public function __construct(array $properties = [])
     {
         $this->properties = $properties;
         parent::__construct('environment-configuration');
     }
 
-    public function getProperties()
+    // phpcs:ignore SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingTraversableTypeHintSpecification
+    public function getProperties(): array
     {
         return $this->properties;
     }
 
-    public function go(TransportInterface $transport, EnvironmentInterface $environment)
+    public function go(TransportInterface $transport, EnvironmentInterface $environment): TransportInterface
     {
+        // @todo Check this!
         return $transport->withEnvironment($environment);
     }
-
 }
diff --git a/src/Commands/ErrorInterface.php b/src/Commands/ErrorInterface.php
@@ -1,21 +1,6 @@
 <?php
-/**
- * SwiftOtter_Base is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * SwiftOtter_Base is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * You should have received a copy of the GNU General Public License
- * along with SwiftOtter_Base. If not, see <http://www.gnu.org/licenses/>.
- *
- * @author Joseph Maxwell
- * @copyright SwiftOtter Studios, 11/5/16
- * @package default
- **/
+
+declare(strict_types=1);
 
 namespace Driver\Commands;
 
@@ -24,9 +9,5 @@
 
 interface ErrorInterface
 {
-    /**
-     * @param TransportInterface $transport
-     * @return TransportInterface
-     */
-    public function error(TransportInterface $transport, EnvironmentInterface $environment);
+    public function error(TransportInterface $transport, EnvironmentInterface $environment): TransportInterface;
 }
diff --git a/src/Commands/Factory.php b/src/Commands/Factory.php
@@ -1,21 +1,6 @@
 <?php
-/**
- * SwiftOtter_Base is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * SwiftOtter_Base is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- * You should have received a copy of the GNU General Public License
- * along with SwiftOtter_Base. If not, see <http://www.gnu.org/licenses/>.
- *
- * @author Joseph Maxwell
- * @copyright SwiftOtter Studios, 11/5/16
- * @package default
- **/
+
+declare(strict_types=1);
 
 namespace Driver\Commands;
 
@@ -24,44 +9,45 @@
 
 class Factory
 {
-    private $configuration;
-    private $container;
-    private $substitutions;
+    private Configuration $configuration;
+    private Container $container;
+    /** @var array<string, string>|null */
+    private ?array $substitutions = null;
 
     public function __construct(Configuration $configuration, Container $container)
     {
         $this->configuration = $configuration;
         $this->container = $container;
     }
 
-    /**
-     * @param $name
-     * @return CommandInterface
-     */
-    public function create($name, $properties = [])
+    // phpcs:ignore SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingTraversableTypeHintSpecification
+    public function create(string $name, array $properties = []): CommandInterface
     {
         $className = $this->getClassName($name);
         return $this->container->make($className, ['properties' => $properties]);
     }
 
-    private function getClassName($name)
+    private function getClassName(string $name): string
     {
-        $class = $this->runSubstitutions($this->configuration->getNode("commands/{$name}/class"));
+        $class = $this->runSubstitutions((string)$this->configuration->getNode("commands/{$name}/class"));
         if (class_exists($class) && in_array(CommandInterface::class, class_implements($class))) {
             return $class;
         } else {
-            throw new \Exception("{$name} doesn't exist or it doesn't implement the type " . CommandInterface::class . ".");
+            var_dump($class);
+            throw new \Exception(
+                "{$name} doesn't exist or it doesn't implement the type " . CommandInterface::class . "."
+            );
         }
     }
 
-    private function runSubstitutions($name)
+    private function runSubstitutions(string $name): string
     {
         $substitutions = $this->getSubstitutions();
         preg_match_all("/%(.+)%/U", $name, $matches);
 
         if (count($matches) > 1) {
-            $replacements = array_reduce($matches[1], function($carry, $name) use ($substitutions) {
-                $carry['%'.$name.'%'] = $substitutions[$name];
+            $replacements = array_reduce($matches[1], function ($carry, $name) use ($substitutions) {
+                $carry['%' . $name . '%'] = $substitutions[$name];
                 return $carry;
             }, []);
 
@@ -71,7 +57,10 @@ private function runSubstitutions($name)
         }
     }
 
-    private function getSubstitutions()
+    /**
+     * @return string[]
+     */
+    private function getSubstitutions(): array
     {
         if (!$this->substitutions) {
             $databaseEngine = $this->configuration->getNode('connections/database');
@@ -83,9 +72,8 @@ private function getSubstitutions()
                 'engine' => $this->configuration->getNode("engines/{$databaseEngine}/class-name")
             ];
             $this->substitutions = $substitutions;
-
         }
 
         return $this->substitutions;
     }
-}
+}