more detailed operation result

Author: ardabeyazoglu

Diff for: src/Result.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace PhpRetention;
+
+use DateTimeImmutable;
+use JsonSerializable;
+use ReflectionClass;
+
+class Result implements JsonSerializable
+{
+    public function __construct(
+        public readonly array $keepList,
+        public readonly array $pruneList,
+        public readonly int $startTime,
+        public readonly int $endTime
+    )
+    {}
+
+    public function jsonSerialize(): array
+    {
+        $reflection = new ReflectionClass($this);
+        $props = $reflection->getProperties();
+        $data = [];
+        foreach ($props as $prop) {
+            if ($prop->isPublic()) {
+                $data[$prop->getName()] = $prop->getValue($this);
+            }
+        }
+        return $data;
+    }
+}

Diff for: src/Retention.php

@@ -161,8 +161,10 @@ public function setExcludePattern(string $pattern)
      * @param string $baseDir
      * @return array
      */
-    public function apply(string $baseDir)
+    public function apply(string $baseDir): Result
     {
+        $startTime = time();
+
         $files = $this->findFiles($baseDir);
         $result = $this->checkPolicy($files);
         $keepList = $result['keep'];
@@ -198,7 +200,14 @@ public function apply(string $baseDir)
             }
         }
 
-        return $keepList;
+        $endTime = time();
+
+        return new Result(
+            keepList: $keepList,
+            pruneList: $pruneList,
+            startTime: $startTime,
+            endTime: $endTime
+        );
     }
 
     /**

Diff for: tests/RetentionTest.php

@@ -142,7 +142,8 @@ public function testPrunePolicy(array $policy, array $expectedKeepList)
 
         /** @var Retention $retention */
         $retention->setPolicyConfig($policy);
-        $actualKeepList = $retention->apply('');
+        $result = $retention->apply('');
+        $actualKeepList = $result->keepList;
 
         self::assertSameSize($expectedKeepList, $actualKeepList);
 
@@ -266,25 +267,25 @@ private function getDummyFileData(): array
 
     public function testGrouping()
     {
-        $testFiles = [
-            '/backup/tenant/mysql-20240106.tar.gz',
-            '/backup/tenant/files-20240106.tar.gz',
-            '/backup/tenant/mysql-20240107.tar.gz',
-            '/backup/tenant/files-20240107.tar.gz'
-        ];
         $expectedKeptFiles = [
             '/backup/tenant/mysql-20240107.tar.gz',
             '/backup/tenant/files-20240107.tar.gz'
         ];
 
         $retention = new Retention();
         $retention->setPolicyConfig(['keep-last' => 1]);
-        $retention->setPruneHandler(function (FileInfo $fileInfo) {
+        $retention->setPruneHandler(function () {
             // simulate pruning
             return true;
         });
-        $retention->setFindHandler(function (string $targetDir) use ($testFiles) {
+        $retention->setFindHandler(function () {
             $files = [];
+            $testFiles = [
+                '/backup/tenant/mysql-20240106.tar.gz',
+                '/backup/tenant/files-20240106.tar.gz',
+                '/backup/tenant/mysql-20240107.tar.gz',
+                '/backup/tenant/files-20240107.tar.gz'
+            ];
             foreach ($testFiles as $filepath) {
                 if (preg_match('/\-([0-9]{4})([0-9]{2})([0-9]{2})/', $filepath, $matches)) {
                     $year = intval($matches[1]);
@@ -312,7 +313,8 @@ public function testGrouping()
 
             return null;
         });
-        $kept = $retention->apply('/backup/tenant');
+        $result = $retention->apply('/backup/tenant');
+        $kept = $result->keepList;
 
         $actualKeptFiles = [];
         foreach ($kept as $f) {