removing files that exist and shouldn't anymore

Author: adammatysiak

README.md

@@ -48,6 +48,7 @@ Configuration
 | path                             | Path where environments will be stored                                                     | environments/                                        |
 | files                            | Files that will be stored for each environment                                             | [   '.env',   'phpunit.xml',   'public/.htaccess', ] |
 | clear_directory_when_overwriting | If set to true, overwriting environment will be cleared out before putting new files there | false                                                |
+| keep_existing_file_when_missing  | If set to true, existing file in base directory will be not deleted when this file is missing in environment set to active | false                                                |
 
 
 Usage
@@ -128,6 +129,9 @@ vendor/bin/phpunit
 Changelog
 ---------
 
+2.1.0
+* Removing files that are exist in base folder but not exist in environment being set to active
+
 2.0.0
 * Support for all Laravel 5.* versions (to-date)
 

config/laravel-environments.php

@@ -23,4 +23,10 @@
      * Potential danger of delete some files that are stored with purpose.
      */
     'clear_directory_when_overwriting' => false,
+
+    /*
+     * Keep existing file in base directory when this file is  
+     * not existing in environment that being set as active.
+     */
+    'keep_existing_file_when_missing' => false,
 ];

src/Services/EnvironmentManagerService.php

@@ -177,6 +177,9 @@ public function setActive($name)
 
         $this->activateFiles();
 
+        if (! $this->getConfig('keep_existing_file_when_missing'))
+            $this->deleteNotExistingFiles();
+
         return true;
     }
 
@@ -203,4 +206,18 @@ protected function stripEnvPath($file)
     {
         return str_replace($this->path, '', $file);
     }
+
+    protected function deleteNotExistingFiles()
+    {
+        $files = $this->getConfig('files');
+
+        collect($files)
+            ->each(function ($file) {
+                if (File::exists($this->path . $file)) {
+                    return;
+                }
+
+                File::delete(base_path($file));
+            });
+    }
 }

tests/unit/SetCommandTest.php

@@ -137,4 +137,84 @@ public function sequentional_environment_activation()
             $this->assertEquals('env staging content', File::get($file));
         });
     }
+
+    /** @test */
+    public function set_env_without_one_of_files_and_delete_this_missing_file()
+    {
+        config([
+            'laravel-environments.files' => [
+                '.env',
+                'missing.php',
+            ],
+        ]);
+
+        File::put($this->getBaseDirectory('.env'), 'env content');
+        File::put($this->getBaseDirectory('missing.php'), 'missing content');
+
+        tap($this->getBaseDirectory('missing.php'), function ($file) {
+            $this->assertTrue(File::exists($file));
+        });
+
+        $this->executeCreate([
+            'name' => 'local5',
+        ]);
+
+        tap($this->getTempDirectory('local5').'missing.php', function ($file) {
+            File::delete($file);
+            $this->assertFalse(File::exists($file));
+        });
+
+        $this->executeSet([
+            'name' => 'local5',
+        ]);
+
+        tap($this->getBaseDirectory('missing.php'), function ($file) {
+            $this->assertFalse(File::exists($file));
+        });
+
+        tap($this->getBaseDirectory('.env'), function ($file) {
+            $this->assertTrue(File::exists($file));
+            $this->assertEquals('env content', File::get($file));
+        });
+    }
+
+    /** @test */
+    public function set_env_without_one_of_files_and_not_delete_this_missing_file_because_of_config()
+    {
+        config([
+            'laravel-environments.files' => [
+                '.env',
+                'missing.php',
+            ],
+        ]);
+
+        config([
+            'laravel-environments.keep_existing_file_when_missing' => true,
+        ]);
+
+        File::put($this->getBaseDirectory('.env'), 'env content');
+        File::put($this->getBaseDirectory('missing.php'), 'missing content');
+
+        tap($this->getBaseDirectory('missing.php'), function ($file) {
+            $this->assertTrue(File::exists($file));
+        });
+
+        $this->executeCreate([
+            'name' => 'local6',
+        ]);
+
+        tap($this->getTempDirectory('local6').'missing.php', function ($file) {
+            File::delete($file);
+            $this->assertFalse(File::exists($file));
+        });
+
+        $this->executeSet([
+            'name' => 'local6',
+        ]);
+
+        tap($this->getBaseDirectory('missing.php'), function ($file) {
+            $this->assertTrue(File::exists($file));
+            $this->assertEquals('missing content', File::get($file));
+        });
+    }
 }