Also track removed files

Author: AydinHassan

src/MagentoHackathon/Composer/Magento/Deploystrategy/DeploystrategyAbstract.php

@@ -5,6 +5,8 @@
 
 namespace MagentoHackathon\Composer\Magento\Deploystrategy;
 
+use Composer\Util\Filesystem;
+
 /**
  * Abstract deploy strategy
  */
@@ -61,6 +63,19 @@ abstract class DeploystrategyAbstract
      */
     protected $deployedFiles = array();
 
+    /**
+     * List of files/folders which were
+     * remove via this remove operation
+     *
+     * @var array
+     */
+    protected $removedFiles = array();
+
+    /**
+     * @var Filesystem
+     */
+    protected $filesystem;
+
     /**
      * Constructor
      *
@@ -69,8 +84,9 @@ abstract class DeploystrategyAbstract
      */
     public function __construct($sourceDir, $destDir)
     {
-        $this->destDir = $destDir;
-        $this->sourceDir = $sourceDir;
+        $this->destDir      = $destDir;
+        $this->sourceDir    = $sourceDir;
+        $this->filesystem   = new Filesystem;
     }
 
     /**
@@ -357,8 +373,8 @@ public function create($source, $dest)
      */
     public function remove($source, $dest)
     {
-        $sourcePath = $this->getSourceDir() . '/' . $this->removeTrailingSlash($source);
-        $destPath = $this->getDestDir() . '/' . $dest;
+        $sourcePath = $this->getSourceDir() . '/' . ltrim($this->removeTrailingSlash($source), '\\/');
+        $destPath = $this->getDestDir() . '/' . ltrim($dest, '\\/');
 
         // If source doesn't exist, check if it's a glob expression, otherwise we have nothing we can do
         if (!file_exists($sourcePath)) {
@@ -382,7 +398,8 @@ public function remove($source, $dest)
         if (basename($sourcePath) !== basename($destPath)) {
             $destPath .= '/' . basename($source);
         }
-        self::rmdirRecursive($destPath);
+        $this->filesystem->remove($destPath);
+        $this->addRemovedFile($destPath);
     }
 
     /**
@@ -395,20 +412,17 @@ public function rmEmptyDirsRecursive($dir, $stopDir = null)
     {
         $absoluteDir = $this->getDestDir() . '/' . $dir;
         if (is_dir($absoluteDir)) {
+
             $iterator = new \RecursiveIteratorIterator(
-                new \RecursiveDirectoryIterator($absoluteDir),
+                new \RecursiveDirectoryIterator($absoluteDir, \RecursiveDirectoryIterator::SKIP_DOTS),
                 \RecursiveIteratorIterator::CHILD_FIRST
             );
 
-            foreach ($iterator as $item) {
-                /** @var SplFileInfo $item */
-                $path = (string)$item;
-                if (!strcmp($item->getFilename(), '.') || !strcmp($item->getFilename(), '..')) {
-                    continue;
-                }
+            if (iterator_count($iterator) > 0) {
                 // The directory contains something, do not remove
                 return;
             }
+
             // RecursiveIteratorIterator have opened handle on $absoluteDir
             // that cause Windows to block the directory and not remove it until
             // the iterator will be destroyed.
@@ -427,24 +441,6 @@ public function rmEmptyDirsRecursive($dir, $stopDir = null)
         }
     }
 
-    /**
-     * Recursively removes the specified directory or file
-     *
-     * @param $dir
-     */
-    public static function rmdirRecursive($dir)
-    {
-        $fs = new \Composer\Util\Filesystem();
-        if(is_dir($dir)){
-            $result = $fs->removeDirectory($dir);
-        }else{
-            @unlink($dir);
-        }
-
-        return;
-    }
-
-
     /**
      * Create the module's files in the given destination.
      *
@@ -468,6 +464,17 @@ public function addDeployedFile($file)
         $this->deployedFiles[] = $file;
     }
 
+    /**
+     * Add a file/folder to the list of removed files
+     * @param string $file
+     */
+    public function addRemovedFile($file)
+    {
+        //strip of destination deploy location
+        $file = preg_replace(sprintf('/^%s/', preg_quote($this->getDestDir(), '/')), '', $file);
+        $this->removedFiles[] = $file;
+    }
+
     /**
      * Get all the deployed files
      *
@@ -477,4 +484,14 @@ public function getDeployedFiles()
     {
         return $this->deployedFiles;
     }
+
+    /**
+     * Get all the removed files
+     *
+     * @return array
+     */
+    public function getRemovedFiles()
+    {
+        return $this->removedFiles;
+    }
 }

src/MagentoHackathon/Composer/Magento/Deploystrategy/Symlink.php

@@ -72,7 +72,7 @@ public function createDelegate($source, $dest)
         if (file_exists($destPath) && is_dir($destPath)) {
             if (basename($sourcePath) === basename($destPath)) {
                 if ($this->isForced()) {
-                    $this->rmdirRecursive($destPath);
+                    $this->filesystem->remove($destPath);
                 } else {
                     throw new \ErrorException("Target $dest already exists (set extra.magento-force to override)");
                 }

tests/MagentoHackathon/Composer/Magento/Deploystrategy/AbstractTest.php

@@ -409,4 +409,31 @@ public function testSourceAndTargetAreDirsDoExist()
             $this->assertFileType($testTargetContent, self::TEST_FILETYPE_FILE);
         }
     }
+
+    public function testCleanStoresAllRemovedFiles()
+    {
+        $directory  = '/app/code/Vendor/Module';
+        $file1      = $directory . '/file1.txt';
+        $file2      = $directory . '/file2.txt';
+        $this->mkdir($this->sourceDir . $directory);
+        touch($this->sourceDir . $file1);
+        touch($this->sourceDir . $file2);
+        $this->strategy->setMappings(array(array($file1, $file1), array($file2, $file2)));
+
+        $this->strategy->deploy();
+
+        $this->assertFileExists($this->destDir . $file1);
+        $this->assertFileExists($this->destDir . $file2);
+
+        $this->strategy->clean();
+
+        $this->assertFileNotExists($this->destDir . $file1);
+        $this->assertFileNotExists($this->destDir . $file2);
+        $this->assertFileNotExists($this->destDir . $directory);
+
+        $this->assertEquals(
+            array($file1, $file2),
+            $this->strategy->getRemovedFiles()
+        );
+    }
 }