feature symfony#59477 [Mailer][Notifier] Add and use Dsn::getBooleanOption() (OskarStark)

This PR was squashed before being merged into the 7.3 branch.

Discussion
----------

[Mailer][Notifier] Add and use `Dsn::getBooleanOption()`

| Q             | A
| ------------- | ---
| Branch?       | 7.3
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Issues        | --
| License       | MIT

Commits
-------

67514f8 [Mailer][Notifier] Add and use `Dsn::getBooleanOption()`

Author: fabpot

src/Symfony/Component/Mailer/Bridge/Mailjet/Transport/MailjetTransportFactory.php

@@ -24,7 +24,7 @@ public function create(Dsn $dsn): TransportInterface
         $user = $this->getUser($dsn);
         $password = $this->getPassword($dsn);
         $host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
-        $sandbox = filter_var($dsn->getOption('sandbox', false), \FILTER_VALIDATE_BOOL);
+        $sandbox = $dsn->getBooleanOption('sandbox');
 
         if ('mailjet+api' === $scheme) {
             return (new MailjetApiTransport($user, $password, $this->client, $this->dispatcher, $this->logger, $sandbox))->setHost($host);

src/Symfony/Component/Mailer/Bridge/Mailjet/composer.json

@@ -17,7 +17,7 @@
     ],
     "require": {
         "php": ">=8.2",
-        "symfony/mailer": "^7.2"
+        "symfony/mailer": "^7.3"
     },
     "require-dev": {
         "symfony/http-client": "^6.4|^7.0",

src/Symfony/Component/Mailer/CHANGELOG.md

@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add DSN param `retry_period` to override default email transport retry period
+ * Add `Dsn::getBooleanOption()`
 
 7.2
 ---

src/Symfony/Component/Mailer/Tests/Transport/DsnTest.php

@@ -105,4 +105,29 @@ public static function invalidDsnProvider(): iterable
             'The mailer DSN must contain a host (use "default" by default).',
         ];
     }
+
+    /**
+     * @dataProvider getBooleanOptionProvider
+     */
+    public function testGetBooleanOption(bool $expected, string $dsnString, string $option, bool $default)
+    {
+        $dsn = Dsn::fromString($dsnString);
+
+        $this->assertSame($expected, $dsn->getBooleanOption($option, $default));
+    }
+
+    public static function getBooleanOptionProvider(): iterable
+    {
+        yield [true, 'scheme://localhost?enabled=1', 'enabled', false];
+        yield [true, 'scheme://localhost?enabled=true', 'enabled', false];
+        yield [true, 'scheme://localhost?enabled=on', 'enabled', false];
+        yield [true, 'scheme://localhost?enabled=yes', 'enabled', false];
+        yield [false, 'scheme://localhost?enabled=0', 'enabled', false];
+        yield [false, 'scheme://localhost?enabled=false', 'enabled', false];
+        yield [false, 'scheme://localhost?enabled=off', 'enabled', false];
+        yield [false, 'scheme://localhost?enabled=no', 'enabled', false];
+
+        yield [false, 'scheme://localhost', 'not_existant', false];
+        yield [true, 'scheme://localhost', 'not_existant', true];
+    }
 }

src/Symfony/Component/Mailer/Transport/Dsn.php

@@ -79,4 +79,9 @@ public function getOption(string $key, mixed $default = null): mixed
     {
         return $this->options[$key] ?? $default;
     }
+
+    public function getBooleanOption(string $key, bool $default = false): bool
+    {
+        return filter_var($this->getOption($key, $default), \FILTER_VALIDATE_BOOLEAN);
+    }
 }

src/Symfony/Component/Notifier/Bridge/Isendpro/IsendproTransportFactory.php

@@ -25,8 +25,8 @@ public function create(Dsn $dsn): IsendproTransport
 
         $keyid = $this->getUser($dsn);
         $from = $dsn->getOption('from', null);
-        $noStop = filter_var($dsn->getOption('no_stop', false), \FILTER_VALIDATE_BOOLEAN);
-        $sandbox = filter_var($dsn->getOption('sandbox', false), \FILTER_VALIDATE_BOOLEAN);
+        $noStop = $dsn->getBooleanOption('no_stop');
+        $sandbox = $dsn->getBooleanOption('sandbox');
         $host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
         $port = $dsn->getPort();
 

src/Symfony/Component/Notifier/Bridge/Isendpro/composer.json

@@ -22,7 +22,7 @@
     "require": {
         "php": ">=8.2",
         "symfony/http-client": "^6.4|^7.0",
-        "symfony/notifier": "^7.2"
+        "symfony/notifier": "^7.3"
     },
     "require-dev": {
         "symfony/event-dispatcher": "^6.4|^7.0"

src/Symfony/Component/Notifier/Bridge/OvhCloud/OvhCloudTransportFactory.php

@@ -33,7 +33,7 @@ public function create(Dsn $dsn): OvhCloudTransport
         $consumerKey = $dsn->getRequiredOption('consumer_key');
         $serviceName = $dsn->getRequiredOption('service_name');
         $sender = $dsn->getOption('sender');
-        $noStopClause = filter_var($dsn->getOption('no_stop_clause', false), \FILTER_VALIDATE_BOOL);
+        $noStopClause = $dsn->getBooleanOption('no_stop_clause');
         $host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
         $port = $dsn->getPort();
 

src/Symfony/Component/Notifier/Bridge/OvhCloud/composer.json

@@ -18,7 +18,7 @@
     "require": {
         "php": ">=8.2",
         "symfony/http-client": "^6.4|^7.0",
-        "symfony/notifier": "^7.2"
+        "symfony/notifier": "^7.3"
     },
     "autoload": {
         "psr-4": { "Symfony\\Component\\Notifier\\Bridge\\OvhCloud\\": "" },

src/Symfony/Component/Notifier/Bridge/SmsBiuras/SmsBiurasTransportFactory.php

@@ -31,7 +31,7 @@ public function create(Dsn $dsn): SmsBiurasTransport
         $uid = $this->getUser($dsn);
         $apiKey = $this->getPassword($dsn);
         $from = $dsn->getRequiredOption('from');
-        $testMode = filter_var($dsn->getOption('test_mode', false), \FILTER_VALIDATE_BOOL);
+        $testMode = $dsn->getBooleanOption('test_mode');
         $host = 'default' === $dsn->getHost() ? null : $dsn->getHost();
         $port = $dsn->getPort();