Merge pull request #62 from DirectoryTree/fakes

Fakes

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/MessageQuery.php

@@ -22,49 +22,9 @@
 /**
  * @mixin \DirectoryTree\ImapEngine\Connection\ImapQueryBuilder
  */
-class MessageQuery
+class MessageQuery implements MessageQueryInterface
 {
-    use Conditionable, ForwardsCalls;
-
-    /**
-     * The current page.
-     */
-    protected int $page = 1;
-
-    /**
-     * The fetch limit.
-     */
-    protected ?int $limit = null;
-
-    /**
-     * Whether to fetch the message body.
-     */
-    protected bool $fetchBody = false;
-
-    /**
-     * Whether to fetch the message flags.
-     */
-    protected bool $fetchFlags = false;
-
-    /**
-     * Whether to fetch the message headers.
-     */
-    protected bool $fetchHeaders = false;
-
-    /**
-     * The fetch order.
-     */
-    protected string $fetchOrder = 'desc';
-
-    /**
-     * Whether to leave messages fetched as unread by default.
-     */
-    protected bool $fetchAsUnread = true;
-
-    /**
-     * The methods that should be returned from query builder.
-     */
-    protected array $passthru = ['toimap', 'isempty'];
+    use Conditionable, ForwardsCalls, QueriesMessages;
 
     /**
      * Constructor.
@@ -74,230 +34,6 @@ public function __construct(
         protected ImapQueryBuilder $query,
     ) {}
 
-    /**
-     * Handle dynamic method calls into the query builder.
-     */
-    public function __call(string $method, array $parameters): mixed
-    {
-        if (in_array(strtolower($method), $this->passthru)) {
-            return $this->query->{$method}(...$parameters);
-        }
-
-        $this->forwardCallTo($this->query, $method, $parameters);
-
-        return $this;
-    }
-
-    /**
-     * Don't mark messages as read when fetching.
-     */
-    public function leaveUnread(): static
-    {
-        $this->fetchAsUnread = true;
-
-        return $this;
-    }
-
-    /**
-     * Mark all messages as read when fetching.
-     */
-    public function markAsRead(): static
-    {
-        $this->fetchAsUnread = false;
-
-        return $this;
-    }
-
-    /**
-     * Set the limit and page for the current query.
-     */
-    public function limit(int $limit, int $page = 1): static
-    {
-        if ($page >= 1) {
-            $this->page = $page;
-        }
-
-        $this->limit = $limit;
-
-        return $this;
-    }
-
-    /**
-     * Get the set fetch limit.
-     */
-    public function getLimit(): ?int
-    {
-        return $this->limit;
-    }
-
-    /**
-     * Set the fetch limit.
-     */
-    public function setLimit(int $limit): static
-    {
-        $this->limit = max($limit, 1);
-
-        return $this;
-    }
-
-    /**
-     * Get the set page.
-     */
-    public function getPage(): int
-    {
-        return $this->page;
-    }
-
-    /**
-     * Set the page.
-     */
-    public function setPage(int $page): static
-    {
-        $this->page = $page;
-
-        return $this;
-    }
-
-    /**
-     * Determine if the body of messages is being fetched.
-     */
-    public function isFetchingBody(): bool
-    {
-        return $this->fetchBody;
-    }
-
-    /**
-     * Determine if the flags of messages is being fetched.
-     */
-    public function isFetchingFlags(): bool
-    {
-        return $this->fetchFlags;
-    }
-
-    /**
-     * Determine if the headers of messages is being fetched.
-     */
-    public function isFetchingHeaders(): bool
-    {
-        return $this->fetchHeaders;
-    }
-
-    /**
-     * Fetch the body of messages.
-     */
-    public function withFlags(): static
-    {
-        return $this->setFetchFlags(true);
-    }
-
-    /**
-     * Fetch the body of messages.
-     */
-    public function withBody(): static
-    {
-        return $this->setFetchBody(true);
-    }
-
-    /**
-     * Fetch the body of messages.
-     */
-    public function withHeaders(): static
-    {
-        return $this->setFetchHeaders(true);
-    }
-
-    /**
-     * Don't fetch the body of messages.
-     */
-    public function withoutBody(): static
-    {
-        return $this->setFetchBody(false);
-    }
-
-    /**
-     * Don't fetch the body of messages.
-     */
-    public function withoutHeaders(): static
-    {
-        return $this->setFetchHeaders(false);
-    }
-
-    /**
-     * Don't fetch the body of messages.
-     */
-    public function withoutFlags(): static
-    {
-        return $this->setFetchFlags(false);
-    }
-
-    /**
-     * Set whether to fetch the flags.
-     */
-    protected function setFetchFlags(bool $fetchFlags): static
-    {
-        $this->fetchFlags = $fetchFlags;
-
-        return $this;
-    }
-
-    /**
-     * Set the fetch body flag.
-     */
-    protected function setFetchBody(bool $fetchBody): static
-    {
-        $this->fetchBody = $fetchBody;
-
-        return $this;
-    }
-
-    /**
-     * Set whether to fetch the headers.
-     */
-    protected function setFetchHeaders(bool $fetchHeaders): static
-    {
-        $this->fetchHeaders = $fetchHeaders;
-
-        return $this;
-    }
-
-    /**
-     * Set the fetch order.
-     */
-    public function setFetchOrder(string $fetchOrder): static
-    {
-        $fetchOrder = strtolower($fetchOrder);
-
-        if (in_array($fetchOrder, ['asc', 'desc'])) {
-            $this->fetchOrder = $fetchOrder;
-        }
-
-        return $this;
-    }
-
-    /**
-     * Get the fetch order.
-     */
-    public function getFetchOrder(): string
-    {
-        return $this->fetchOrder;
-    }
-
-    /**
-     * Set the fetch order to 'ascending'.
-     */
-    public function setFetchOrderAsc(): static
-    {
-        return $this->setFetchOrder('asc');
-    }
-
-    /**
-     * Set the fetch order to 'descending'.
-     */
-    public function setFetchOrderDesc(): static
-    {
-        return $this->setFetchOrder('desc');
-    }
-
     /**
      * Execute an IMAP search request.
      */
@@ -518,7 +254,7 @@ public function paginate(int $perPage = 5, $page = null, string $pageName = 'pag
     /**
      * Find a message by the given identifier type or throw an exception.
      */
-    public function findOrFail(int $id, ImapFetchIdentifier $identifier = ImapFetchIdentifier::Uid)
+    public function findOrFail(int $id, ImapFetchIdentifier $identifier = ImapFetchIdentifier::Uid): MessageInterface
     {
         /** @var UntaggedResponse $response */
         $response = $this->uid($id, $identifier)->firstOrFail();