Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions src/SettingsServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
use AgentSoftware\Settings\Support\ContextSerializers\ContextSerializer;
use AgentSoftware\Settings\Support\KeyGenerators\Md5KeyGenerator;
use AgentSoftware\Settings\Support\ValueSerializers\ValueSerializer;
use Rawilk\Settings\Support\Context;
use Spatie\LaravelPackageTools\Package;
use Spatie\LaravelPackageTools\PackageServiceProvider;

Expand All @@ -32,6 +33,7 @@ public function packageBooted(): void

public function packageRegistered(): void
{
$this->registerClassAliases();
$this->registerSettings();
}

Expand All @@ -43,6 +45,16 @@ public function provides(): array
];
}

protected function registerClassAliases(): void
{
if (! class_exists(Context::class, false)) {
class_alias(
Support\Context::class,
'Rawilk\Settings\Support\Context',
);
}
}

protected function bootModelBindings(): void
{
$config = $this->app['config']['settings.drivers.eloquent'];
Expand Down
10 changes: 9 additions & 1 deletion src/Support/ContextSerializers/ContextSerializer.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ class ContextSerializer implements ContextSerializerContract
{
public function serialize(?Context $context = null): string
{
return serialize($context);
$serialized = serialize($context);

// Maintain backward compatibility with the old Rawilk namespace
// so that key generation produces identical keys for existing data.
return str_replace(
sprintf('O:%d:"%s"', strlen('AgentSoftware\\Settings\\Support\\Context'), 'AgentSoftware\\Settings\\Support\\Context'),
sprintf('O:%d:"%s"', strlen('Rawilk\\Settings\\Support\\Context'), 'Rawilk\\Settings\\Support\\Context'),
$serialized,
);
}
}
26 changes: 25 additions & 1 deletion tests/Unit/ContextSerializers/ContextSerializerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,35 @@

$serializer = new ContextSerializer;

expect($serializer->serialize($context))->toBe(serialize($context));
$result = $serializer->serialize($context);

expect($result)->toContain('Rawilk\Settings\Support\Context')
->and($result)->not->toContain('AgentSoftware\Settings\Support\Context');
});

it('serializes null values', function () {
$serializer = new ContextSerializer;

expect($serializer->serialize(null))->toBe(serialize(null));
});

it('produces output compatible with the old Rawilk namespace for backward compatibility', function () {
$context = (new Context)->set('model', 'App\Models\Website')->set('id', '123');

$serializer = new ContextSerializer;
$serialized = $serializer->serialize($context);

expect($serialized)->toContain('O:31:"Rawilk\Settings\Support\Context"');
});

it('produces output that can be unserialized back to a valid Context', function () {
$context = (new Context)->set('model', 'App\Models\Website')->set('id', '123');

$serializer = new ContextSerializer;
$serialized = $serializer->serialize($context);

$unserialized = unserialize($serialized);

expect($unserialized)->toBeInstanceOf(Context::class)
->and($unserialized->toArray())->toBe($context->toArray());
});
4 changes: 3 additions & 1 deletion tests/Unit/KeyGenerators/HashKeyGeneratorTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,10 @@
'id' => 123,
]);

$serializer = new ContextSerializer;

expect($this->keyGenerator->generate('my-key', $context))
->toBe(hash('xxh128', 'my-key' . serialize($context)));
->toBe(hash('xxh128', 'my-key' . $serializer->serialize($context)));
});

it('works with other context serializers', function () {
Expand Down
4 changes: 3 additions & 1 deletion tests/Unit/KeyGenerators/Md5KeyGeneratorTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@
'id' => 123,
]);

$serializer = new ContextSerializer;

expect($this->keyGenerator->generate('my-key', $context))
->toBe(md5('my-key' . serialize($context)));
->toBe(md5('my-key' . $serializer->serialize($context)));
});

it('works with other context serializers', function () {
Expand Down
4 changes: 3 additions & 1 deletion tests/Unit/KeyGenerators/ReadableKeyGeneratorTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,7 @@
'id' => 123,
]);

expect($this->keyGenerator->generate('my-key', $context))->toBe('my-key:c:::' . serialize($context));
$serializer = new ContextSerializer;

expect($this->keyGenerator->generate('my-key', $context))->toBe('my-key:c:::' . $serializer->serialize($context));
});