Merge pull request #22 from tattersoftware/test

Test

Author: MGatner

README.md

@@ -1,8 +1,9 @@
 # Tatter\Outbox
 Email toolkit for CodeIgniter 4
 
-[![](https://github.com/tattersoftware/codeigniter4-outbox/workflows/PHPUnit/badge.svg)](https://github.com/tattersoftware/codeigniter4-outbox/actions?query=workflow%3A%22PHPUnit)
-[![](https://github.com/tattersoftware/codeigniter4-outbox/workflows/PHPStan/badge.svg)](https://github.com/tattersoftware/codeigniter4-outbox/actions?query=workflow%3A%22PHPStan)
+[![](https://github.com/tattersoftware/codeigniter4-outbox/workflows/PHPUnit/badge.svg)](https://github.com/tattersoftware/codeigniter4-outbox/actions/workflows/test.yml)
+[![](https://github.com/tattersoftware/codeigniter4-outbox/workflows/PHPStan/badge.svg)](https://github.com/tattersoftware/codeigniter4-outbox/actions/workflows/analyze.yml)
+[![](https://github.com/tattersoftware/codeigniter4-outbox/workflows/Deptrac/badge.svg)](https://github.com/tattersoftware/codeigniter4-outbox/actions/workflows/inspect.yml)
 [![Coverage Status](https://coveralls.io/repos/github/tattersoftware/codeigniter4-outbox/badge.svg?branch=develop)](https://coveralls.io/github/tattersoftware/codeigniter4-outbox?branch=develop)
 
 ## Quick Start
@@ -21,17 +22,32 @@ model(TemplateModel::class)->findByName('Default')
 	->send();
 ```
 
-## Description
+## Features
 
-**Outbox** supplies a handful of useful tools to supplement the framework's native `Email`
-class.
+**Outbox** supplies useful tools to supplement the framework's native `Email` class:
+logging, style inlining, and templating.
+
+## Installation
+
+Install easily via Composer to take advantage of CodeIgniter 4's autoloading capabilities
+and always be up-to-date:
+```bash
+composer require tatter/outbox
+```
+
+Or, install manually by downloading the source files and adding the directory to
+**app/Config/Autoload.php**.
 
 ## Configuration (optional)
 
 The library's default behavior can be altered by extending its config file. Copy
 **examples/Outbox.php** to **app/Config/** and follow the instructions
 in the comments. If no config file is found in **app/Config** then the library will use its own.
 
+If you plan to use the Template Routes (see below) you should also want to configure
+[Tatter\Layouts](https://github.com/tattersoftware/codeigniter4-layouts) to ensure the
+views are displayed properly for your app.
+
 ## Usage
 
 ### Logging

composer.json

@@ -27,7 +27,6 @@
     },
     "require-dev": {
         "codeigniter4/codeigniter4": "dev-develop",
-        "tatter/imposter": "^1.0",
         "tatter/tools": "^1.15"
     },
     "autoload": {

src/Entities/Email.php

@@ -3,6 +3,7 @@
 namespace Tatter\Outbox\Entities;
 
 use CodeIgniter\Entity\Entity;
+use RuntimeException;
 
 class Email extends Entity
 {
@@ -58,11 +59,13 @@ public function getRecipients(): array
      * Helper function to return attachments or recipients.
      *
      * @param string $target Object/table/model to request
+     *
+     * @throws RuntimeException
      */
     protected function getRelatedItems(string $target): array
     {
         if (empty($this->id)) {
-            throw new \RuntimeException('Object must be created before getting relations.');
+            throw new RuntimeException('Object must be created before getting relations.');
         }
 
         $property = $target . 's';

tests/entities/EmailTest.php

@@ -57,4 +57,14 @@ public function testGetRecipients()
         $this->assertInstanceOf(Recipient::class, $result[0]);
         $this->assertSame('[email protected]', $result[0]->email);
     }
+
+    public function testGetRelatedUncreatedThrows()
+    {
+        $email = new Email();
+
+        $this->expectException('RuntimeException');
+        $this->expectExceptionMessage('Object must be created before getting relations.');
+
+        $email->getRecipients();
+    }
 }