Skip to content
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

Refactor auditSync, auditDetach, auditAttach methods #866

Merged
merged 1 commit into from
Oct 10, 2023
+72 −42
Merged

Refactor auditSync, auditDetach, auditAttach methods #866

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
80 changes: 42 additions & 38 deletions src/Auditable.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -647,6 +647,7 @@ public function transitionTo(Contracts\Audit $audit, bool $old = false): Contrac
* @param mixed $id
* @param array $attributes
* @param bool $touch
* @param array $columns
* @return void
* @throws AuditingException
*/
Expand All @@ -655,23 +656,18 @@ public function auditAttach(string $relationName, $id, array $attributes = [], $
if (!method_exists($this, $relationName) || !method_exists($this->{$relationName}(), 'attach')) {
throw new AuditingException('Relationship ' . $relationName . ' was not found or does not support method attach');
}
$this->auditEvent = 'attach';
$this->isCustomEvent = true;
$this->auditCustomOld = [
$relationName => $this->{$relationName}()->get($columns)->toArray()
];

$old = $this->{$relationName}()->get($columns);
$this->{$relationName}()->attach($id, $attributes, $touch);
$this->auditCustomNew = [
$relationName => $this->{$relationName}()->get($columns)->toArray()
];
Event::dispatch(AuditCustom::class, [$this]);
$this->isCustomEvent = false;
$new = $this->{$relationName}()->get($columns);
$this->dispatchRelationAuditEvent($relationName, 'attach', $old, $new);
}

/**
* @param string $relationName
* @param mixed $ids
* @param bool $touch
* @param array $columns
* @return int
* @throws AuditingException
*/
Expand All @@ -681,25 +677,19 @@ public function auditDetach(string $relationName, $ids = null, $touch = true, $c
throw new AuditingException('Relationship ' . $relationName . ' was not found or does not support method detach');
}

$this->auditEvent = 'detach';
$this->isCustomEvent = true;
$this->auditCustomOld = [
$relationName => $this->{$relationName}()->get($columns)->toArray()
];
$old = $this->{$relationName}()->get($columns);
$results = $this->{$relationName}()->detach($ids, $touch);
$this->auditCustomNew = [
$relationName => $this->{$relationName}()->get($columns)->toArray()
];
Event::dispatch(AuditCustom::class, [$this]);
$this->isCustomEvent = false;
$new = $this->{$relationName}()->get($columns);
$this->dispatchRelationAuditEvent($relationName, 'detach', $old, $new);

return empty($results) ? 0 : $results;
}

/**
* @param $relationName
* @param \Illuminate\Support\Collection|\Illuminate\Database\Eloquent\Model|array $ids
* @param bool $detaching
* @param bool $skipUnchanged
* @param array $columns
* @return array
* @throws AuditingException
*/
Expand All @@ -709,34 +699,22 @@ public function auditSync($relationName, $ids, $detaching = true, $columns = ['*
throw new AuditingException('Relationship ' . $relationName . ' was not found or does not support method sync');
}

$this->auditEvent = 'sync';

$this->auditCustomOld = [
$relationName => $this->{$relationName}()->get($columns)->toArray()
];

$old = $this->{$relationName}()->get($columns);
$changes = $this->{$relationName}()->sync($ids, $detaching);

if (collect($changes)->flatten()->isEmpty()) {
$this->auditCustomOld = [];
$this->auditCustomNew = [];
$old = $new = collect([]);
} else {
$this->auditCustomNew = [
$relationName => $this->{$relationName}()->get($columns)->toArray()
];
$new = $this->{$relationName}()->get($columns);
}

$this->isCustomEvent = true;
Event::dispatch(AuditCustom::class, [$this]);
$this->isCustomEvent = false;
$this->dispatchRelationAuditEvent($relationName, 'sync', $old, $new);

return $changes;
}

/**
* @param string $relationName
* @param \Illuminate\Support\Collection|\Illuminate\Database\Eloquent\Model|array $ids
* @param bool $skipUnchanged
* @param array $columns
* @return array
* @throws AuditingException
*/
Expand All @@ -745,6 +723,32 @@ public function auditSyncWithoutDetaching(string $relationName, $ids, $columns =
if (!method_exists($this, $relationName) || !method_exists($this->{$relationName}(), 'syncWithoutDetaching')) {
throw new AuditingException('Relationship ' . $relationName . ' was not found or does not support method syncWithoutDetaching');
}

return $this->auditSync($relationName, $ids, false, $columns);
}

/**
* @param string $relationName
* @param string $event
* @param \Illuminate\Support\Collection $old
* @param \Illuminate\Support\Collection $new
* @return void
*/
private function dispatchRelationAuditEvent($relationName, $event, $old, $new)
{
$this->auditCustomOld[$relationName] = $old->toArray();
$this->auditCustomNew[$relationName] = $new->toArray();

if (
empty($this->auditCustomOld[$relationName]) &&
empty($this->auditCustomNew[$relationName])
) {
$this->auditCustomOld = $this->auditCustomNew = [];
}

$this->auditEvent = $event;
$this->isCustomEvent = true;
Event::dispatch(AuditCustom::class, [$this]);
$this->isCustomEvent = false;
}
}
34 changes: 30 additions & 4 deletions tests/Functional/AuditingTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -594,11 +594,10 @@ public function itWillAuditCustomEventData()

$article->auditAttach('categories', $firstCategory);
$article->auditAttach('categories', $secondCategory);
$lastAttachedArticle = \end($article->audits->last()->getModified()['categories']['new']);

$this->assertSame($firstCategory->name, $article->categories->first()->name);
$this->assertSame(
$secondCategory->name,
$article->audits->last()->getModified()['categories']['new'][1]['name']
);
$this->assertSame($secondCategory->name, $lastAttachedArticle['name']);
}

/**
Expand Down Expand Up @@ -627,6 +626,33 @@ public function itWillAuditSync()
$this->assertGreaterThan($no_of_audits_before, $no_of_audits_after);
}

/**
* @test
* @return void
*/
public function itWillAuditDetach()
{
$firstCategory = factory(Category::class)->create();
$secondCategory = factory(Category::class)->create();
$article = factory(Article::class)->create();

$article->categories()->attach($firstCategory);
$article->categories()->attach($secondCategory);

$no_of_audits_before = Audit::where('auditable_type', Article::class)->count();
$categoryBefore = $article->categories()->first()->getKey();

$article->auditDetach('categories', [$firstCategory->getKey()]);

$no_of_audits_after = Audit::where('auditable_type', Article::class)->count();
$categoryAfter = $article->categories()->first()->getKey();

$this->assertSame($firstCategory->getKey(), $categoryBefore);
$this->assertSame($secondCategory->getKey(), $categoryAfter);
$this->assertNotSame($categoryBefore, $categoryAfter);
$this->assertGreaterThan($no_of_audits_before, $no_of_audits_after);
}

/**
* @test
* @return void
Expand Down