Merge pull request #6 from tattersoftware/find-by-name

Add Templates findByName

Author: MGatner

phpstan.neon.dist

@@ -11,6 +11,7 @@ parameters:
 		- src/Views/*
 	ignoreErrors:
 		- '#Cannot access property [\$a-z_]+ on (array|object)#'
+		- '#Unsafe usage of new static\(\)#'
 	universalObjectCratesClasses:
 		- CodeIgniter\Entity
 		- Faker\Generator

src/Exceptions/TemplatesException.php

@@ -0,0 +1,9 @@
+<?php namespace Tatter\Outbox\Exceptions;
+
+class TemplatesException extends \RuntimeException
+{
+	public static function forMissingTemplate(string $name)
+	{
+		return new static(lang('Templates.missingTemplate', [$name]));
+	}
+}

src/Language/en/Templates.php

@@ -0,0 +1,5 @@
+<?php
+
+return [
+	'missingTemplate' => 'Unable to find the email template "{0}".',
+];

src/Models/TemplateModel.php

@@ -2,6 +2,7 @@
 
 use CodeIgniter\Model;
 use Tatter\Outbox\Entities\Template;
+use Tatter\Outbox\Exceptions\TemplatesException;
 
 class TemplateModel extends Model
 {
@@ -16,4 +17,23 @@ class TemplateModel extends Model
 	protected $allowedFields = [
 		'name', 'subject', 'body', 'tokens', 'parent_id',
 	];
+
+	/**
+	 * Returns a Template by its name, throws if not found.
+	 *
+	 * @param string $name
+	 *
+	 * @return Template
+	 *
+	 * @throws TemplatesException
+	 */
+	public function findByName(string $name): Template
+    {
+    	if ($template = $this->where('name', $name)->first())
+    	{
+    		return $template;
+    	}
+
+		throw TemplatesException::forMissingTemplate($name);
+    }
 }

tests/templates/ParentTest.php

@@ -1,6 +1,5 @@
 <?php
 
-use CodeIgniter\Test\CIUnitTestCase;
 use CodeIgniter\Test\DOMParser;
 use Tatter\Outbox\Entities\Template;
 use Tatter\Outbox\Models\TemplateModel;

tests/templates/TemplateModelTest.php

@@ -0,0 +1,43 @@
+<?php
+
+use Tatter\Outbox\Entities\Template;
+use Tatter\Outbox\Exceptions\TemplatesException;
+use Tatter\Outbox\Models\TemplateModel;
+use Tests\Support\DatabaseTestCase;
+
+class TemplateModelTest extends DatabaseTestCase
+{
+	/**
+	 * @var Template
+	 */
+	protected $template;
+
+	public function setUp(): void
+	{
+		parent::setUp();
+
+		$this->template = new Template([
+			'name'      => 'Test Template',
+			'subject'   => 'Some {subject}',
+			'body'      => '<p>{number}</p>',
+			'tokens'    => ['subject', 'number', 'foobar'],
+		]);
+		$this->template->id = model(TemplateModel::class)->insert($this->template);
+	}
+
+	public function testFindByName()
+	{
+		$result = model(TemplateModel::class)->findByName($this->template->name);
+
+		$this->assertInstanceOf(Template::class, $result);
+		$this->assertEquals($this->template->id, $result->id);
+	}
+
+	public function testFindByNameThrowsOnFailure()
+	{
+		$this->expectException(TemplatesException::class);
+		$this->expectExceptionMessage(lang('Templates.missingTemplate', ['foobar']));
+
+		model(TemplateModel::class)->findByName('foobar');
+	}
+}