Remove LoggerInterface::batchOperationResults

tangrufus · tangrufus · commit 5a57798dfb5c · 2018-09-03T18:02:49.000+08:00
Because it produces noisy outputs and make the code complicated.
diff --git a/src/CLI/Logger.php b/src/CLI/Logger.php
@@ -152,27 +152,4 @@ public function log($level, $message, array $_context = []): void
     {
         WP_CLI::log('[' . $level . ']' . $message);
     }
-
-    /**
-     * Report the results of the same operation against multiple resources.
-     *
-     * @param string       $noun      Resource being affected (e.g. plugin).
-     * @param string       $verb      Type of action happening to the noun (e.g. activate).
-     * @param integer      $total     Total number of resource being affected.
-     * @param integer      $successes Number of successful operations.
-     * @param integer      $failures  Number of failures.
-     * @param null|integer $skips     Optional. Number of skipped operations. Default null (don't show skips).
-     *
-     * @return void
-     */
-    public function batchOperationResults(
-        string $noun,
-        string $verb,
-        int $total,
-        int $successes,
-        int $failures,
-        ?int $skips = null
-    ): void {
-        report_batch_operation_results($noun, $verb, $total, $successes, $failures, $skips);
-    }
 }
diff --git a/src/LoggerInterface.php b/src/LoggerInterface.php
@@ -15,25 +15,4 @@ interface LoggerInterface extends BaseLoggerInterface
      * @return void
      */
     public function section($title): void;
-
-    /**
-     * Report the results of the same operation against multiple resources.
-     *
-     * @param string       $noun      Resource being affected (e.g. plugin).
-     * @param string       $verb      Type of action happening to the noun (e.g. activate).
-     * @param integer      $total     Total number of resource being affected.
-     * @param integer      $successes Number of successful operations.
-     * @param integer      $failures  Number of failures.
-     * @param null|integer $skips     Optional. Number of skipped operations. Default null (don't show skips).
-     *
-     * @return void
-     */
-    public function batchOperationResults(
-        string $noun,
-        string $verb,
-        int $total,
-        int $successes,
-        int $failures,
-        ?int $skips = null
-    ): void;
 }
diff --git a/src/Operations/AttachmentImages/Optimize.php b/src/Operations/AttachmentImages/Optimize.php
@@ -10,14 +10,8 @@
 use TypistTech\ImageOptimizeCommand\Repositories\AttachmentRepository;
 use function WP_CLI\Utils\normalize_path;
 
-/**
- * TODO: Refactor this class.
- */
 class Optimize
 {
-    protected const SUCCESS = 0;
-    protected const ERROR = 1;
-
     /**
      * The logger.
      *
@@ -77,38 +71,22 @@ public function execute(int ...$ids): void
         });
         $ids = array_filter($ids);
 
-        $results = array_map(function (int $id): array {
+        array_map(function (int $id): void {
             // phpcs:ignore
-            return $this->optimizeAttachment($id);
+            $this->optimizeAttachment($id);
         }, $ids);
 
-        $results = $this->flattenResults($results);
-
-        $successes = count(array_filter($results, function (int $result): bool {
-            return static::SUCCESS === $result;
-        }));
-
-        $failures = count(array_filter($results, function (int $result): bool {
-            return static::ERROR === $result;
-        }));
-
-        $this->logger->batchOperationResults(
-            'image',
-            'optimize',
-            count($results),
-            $successes,
-            $failures
-        );
+        $this->logger->info('Finished');
     }
 
     /**
      * Optimize all images of an attachment.
      *
      * @param int $id The attachment ID.
      *
-     * @return int[]
+     * @return void
      */
-    protected function optimizeAttachment(int $id): array
+    protected function optimizeAttachment(int $id): void
     {
         $this->logger->debug('Optimizing images of attachment ID: ' . $id);
 
@@ -118,72 +96,51 @@ protected function optimizeAttachment(int $id): array
             return normalize_path($path);
         }, $paths);
 
-        $results = array_map(function (string $imagePath): int {
+        $results = array_map(function (string $imagePath): bool {
             // phpcs:ignore
             return $this->optimizeImage($imagePath);
         }, $normalizedPaths);
 
-        if (in_array(static::SUCCESS, $results, true)) {
+        if (in_array(true, $results, true)) {
             $this->logger->debug('Marking attachment ID: ' . $id . ' as optimized.');
             $this->repo->markAsOptimized($id);
             $this->logger->notice('Optimized images of attachment ID: ' . $id);
         }
-
-        return $results;
     }
 
     /**
      * Optimize an image.
      *
      * @param string $path Path to the image.
      *
-     * @return int
+     * @return bool
      */
-    protected function optimizeImage(string $path): int
+    protected function optimizeImage(string $path): bool
     {
         try {
             $this->logger->debug('Optimizing image - ' . $path);
 
             if (! is_readable($path)) {
                 $this->logger->error('Image not readable - ' . $path);
 
-                return static::ERROR;
+                return false;
             }
 
             // phpcs:ignore WordPress.VIP.FileSystemWritesDisallow.file_ops_is_writable
             if (! is_writable($path)) {
                 $this->logger->error('Image not writable - ' . $path);
 
-                return static::ERROR;
+                return false;
             }
 
             $this->optimizerChain->optimize($path);
 
-            return static::SUCCESS;
+            return true;
             // phpcs:ignore
         } catch (IOException $exception) {
             $this->logger->error('Failed to optimize ' . $path);
 
-            return static::ERROR;
-        }
-    }
-
-    /**
-     * Flatten result arrays.
-     *
-     * @param array $results Array of result arrays.
-     *
-     * @return int[]
-     */
-    protected function flattenResults(array $results): array
-    {
-        switch (count($results)) {
-            case 0:
-                return [];
-            case 1:
-                return $results[0];
-            default:
-                return array_merge(...$results);
+            return false;
         }
     }
 }
diff --git a/src/Operations/AttachmentImages/Restore.php b/src/Operations/AttachmentImages/Restore.php
@@ -63,30 +63,22 @@ public function execute(int ...$ids): void
         $total = count($ids);
         $this->logger->section('Restoring full sized images for ' . $total . ' attachment(s)');
 
-        $results = array_map(function (int $id): int {
+        array_map(function (int $id): void {
             // phpcs:ignore
-            return $this->restore($id);
+            $this->restore($id);
         }, $ids);
 
-        $successes = count(array_filter($results, function (int $result): bool {
-            return static::SUCCESS === $result;
-        }));
-
-        $failures = count(array_filter($results, function (int $result): bool {
-            return static::ERROR === $result;
-        }));
-
-        $this->logger->batchOperationResults('full sized image', 'restore', $total, $successes, $failures);
+        $this->logger->info('Finished');
     }
 
     /**
      * Override an attachment full sized image with its `.original` version.
      *
      * @param int $id The attachment ID.
      *
-     * @return int
+     * @return void
      */
-    protected function restore(int $id): int
+    protected function restore(int $id): void
     {
         try {
             $this->logger->debug('Restoring attachment ID: ' . $id);
@@ -96,8 +88,7 @@ protected function restore(int $id): int
 
             if (empty($path)) {
                 $this->logger->error('Full sized image not found for attachment ID: ' . $id);
-
-                return static::ERROR;
+                return;
             }
 
             $path = normalize_path($path);
@@ -111,12 +102,9 @@ protected function restore(int $id): int
             $this->repo->markAsNonOptimized($id);
             $this->logger->notice('Restored attachment ID: ' . $id);
 
-            return static::SUCCESS;
             // phpcs:ignore
         } catch (IOException $exception) {
             $this->logger->error('Failed to restore full sized image for attachment ID: ' . $id);
-
-            return static::ERROR;
         }
     }
 }
diff --git a/src/Operations/Backup.php b/src/Operations/Backup.php
@@ -57,34 +57,22 @@ public function execute(string ...$paths): void
             return normalize_path($path);
         }, $paths);
 
-        $results = array_map(function (string $path): int {
+        array_map(function (string $path): void {
             // phpcs:ignore
-            return $this->backup($path);
+            $this->backup($path);
         }, $normalizedPaths);
 
-        $successes = count(array_filter($results, function (int $result): bool {
-            return static::SUCCESS === $result;
-        }));
-
-        $failures = count(array_filter($results, function (int $result): bool {
-            return static::ERROR === $result;
-        }));
-
-        $skips = count(array_filter($results, function (int $result): bool {
-            return static::SKIP === $result;
-        }));
-
-        $this->logger->batchOperationResults('full sized image', 'backup', $total, $successes, $failures, $skips);
+        $this->logger->info('Finished');
     }
 
     /**
      * Backup a file at its directory with `.original` extension.
      *
      * @param string $path Path to the file to be backed up.
      *
-     * @return int
+     * @return void
      */
-    protected function backup(string $path): int
+    protected function backup(string $path): void
     {
         try {
             $this->logger->debug('Backing up full sized image - ' . $path);
@@ -93,18 +81,15 @@ protected function backup(string $path): int
             if ($isBackupExists) {
                 $this->logger->debug('Skip: Backup already exists - ' . $path);
 
-                return static::SKIP;
+                return;
             }
 
             $this->filesystem->copy($path, $path . static::ORIGINAL_EXTENSION);
             $this->logger->notice('Backed up full sized image - ' . $path);
 
-            return static::SUCCESS;
             // phpcs:ignore
         } catch (IOException | FileNotFoundException $exception) {
             $this->logger->error('Failed to backup ' . $path);
-
-            return static::ERROR;
         }
     }
 }
diff --git a/tests/unit/Operations/AttachmentImages/RestoreTest.php b/tests/unit/Operations/AttachmentImages/RestoreTest.php
@@ -53,9 +53,6 @@ public function testRestoreSuccess()
         $logger->shouldHaveReceived('section')
                ->with('Restoring full sized images for 1 attachment(s)')
                ->once();
-        $logger->shouldHaveReceived('batchOperationResults')
-               ->with('full sized image', 'restore', 1, 1, 0)
-               ->once();
 
         $this->filesystem->seeFileFound('restore-me.txt', $this->testDir);
         $this->filesystem->dontSeeFileFound('restore-me.txt.original', $this->testDir);
@@ -88,9 +85,6 @@ public function testRestoreNotExistBackup()
         $logger->shouldHaveReceived('section')
                ->with('Restoring full sized images for 1 attachment(s)')
                ->once();
-        $logger->shouldHaveReceived('batchOperationResults')
-               ->with('full sized image', 'restore', 1, 0, 1)
-               ->once();
 
         $this->filesystem->dontSeeFileFound('not-exist.png', $this->testDir);
         $this->filesystem->dontSeeFileFound('not-exist.png.original', $this->testDir);
@@ -122,9 +116,6 @@ public function testRestoreNotAttachment()
         $logger->shouldHaveReceived('error')
                ->with('Full sized image not found for attachment ID: 123')
                ->once();
-        $logger->shouldHaveReceived('batchOperationResults')
-               ->with('full sized image', 'restore', 1, 0, 1)
-               ->once();
     }
 
     protected function _before()
diff --git a/tests/unit/Operations/BackupTest.php b/tests/unit/Operations/BackupTest.php
@@ -43,9 +43,6 @@ public function testBackupSuccess()
         $logger->shouldHaveReceived('section')
                ->with('Backing up 1 full sized image(s)')
                ->once();
-        $logger->shouldHaveReceived('batchOperationResults')
-               ->with('full sized image', 'backup', 1, 1, 0, 0)
-               ->once();
     }
 
     public function testBackupOriginalNotExist()
@@ -64,9 +61,6 @@ public function testBackupOriginalNotExist()
         $logger->shouldHaveReceived('section')
                ->with('Backing up 1 full sized image(s)')
                ->once();
-        $logger->shouldHaveReceived('batchOperationResults')
-               ->with('full sized image', 'backup', 1, 0, 1, 0)
-               ->once();
     }
 
     public function testBackupAlreadyExist()
@@ -85,9 +79,6 @@ public function testBackupAlreadyExist()
         $logger->shouldHaveReceived('section')
                ->with('Backing up 1 full sized image(s)')
                ->once();
-        $logger->shouldHaveReceived('batchOperationResults')
-               ->with('full sized image', 'backup', 1, 0, 0, 1)
-               ->once();
     }
 
     public function testBackup()
@@ -114,9 +105,6 @@ public function testBackup()
         $logger->shouldHaveReceived('section')
                ->with('Backing up 3 full sized image(s)')
                ->once();
-        $logger->shouldHaveReceived('batchOperationResults')
-               ->with('full sized image', 'backup', 3, 1, 1, 1)
-               ->once();
     }
 
     protected function _before()
