Skip to content

Fix: refactor for presentation formatter #487

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

Open
andrestejerina97 wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −69
Open

Fix: refactor for presentation formatter #487

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
53 changes: 4 additions & 49 deletions app/Audit/ConcreteFormatters/PresentationFormatters/BasePresentationAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,52 +22,9 @@

abstract class BasePresentationAuditLogFormatter extends AbstractAuditLogFormatter
{
protected string $event_type;

public function __construct(string $event_type)
{
$this->event_type = $event_type;
}

protected function extractChangedFields(array $change_set): array
{
$changed_fields = [];
$old_status = null;
$new_status = null;

if (isset($change_set['Title'])) {
$changed_fields[] = "title";
}
if (isset($change_set['Abstract'])) {
$changed_fields[] = "abstract";
}
if (isset($change_set['ProblemAddressed'])) {
$changed_fields[] = "problem_addressed";
}
if (isset($change_set['AttendeesExpectedLearnt'])) {
$changed_fields[] = "attendees_expected_learnt";
}

if (isset($change_set['Status'])) {
$changed_fields[] = "status";
$old_status = $change_set['Status'][0] ?? null;
$new_status = $change_set['Status'][1] ?? null;
}
if (isset($change_set['CategoryID']) || isset($change_set['category'])) {
$changed_fields[] = "track";
}
if (isset($change_set['Published'])) {
$changed_fields[] = "published";
}
if (isset($change_set['SelectionPlanID'])) {
$changed_fields[] = "selection_plan";
}

return [
'fields' => !empty($changed_fields) ? implode(', ', $changed_fields) : 'properties',
'old_status' => $old_status,
'new_status' => $new_status,
];
parent::__construct($event_type);
}

protected function getPresentationData(Presentation $subject): array
Expand All @@ -91,7 +48,7 @@ protected function getPresentationData(Presentation $subject): array
];
}

public function format($subject, array $change_set): ?string
public function format(mixed $subject, array $change_set): ?string
{
if (!$subject instanceof Presentation) {
return null;
Expand All @@ -105,9 +62,7 @@ public function format($subject, array $change_set): ?string
return $this->formatCreation($data);

case IAuditStrategy::EVENT_ENTITY_UPDATE:
$extracted = $this->extractChangedFields($change_set);
$extracted['change_set'] = $change_set;
return $this->formatUpdate($data, $extracted);
return $this->formatUpdate($data, $change_set);

case IAuditStrategy::EVENT_ENTITY_DELETION:
return $this->formatDeletion($data);
Expand All @@ -121,7 +76,7 @@ public function format($subject, array $change_set): ?string

abstract protected function formatCreation(array $data): string;

abstract protected function formatUpdate(array $data, array $extracted): string;
abstract protected function formatUpdate(array $data, array $change_set): string;

abstract protected function formatDeletion(array $data): string;
}
21 changes: 5 additions & 16 deletions ...Audit/ConcreteFormatters/PresentationFormatters/PresentationEventApiAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,37 +30,26 @@ protected function formatCreation(array $data): string
);
}

protected function formatUpdate(array $data, array $extracted): string
protected function formatUpdate(array $data, array $change_set): string
{
if ($extracted['old_status'] && $extracted['new_status']) {
return sprintf(
"Presentation '%s' (%s) status changed: %s → %s (%s changed) by user %s",
$data['title'],
$data['id'],
strtoupper($extracted['old_status']),
strtoupper($extracted['new_status']),
$extracted['fields'],
$this->getUserInfo()
);
}

return sprintf(
"Presentation '%s' (%s) modified (%s changed) by user %s",
"Presentation '%s' (%s) updated: %s by user %s",
$data['title'],
$data['id'],
$extracted['fields'],
$this->buildChangeDetails($change_set),
$this->getUserInfo()
);
}

protected function formatDeletion(array $data): string
{
return sprintf(
"Presentation '%s' (%s) created by '%s' under track '%s' was removed by user %s",
"Presentation '%s' (%s) created by '%s' under track '%s' (Plan: %s) was removed by user %s",
$data['title'],
$data['id'],
$data['creator_name'],
$data['category_name'],
$data['plan_name'],
$this->getUserInfo()
);
}
Expand Down
8 changes: 4 additions & 4 deletions ...dit/ConcreteFormatters/PresentationFormatters/PresentationSubmissionAuditLogFormatter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,26 +30,26 @@ protected function formatCreation(array $data): string
);
}

protected function formatUpdate(array $data, array $extracted): string
protected function formatUpdate(array $data, array $change_set): string
{
$change_details = $this->buildChangeDetails($extracted['change_set']);
return sprintf(
"Presentation '%s' (%s) updated: %s by user %s",
$data['title'],
$data['id'],
$change_details,
$this->buildChangeDetails($change_set),
$this->getUserInfo()
);
}

protected function formatDeletion(array $data): string
{
return sprintf(
"Presentation '%s' (%s) submitted by '%s' to track '%s' was deleted by user %s",
"Presentation '%s' (%s) submitted by '%s' to track '%s' (Plan: %s) was deleted by user %s",
$data['title'],
$data['id'],
$data['creator_name'],
$data['category_name'],
$data['plan_name'],
$this->getUserInfo()
);
}
Expand Down