From 330d6f939303b32a1b7e87d3cd3651ae5d7b930b Mon Sep 17 00:00:00 2001
From: Oliver Davies <oliver@oliverdavies.uk>
Date: Thu, 9 Jul 2020 20:15:30 +0100
Subject: [PATCH] Add a filter() helper method

Add a namespaced `filter()` method that can be imported via `use
function` and use it as an alternative for `new Filter` or
`Filter::create()`.

This provides a cleaner, easier to read syntax - particularly if you
have a lot of filters in the same file.
---
 composer.json              |  1 +
 src/Helpers.php            | 12 ++++++++++++
 tests/Unit/HelpersTest.php | 17 +++++++++++++++++
 3 files changed, 30 insertions(+)
 create mode 100644 src/Helpers.php
 create mode 100644 tests/Unit/HelpersTest.php

diff --git a/composer.json b/composer.json
index 7e1ca42..aa860a4 100644
--- a/composer.json
+++ b/composer.json
@@ -23,6 +23,7 @@
         "symfony/var-dumper": "^3.4"
     },
     "autoload": {
+        "files": ["src/Helpers.php"],
         "psr-4": {
             "Opdavies\\GmailFilterBuilder\\": "src/"
         }
diff --git a/src/Helpers.php b/src/Helpers.php
new file mode 100644
index 0000000..fb6b658
--- /dev/null
+++ b/src/Helpers.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Opdavies\GmailFilterBuilder;
+
+use Opdavies\GmailFilterBuilder\Model\Filter;
+
+function filter(): Filter
+{
+    return new Filter();
+}
diff --git a/tests/Unit/HelpersTest.php b/tests/Unit/HelpersTest.php
new file mode 100644
index 0000000..020c700
--- /dev/null
+++ b/tests/Unit/HelpersTest.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+use PHPUnit\Framework\TestCase;
+
+use Opdavies\GmailFilterBuilder\Model\Filter as FilterClass;
+use function Opdavies\GmailFilterBuilder\filter;
+
+final class HelpersTest extends TestCase
+{
+    /** @test */
+    public function it_returns_a_filter_object(): void
+    {
+        $this->assertEquals(new FilterClass(), filter());
+    }
+}