Add CHANGED_FILES placeholder

This placeholder only works for pre-push, post-rewrite, post-checkout
and post-merge actions. If it is used in a pre-push hook and multiple
refs are pushed the placeholder will contain all changed files for all
refs.

Author: sebastianfeldmann

src/Runner/Action/Cli/Command/Placeholder/ChangedFiles.php

@@ -0,0 +1,62 @@
+<?php
+
+/**
+ * This file is part of CaptainHook.
+ *
+ * (c) Sebastian Feldmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CaptainHook\App\Runner\Action\Cli\Command\Placeholder;
+
+use CaptainHook\App\Git;
+
+/**
+ * Changed Files Placeholder
+ *
+ * This placeholder only works for pre-push, post-rewrite, post-checkout and post-merge actions.
+ * If it is used in a pre-push hook and multiple refs are pushed the placeholder will contain
+ * all changed files for all refs.
+ *
+ * Usage examples:
+ *  - {$CHANGED_FILES|separated-by:,}
+ *  - {$CHANGED_FILES|in-dir:foo/bar}
+ *  - {$CHANGED_FILES|of-type:php}
+ *
+ * @package CaptainHook
+ * @author  Sebastian Feldmann <[email protected]>
+ * @link    https://github.com/captainhookphp/captainhook
+ * @since   Class available since Release 5.15.3
+ */
+class ChangedFiles extends CheckFiles
+{
+    /**
+     * @param  array<string, string> $options
+     * @return string
+     */
+    public function replacement(array $options): string
+    {
+        $files = [];
+        foreach (Git\Range\Detector::getRanges($this->io) as $range) {
+            $filesInDiff  = isset($options['of-type'])
+                          ? $this->repository->getDiffOperator()->getChangedFilesOfType(
+                              $range->from()->id(),
+                              $range->to()->id(),
+                              $options['of-type']
+                          )
+                          : $this->repository->getDiffOperator()->getChangedFiles(
+                              $range->from()->id(),
+                              $range->to()->id()
+                          );
+
+            $files = array_merge($files, $filesInDiff);
+        }
+        $files = array_unique($files);
+        $files = $this->filterByDirectory($files, $options);
+        $files = $this->replaceInAll($files, $options);
+
+        return implode(($options['separated-by'] ?? ' '), $files);
+    }
+}

tests/unit/Runner/Action/Cli/Command/Placeholder/ChangedFilesTest.php

@@ -0,0 +1,93 @@
+<?php
+
+/**
+ * This file is part of CaptainHook.
+ *
+ * (c) Sebastian Feldmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CaptainHook\App\Runner\Action\Cli\Command\Placeholder;
+
+use CaptainHook\App\Console\IO\Mockery as IOMockery;
+use CaptainHook\App\Config\Mockery as ConfigMockery;
+use CaptainHook\App\Mockery as AppMockery;
+use PHPUnit\Framework\TestCase;
+
+class ChangedFilesTest extends TestCase
+{
+    use IOMockery;
+    use AppMockery;
+    use ConfigMockery;
+
+    /**
+     * Tests ChangedFiles::replacement
+     */
+    public function testCustomSeparator(): void
+    {
+        $io     = $this->createIOMock();
+        $config = $this->createConfigMock();
+        $repo   = $this->createRepositoryMock();
+        $index  = $this->createGitDiffOperator(['file1.php', 'file2.php', 'README.md']);
+        $repo->expects($this->once())->method('getDiffOperator')->willReturn($index);
+
+        $placeholder = new ChangedFiles($io, $config, $repo);
+        $command     = $placeholder->replacement(['separated-by' => ', ']);
+
+        $this->assertEquals('file1.php, file2.php, README.md', $command);
+    }
+
+    /**
+     * Tests ChangedFiles::replacement
+     */
+    public function testOfType(): void
+    {
+        $io     = $this->createIOMock();
+        $config = $this->createConfigMock();
+        $repo   = $this->createRepositoryMock();
+        $index  = $this->createGitDiffOperator(['file1.php', 'file2.php', 'README.md']);
+        $repo->expects($this->once())->method('getDiffOperator')->willReturn($index);
+        $index->expects($this->once())->method('getChangedFilesOfType')->willReturn(['file1.php', 'file2.php']);
+
+        $placeholder = new ChangedFiles($io, $config, $repo);
+        $command     = $placeholder->replacement(['of-type' => 'php']);
+
+        $this->assertEquals('file1.php file2.php', $command);
+    }
+
+    /**
+     * Tests ChangedFiles::replacement
+     */
+    public function testFilterByDirectory(): void
+    {
+        $io     = $this->createIOMock();
+        $config = $this->createConfigMock();
+        $repo   = $this->createRepositoryMock();
+        $index  = $this->createGitDiffOperator(['foo/file1.php', 'foo/file2.php', 'README.md']);
+        $repo->expects($this->once())->method('getDiffOperator')->willReturn($index);
+
+        $placeholder = new ChangedFiles($io, $config, $repo);
+        $command     = $placeholder->replacement(['in-dir' => 'foo/']);
+
+        $this->assertEquals('foo/file1.php foo/file2.php', $command);
+    }
+
+    /**
+     * Tests ChangedFiles::replacement
+     */
+    public function testReplaceWith(): void
+    {
+        $io     = $this->createIOMock();
+        $config = $this->createConfigMock();
+        $repo   = $this->createRepositoryMock();
+        $index  = $this->createGitDiffOperator(['foo/file1.php', 'foo/file2.php', 'README.md']);
+        $repo->expects($this->once())->method('getDiffOperator')->willReturn($index);
+
+        $placeholder = new ChangedFiles($io, $config, $repo);
+        $command     = $placeholder->replacement(['replace' => 'foo/', 'with' => 'bar/']);
+
+        $this->assertEquals('bar/file1.php bar/file2.php README.md', $command);
+    }
+}