Use trait to unify folder comparison logic

Author: stevebauman

src/ComparesFolders.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace DirectoryTree\ImapEngine;
+
+trait ComparesFolders
+{
+    /**
+     * Determine if two folders are the same.
+     */
+    protected function isSameFolder(FolderInterface $a, FolderInterface $b): bool
+    {
+        return $a->path() === $b->path()
+            && $a->mailbox()->config('host') === $b->mailbox()->config('host')
+            && $a->mailbox()->config('username') === $b->mailbox()->config('username');
+    }
+}

src/Folder.php

@@ -14,6 +14,8 @@
 
 class Folder implements Arrayable, FolderInterface, JsonSerializable
 {
+    use ComparesFolders;
+
     /**
      * Constructor.
      */
@@ -73,9 +75,7 @@ public function name(): string
      */
     public function is(FolderInterface $folder): bool
     {
-        return $this->path === $folder->path()
-            && $this->mailbox->config('host') === $folder->mailbox()->config('host')
-            && $this->mailbox->config('username') === $folder->mailbox()->config('username');
+        return $this->isSameFolder($this, $folder);
     }
 
     /**

src/Testing/FakeFolder.php

@@ -2,6 +2,7 @@
 
 namespace DirectoryTree\ImapEngine\Testing;
 
+use DirectoryTree\ImapEngine\ComparesFolders;
 use DirectoryTree\ImapEngine\Exceptions\Exception;
 use DirectoryTree\ImapEngine\FolderInterface;
 use DirectoryTree\ImapEngine\MailboxInterface;
@@ -10,6 +11,8 @@
 
 class FakeFolder implements FolderInterface
 {
+    use ComparesFolders;
+
     /**
      * Constructor.
      */
@@ -69,9 +72,7 @@ public function name(): string
      */
     public function is(FolderInterface $folder): bool
     {
-        return $this->path === $folder->path()
-            && $this->mailbox->config('host') === $folder->mailbox()->config('host')
-            && $this->mailbox->config('username') === $folder->mailbox()->config('username');
+        return $this->isSameFolder($this, $folder);
     }
 
     /**
@@ -173,6 +174,8 @@ public function setMailbox(MailboxInterface $mailbox): FakeFolder
 
     /**
      * Set the folder's messages.
+     *
+     * @param  FakeMessage[]  $messages
      */
     public function setMessages(array $messages): FakeFolder
     {
@@ -181,6 +184,24 @@ public function setMessages(array $messages): FakeFolder
         return $this;
     }
 
+    /**
+     * Get the folder's messages.
+     *
+     * @return FakeMessage[]
+     */
+    public function getMessages(): array
+    {
+        return $this->messages;
+    }
+
+    /**
+     * Add a message to the folder.
+     */
+    public function addMessage(FakeMessage $message): void
+    {
+        $this->messages[] = $message;
+    }
+
     /**
      * Set the folder's delimiter.
      */