Adding option to write patches for files deleted in user's app

Author: weaverryan

src/Command/UpdateRecipesCommand.php

@@ -197,6 +197,33 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             ]);
         }
 
+        if (0 !== \count($patch->getRemovedPatches())) {
+            if (1 === \count($patch->getRemovedPatches())) {
+                $notes = [
+                    sprintf('  The file <comment>%s</comment> was not updated because it doesn\'t exist in your app.', array_keys($patch->getRemovedPatches())[0]),
+                ];
+            } else {
+                $notes = ['  The following files were not updated because they don\'t exist in your app:'];
+                foreach ($patch->getRemovedPatches() as $filename => $contents) {
+                    $notes[] = sprintf('    * <comment>%s</comment>', $filename);
+                }
+            }
+            $io->write([
+                '',
+                '  <bg=red;fg=white>NOTE:</>',
+            ]);
+            $io->write($notes);
+            $io->write('');
+            if ($io->askConfirmation('  Would you like to save the "diff" to a file so you can review it? (Y/n) ')) {
+                $patchFilename = str_replace('/', '.', $packageName).'.updates-for-deleted-files.patch';
+                file_put_contents($this->rootDir.'/'.$patchFilename, implode("\n", $patch->getRemovedPatches()));
+                $io->write([
+                    '',
+                    sprintf('  Saved diff to <info>%s</info>', $patchFilename),
+                ]);
+            }
+        }
+
         if ($patch->getPatch()) {
             $io->write('');
             $io->write('  Calculating CHANGELOG...', false);

src/Update/DiffHelper.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Flex\Update;
+
+class DiffHelper
+{
+    public static function removeFilesFromPatch(string $patch, array $files, array &$removedPatches): string
+    {
+        foreach ($files as $filename) {
+            $start = strpos($patch, sprintf('diff --git a/%s b/%s', $filename, $filename));
+            if (false === $start) {
+                throw new \LogicException(sprintf('Could not find file "%s" in the patch', $filename));
+            }
+
+            $end = strpos($patch, 'diff --git a/', $start + 1);
+            $contentBefore = substr($patch, 0, $start);
+            if (false === $end) {
+                // last patch in the file
+                $removedPatches[$filename] = rtrim(substr($patch, $start), "\n");
+                $patch = rtrim($contentBefore, "\n");
+
+                continue;
+            }
+
+            $removedPatches[$filename] = rtrim(substr($patch, $start, $end - $start), "\n");
+            $patch = $contentBefore.substr($patch, $end);
+        }
+
+        return $patch;
+    }
+}

src/Update/RecipePatch.php

@@ -15,11 +15,13 @@ class RecipePatch
 {
     private $patch;
     private $blobs;
+    private $removedPatches;
 
-    public function __construct(string $patch, array $blobs)
+    public function __construct(string $patch, array $blobs, array $removedPatches = [])
     {
         $this->patch = $patch;
         $this->blobs = $blobs;
+        $this->removedPatches = $removedPatches;
     }
 
     public function getPatch(): string
@@ -31,4 +33,13 @@ public function getBlobs(): array
     {
         return $this->blobs;
     }
+
+    /**
+     * Patches for modified files that were removed because the file
+     * has been deleted in the user's project.
+     */
+    public function getRemovedPatches(): array
+    {
+        return $this->removedPatches;
+    }
 }

src/Update/RecipePatcher.php

@@ -93,12 +93,13 @@ public function generatePatch(array $originalFiles, array $newFiles): RecipePatc
         }
 
         // If a file is being modified, but does not exist in the current project,
-        // it cannot be patched. Ignore these files and leave them deleted.
+        // it cannot be patched. We generate the diff for these, but then remove
+        // it from the patch (and optionally report this diff to the user).
         $modifiedFiles = array_intersect_key(array_keys($originalFiles), array_keys($newFiles));
+        $deletedModifiedFiles = [];
         foreach ($modifiedFiles as $modifiedFile) {
             if (!file_exists($this->rootDir.'/'.$modifiedFile)) {
-                unset($originalFiles[$modifiedFile]);
-                unset($newFiles[$modifiedFile]);
+                $deletedModifiedFiles[] = $modifiedFile;
             }
         }
 
@@ -122,9 +123,14 @@ public function generatePatch(array $originalFiles, array $newFiles): RecipePatc
             $this->writeFiles($newFiles, $tmpPath);
             $this->execute('git add -A', $tmpPath);
 
+            $patchString = $this->execute('git diff --cached', $tmpPath);
+            $removedPatches = [];
+            $patchString = DiffHelper::removeFilesFromPatch($patchString, $deletedModifiedFiles, $removedPatches);
+
             return new RecipePatch(
-                $this->execute('git diff --cached', $tmpPath),
-                $blobs
+                $patchString,
+                $blobs,
+                $removedPatches
             );
         } finally {
             try {