add readable string method to address

genkgo · Nov 23, 2017 · 95aa894 · 95aa894
1 parent 05dea08
commit 95aa894
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 0 deletions.
diff --git a/src/Address.php b/src/Address.php
@@ -99,6 +99,23 @@ public function __toString(): string
         return sprintf('%s <%s>', $encodedName, $this->address->getPunyCode());
     }
 
+    /**
+     * @return string
+     */
+    public function toReadableString(): string
+    {
+        if ($this->name === '') {
+            return (string)$this->address;
+        }
+
+        $encodedName = $this->name;
+        if ($encodedName !== $this->name || preg_match('/[^A-Za-z0-9!#$%&\'*+\/=?^_`{|}~ -]/', $this->name) === 1) {
+            $encodedName = sprintf('"%s"', $encodedName);
+        }
+
+        return sprintf('%s <%s>', $encodedName, $this->address->getAddress());
+    }
+
     /**
      * @param string $addressAsString
      * @return Address

diff --git a/test/Unit/AddressTest.php b/test/Unit/AddressTest.php
@@ -103,6 +103,22 @@ public function it_parses_address_strings(string $addressString, bool $construct
         }
     }
 
+    /**
+     * @test
+     * @dataProvider provideAddressStrings
+     */
+    public function it_can_be_converted_to_readable_string()
+    {
+        $address = new Address(new EmailAddress('local-part@münchen.com'), 'sprode, henriëtte');
+        $this->assertEquals('"sprode, henriëtte" <local-part@münchen.com>', $address->toReadableString());
+
+        $address = new Address(new EmailAddress('local-part@münchen.com'), 'Frederik');
+        $this->assertEquals('Frederik <local-part@münchen.com>', $address->toReadableString());
+
+        $address = new Address(new EmailAddress('local-part@münchen.com'));
+        $this->assertEquals('local-part@münchen.com', $address->toReadableString());
+    }
+
     /**
      * @return array
      */