feat: add array export for progress snapshots

Author: insign

src/Progressable.php

@@ -644,4 +644,25 @@ public function incrementStep(int $amount = 1): static {
 
         return $this->setStep($current + $amount);
     }
+
+    /**
+     * Get the current progress snapshot 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' => null,
+            'message' => $this->getStatusMessage(),
+            'metadata' => $this->getMetadata(),
+            'total_steps' => $this->getTotalSteps(),
+            'current_step' => $this->getStep(),
+        ];
+    }
 }

tests/ProgressableTest.php

@@ -553,4 +553,44 @@ 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']);
+
+        $array = $this->toArray();
+
+        $this->assertEquals(50.0, $array['progress']);
+        $this->assertEquals(50.0, $array['overall_progress']);
+        $this->assertFalse($array['is_complete']);
+        $this->assertFalse($array['is_overall_complete']);
+        $this->assertNull($array['estimated_time_remaining']);
+        $this->assertEquals('Halfway there', $array['message']);
+        $this->assertEquals(['foo' => 'bar'], $array['metadata']);
+        $this->assertEquals(10, $array['total_steps']);
+        $this->assertEquals(5, $array['current_step']);
+    }
+
+    public function test_to_array_without_unique_name(): void {
+        $this->progress = 50.0;
+        $this->totalSteps = 10;
+        $this->currentStep = 5;
+        $this->statusMessage = 'Halfway there';
+        $this->metadata = ['foo' => 'bar'];
+
+        $this->assertEquals([
+            '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->toArray());
+    }
 }