Merge pull request #644 from cakephp/filesystem

Update use of deprecate File and Folder classes
cakephp · Feb 20, 2020 · 16aaca7 · 16aaca7
2 parents a78d203 + 54ac868
commit 16aaca7
Show file tree

Hide file tree

Showing 9 changed files with 66 additions and 27 deletions.
diff --git a/src/Command/PluginCommand.php b/src/Command/PluginCommand.php
@@ -26,7 +26,7 @@
 use Cake\Core\App;
 use Cake\Core\Configure;
 use Cake\Core\Plugin;
-use Cake\Filesystem\Folder;
+use Cake\Filesystem\Filesystem;
 use Cake\Utility\Inflector;
 
 /**
@@ -195,10 +195,15 @@ protected function _generateFiles(
         $paths = array_merge($paths, Configure::read('App.paths.templates'));
         $paths[] = Plugin::templatePath('Bake');
 
+        $fs = new Filesystem();
+        $templates = [];
         do {
             $templatesPath = array_shift($paths) . BakeView::BAKE_TEMPLATE_FOLDER . '/Plugin';
-            $templatesDir = new Folder($templatesPath);
-            $templates = $templatesDir->findRecursive('.*\.(twig|php)');
+            if (is_dir($templatesPath)) {
+                $templates = array_keys(iterator_to_array(
+                    $fs->findRecursive($templatesPath, '/.*\.(twig|php)/')
+                ));
+            }
         } while (!$templates);
 
         sort($templates);

diff --git a/src/Command/TestCommand.php b/src/Command/TestCommand.php
@@ -25,7 +25,7 @@
 use Cake\Core\Configure;
 use Cake\Core\Exception\Exception;
 use Cake\Core\Plugin;
-use Cake\Filesystem\Folder;
+use Cake\Filesystem\Filesystem;
 use Cake\Http\Response;
 use Cake\Http\ServerRequest as Request;
 use Cake\ORM\Table;
@@ -204,12 +204,15 @@ protected function _getClassOptions(string $namespace): array
         if ($this->plugin) {
             $base = Plugin::classPath($this->plugin);
         }
+
         $path = $base . str_replace('\\', DS, $namespace);
-        $folder = new Folder($path);
-        [, $files] = $folder->read();
-        foreach ($files as $file) {
-            $classes[] = str_replace('.php', '', $file);
+        $files = (new Filesystem())->find($path);
+        foreach ($files as $fileObj) {
+            if ($fileObj->isFile()) {
+                $classes[] = substr($fileObj->getFileName(), 0, -4);
+            }
         }
+        sort($classes);
 
         return $classes;
     }

diff --git a/src/Shell/Task/BakeTask.php b/src/Shell/Task/BakeTask.php
@@ -23,7 +23,6 @@
 use Cake\Console\Shell;
 use Cake\Core\Configure;
 use Cake\Core\ConventionsTrait;
-use Cake\Filesystem\File;
 
 /**
  * Base class for Bake Tasks.
@@ -181,9 +180,8 @@ protected function _getName(string $name): string
      */
     protected function _deleteEmptyFile(string $path): void
     {
-        $File = new File($path);
-        if ($File->exists()) {
-            $File->delete();
+        if (file_exists($path)) {
+            unlink($path);
             $this->out(sprintf('<success>Deleted</success> `%s`', $path), 1, Shell::QUIET);
         }
     }

diff --git a/tests/TestCase/Command/PluginCommandTest.php b/tests/TestCase/Command/PluginCommandTest.php
@@ -24,7 +24,8 @@
 use Cake\Core\App;
 use Cake\Core\Configure;
 use Cake\Core\Plugin;
-use Cake\Filesystem\Folder;
+use Cake\Filesystem\Filesystem;
+use SplFileInfo;
 
 /**
  * PluginCommand Test
@@ -66,8 +67,8 @@ public function setUp(): void
      */
     public function tearDown(): void
     {
-        $folder = new Folder(TMP . 'plugin_task');
-        $folder->delete();
+        $fs = new Filesystem();
+        $fs->deleteDir(TMP . 'plugin_task');
 
         if (file_exists(APP . 'Application.php.bak')) {
             rename(APP . 'Application.php.bak', APP . 'Application.php');
@@ -97,7 +98,6 @@ public function testMainCustomAppNamespace()
     {
         $this->exec('bake plugin Simple', ['y', 'n']);
         $this->assertExitCode(Command::CODE_SUCCESS);
-        $this->assertPluginContents('Simple');
 
         $bakedRoot = App::path('plugins')[0];
         $appController = $bakedRoot . 'Simple/src/Controller/AppController.php';
@@ -189,8 +189,8 @@ public function testMainUpdateComposer()
         copy(ROOT . 'composer.json.bak', $composerConfig);
         unlink(ROOT . 'composer.json.bak');
 
-        $folder = new Folder(ROOT . 'vendor');
-        $folder->delete();
+        $fs = new Filesystem();
+        $fs->deleteDir(ROOT . 'vendor');
     }
 
     /**
@@ -244,23 +244,47 @@ public function assertPluginContents($pluginName)
     {
         $pluginName = str_replace('/', DS, $pluginName);
         $comparisonRoot = $this->_compareBasePath . $pluginName . DS;
-        $comparisonDir = new Folder($comparisonRoot);
-        $comparisonFiles = $comparisonDir->findRecursive();
+        $comparisonFiles = $this->getFiles($comparisonRoot);
 
         $bakedRoot = App::path('plugins')[0] . $pluginName . DS;
-        $bakedDir = new Folder($bakedRoot);
-        $bakedFiles = $comparisonDir->findRecursive();
+        $bakedFiles = $this->getFiles($bakedRoot);
 
         $this->assertSame(
             count($comparisonFiles),
             count($bakedFiles),
             'A different number of files were created than expected'
         );
 
-        foreach ($comparisonFiles as $file) {
-            $file = substr($file, strlen($comparisonRoot));
-            $result = file_get_contents($bakedRoot . $file);
-            $this->assertSameAsFile($pluginName . DS . $file, $result);
+        foreach ($comparisonFiles as $key => $file) {
+            $result = file_get_contents($file);
+            $this->assertSameAsFile($bakedFiles[$key], $result);
         }
     }
+
+    /**
+     * Get recursive files list for given path.
+     *
+     * @param string $path
+     * @return array
+     */
+    protected function getFiles(string $path): array
+    {
+        if (!is_dir($path)) {
+            return [];
+        }
+
+        $fs = new Filesystem();
+
+        $iterator = $fs->findRecursive(
+            $path,
+            function (SplFileInfo $fileInfo) {
+                return $fileInfo->isFile();
+            }
+        );
+
+        $files = array_keys(iterator_to_array($iterator));
+        sort($files);
+
+        return $files;
+    }
 }
diff --git a/tests/TestCase/Command/SimpleBakeCommandTest.php b/tests/TestCase/Command/SimpleBakeCommandTest.php
@@ -33,7 +33,8 @@ class SimpleBakeCommandTest extends TestCase
     public function setUp(): void
     {
         parent::setUp();
-        $this->_compareBasePath = Plugin::path('Bake') . 'tests' . DS . 'comparisons' . DS . 'Simple' . DS;
+        $this->_compareBasePath = Plugin::path('Bake') . 'tests' . DS . 'comparisons' . DS
+            . 'Plugin' . DS . 'Simple' . DS;
         $this->useCommandRunner();
         $this->setAppNamespace('Bake\Test\App');
     }

diff --git a/tests/comparisons/Plugin/Company/Example/.gitignore b/tests/comparisons/Plugin/Company/Example/.gitignore
@@ -0,0 +1,4 @@
+/composer.lock
+/phpunit.xml
+/vendor
+config/Migrations/schema-dump-default.lock
diff --git a/tests/comparisons/Simple/testBake.php → tests/comparisons/Plugin/Simple/testBake.php b/tests/comparisons/Simple/testBake.php → tests/comparisons/Plugin/Simple/testBake.php
diff --git a/tests/comparisons/Simple/testBakePlugin.php → ...parisons/Plugin/Simple/testBakePlugin.php b/tests/comparisons/Simple/testBakePlugin.php → ...parisons/Plugin/Simple/testBakePlugin.php
diff --git a/tests/comparisons/Plugin/SimpleExample/.gitignore b/tests/comparisons/Plugin/SimpleExample/.gitignore
@@ -0,0 +1,4 @@
+/composer.lock
+/phpunit.xml
+/vendor
+config/Migrations/schema-dump-default.lock