[Mailer] Renamed getName() to toString()

fabpot · fabpot · commit 8da8f829c9c7 · 2019-09-02T11:41:25.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,7 +11,7 @@ CHANGELOG
  * Added PHPUnit constraints
  * Added `MessageDataCollector`
  * Added `MessageEvents` and `MessageLoggerListener` to allow collecting sent emails
- * [BC BREAK] `TransportInterface` has a new `getName()` method
+ * [BC BREAK] `TransportInterface` has a new `__toString()` method
  * [BC BREAK] Classes `AbstractApiTransport` and `AbstractHttpTransport` moved under `Transport` sub-namespace.
  * [BC BREAK] Transports depend on `Symfony\Contracts\EventDispatcher\EventDispatcherInterface`
    instead of `Symfony\Component\EventDispatcher\EventDispatcherInterface`.
diff --git a/Event/MessageEvent.php b/Event/MessageEvent.php
@@ -24,14 +24,14 @@ final class MessageEvent extends Event
 {
     private $message;
     private $envelope;
-    private $transportName;
+    private $transport;
     private $queued;
 
-    public function __construct(RawMessage $message, SmtpEnvelope $envelope, string $transportName, bool $queued = false)
+    public function __construct(RawMessage $message, SmtpEnvelope $envelope, string $transport, bool $queued = false)
     {
         $this->message = $message;
         $this->envelope = $envelope;
-        $this->transportName = $transportName;
+        $this->transport = $transport;
         $this->queued = $queued;
     }
 
@@ -55,9 +55,9 @@ public function setEnvelope(SmtpEnvelope $envelope): void
         $this->envelope = $envelope;
     }
 
-    public function getTransportName(): string
+    public function getTransport(): string
     {
-        return $this->transportName;
+        return $this->transport;
     }
 
     public function isQueued(): bool
diff --git a/Event/MessageEvents.php b/Event/MessageEvents.php
@@ -24,7 +24,7 @@ class MessageEvents
     public function add(MessageEvent $event): void
     {
         $this->events[] = $event;
-        $this->transports[$event->getTransportName()] = true;
+        $this->transports[$event->getTransport()] = true;
     }
 
     public function getTransports(): array
@@ -43,7 +43,7 @@ public function getEvents(string $name = null): array
 
         $events = [];
         foreach ($this->events as $event) {
-            if ($name === $event->getTransportName()) {
+            if ($name === $event->getTransport()) {
                 $events[] = $event;
             }
         }
diff --git a/Mailer.php b/Mailer.php
@@ -54,7 +54,7 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): void
                     throw new TransportException('Cannot send message without a valid envelope.', 0, $e);
                 }
             }
-            $event = new MessageEvent($message, $envelope, $this->transport->getName(), true);
+            $event = new MessageEvent($message, $envelope, (string) $this->transport, true);
             $this->dispatcher->dispatch($event);
         }
 
diff --git a/Test/TransportFactoryTestCase.php b/Test/TransportFactoryTestCase.php
@@ -70,7 +70,7 @@ public function testCreate(Dsn $dsn, TransportInterface $transport): void
 
         $this->assertEquals($transport, $factory->create($dsn));
         if ('smtp' !== $dsn->getScheme() && 'smtps' !== $dsn->getScheme()) {
-            $this->assertStringMatchesFormat($dsn->getScheme().'://%S'.$dsn->getHost().'%S', $transport->getName());
+            $this->assertStringMatchesFormat($dsn->getScheme().'://%S'.$dsn->getHost().'%S', (string) $transport);
         }
     }
 
diff --git a/Tests/Transport/FailoverTransportTest.php b/Tests/Transport/FailoverTransportTest.php
@@ -29,14 +29,14 @@ public function testSendNoTransports()
         new FailoverTransport([]);
     }
 
-    public function testGetName()
+    public function testToString()
     {
         $t1 = $this->createMock(TransportInterface::class);
-        $t1->expects($this->once())->method('getName')->willReturn('t1://local');
+        $t1->expects($this->once())->method('__toString')->willReturn('t1://local');
         $t2 = $this->createMock(TransportInterface::class);
-        $t2->expects($this->once())->method('getName')->willReturn('t2://local');
+        $t2->expects($this->once())->method('__toString')->willReturn('t2://local');
         $t = new FailoverTransport([$t1, $t2]);
-        $this->assertEquals('t1://local || t2://local', $t->getName());
+        $this->assertEquals('t1://local || t2://local', (string) $t);
     }
 
     public function testSendFirstWork()
diff --git a/Tests/Transport/NullTransportTest.php b/Tests/Transport/NullTransportTest.php
@@ -16,9 +16,9 @@
 
 class NullTransportTest extends TestCase
 {
-    public function testName()
+    public function testToString()
     {
         $t = new NullTransport();
-        $this->assertEquals('smtp://null', $t->getName());
+        $this->assertEquals('smtp://null', (string) $t);
     }
 }
diff --git a/Tests/Transport/RoundRobinTransportTest.php b/Tests/Transport/RoundRobinTransportTest.php
@@ -28,14 +28,14 @@ public function testSendNoTransports()
         new RoundRobinTransport([]);
     }
 
-    public function testGetName()
+    public function testToString()
     {
         $t1 = $this->createMock(TransportInterface::class);
-        $t1->expects($this->once())->method('getName')->willReturn('t1://local');
+        $t1->expects($this->once())->method('__toString')->willReturn('t1://local');
         $t2 = $this->createMock(TransportInterface::class);
-        $t2->expects($this->once())->method('getName')->willReturn('t2://local');
+        $t2->expects($this->once())->method('__toString')->willReturn('t2://local');
         $t = new RoundRobinTransport([$t1, $t2]);
-        $this->assertEquals('t1://local && t2://local', $t->getName());
+        $this->assertEquals('t1://local && t2://local', (string) $t);
     }
 
     public function testSendAlternate()
diff --git a/Tests/Transport/SendmailTransportTest.php b/Tests/Transport/SendmailTransportTest.php
@@ -16,9 +16,9 @@
 
 class SendmailTransportTest extends TestCase
 {
-    public function testName()
+    public function testToString()
     {
         $t = new SendmailTransport();
-        $this->assertEquals('smtp://sendmail', $t->getName());
+        $this->assertEquals('smtp://sendmail', (string) $t);
     }
 }
diff --git a/Tests/Transport/Smtp/EsmtpTransportTest.php b/Tests/Transport/Smtp/EsmtpTransportTest.php
@@ -16,28 +16,28 @@
 
 class EsmtpTransportTest extends TestCase
 {
-    public function testName()
+    public function testToString()
     {
         $t = new EsmtpTransport();
-        $this->assertEquals('smtp://localhost', $t->getName());
+        $this->assertEquals('smtp://localhost', (string) $t);
 
         $t = new EsmtpTransport('example.com');
         if (\defined('OPENSSL_VERSION_NUMBER')) {
-            $this->assertEquals('smtps://example.com', $t->getName());
+            $this->assertEquals('smtps://example.com', (string) $t);
         } else {
-            $this->assertEquals('smtp://example.com', $t->getName());
+            $this->assertEquals('smtp://example.com', (string) $t);
         }
 
         $t = new EsmtpTransport('example.com', 2525);
-        $this->assertEquals('smtp://example.com:2525', $t->getName());
+        $this->assertEquals('smtp://example.com:2525', (string) $t);
 
         $t = new EsmtpTransport('example.com', 0, true);
-        $this->assertEquals('smtps://example.com', $t->getName());
+        $this->assertEquals('smtps://example.com', (string) $t);
 
         $t = new EsmtpTransport('example.com', 0, false);
-        $this->assertEquals('smtp://example.com', $t->getName());
+        $this->assertEquals('smtp://example.com', (string) $t);
 
         $t = new EsmtpTransport('example.com', 466, true);
-        $this->assertEquals('smtps://example.com:466', $t->getName());
+        $this->assertEquals('smtps://example.com:466', (string) $t);
     }
 }
diff --git a/Tests/Transport/Smtp/SmtpTransportTest.php b/Tests/Transport/Smtp/SmtpTransportTest.php
@@ -17,12 +17,12 @@
 
 class SmtpTransportTest extends TestCase
 {
-    public function testName()
+    public function testToString()
     {
         $t = new SmtpTransport();
-        $this->assertEquals('smtps://localhost', $t->getName());
+        $this->assertEquals('smtps://localhost', (string) $t);
 
         $t = new SmtpTransport((new SocketStream())->setHost('127.0.0.1')->setPort(2525)->disableTls());
-        $this->assertEquals('smtp://127.0.0.1:2525', $t->getName());
+        $this->assertEquals('smtp://127.0.0.1:2525', (string) $t);
     }
 }
diff --git a/Tests/TransportTest.php b/Tests/TransportTest.php
@@ -69,7 +69,7 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
         throw new \BadMethodCallException('This method newer should be called.');
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         return sprintf('dummy://local');
     }
diff --git a/Transport/AbstractTransport.php b/Transport/AbstractTransport.php
@@ -67,7 +67,7 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
             }
         }
 
-        $event = new MessageEvent($message, $envelope, $this->getName());
+        $event = new MessageEvent($message, $envelope, (string) $this);
         $this->dispatcher->dispatch($event);
         $envelope = $event->getEnvelope();
         if (!$envelope->getRecipients()) {
diff --git a/Transport/NullTransport.php b/Transport/NullTransport.php
@@ -24,7 +24,7 @@ protected function doSend(SentMessage $message): void
     {
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         return 'smtp://null';
     }
diff --git a/Transport/RoundRobinTransport.php b/Transport/RoundRobinTransport.php
@@ -56,10 +56,10 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
         throw new TransportException('All transports failed.');
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         return implode(' '.$this->getNameSymbol().' ', array_map(function (TransportInterface $transport) {
-            return $transport->getName();
+            return (string) $transport;
         }, $this->transports));
     }
 
diff --git a/Transport/SendmailTransport.php b/Transport/SendmailTransport.php
@@ -73,10 +73,10 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
         return parent::send($message, $envelope);
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         if ($this->transport) {
-            return $this->transport->getName();
+            return (string) $this->transport;
         }
 
         return 'smtp://sendmail';
diff --git a/Transport/Smtp/SmtpTransport.php b/Transport/Smtp/SmtpTransport.php
@@ -126,7 +126,7 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
         return $message;
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         if ($this->stream instanceof SocketStream) {
             $name = sprintf('smtp%s://%s', ($tls = $this->stream->isTLS()) ? 's' : '', $this->stream->getHost());
diff --git a/Transport/TransportInterface.php b/Transport/TransportInterface.php
@@ -31,5 +31,5 @@ interface TransportInterface
      */
     public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentMessage;
 
-    public function getName(): string;
+    public function __toString(): string;
 }

Original file line number	Diff line number	Diff line change
`@@ -24,14 +24,14 @@ final class MessageEvent extends Event`
`24`	`24`	`{`
`25`	`25`	`private $message;`
`26`	`26`	`private $envelope;`
`27`		`- private $transportName;`
	`27`	`+ private $transport;`
`28`	`28`	`private $queued;`
`29`	`29`
`30`		`- public function __construct(RawMessage $message, SmtpEnvelope $envelope, string $transportName, bool $queued = false)`
	`30`	`+ public function __construct(RawMessage $message, SmtpEnvelope $envelope, string $transport, bool $queued = false)`
`31`	`31`	`{`
`32`	`32`	`$this->message = $message;`
`33`	`33`	`$this->envelope = $envelope;`
`34`		`- $this->transportName = $transportName;`
	`34`	`+ $this->transport = $transport;`
`35`	`35`	`$this->queued = $queued;`
`36`	`36`	`}`
`37`	`37`
`@@ -55,9 +55,9 @@ public function setEnvelope(SmtpEnvelope $envelope): void`
`55`	`55`	`$this->envelope = $envelope;`
`56`	`56`	`}`
`57`	`57`
`58`		`- public function getTransportName(): string`
	`58`	`+ public function getTransport(): string`
`59`	`59`	`{`
`60`		`- return $this->transportName;`
	`60`	`+ return $this->transport;`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`public function isQueued(): bool`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class MessageEvents`
`24`	`24`	`public function add(MessageEvent $event): void`
`25`	`25`	`{`
`26`	`26`	`$this->events[] = $event;`
`27`		`- $this->transports[$event->getTransportName()] = true;`
	`27`	`+ $this->transports[$event->getTransport()] = true;`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`public function getTransports(): array`
`@@ -43,7 +43,7 @@ public function getEvents(string $name = null): array`
`43`	`43`
`44`	`44`	`$events = [];`
`45`	`45`	`foreach ($this->events as $event) {`
`46`		`- if ($name === $event->getTransportName()) {`
	`46`	`+ if ($name === $event->getTransport()) {`
`47`	`47`	`$events[] = $event;`
`48`	`48`	`}`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): void`
`54`	`54`	`throw new TransportException('Cannot send message without a valid envelope.', 0, $e);`
`55`	`55`	`}`
`56`	`56`	`}`
`57`		`- $event = new MessageEvent($message, $envelope, $this->transport->getName(), true);`
	`57`	`+ $event = new MessageEvent($message, $envelope, (string) $this->transport, true);`
`58`	`58`	`$this->dispatcher->dispatch($event);`
`59`	`59`	`}`
`60`	`60`
Original file line number	Diff line number	Diff line change
`@@ -70,7 +70,7 @@ public function testCreate(Dsn $dsn, TransportInterface $transport): void`
`70`	`70`
`71`	`71`	`$this->assertEquals($transport, $factory->create($dsn));`
`72`	`72`	`if ('smtp' !== $dsn->getScheme() && 'smtps' !== $dsn->getScheme()) {`
`73`		`- $this->assertStringMatchesFormat($dsn->getScheme().'://%S'.$dsn->getHost().'%S', $transport->getName());`
	`73`	`+ $this->assertStringMatchesFormat($dsn->getScheme().'://%S'.$dsn->getHost().'%S', (string) $transport);`
`74`	`74`	`}`
`75`	`75`	`}`
`76`	`76`
Original file line number	Diff line number	Diff line change
`@@ -29,14 +29,14 @@ public function testSendNoTransports()`
`29`	`29`	`new FailoverTransport([]);`
`30`	`30`	`}`
`31`	`31`
`32`		`- public function testGetName()`
	`32`	`+ public function testToString()`
`33`	`33`	`{`
`34`	`34`	`$t1 = $this->createMock(TransportInterface::class);`
`35`		`- $t1->expects($this->once())->method('getName')->willReturn('t1://local');`
	`35`	`+ $t1->expects($this->once())->method('__toString')->willReturn('t1://local');`
`36`	`36`	`$t2 = $this->createMock(TransportInterface::class);`
`37`		`- $t2->expects($this->once())->method('getName')->willReturn('t2://local');`
	`37`	`+ $t2->expects($this->once())->method('__toString')->willReturn('t2://local');`
`38`	`38`	`$t = new FailoverTransport([$t1, $t2]);`
`39`		`- $this->assertEquals('t1://local \|\| t2://local', $t->getName());`
	`39`	`+ $this->assertEquals('t1://local \|\| t2://local', (string) $t);`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`public function testSendFirstWork()`
Original file line number	Diff line number	Diff line change
`@@ -16,9 +16,9 @@`
`16`	`16`
`17`	`17`	`class NullTransportTest extends TestCase`
`18`	`18`	`{`
`19`		`- public function testName()`
	`19`	`+ public function testToString()`
`20`	`20`	`{`
`21`	`21`	`$t = new NullTransport();`
`22`		`- $this->assertEquals('smtp://null', $t->getName());`
	`22`	`+ $this->assertEquals('smtp://null', (string) $t);`
`23`	`23`	`}`
`24`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,14 +28,14 @@ public function testSendNoTransports()`
`28`	`28`	`new RoundRobinTransport([]);`
`29`	`29`	`}`
`30`	`30`
`31`		`- public function testGetName()`
	`31`	`+ public function testToString()`
`32`	`32`	`{`
`33`	`33`	`$t1 = $this->createMock(TransportInterface::class);`
`34`		`- $t1->expects($this->once())->method('getName')->willReturn('t1://local');`
	`34`	`+ $t1->expects($this->once())->method('__toString')->willReturn('t1://local');`
`35`	`35`	`$t2 = $this->createMock(TransportInterface::class);`
`36`		`- $t2->expects($this->once())->method('getName')->willReturn('t2://local');`
	`36`	`+ $t2->expects($this->once())->method('__toString')->willReturn('t2://local');`
`37`	`37`	`$t = new RoundRobinTransport([$t1, $t2]);`
`38`		`- $this->assertEquals('t1://local && t2://local', $t->getName());`
	`38`	`+ $this->assertEquals('t1://local && t2://local', (string) $t);`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`public function testSendAlternate()`