Code cleanup

.github/workflows/build.yml

@@ -24,6 +24,7 @@ jobs:
               uses: shivammathur/setup-php@v2
               with:
                   php-version: ${{ matrix.php }}
+                  coverage: pcov
             - name: Get composer cache directory
               id: composer-cache
               run: echo "::set-output name=dir::$(composer config cache-files-dir)"
@@ -35,5 +36,9 @@ jobs:
                   restore-keys: ${{ runner.os }}-composer-
             - name: Install dependencies
               run: composer update $DEFAULT_COMPOSER_FLAGS
-            - name: Run unit tests without coverage
-              run: vendor/bin/phpunit --verbose --colors=always
+            - name: Run unit tests with coverage
+              run: vendor/bin/phpunit --coverage-text
+            - name: Static analysis (Psalm)
+              run: vendor/bin/psalm
+            - name: Test code style
+              run: vendor/bin/ecs

CHANGELOG.md

@@ -1,12 +1,13 @@
 Yii Framework 2 Symfony mailer extension Change Log
 ================================================
 
-2.0.5 under development
+3.0.0 under development
 -----------------------
 
-- no changes in this release.
-
+- Enh #27: Extensive rewrite to make it more statically typed and better testable (sammousa)
+- Enh #22: Added an exception if there is no transport configuration (Krakozaber)
 
+
 2.0.4 September 04, 2022
 ------------------------
 
@@ -38,4 +39,3 @@ Yii Framework 2 Symfony mailer extension Change Log
 -----------------------
 
 - Initial release.
-

captainhook.json

@@ -0,0 +1,59 @@
+{
+    "commit-msg": {
+        "enabled": true,
+        "actions": []
+    },
+    "pre-push": {
+        "enabled": false,
+        "actions": []
+    },
+    "pre-commit": {
+        "enabled": true,
+        "actions": [
+            {
+                "action": "\\CaptainHook\\App\\Hook\\PHP\\Action\\Linting",
+                "options": [],
+                "conditions": []
+            },
+            {
+                "action": "vendor/bin/phpunit",
+                "options": [],
+                "conditions": []
+            },
+            {
+                "action": "vendor/bin/ecs",
+                "options": [],
+                "conditions": []
+            },
+            {
+                "action": "vendor/bin/psalm",
+                "options": [],
+                "conditions": []
+            }
+        ]
+    },
+    "prepare-commit-msg": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-commit": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-merge": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-checkout": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-rewrite": {
+        "enabled": false,
+        "actions": []
+    },
+    "post-change": {
+        "enabled": false,
+        "actions": []
+    }
+}

composer.json

@@ -30,7 +30,11 @@
         "symfony/mailer": ">=5.4.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "9.5.10"
+        "phpunit/phpunit": "9.5.10",
+        "symplify/easy-coding-standard": "^10.1",
+        "vimeo/psalm": "^4.22",
+        "captainhook/captainhook": "^5.10",
+        "captainhook/plugin-composer": "^5.3"
     },
     "repositories": [
         {
@@ -43,14 +47,20 @@
             "yii\\symfonymailer\\": "src"
         }
     },
+    "autoload-dev": {
+        "classmap": [
+            "vendor/yiisoft/yii2/Yii.php"
+        ]
+    },
     "extra": {
         "branch-alias": {
             "dev-master": "2.0.x-dev"
         }
     },
     "config": {
         "allow-plugins": {
-            "yiisoft/yii2-composer": true
+            "yiisoft/yii2-composer": true,
+            "captainhook/plugin-composer": true
         }
     }
 }

ecs.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+use Symplify\EasyCodingStandard\ValueObject\Option;
+use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
+
+return static function (ECSConfig $ecsConfig): void {
+    $ecsConfig->paths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ]);
+
+    // run and fix, one by one
+    $ecsConfig->import(SetList::ARRAY);
+    $ecsConfig->import(SetList::DOCBLOCK);
+    $ecsConfig->import(SetList::PSR_12);
+
+    $ecsConfig->ruleWithConfiguration(ArraySyntaxFixer::class, [
+        'syntax' => 'short'
+    ]);
+
+
+
+};

phpunit.xml.dist

@@ -5,10 +5,16 @@
          convertErrorsToExceptions="true"
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
+         forceCoversAnnotation="true"
          stopOnFailure="false">
     <testsuites>
         <testsuite name="Yii2-swiftmailer Test Suite">
             <directory>./tests</directory>
         </testsuite>
     </testsuites>
-</phpunit>
+    <coverage>
+        <include>
+            <directory suffix=".php">src</directory>
+        </include>
+    </coverage>
+</phpunit>

psalm.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="1"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

src/DkimMessageSigner.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace yii\symfonymailer;
+
+use Symfony\Component\Mime\Crypto\DkimSigner;
+use Symfony\Component\Mime\Message;
+
+/**
+ * @codeCoverageIgnore This class is a trivial proxy that requires no testing
+ */
+class DkimMessageSigner implements MessageSignerInterface
+{
+    private DkimSigner $dkimSigner;
+
+    public function __construct(DkimSigner $dkimSigner)
+    {
+        $this->dkimSigner = $dkimSigner;
+    }
+
+    public function sign(Message $message, array $options = []): Message
+    {
+        return $this->dkimSigner->sign($message, $options);
+    }
+}