Add support for deleting empty subdirectories (spatie#25)

Author: mariavilaro

README.md

@@ -66,7 +66,7 @@ return [
 
 Specify the directories that need cleaning in the config file.
 
-When running the console command `clean:directories` all files in the specified directories older then `deleteAllOlderThanMinutes` will be deleted.
+When running the console command `clean:directories` all files in the specified directories older then `deleteAllOlderThanMinutes` will be deleted. Empty subdirectories will also be deleted.
 
 This command can be scheduled in Laravel's console kernel.
 

src/DirectoryCleaner.php

@@ -44,6 +44,17 @@ public function deleteFilesOlderThanMinutes(int $minutes) : Collection
             });
     }
 
+    public function deleteEmptySubdirectories() : Collection
+    {
+        return collect($this->filesystem->directories($this->directory))
+            ->filter(function ($directory) {
+                return ! $this->filesystem->allFiles($directory);
+            })
+            ->each(function ($directory) {
+                $this->filesystem->deleteDirectory($directory);
+            });
+    }
+
     protected function policy() : CleanupPolicy
     {
         return resolve(config(

src/DirectoryCleanupCommand.php

@@ -20,6 +20,7 @@ public function handle()
         collect($directories)->each(function ($config, $directory) {
             if (File::isDirectory($directory)) {
                 $this->deleteFilesIfOlderThanMinutes($directory, $config['deleteAllOlderThanMinutes']);
+                $this->deleteEmptySubdirectories($directory);
             }
         });
 
@@ -34,4 +35,13 @@ protected function deleteFilesIfOlderThanMinutes(string $directory, int $minutes
 
         $this->info("Deleted {$deletedFiles->count()} file(s) from {$directory}.");
     }
+
+    protected function deleteEmptySubdirectories(string $directory)
+    {
+        $deletedSubdirectories = app(DirectoryCleaner::class)
+            ->setDirectory($directory)
+            ->deleteEmptySubdirectories();
+
+        $this->info("Deleted {$deletedSubdirectories->count()} directory(ies) from {$directory}.");
+    }
 }

tests/DirectoryCleanupTest.php

@@ -126,12 +126,37 @@ public function it_doesnt_fail_if_a_configured_dir_doesnt_exist()
         $this->assertFileNotExists("{$existingDirectory}/5MinutesOld.txt");
     }
 
+    /** @test */
+    public function it_can_delete_empty_subdirectories()
+    {
+        $directories[$this->getTempDirectory('deleteEmptySubdirs', true)] = [
+            'deleteAllOlderThanMinutes' => 3,
+            'deleteEmptySubdirectories' => true,
+        ];
+
+        $this->app['config']->set('laravel-directory-cleanup', compact('directories'));
+
+        foreach ($directories as $directory => $config) {
+            $this->createDirectory("{$directory}/emptyDir");
+            $this->createFile("{$directory}/emptyDir/5MinutesOld.txt", 5);
+            $this->createDirectory("{$directory}/notEmptyDir");
+            $this->createFile("{$directory}/notEmptyDir/1MinutesOld.txt", 1);
+        }
+
+        $this->artisan('clean:directories');
+
+        foreach ($directories as $directory => $config) {
+            $this->assertDirectoryExists("{$directory}/notEmptyDir");
+            $this->assertDirectoryNotExists("{$directory}/emptyDir");
+        }
+    }
+
     protected function createFile(string $fileName, int $ageInMinutes)
     {
         touch($fileName, Carbon::now()->subMinutes($ageInMinutes)->subSeconds(5)->timestamp);
     }
 
-    protected function createDirectory(string $fileName, int $ageInMinutes)
+    protected function createDirectory(string $fileName)
     {
         mkdir($fileName);
     }