Code cleanup

composer.json

@@ -30,7 +30,8 @@
         "symfony/mailer": ">=5.4.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "9.5.10"
+        "phpunit/phpunit": "9.5.10",
+        "symplify/easy-coding-standard": "^10.1"
     },
     "repositories": [
         {

ecs.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symplify\EasyCodingStandard\ValueObject\Option;
+use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $parameters = $containerConfigurator->parameters();
+    $parameters->set(Option::PATHS, [
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ]);
+
+    $services = $containerConfigurator->services();
+    $services->set(ArraySyntaxFixer::class)
+        ->call('configure', [[
+            'syntax' => 'short',
+        ]]);
+
+    // run and fix, one by one
+     $containerConfigurator->import(SetList::SPACES);
+     $containerConfigurator->import(SetList::ARRAY);
+     $containerConfigurator->import(SetList::DOCBLOCK);
+     $containerConfigurator->import(SetList::PSR_12);
+};

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>

src/DkimSignerWrapper.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 DkimSignerWrapper implements SymfonyMessageSignerInterface
+{
+    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);
+    }
+}

src/Logger.php

@@ -7,124 +7,37 @@
 
 namespace yii\symfonymailer;
 
-use Yii;
+use Psr\Log\InvalidArgumentException;
 use Psr\Log\LoggerInterface;
+use Psr\Log\LoggerTrait;
+use Psr\Log\LogLevel;
+use Yii;
+use yii\log\Logger as YiiLogger;
 
 final class Logger implements LoggerInterface
 {
-    /**
-     * System is unusable.
-     *
-     * @param string|\Stringable $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function emergency($message, array $context = []): void
-    {
-        Yii::getLogger()->log($message, \yii\log\Logger::LEVEL_ERROR, __METHOD__);
-    }
+    use LoggerTrait;
 
-    /**
-     * Action must be taken immediately.
-     *
-     * Example: Entire website down, database unavailable, etc. This should
-     * trigger the SMS alerts and wake you up.
-     *
-     * @param string|\Stringable $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function alert($message, array $context = []): void
-    {
-        Yii::getLogger()->log($message, \yii\log\Logger::LEVEL_ERROR, __METHOD__);
-    }
+    private YiiLogger $logger;
 
-    /**
-     * Critical conditions.
-     *
-     * Example: Application component unavailable, unexpected exception.
-     *
-     * @param string|\Stringable $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function critical($message, array $context = []): void
-    {
-        Yii::getLogger()->log($message, \yii\log\Logger::LEVEL_ERROR, __METHOD__);
-    }
+    private array $map;
 
-    /**
-     * Runtime errors that do not require immediate action but should typically
-     * be logged and monitored.
-     *
-     * @param string|\Stringable $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function error($message, array $context = []): void
-    {
-        Yii::getLogger()->log($message, \yii\log\Logger::LEVEL_ERROR, __METHOD__);
-    }
+    private string $category;
 
-    /**
-     * Exceptional occurrences that are not errors.
-     *
-     * Example: Use of deprecated APIs, poor use of an API, undesirable things
-     * that are not necessarily wrong.
-     *
-     * @param string|\Stringable $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function warning($message, array $context = []): void
-    {
-        Yii::getLogger()->log($message, \yii\log\Logger::LEVEL_WARNING, __METHOD__);
-    }
-
-    /**
-     * Normal but significant events.
-     *
-     * @param string|\Stringable $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function notice($message, array $context = []): void
-    {
-        Yii::getLogger()->log($message, \yii\log\Logger::LEVEL_WARNING, __METHOD__);
-    }
-
-    /**
-     * Interesting events.
-     *
-     * Example: User logs in, SQL logs.
-     *
-     * @param string|\Stringable $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function info($message, array $context = []): void
-    {
-        Yii::getLogger()->log($message, \yii\log\Logger::LEVEL_INFO, __METHOD__);
-    }
-
-    /**
-     * Detailed debug information.
-     *
-     * @param string|\Stringable $message
-     * @param mixed[] $context
-     *
-     * @return void
-     */
-    public function debug($message, array $context = []): void
+    public function __construct(YiiLogger $logger, array $map = [
+        LogLevel::ERROR => YiiLogger::LEVEL_ERROR,
+        LogLevel::CRITICAL => YiiLogger::LEVEL_ERROR,
+        LogLevel::ALERT => YiiLogger::LEVEL_ERROR,
+        LogLevel::EMERGENCY => YiiLogger::LEVEL_ERROR,
+        LogLevel::NOTICE => YiiLogger::LEVEL_WARNING,
+        LogLevel::WARNING => YiiLogger::LEVEL_WARNING,
+        LogLevel::DEBUG => YiiLogger::LEVEL_INFO,
+        LogLevel::INFO => YiiLogger::LEVEL_INFO,
+    ], string $category = 'PSR Logging Adapter')
     {
-        Yii::getLogger()->log($message, \yii\log\Logger::LEVEL_INFO, __METHOD__);
+        $this->logger = $logger;
+        $this->map = $map;
+        $this->category = $category;
     }
 
     /**
@@ -134,30 +47,14 @@ public function debug($message, array $context = []): void
      * @param string|\Stringable $message
      * @param mixed[] $context
      *
-     * @return void
-     *
      * @throws \Psr\Log\InvalidArgumentException
      */
     public function log($level, $message, array $context = []): void
     {
-        switch ($level) {
-            case 'error':
-            case 'critical':
-            case 'alert':
-            case 'emergency':
-                $level = \yii\log\Logger::LEVEL_ERROR;
-                break;
-            case 'notice':
-            case 'warning':
-                $level = \yii\log\Logger::LEVEL_WARNING;
-                break;
-            case 'debug':
-            case 'info':
-                $level = \yii\log\Logger::LEVEL_INFO;
-                break;
-            default:
-                $level = \yii\log\Logger::LEVEL_INFO;
+        if (! isset($this->map[$level])) {
+            throw new InvalidArgumentException("Unknown logging level $level");
         }
-        Yii::getLogger()->log($message, $level, __METHOD__);
+
+        $this->logger->log($message, $this->map[$level], $this->category);
     }
 }