opdavies/gmail-filter-builder
1
0
Fork 0
mirror of https://github.com/opdavies/gmail-filter-builder.git synced 2025-02-13 04:36:57 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add filter conditions using a class

Browse source
This commit is contained in:
Oliver Davies 2019-05-03 21:02:13 +01:00
parent 22b696d47c
commit 5d5d5118ef
3 changed files with 146 additions and 78 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
src/Model/Filter.php
View file

@ -2,6 +2,8 @@
namespace Opdavies\GmailFilterBuilder\Model;
use Tightenco\Collect\Support\Collection;
class Filter
{
/** @var string */
@ -12,6 +14,13 @@ class Filter
*/
private $properties = [];
private $conditions;
public function __construct()
{
$this->conditions = collect();
}
/**
* @return static
*/
@ -27,7 +36,7 @@ class Filter
*/
public function has(string $value): self
{
$this->properties['hasTheWord'] = $value;
$this->conditions->push(new FilterCondition('hasTheWord', $value));
return $this;
}
@ -39,7 +48,7 @@ class Filter
*/
public function hasNot(string $value): self
{
$this->properties['doesNotHaveTheWord'] = $value;
$this->conditions->push(new FilterCondition('doesNotHaveTheWord', $value));
return $this;
}
@ -51,11 +60,7 @@ class Filter
*/
public function from($values): self
{
if (!empty($values)) {
$this->properties['from'] = collect($values)->map(function ($value) {
return trim($value);
})->all();
}
$this->conditions->push(new FilterCondition('from', $values));
return $this;
}
@ -67,11 +72,7 @@ class Filter
*/
public function to($values): self
{
if (!empty($values)) {
$this->properties['to'] = collect($values)->map(function ($value) {
return trim($value);
})->all();
}
$this->conditions->push(new FilterCondition('to', $values));
return $this;
}
@ -83,9 +84,10 @@ class Filter
*/
public function subject($values): self
{
$this->properties['subject'] = collect($values)->map(function ($value) {
return json_encode($value);
})->implode('|');
$this->conditions->push(new FilterCondition(
'subject',
collect($values)->map('json_encode')
));
return $this;
}
@ -95,7 +97,7 @@ class Filter
*/
public function hasAttachment(): self
{
$this->properties['hasAttachment'] = 'true';
$this->conditions->push(new FilterCondition('hasAttachment', 'true'));
return $this;
}
@ -109,7 +111,6 @@ class Filter
*/
public function fromList($value): self
{
$value = collect($value)->implode(self::SEPARATOR);
$this->has("list:{$value}");
return $this;
@ -120,7 +121,7 @@ class Filter
*/
public function excludeChats(): self
{
$this->properties['excludeChats'] = 'true';
$this->conditions->push(new FilterCondition('excludeChats', 'true'));
return $this;
}
@ -275,4 +276,9 @@ class Filter
{
return $this->properties;
}
public function getConditions(): Collection
{
return $this->conditions;
}
}

30
src/Model/FilterCondition.php Normal file
View file

@ -0,0 +1,30 @@
<?php
namespace Opdavies\GmailFilterBuilder\Model;
use Tightenco\Collect\Support\Collection;
class FilterCondition
{
/** @var string */
private $property;
/** @var Collection */
private $values;
public function __construct(string $property, $values)
{
$this->property = $property;
$this->values = collect($values);
}
public function getProperty(): string
{
return $this->property;
}
public function getValues(): Collection
{
return $this->values;
}
}

152
tests/Unit/Model/FilterTest.php
View file

@ -3,6 +3,7 @@
namespace Opdavies\Tests\GmailFilterBuilder\Model;
use Opdavies\GmailFilterBuilder\Model\Filter;
use Opdavies\GmailFilterBuilder\Model\FilterCondition;
use PHPUnit\Framework\TestCase;
/**
@ -31,10 +32,13 @@ class FilterTest extends TestCase
*/
public function can_filter_on_a_has_value()
{
$this->assertEquals(
['hasTheWord' => 'something'],
$this->filter->has('something')->toArray()
);
$filter = $this->filter->has('something');
$condition = $filter->getConditions()->first();
$this->assertInstanceOf(FilterCondition::class, $condition);
$this->assertSame('hasTheWord', $condition->getProperty());
$this->assertSame('something', $condition->getValues()->first());
}
/**
@ -43,80 +47,104 @@ class FilterTest extends TestCase
*/
public function can_filter_on_a_has_not_value()
{
$this->assertEquals(
['doesNotHaveTheWord' => 'something'],
$this->filter->hasNot('something')->toArray()
);
$filter = $this->filter->hasNot('something else');
$condition = $filter->getConditions()->first();
$this->assertInstanceOf(FilterCondition::class, $condition);
$this->assertSame('doesNotHaveTheWord', $condition->getProperty());
$this->assertSame('something else', $condition->getValues()->first());
}
/**
* @test
* @covers ::from
*/
public function can_filter_based_on_the_sender()
public function can_filter_based_on_a_single_sender()
{
// Ensure that we can set one from address.
$this->assertEquals(
['from' => ['foo@example.com']],
$this->filter->from('foo@example.com')->toArray()
);
$filter = $this->filter->from('foo@example.com');
// Ensure that we can set multiple from addresses.
$this->assertEquals(
['from' => ['foo@example.com', 'bar@example.com']],
$this->filter->from(['foo@example.com', 'bar@example.com'])->toArray()
);
$condition = $filter->getConditions()->first();
$this->assertInstanceOf(FilterCondition::class, $condition);
$this->assertSame('from', $condition->getProperty());
$this->assertSame('foo@example.com', $condition->getValues()->first());
}
/**
* @test
* @covers ::from
*/
public function no_from_property_exists_if_the_value_is_empty()
public function can_filter_based_on_multiple_senders()
{
$this->assertArrayNotHasKey('from', $this->filter->from('')->toArray());
$this->assertArrayNotHasKey('from', $this->filter->from([])->toArray());
$addresses = ['foo@example.com', 'bar@example.com'];
$filter = $this->filter->from($addresses);
$condition = $filter->getConditions()->first();
$this->assertInstanceOf(FilterCondition::class, $condition);
$this->assertSame('from', $condition->getProperty());
$this->assertSame($addresses, $condition->getValues()->toArray());
}
/**
* @test
* @covers ::to
*/
public function can_filter_based_on_the_recipient()
public function can_filter_based_on_a_single_recipient()
{
$this->assertEquals(
['to' => ['foo@example.com']],
$this->filter->to('foo@example.com')->toArray()
);
$filter = $this->filter->to('foo@example.com');
$this->assertEquals(
['to' => ['bar@example.com', 'baz@example.com']],
$this->filter->to(['bar@example.com', 'baz@example.com'])->toArray()
);
$condition = $filter->getConditions()->first();
$this->assertInstanceOf(FilterCondition::class, $condition);
$this->assertSame('to', $condition->getProperty());
$this->assertSame('foo@example.com', $condition->getValues()->first());
}
/** @test */
public function no_to_property_exists_if_the_value_is_empty()
/**
* @test
* @covers ::from
*/
public function can_filter_based_on_multiple_recipients()
{
$this->assertArrayNotHasKey('to', $this->filter->to('')->toArray());
$this->assertArrayNotHasKey('to', $this->filter->to([])->toArray());
$addresses = ['foo@example.com', 'bar@example.com'];
$filter = $this->filter->to($addresses);
$condition = $filter->getConditions()->first();
$this->assertInstanceOf(FilterCondition::class, $condition);
$this->assertSame('to', $condition->getProperty());
$this->assertSame($addresses, $condition->getValues()->toArray());
}
/**
* @test
* @covers ::subject
*/
public function can_filter_based_on_the_subject()
public function can_filter_based_on_a_single_subject()
{
$this->assertEquals(
['subject' => '"Something"'],
$this->filter->subject('Something')->toArray()
);
$filter = $this->filter->subject('foo@example.com');
$this->assertEquals(
['subject' => '"Test"|"Foo bar"'],
$this->filter->subject(['Test', 'Foo bar'])->toArray()
);
$condition = $filter->getConditions()->first();
$this->assertInstanceOf(FilterCondition::class, $condition);
$this->assertSame('subject', $condition->getProperty());
$this->assertSame('"foo@example.com"', $condition->getValues()->first());
}
/** @test */
public function can_filter_based_on_multiple_subjects()
{
$filter = $this->filter->subject(['foo', 'bar']);
$condition = $filter->getConditions()->first();
$this->assertInstanceOf(FilterCondition::class, $condition);
$this->assertSame('subject', $condition->getProperty());
$this->assertSame(['"foo"', '"bar"'], $condition->getValues()->toArray());
}
/**
@ -125,10 +153,13 @@ class FilterTest extends TestCase
*/
public function can_filter_based_on_whether_there_is_an_attachment()
{
$this->assertEquals(
['hasAttachment' => 'true'],
$this->filter->hasAttachment()->toArray()
);
$filter = $this->filter->hasAttachment();
$condition = $filter->getConditions()->first();
$this->assertInstanceOf(FilterCondition::class, $condition);
$this->assertSame('hasAttachment', $condition->getProperty());
$this->assertSame('true', $condition->getValues()->first());
}
/**
@ -137,15 +168,13 @@ class FilterTest extends TestCase
*/
public function can_filter_based_on_wether_it_was_sent_to_a_list()
{
$this->assertEquals(
['hasTheWord' => 'list:foobar'],
$this->filter->fromList('foobar')->toArray()
);
$filter = $this->filter->fromList('php-weekly');
$this->assertEquals(
['hasTheWord' => 'list:list-one.com|list-two.com'],
$this->filter->fromList(['list-one.com', 'list-two.com'])->toArray()
);
$condition = $filter->getConditions()->first();
$this->assertInstanceOf(FilterCondition::class, $condition);
$this->assertSame('hasTheWord', $condition->getProperty());
$this->assertSame('list:php-weekly', $condition->getValues()->first());
}
/**
@ -154,10 +183,13 @@ class FilterTest extends TestCase
*/
public function chats_can_be_excluded()
{
$this->assertEquals(
['excludeChats' => 'true'],
$this->filter->excludeChats()->toArray()
);
$filter = $this->filter->excludeChats();
$condition = $filter->getConditions()->first();
$this->assertInstanceOf(FilterCondition::class, $condition);
$this->assertSame('excludeChats', $condition->getProperty());
$this->assertSame('true', $condition->getValues()->first());
}
/**