Skip to content

Add toArray method for state export #14

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

Closed
insign wants to merge 1 commit into from
Closed

Add toArray method for state export #14

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
21 changes: 21 additions & 0 deletions src/Progressable.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -644,4 +644,25 @@ public function incrementStep(int $amount = 1): static {

return $this->setStep($current + $amount);
}

/**
* Get the instance as an array.
*
* @return array<string, mixed>
*/
public function toArray(): array {
$hasUniqueName = isset($this->overallUniqueName);

return [
'progress' => $this->getLocalProgress(),
'overall_progress' => $hasUniqueName ? $this->getOverallProgress() : null,
'is_complete' => $this->isComplete(),
'is_overall_complete' => $hasUniqueName ? $this->isOverallComplete() : null,
'estimated_time_remaining' => $hasUniqueName ? $this->getEstimatedTimeRemaining() : null,
'message' => $this->getStatusMessage(),
'metadata' => $this->getMetadata(),
'total_steps' => $this->getTotalSteps(),
'current_step' => $this->getStep(),
];
}
}
57 changes: 57 additions & 0 deletions tests/ProgressableTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -553,4 +553,61 @@ public function test_set_step_without_total_steps(): void {
$this->assertEquals(5, $this->getStep());
$this->assertEquals(0, $this->getLocalProgress());
}

public function test_to_array(): void {
$this->setOverallUniqueName('test_to_array_'.$this->testId);
$this->setTotalSteps(10);
$this->setStep(5);
$this->setStatusMessage('Halfway there');
$this->setMetadata(['foo' => 'bar']);

$expected = [
'progress' => 50.0,
'overall_progress' => 50.0,
'is_complete' => false,
'is_overall_complete' => false,
'estimated_time_remaining' => null, // null because of timing in tests without setting up carbon
'message' => 'Halfway there',
'metadata' => ['foo' => 'bar'],
'total_steps' => 10,
'current_step' => 5,
];

$array = $this->toArray();

$this->assertEquals($expected['progress'], $array['progress']);
$this->assertEquals($expected['overall_progress'], $array['overall_progress']);
$this->assertEquals($expected['is_complete'], $array['is_complete']);
$this->assertEquals($expected['is_overall_complete'], $array['is_overall_complete']);
$this->assertEquals($expected['message'], $array['message']);
$this->assertEquals($expected['metadata'], $array['metadata']);
$this->assertEquals($expected['total_steps'], $array['total_steps']);
$this->assertEquals($expected['current_step'], $array['current_step']);
}

public function test_to_array_without_unique_name(): void {
// Because setStep triggers updateLocalProgressData which calls getOverallProgressData
// which requires overallUniqueName, we can only test setting the fields that don't trigger it
// or we should avoid calling setStep. We can set progress using reflection, or just use
// the default state without overallUniqueName.
$this->progress = 50.0;
$this->totalSteps = 10;
$this->currentStep = 5;
$this->statusMessage = 'Halfway there';
$this->metadata = ['foo' => 'bar'];

$expected = [
'progress' => 50.0,
'overall_progress' => null,
'is_complete' => false,
'is_overall_complete' => null,
'estimated_time_remaining' => null,
'message' => 'Halfway there',
'metadata' => ['foo' => 'bar'],
'total_steps' => 10,
'current_step' => 5,
];

$this->assertEquals($expected, $this->toArray());
}
}
Loading