Skip to content

Commit 87deb1d

Browse files
b00gizmb00gizm
committed
feat: Add ChainRepository to support multiple repositories.
This is useful if you want to support multiple repositories, for example for database and cache. In its default implementation, it will delegate collection operations to the first repository in the chain.
1 parent 6abd60e commit 87deb1d

File tree

2 files changed

+216
-0
lines changed

2 files changed

+216
-0
lines changed

‎src/Domain/ChainRepository.php

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace GeekCell\Ddd\Domain;
6+
7+
use Assert;
8+
use GeekCell\Ddd\Contracts\Domain\Paginator;
9+
use GeekCell\Ddd\Contracts\Domain\Repository as RepositoryInterface;
10+
use Traversable;
11+
12+
abstract class ChainRepository implements RepositoryInterface
13+
{
14+
/**
15+
* @var array<class-string<RepositoryInterface>, RepositoryInterface>
16+
*/
17+
private array $repositories;
18+
19+
/**
20+
* @var class-string<RepositoryInterface>
21+
*/
22+
private string $primaryRepositoryKey;
23+
24+
/**
25+
* ChainRepository constructor.
26+
*/
27+
public function __construct(RepositoryInterface ...$repositories)
28+
{
29+
foreach ($repositories as $repository) {
30+
$this->repositories[get_class($repository)] = $repository;
31+
}
32+
33+
// Select the first repository as primary by default
34+
$firstRepository = reset($repositories);
35+
$this->selectPrimary($firstRepository);
36+
}
37+
38+
/**
39+
* Selects the primary repository, which will be used for collection,
40+
* pagination and count.
41+
*
42+
* @param RepositoryInterface $repository
43+
*
44+
* @throws Assert\AssertionFailedException
45+
*/
46+
protected function selectPrimary(RepositoryInterface $repository): void
47+
{
48+
$className = get_class($repository);
49+
Assert\Assertion::keyExists($this->repositories, $className);
50+
51+
$this->primaryRepositoryKey = $className;
52+
}
53+
54+
/**
55+
* Returns the currently selected primary repository.
56+
*
57+
* @return RepositoryInterface
58+
*/
59+
protected function getPrimary(): RepositoryInterface
60+
{
61+
return $this->repositories[$this->primaryRepositoryKey];
62+
}
63+
64+
/**
65+
* Delegate operation to the currently selected primary repository.
66+
* For more advanced scenarios, this method can be overridden.
67+
*
68+
* @inheritDoc
69+
*/
70+
public function collect(): Collection
71+
{
72+
return $this->getPrimary()->collect();
73+
}
74+
75+
/**
76+
* Delegate operation to the currently selected primary repository.
77+
* For more advanced scenarios, this method can be overridden.
78+
*
79+
* @inheritDoc
80+
*/
81+
public function paginate(int $itemsPerPage, int $currentPage = 1): Paginator
82+
{
83+
return $this->getPrimary()->paginate($itemsPerPage, $currentPage);
84+
}
85+
86+
/**
87+
* Delegate operation to the currently selected primary repository.
88+
* For more advanced scenarios, this method can be overridden.
89+
*
90+
* @inheritDoc
91+
*/
92+
public function count(): int
93+
{
94+
return $this->getPrimary()->count();
95+
}
96+
97+
/**
98+
* Delegate operation to the currently selected primary repository.
99+
* For more advanced scenarios, this method can be overridden.
100+
*
101+
* @inheritDoc
102+
*/
103+
public function getIterator(): Traversable
104+
{
105+
return $this->getPrimary()->getIterator();
106+
}
107+
}

‎tests/Domain/ChainRepositoryTest.php

+109
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace GeekCell\Ddd\Tests\Domain;
6+
7+
use GeekCell\Ddd\Contracts\Domain\Repository;
8+
use GeekCell\Ddd\Domain\ChainRepository;
9+
use Mockery;
10+
use PHPUnit\Framework\TestCase;
11+
12+
/**
13+
* Test subject.
14+
*
15+
* @package GeekCell\Ddd\Tests\Domain
16+
*/
17+
class TestChainRepository extends ChainRepository
18+
{
19+
public function select(Repository $repository): void
20+
{
21+
$this->selectPrimary($repository);
22+
}
23+
}
24+
25+
class ChainRepositoryTest extends TestCase
26+
{
27+
public function testChainDefault(): void
28+
{
29+
// Given
30+
$mockFirst = Mockery::mock(Repository::class);
31+
$mockSecond = Mockery::mock(Repository::class);
32+
$mockThird = Mockery::mock(Repository::class);
33+
34+
$chainRepository = new TestChainRepository(
35+
$mockFirst,
36+
$mockSecond,
37+
$mockThird,
38+
);
39+
40+
/** @var Mockery\MockInterface $mockFirst */
41+
$mockFirst->expects('collect')->once();
42+
$mockFirst->expects('paginate')->once();
43+
$mockFirst->expects('getIterator')->once();
44+
$mockFirst->expects('count')->once();
45+
46+
/** @var Mockery\MockInterface $mockSecond */
47+
$mockSecond->expects('collect')->never();
48+
$mockSecond->expects('paginate')->never();
49+
$mockSecond->expects('getIterator')->never();
50+
$mockSecond->expects('count')->never();
51+
52+
/** @var Mockery\MockInterface $mockThird */
53+
$mockThird->expects('collect')->never();
54+
$mockThird->expects('paginate')->never();
55+
$mockThird->expects('getIterator')->never();
56+
$mockThird->expects('count')->never();
57+
58+
// When
59+
$chainRepository->collect();
60+
$chainRepository->paginate(10);
61+
$chainRepository->getIterator();
62+
$chainRepository->count();
63+
64+
$this->addToAssertionCount(12);
65+
}
66+
67+
public function testChainSelect(): void
68+
{
69+
// Given
70+
$mockFirst = Mockery::mock(Repository::class);
71+
$mockSecond = Mockery::mock(Repository::class);
72+
$mockThird = Mockery::mock(Repository::class);
73+
74+
$chainRepository = new TestChainRepository(
75+
$mockFirst,
76+
$mockSecond,
77+
$mockThird,
78+
);
79+
80+
/** @var Mockery\MockInterface $mockFirst */
81+
$mockFirst->expects('collect')->never();
82+
$mockFirst->expects('paginate')->never();
83+
$mockFirst->expects('getIterator')->never();
84+
$mockFirst->expects('count')->never();
85+
86+
/** @var Mockery\MockInterface $mockSecond */
87+
$mockSecond->expects('collect')->once();
88+
$mockSecond->expects('paginate')->once();
89+
$mockSecond->expects('getIterator')->once();
90+
$mockSecond->expects('count')->once();
91+
92+
/** @var Mockery\MockInterface $mockThird */
93+
$mockThird->expects('collect')->never();
94+
$mockThird->expects('paginate')->never();
95+
$mockThird->expects('getIterator')->never();
96+
$mockThird->expects('count')->never();
97+
98+
// When
99+
100+
/** @var Repository $mockSecond */
101+
$chainRepository->select($mockSecond);
102+
$chainRepository->collect();
103+
$chainRepository->paginate(10);
104+
$chainRepository->getIterator();
105+
$chainRepository->count();
106+
107+
$this->addToAssertionCount(12);
108+
}
109+
}

0 commit comments

Comments
 (0)