Add FindCommand

Author: tangrufus

command.php

@@ -7,6 +7,7 @@
 use TypistTech\ImageOptimizeCommand\CLI\Commands\AttachmentCommand;
 use TypistTech\ImageOptimizeCommand\CLI\Commands\BatchCommand;
 use TypistTech\ImageOptimizeCommand\CLI\Commands\CommandNamespace;
+use TypistTech\ImageOptimizeCommand\CLI\Commands\FindCommand;
 use TypistTech\ImageOptimizeCommand\CLI\Commands\ResetCommand;
 use TypistTech\ImageOptimizeCommand\CLI\Commands\RestoreCommand;
 use WP_CLI;
@@ -16,7 +17,11 @@
 }
 
 WP_CLI::add_command('image-optimize', CommandNamespace::class);
+
 WP_CLI::add_command('image-optimize attachment', AttachmentCommand::class);
 WP_CLI::add_command('image-optimize batch', BatchCommand::class);
+
 WP_CLI::add_command('image-optimize restore', RestoreCommand::class);
 WP_CLI::add_command('image-optimize reset', ResetCommand::class);
+
+WP_CLI::add_command('image-optimize find', FindCommand::class);

src/CLI/Commands/CommandNamespace.php

@@ -22,6 +22,9 @@
  *
  *     # Restore all full sized images and drop all meta flags
  *     $ wp image-optimize reset
+ *
+ *     # Find and optimize images under a given directory.
+ *     $ wp image-optimize find /path/to/my/directory
  */
 class CommandNamespace extends BaseCommandNamespace
 {

src/CLI/Commands/FindCommand.php

@@ -0,0 +1,55 @@
+<?php
+declare(strict_types=1);
+
+namespace TypistTech\ImageOptimizeCommand\CLI\Commands;
+
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\Finder\Finder;
+use TypistTech\ImageOptimizeCommand\CLI\LoggerFactory;
+use TypistTech\ImageOptimizeCommand\Operations\Find;
+use TypistTech\ImageOptimizeCommand\Operations\Optimize;
+use TypistTech\ImageOptimizeCommand\OptimizerChainFactory;
+
+class FindCommand
+{
+    /**
+     * Find and optimize images under a given directory.
+     *
+     * ## OPTIONS
+     *
+     * <directory>
+     * : Path to the directory.
+     *
+     * [--extensions=<extensions>]
+     * : File types to optimize, separated by commas.
+     * Default: gif,jpeg,jpg,png
+     *
+     * ## EXAMPLES
+     *
+     *     # Find and optimize images under /path/to/my/directory
+     *     $ wp image-optimize find /path/to/my/directory
+     *
+     *     # Find and optimize SVGs,PNGs under /path/to/my/directory
+     *     $ wp image-optimize find /path/to/my/directory --extensions=svg,png
+     */
+    public function __invoke($args, $assocArgs): void
+    {
+        $extensions = $assocArgs['extensions'] ?? 'gif,jpeg,jpg,png';
+        $extensions = explode(',', $extensions);
+
+        $logger = LoggerFactory::create();
+        $findOperation = new Find(
+            new Finder(),
+            $logger
+        );
+
+        $optimizeOperation = new Optimize(
+            OptimizerChainFactory::create(),
+            new Filesystem(),
+            $logger
+        );
+
+        $images = $findOperation->execute($args[0], ...$extensions);
+        $optimizeOperation->execute(...$images);
+    }
+}

src/Operations/Find.php

@@ -4,6 +4,7 @@
 
 namespace TypistTech\ImageOptimizeCommand\Operations;
 
+use InvalidArgumentException;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Finder\SplFileInfo;
 use TypistTech\ImageOptimizeCommand\LoggerInterface;
@@ -47,18 +48,43 @@ public function __construct(Finder $finder, LoggerInterface $logger)
      */
     public function execute(string $directory, string ...$extensions): array
     {
+        $this->logger->section('Finding images');
+
         $directory = normalize_path($directory);
         $pattern = sprintf(
             '/\.(%1$s)$/',
             implode('|', $extensions)
         );
 
-        $files = $this->finder->files()
-            ->in($directory)
-            ->name($pattern);
+        $this->logger->info('Directory: ' . $directory);
+        $this->logger->info('Pattern: ' . $pattern);
+
+        $files = $this->find($directory, $pattern);
+        $this->logger->notice(count($files) . 'image(s) found.');
+
+        return array_values($files);
+    }
+
+    /**
+     * Find files under a directory with specific name pattern.
+     *
+     * @param string $directory Normalize_directory path.
+     * @param string $pattern   File name regex.
+     *
+     * @return string[]
+     */
+    protected function find(string $directory, string $pattern): array
+    {
+        try {
+            $files = $this->finder->files()->in($directory)->name($pattern);
+
+            return array_map(function (SplFileInfo $file): string {
+                return $file->getRealPath();
+            }, iterator_to_array($files));
 
-        return array_map(function (SplFileInfo $file): string {
-            return $file->getRealPath();
-        }, iterator_to_array($files));
+            // phpcs:ignore
+        } catch (InvalidArgumentException $exception) {
+            return [];
+        }
     }
 }

tests/unit/Operations/FindTest.php

@@ -28,7 +28,7 @@ class FindTest extends Unit
      */
     protected $testDir;
 
-    public function testFind()
+    public function testFindSuccess()
     {
         $finder = new Finder();
         $logger = Mockery::spy(LoggerInterface::class);
@@ -49,6 +49,17 @@ public function testFind()
         $this->assertSame($expected, $actual);
     }
 
+    public function testFindNotExistDir()
+    {
+        $finder = new Finder();
+        $logger = Mockery::spy(LoggerInterface::class);
+        $find = new Find($finder, $logger);
+
+        $actual = $find->execute('/not/exist', 'png', 'txt', 'original', 'xyz');
+
+        $this->assertSame([], $actual);
+    }
+
     protected function _before()
     {
         $this->filesystem = $this->getModule('Filesystem');
@@ -60,11 +71,11 @@ protected function _before()
         );
 
         WP_Mock::userFunction('WP_CLI\Utils\normalize_path')
-            ->with(Mockery::type('string'))
-            ->andReturnUsing(function ($arg) {
-                return $arg;
-            })
-            ->zeroOrMoreTimes();
+               ->with(Mockery::type('string'))
+               ->andReturnUsing(function ($arg) {
+                   return $arg;
+               })
+               ->zeroOrMoreTimes();
     }
 
     protected function _after()