Skip to content

Commit

Permalink
Extract VirtualColumn package
Browse files Browse the repository at this point in the history
  • Loading branch information
@stancl
stancl committed Jul 6, 2020
1 parent b362c16 commit f483d0b
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 164 deletions.
3 changes: 2 additions & 1 deletion composer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
"illuminate/support": "^6.0|^7.0",
"facade/ignition-contracts": "^1.0",
"ramsey/uuid": "^3.7|^4.0",
"stancl/jobpipeline": "^1.0"
"stancl/jobpipeline": "^1.0",
"stancl/virtualcolumn": "^1.0"
},
"require-dev": {
"vlucas/phpdotenv": "^3.3|^4.0",
Expand Down
123 changes: 4 additions & 119 deletions src/Database/Concerns/HasDataColumn.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,127 +4,12 @@

namespace Stancl\Tenancy\Database\Concerns;

use Stancl\VirtualColumn\VirtualColumn;

/**
* This trait lets you add a "data" column functionality to any Eloquent model.
* It serializes attributes which don't exist as columns on the model's table
* into a JSON column named data (customizable by overriding getDataColumn).
* Extends VirtualColumn for backwards compatibility. This trait will be removed in v4.
*/
trait HasDataColumn
{
public static $priorityListeners = [];

/**
* We need this property, because both created & saved event listeners
* decode the data (to take precedence before other created & saved)
* listeners, but we don't want the dadta to be decoded twice.
*
* @var string
*/
public $dataEncodingStatus = 'decoded';

public static function bootHasDataColumn()
{
$encode = function (self $model) {
if ($model->dataEncodingStatus === 'encoded') {
return;
}

foreach ($model->getAttributes() as $key => $value) {
if (! in_array($key, static::getCustomColumns())) {
$current = $model->getAttribute(static::getDataColumn()) ?? [];

$model->setAttribute(static::getDataColumn(), array_merge($current, [
$key => $value,
]));

unset($model->attributes[$key]);
}
}

$model->dataEncodingStatus = 'encoded';
};

$decode = function (self $model) {
if ($model->dataEncodingStatus === 'decoded') {
return;
}

foreach ($model->getAttribute(static::getDataColumn()) ?? [] as $key => $value) {
$model->setAttribute($key, $value);
}

$model->setAttribute(static::getDataColumn(), null);

$model->dataEncodingStatus = 'decoded';
};

static::registerPriorityListener('retrieved', function ($model) use ($decode) {
// We always decode after model retrieval.
$model->dataEncodingStatus = 'encoded';

$decode($model);
});

static::registerPriorityListener('saving', $encode);
static::registerPriorityListener('creating', $encode);
static::registerPriorityListener('updating', $encode);

static::registerPriorityListener('saved', $decode);
static::registerPriorityListener('created', $decode);
static::registerPriorityListener('updated', $decode);
}

protected function fireModelEvent($event, $halt = true)
{
$this->runPriorityListeners($event, $halt);

return parent::fireModelEvent($event, $halt);
}

public function runPriorityListeners($event, $halt = true)
{
$listeners = static::$priorityListeners[$event] ?? [];

if (! $event) {
return;
}

foreach ($listeners as $listener) {
if (is_string($listener)) {
$listener = app($listener);
$handle = [$listener, 'handle'];
} else {
$handle = $listener;
}

$handle($this);
}
}

public static function registerPriorityListener(string $event, callable $callback)
{
static::$priorityListeners[$event][] = $callback;
}

public function getCasts()
{
return array_merge(parent::getCasts(), [
static::getDataColumn() => 'array',
]);
}

/**
* Get the name of the column that stores additional data.
*/
public static function getDataColumn(): string
{
return 'data';
}

public static function getCustomColumns(): array
{
return [
'id',
];
}
use VirtualColumn;
}
44 changes: 0 additions & 44 deletions tests/TenantModelTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,44 +50,6 @@ public function current_tenant_can_be_resolved_from_service_container_using_type
$this->assertSame(null, app(Contracts\Tenant::class));
}

/** @test */
public function keys_which_dont_have_their_own_column_go_into_data_json_column()
{
$tenant = Tenant::create([
'foo' => 'bar',
]);

// Test that model works correctly
$this->assertSame('bar', $tenant->foo);
$this->assertSame(null, $tenant->data);

// Low level test to assert database structure
$this->assertSame(['foo' => 'bar'], json_decode(DB::table('tenants')->where('id', $tenant->id)->first()->data, true));
$this->assertSame(null, DB::table('tenants')->where('id', $tenant->id)->first()->foo ?? null);

// Model has the correct structure when retrieved
$tenant = Tenant::first();
$this->assertSame('bar', $tenant->foo);
$this->assertSame(null, $tenant->data);

// Model can be updated
$tenant->update([
'foo' => 'baz',
'abc' => 'xyz',
]);

$this->assertSame('baz', $tenant->foo);
$this->assertSame('xyz', $tenant->abc);
$this->assertSame(null, $tenant->data);

// Model can be retrieved after update & is structure correctly
$tenant = Tenant::first();

$this->assertSame('baz', $tenant->foo);
$this->assertSame('xyz', $tenant->abc);
$this->assertSame(null, $tenant->data);
}

/** @test */
public function id_is_generated_when_no_id_is_supplied()
{
Expand Down Expand Up @@ -170,12 +132,6 @@ public function tenant_can_be_created_even_when_we_are_in_another_tenants_contex
$this->assertSame(2, Tenant::count());
}

/** @test */
public function data_is_never_encoded_or_decoded_twice()
{
// todo. tests for registerPriorityListener
}

/** @test */
public function the_model_uses_TenantCollection()
{
Expand Down

0 comments on commit f483d0b

Please sign in to comment.