WIP

Author: stevebauman

src/FolderInterface.php

@@ -39,7 +39,7 @@ public function is(FolderInterface $folder): bool;
     /**
      * Begin querying for messages.
      */
-    public function messages(): MessageQuery;
+    public function messages(): MessageQueryInterface;
 
     /**
      * Begin idling on the current folder.

src/FolderRepository.php

@@ -17,35 +17,35 @@ public function __construct(
     /**
      * {@inheritDoc}
      */
-    public function find(string $folder): ?FolderInterface
+    public function find(string $path): ?FolderInterface
     {
-        return $this->get($folder)->first();
+        return $this->get($path)->first();
     }
 
     /**
      * {@inheritDoc}
      */
-    public function findOrFail(string $folder): FolderInterface
+    public function findOrFail(string $path): FolderInterface
     {
-        return $this->get($folder)->firstOrFail();
+        return $this->get($path)->firstOrFail();
     }
 
     /**
      * {@inheritDoc}
      */
-    public function create(string $folder): FolderInterface
+    public function create(string $path): FolderInterface
     {
-        $this->mailbox->connection()->create($folder);
+        $this->mailbox->connection()->create($path);
 
-        return $this->find($folder);
+        return $this->find($path);
     }
 
     /**
      * {@inheritDoc}
      */
-    public function firstOrCreate(string $folder): FolderInterface
+    public function firstOrCreate(string $path): FolderInterface
     {
-        return $this->find($folder) ?? $this->create($folder);
+        return $this->find($path) ?? $this->create($path);
     }
 
     /**

src/FolderRepositoryInterface.php

@@ -9,22 +9,22 @@ interface FolderRepositoryInterface
     /**
      * Find a folder.
      */
-    public function find(string $folder): ?FolderInterface;
+    public function find(string $path): ?FolderInterface;
 
     /**
      * Find a folder or throw an exception.
      */
-    public function findOrFail(string $folder): FolderInterface;
+    public function findOrFail(string $path): FolderInterface;
 
     /**
      * Create a new folder.
      */
-    public function create(string $folder): FolderInterface;
+    public function create(string $path): FolderInterface;
 
     /**
      * Find or create a folder.
      */
-    public function firstOrCreate(string $folder): FolderInterface;
+    public function firstOrCreate(string $path): FolderInterface;
 
     /**
      * Get the mailboxes folders.

src/Support/Str.php

@@ -199,4 +199,41 @@ public static function decodeUtf7Imap(string $string): string
             return $result;
         }, $string);
     }
+
+    public static function is($pattern, $value, $ignoreCase = false)
+    {
+        $value = (string) $value;
+
+        if (! is_iterable($pattern)) {
+            $pattern = [$pattern];
+        }
+
+        foreach ($pattern as $pattern) {
+            $pattern = (string) $pattern;
+
+            // If the given value is an exact match we can of course return true right
+            // from the beginning. Otherwise, we will translate asterisks and do an
+            // actual pattern match against the two strings to see if they match.
+            if ($pattern === '*' || $pattern === $value) {
+                return true;
+            }
+
+            if ($ignoreCase && mb_strtolower($pattern) === mb_strtolower($value)) {
+                return true;
+            }
+
+            $pattern = preg_quote($pattern, '#');
+
+            // Asterisks are translated into zero-or-more regular expression wildcards
+            // to make it convenient to check if the strings starts with the given
+            // pattern such as "library/*", making any string check convenient.
+            $pattern = str_replace('\*', '.*', $pattern);
+
+            if (preg_match('#^'.$pattern.'\z#'.($ignoreCase ? 'isu' : 'su'), $value) === 1) {
+                return true;
+            }
+        }
+
+        return false;
+    }
 }

src/Testing/FakeFolder.php

@@ -5,7 +5,7 @@
 use DirectoryTree\ImapEngine\Exceptions\Exception;
 use DirectoryTree\ImapEngine\FolderInterface;
 use DirectoryTree\ImapEngine\MailboxInterface;
-use DirectoryTree\ImapEngine\MessageQuery;
+use DirectoryTree\ImapEngine\MessageQueryInterface;
 use DirectoryTree\ImapEngine\Support\Str;
 
 class FakeFolder implements FolderInterface
@@ -77,7 +77,7 @@ public function is(FolderInterface $folder): bool
     /**
      * {@inheritDoc}
      */
-    public function messages(): MessageQuery
+    public function messages(): MessageQueryInterface
     {
         // Ensure the folder is selected.
         $this->select(true);

src/Testing/FakeFolderRepository.php

@@ -6,7 +6,7 @@
 use DirectoryTree\ImapEngine\FolderInterface;
 use DirectoryTree\ImapEngine\FolderRepositoryInterface;
 use DirectoryTree\ImapEngine\MailboxInterface;
-use Illuminate\Support\ItemNotFoundException;
+use DirectoryTree\ImapEngine\Support\Str;
 
 class FakeFolderRepository implements FolderRepositoryInterface
 {
@@ -22,48 +22,46 @@ public function __construct(
     /**
      * {@inheritDoc}
      */
-    public function find(string $folder): ?FolderInterface
+    public function find(string $path): ?FolderInterface
     {
-        return $this->folders[$folder] ?? null;
+        return $this->get()->first(
+            fn (FolderInterface $folder) => $folder->path() === $path
+        );
     }
 
     /**
      * {@inheritDoc}
      */
-    public function findOrFail(string $folder): FolderInterface
+    public function findOrFail(string $path): FolderInterface
     {
-        return $this->folders[$folder] ?? throw new ItemNotFoundException("Folder [{$folder}] not found.");
+        return $this->get()->firstOrFail(
+            fn (FolderInterface $folder) => $folder->path() === $path
+        );
     }
 
     /**
      * {@inheritDoc}
      */
-    public function create(string $folder): FolderInterface
+    public function create(string $path): FolderInterface
     {
-        return $this->folders[$folder] = new FakeFolder($folder, mailbox: $this->mailbox);
+        return $this->folders[] = new FakeFolder($path, mailbox: $this->mailbox);
     }
 
     /**
      * {@inheritDoc}
      */
-    public function firstOrCreate(string $folder): FolderInterface
+    public function firstOrCreate(string $path): FolderInterface
     {
-        return $this->find($folder) ?? $this->create($folder);
+        return $this->find($path) ?? $this->create($path);
     }
 
     /**
      * {@inheritDoc}
      */
     public function get(?string $match = '*', ?string $reference = ''): FolderCollection
     {
-        $pattern = str_replace(
-            ['*', '%'],
-            ['.*', '[^/]*'],
-            preg_quote($match, '/'),
-        );
-
         return FolderCollection::make($this->folders)->filter(
-            fn (FolderInterface $folder) => (bool) preg_match('/^'.$pattern.'$/', $folder->path())
+            fn (FolderInterface $folder) => Str::is($match, $folder->path())
         );
     }
 }

src/Testing/FakeMailbox.php

@@ -15,11 +15,6 @@ class FakeMailbox implements MailboxInterface
      */
     protected ?FolderInterface $selected = null;
 
-    /**
-     * The next available message UID.
-     */
-    protected static int $nextMessageUid = 1;
-
     /**
      * Constructor.
      */
@@ -125,12 +120,4 @@ public function selected(FolderInterface $folder): bool
     {
         return $this->selected?->is($folder) ?? false;
     }
-
-    /**
-     * Get the next available UID and increment the counter.
-     */
-    public function getNextUid(): int
-    {
-        return static::$nextMessageUid++;
-    }
 }

src/Testing/FakeMessageQuery.php

@@ -62,11 +62,11 @@ public function append(string $message, mixed $flags = null): int
     {
         $uid = 1;
 
-        if ($message = $this->get()->last()) {
-            $uid = $message->uid() + 1;
+        if ($lastMessage = $this->get()->last()) {
+            $uid = $lastMessage->uid() + 1;
         }
 
-        $this->messages[] = new FakeMessage($uid, $flags, $message);
+        $this->messages[] = new FakeMessage($uid, $flags === null ? [] : $flags, $message);
 
         return $uid;
     }
@@ -116,6 +116,14 @@ public function find(int $id, ImapFetchIdentifier $identifier = ImapFetchIdentif
      */
     public function destroy(array|int $uids, bool $expunge = false): void
     {
-        // Do nothing.
+        $messages = $this->get()->keyBy(
+            fn (MessageInterface $message) => $message->uid()
+        );
+
+        foreach ((array) $uids as $uid) {
+            $messages->pull($uid);
+        }
+
+        $this->messages = $messages->values()->all();
     }
 }