Skip to content

Add opt-in filtered column persist support to AbstractMapper #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alganet merged 1 commit into from
Mar 19, 2026
Merged

Add opt-in filtered column persist support to AbstractMapper #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions src/AbstractMapper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
use Respect\Data\Collections\Filtered;
use SplObjectStorage;

use function array_flip;
use function array_intersect_key;

abstract class AbstractMapper
{
/** @var SplObjectStorage<object, true> */
Expand Down Expand Up @@ -105,6 +108,27 @@ public function registerCollection(string $alias, Collection $collection): void

abstract protected function defaultHydrator(Collection $collection): Hydrator;

/**
* @param array<string, mixed> $columns
*
* @return array<string, mixed>
*/
protected function filterColumns(array $columns, Collection $collection): array
{
if (
!$collection instanceof Filtered
|| !$collection->filters
|| $collection->identifierOnly
|| $collection->name === null
) {
return $columns;
}

$pk = $this->style->identifier($collection->name);

return array_intersect_key($columns, array_flip([...$collection->filters, $pk]));
}

protected function resolveHydrator(Collection $collection): Hydrator
{
return $collection->hydrator ?? $this->defaultHydrator($collection);
Expand Down
105 changes: 105 additions & 0 deletions tests/AbstractMapperTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -369,4 +369,109 @@ public function filteredWithoutNextFallsBackToNormalPersist(): void
$fetched = $mapper->post->fetch();
$this->assertEquals('Direct', $fetched->title);
}

#[Test]
public function filteredUpdatePersistsOnlyFilteredColumns(): void
{
$mapper = new InMemoryMapper();
$mapper->seed('post', [
['id' => 1, 'title' => 'Original', 'text' => 'Body'],
]);

$mapper->postTitles = Filtered::post('title');
$post = $mapper->postTitles()->fetch();
$this->assertIsObject($post);

$mapper->entityFactory->set($post, 'title', 'Changed');
$mapper->postTitles()->persist($post);
$mapper->flush();

$fetched = $mapper->post->fetch();
$this->assertEquals('Changed', $mapper->entityFactory->get($fetched, 'title'));
$this->assertEquals('Body', $mapper->entityFactory->get($fetched, 'text'));
}

#[Test]
public function filteredInsertPersistsOnlyFilteredColumns(): void
{
$mapper = new InMemoryMapper();
$mapper->seed('post', []);

$mapper->postTitles = Filtered::post('title');
$post = new stdClass();
$post->id = 1;
$post->title = 'Partial';
$post->text = 'Should not persist';
$mapper->postTitles()->persist($post);
$mapper->flush();

$fetched = $mapper->post->fetch();
$this->assertEquals('Partial', $mapper->entityFactory->get($fetched, 'title'));
$this->assertNull($mapper->entityFactory->get($fetched, 'text'));
}

#[Test]
public function filterColumnsPassesThroughForPlainCollection(): void
{
$mapper = new InMemoryMapper();
$mapper->seed('post', [
['id' => 1, 'title' => 'Original', 'text' => 'Body'],
]);

$post = $mapper->post->fetch();
$this->assertIsObject($post);

$mapper->entityFactory->set($post, 'title', 'Changed');
$mapper->entityFactory->set($post, 'text', 'New Body');
$mapper->post->persist($post);
$mapper->flush();

$fetched = $mapper->post->fetch();
$this->assertEquals('Changed', $mapper->entityFactory->get($fetched, 'title'));
$this->assertEquals('New Body', $mapper->entityFactory->get($fetched, 'text'));
}

#[Test]
public function filterColumnsPassesThroughForEmptyFilters(): void
{
$mapper = new InMemoryMapper();
$mapper->seed('post', [
['id' => 1, 'title' => 'Original', 'text' => 'Body'],
]);

$mapper->allPosts = Filtered::post();
$post = $mapper->allPosts()->fetch();
$this->assertIsObject($post);

$mapper->entityFactory->set($post, 'title', 'Changed');
$mapper->entityFactory->set($post, 'text', 'New Body');
$mapper->allPosts()->persist($post);
$mapper->flush();

$fetched = $mapper->post->fetch();
$this->assertEquals('Changed', $mapper->entityFactory->get($fetched, 'title'));
$this->assertEquals('New Body', $mapper->entityFactory->get($fetched, 'text'));
}

#[Test]
public function filterColumnsPassesThroughForIdentifierOnly(): void
{
$mapper = new InMemoryMapper();
$mapper->seed('post', [
['id' => 1, 'title' => 'Original', 'text' => 'Body'],
]);

$mapper->postIds = Filtered::post(Filtered::IDENTIFIER_ONLY);
$post = $mapper->postIds()->fetch();
$this->assertIsObject($post);

$mapper->entityFactory->set($post, 'title', 'Changed');
$mapper->entityFactory->set($post, 'text', 'New Body');
$mapper->postIds()->persist($post);
$mapper->flush();

$fetched = $mapper->post->fetch();
$this->assertEquals('Changed', $mapper->entityFactory->get($fetched, 'title'));
$this->assertEquals('New Body', $mapper->entityFactory->get($fetched, 'text'));
}
}
13 changes: 10 additions & 3 deletions tests/InMemoryMapper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
use Respect\Data\Hydrators\Nested;

use function array_filter;
use function array_merge;
use function array_values;
use function is_array;
use function reset;
Expand Down Expand Up @@ -56,7 +57,10 @@ public function flush(): void
$collection = $this->tracked[$entity];
$tableName = (string) $collection->name;
$pk = $this->style->identifier($tableName);
$row = $this->entityFactory->extractProperties($entity);
$row = $this->filterColumns(
$this->entityFactory->extractProperties($entity),
$collection,
);

if (!isset($row[$pk])) {
++$this->lastInsertId;
Expand All @@ -76,11 +80,14 @@ public function flush(): void
$tableName = (string) $collection->name;
$pk = $this->style->identifier($tableName);
$pkValue = $this->entityFactory->get($entity, $pk);
$row = $this->entityFactory->extractProperties($entity);
$row = $this->filterColumns(
$this->entityFactory->extractProperties($entity),
$collection,
);

foreach ($this->tables[$tableName] as $index => $existing) {
if (isset($existing[$pk]) && $existing[$pk] == $pkValue) {
$this->tables[$tableName][$index] = $row;
$this->tables[$tableName][$index] = array_merge($existing, $row);

break;
}
Expand Down
Loading