Exclude certain files from being deleted (spatie#20)

* Add test

* Reject files which are in the ignoredFiles array

* Update default config

* Update method signatures to make things work 🙁

* Update Config

* Update README

* Add DefaultCleanupPolicy

* Update Implementation and Test

* Rename DefaultCleanupPolicy to Basic

* Rename Method in Policy

* Revert README

* Add mockery/mockery as a dev dependency

* Fix StyleCI

* Update README with usage docs

* Revert original changes

Author: stefanzweifel

README.md

@@ -35,6 +35,13 @@ This is the content of the published config file `laravel-directory-cleanup`
 ```
 return [
 
+    /*
+     * A policy will determine if a given file should be deleted. This is the perfect
+     * place to apply custom rules (like only deleting files with a certain extension).
+     * A valid policy is any class that extends `Spatie\DirectoryCleanup\Policies\Policy`
+     */
+    'cleanup_policy' => \Spatie\DirectoryCleanup\Policies\Basic::class,
+
     'directories' => [
         
         /**
@@ -69,6 +76,28 @@ protected function schedule(Schedule $schedule)
 
 ```
 
+If you want to apply additional conditional logic before a file is deleted, you can replace the default `cleanup_policy` with a custom one.
+Create a class which extends `Spatie\DirectoryCleanup\Policies\Policy` and add your logic to the `allow` method. Make sure to return `true` if the file should be deleted.
+
+```php
+// app/CleanupPolicies/MyPolicy.php
+
+namespace App\CleanupPolicies;
+
+use Symfony\Component\Finder\SplFileInfo;
+use Spatie\DirectoryCleanup\Policies\Policy;
+
+class MyPolicy extends Policy
+{
+    public function allow(SplFileInfo $file) : bool
+    {
+        $filesToKeep = ['robots.txt'];
+
+        return ! in_array($file->getFilename(), $filesToKeep);
+    }
+}
+```
+
 ## Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

composer.json

@@ -28,6 +28,7 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^5.0|^6.0|^7.0",
+        "mockery/mockery": "^1.1",
         "orchestra/testbench":"~3.3.0|~3.4.0|~3.5.0|~3.6.0|~3.7.0"
     },
     "autoload": {

config/laravel-directory-cleanup.php

@@ -2,6 +2,13 @@
 
 return [
 
+    /*
+     * A policy will determine if a given file should be deleted. This is the perfect
+     * place to apply custom rules (like only deleting files with a certain extension).
+     * A valid policy is any class that extends `Spatie\DirectoryCleanup\Policies\Policy`
+     */
+    'cleanup_policy' => \Spatie\DirectoryCleanup\Policies\Basic::class,
+
     'directories' => [
 
         /*
@@ -11,7 +18,7 @@
 
         /*
         'path/to/a/directory' => [
-            'deleteAllOlderThanMinutes' => 60 * 24
+            'deleteAllOlderThanMinutes' => 60 * 24,
         ],
         */
     ],

src/DirectoryCleaner.php

@@ -5,6 +5,7 @@
 use Carbon\Carbon;
 use Illuminate\Support\Collection;
 use Illuminate\Filesystem\Filesystem;
+use Spatie\DirectoryCleanup\Policies\Policy;
 
 class DirectoryCleaner
 {
@@ -48,8 +49,22 @@ public function deleteFilesOlderThanMinutes(int $minutes) : Collection
                 return Carbon::createFromTimestamp(filemtime($file))
                     ->lt($timeInPast);
             })
+            ->filter(function ($file) {
+                return $this->policy()->allow($file);
+            })
             ->each(function ($file) {
                 $this->filesystem->delete($file);
             });
     }
+
+    /**
+     * @return \Spatie\DirectoryCleanup\Policies\Policy
+     */
+    protected function policy() : Policy
+    {
+        return resolve(config(
+            'laravel-directory-cleanup.cleanup_policy',
+            \Spatie\DirectoryCleanup\Policies\Basic::class
+        ));
+    }
 }

src/Policies/Basic.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Spatie\DirectoryCleanup\Policies;
+
+use Symfony\Component\Finder\SplFileInfo;
+
+class Basic extends Policy
+{
+    public function allow(SplFileInfo $file) : bool
+    {
+        return true;
+    }
+}

src/Policies/Policy.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Spatie\DirectoryCleanup\Policies;
+
+use Symfony\Component\Finder\SplFileInfo;
+
+abstract class Policy
+{
+    abstract public function allow(SplFileInfo $file) : bool;
+}

tests/CustomCleanupPolicy.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Spatie\DirectoryCleanup\Test;
+
+use Symfony\Component\Finder\SplFileInfo;
+use Spatie\DirectoryCleanup\Policies\Policy;
+
+class CustomCleanupPolicy extends Policy
+{
+    public function allow(SplFileInfo $file) : bool
+    {
+        $filesToKeep = ['keepThisFile.txt'];
+
+        return ! in_array($file->getFilename(), $filesToKeep);
+    }
+}

tests/DirectoryCleanupTest.php

@@ -81,6 +81,30 @@ public function it_can_cleanup_the_directories_specified_in_the_config_file_recu
         }
     }
 
+    /** @test */
+    public function it_can_cleanup_the_directories_specified_in_the_config_file_but_keep_some_files()
+    {
+        $directories[$this->getTempDirectory(1, true)] = [
+            'deleteAllOlderThanMinutes' => 5,
+        ];
+
+        $cleanup_policy = \Spatie\DirectoryCleanup\Test\CustomCleanupPolicy::class;
+
+        $this->app['config']->set('laravel-directory-cleanup', compact('directories', 'cleanup_policy'));
+
+        foreach ($directories as $directory => $config) {
+            $this->createFile("{$directory}/keepThisFile.txt", 5);
+            $this->createFile("{$directory}/removeThisFile.txt", 5);
+        }
+
+        $this->artisan('clean:directories');
+
+        foreach ($directories as $directory => $config) {
+            $this->assertFileExists("{$directory}/keepThisFile.txt");
+            $this->assertFileNotExists("{$directory}/removeThisFile.txt");
+        }
+    }
+
     protected function createFile(string $fileName, int $ageInMinutes)
     {
         touch($fileName, Carbon::now()->subMinutes($ageInMinutes)->subSeconds(5)->timestamp);