Use git file option

Author: kylekatarnls

composer.json

@@ -23,7 +23,7 @@
     "require": {
         "php": "^7.3 || ^8.0",
         "ext-json": "*",
-        "simple-cli/simple-cli": "^1.3.1",
+        "simple-cli/simple-cli": "^1.4",
         "phpmd/phpmd": "^2.7",
         "phpstan/phpstan": "^0.11.15"
     },

src/Phug/Split.php

@@ -25,7 +25,7 @@ public function gray()
         $this->write($this->getColorCode('dark_gray'));
     }
 
-    public function ungray()
+    public function discolor()
     {
         $this->write($this->escapeCharacter.'[0m');
     }

src/Phug/Split/Command/Analyze.php

@@ -37,7 +37,7 @@ class Analyze extends CommandBase
     protected $ast;
 
     /**
-     * @param Split $cli
+     * @param Split|SimpleCli $cli
      *
      * @return bool
      */
@@ -123,6 +123,7 @@ protected function getPackage(string $directory, array $data): array
     {
         return [
             'name' => $data['name'],
+            'directory' => $directory,
             'children' => [],
         ];
     }
@@ -153,4 +154,4 @@ protected function scanDirectories(string $directory): iterable
             yield $mainPackage;
         }
     }
-}
+}

src/Phug/Split/Command/CommandBase.php

@@ -5,15 +5,14 @@
 use Exception;
 use Phug\Split\Git\Commit;
 use Phug\Split\Git\Log;
-use RecursiveDirectoryIterator;
-use RecursiveIteratorIterator;
-use SimpleCli\Command;
-use SimpleCli\Options\Help;
+use SimpleCli\CommandBase as Command;
 
-abstract class CommandBase implements Command
+/**
+ * @property-read string $gitProgram Git program path.
+ * @property-read string $hashPrefix Prefix for split linked commit hashes.
+ */
+abstract class CommandBase extends Command
 {
-    use Help;
-
     /**
      * Escape a value for git command argument or option.
      *
@@ -23,7 +22,7 @@ abstract class CommandBase implements Command
      */
     protected function gitEscape(string $value): string
     {
-        return "$'".addcslashes($value, "'\\")."'";
+        return '"'.addcslashes($value, '"').'"';
     }
 
     /**
@@ -120,23 +119,9 @@ protected function getCurrentLinkedCommitHash(): ?string
      */
     protected function remove(string $fileOrDirectory): bool
     {
-        if (is_dir($fileOrDirectory)) {
-            $dir = new RecursiveDirectoryIterator($fileOrDirectory, RecursiveDirectoryIterator::SKIP_DOTS);
-            $dir = new RecursiveIteratorIterator($dir, RecursiveIteratorIterator::CHILD_FIRST);
-
-            foreach ($dir as $filename => $file) {
-                is_file($filename)
-                    ? unlink($filename)
-                    : rmdir($filename);
-            }
-
-            return rmdir($fileOrDirectory);
-        }
-
-        if (file_exists($fileOrDirectory)) {
-            return unlink($fileOrDirectory);
-        }
+        @shell_exec('rm -rf '.escapeshellarg($fileOrDirectory).' 2>&1');
+        @shell_exec('rmdir /S /Q '.escapeshellarg($fileOrDirectory).' 2>&1');
 
-        return false;
+        return true;
     }
-}
+}

src/Phug/Split/Command/Copy.php

@@ -2,11 +2,11 @@
 
 namespace Phug\Split\Command;
 
+use Exception;
 use Phug\Split;
 use Phug\Split\Command\Options\GitProgram;
 use Phug\Split\Command\Options\HashPrefix;
 use SimpleCli\SimpleCli;
-use Traversable;
 
 /**
  * Copy files from the mono-repository to a sub-package at the current linked revision.
@@ -43,7 +43,9 @@ class Copy extends CommandBase
     public $filters = 'composer.json';
 
     /**
-     * @param Split $cli
+     * @param Split|SimpleCli $cli
+     *
+     * @throws Exception
      *
      * @return bool
      */
@@ -80,111 +82,4 @@ public function run(SimpleCli $cli): bool
 
         return true;
     }
-
-    protected function calculatePackagesTree(Split $cli): bool
-    {
-        $this->directory = realpath($this->directory);
-
-        if (!$this->directory) {
-            return $cli->error('Input directory not found.');
-        }
-
-        $cli->chdir($this->directory);
-
-        if (!file_exists($this->composerFile)) {
-            return $cli->error('Root project directory should contains a '.$this->composerFile.' file.');
-        }
-
-        $data = json_decode(file_get_contents($this->composerFile), true);
-        $vendorDirectory = ($data['config'] ?? [])['vendor-dir'] ?? 'vendor';
-
-        $cli->writeLine($data['name']);
-        $this->ast = $this->mapDirectories('.', function (string $path, string $element) use ($vendorDirectory) {
-            if ($element === $vendorDirectory) {
-                return null;
-            }
-
-            return $this->scanDirectories($path);
-        });
-
-        return true;
-    }
-
-    protected function getPackages(): iterable
-    {
-        if ($this->ast instanceof Traversable) {
-            $this->ast = iterator_to_array($this->ast);
-        }
-
-        return $this->ast;
-    }
-
-    protected function dumpPackagesTree(Split $cli, iterable $packages, int $level = 0): bool
-    {
-        $count = count($packages);
-
-        foreach ($packages as $index => $package) {
-            $symbol = $index === $count - 1 ? '└' : '├';
-            $cli->writeLine(str_repeat('   ', $level).' '.$symbol.' '.$package['name'], 'light_cyan');
-            $this->dumpPackagesTree($cli, $package['children']);
-        }
-
-        return true;
-    }
-
-    protected function mapDirectories(string $directory, callable $callback): iterable
-    {
-        foreach (scandir($directory) as $element) {
-            if (substr($element, 0, 1) === '.') {
-                continue;
-            }
-
-            $path = $directory.DIRECTORY_SEPARATOR.$element;
-
-            if (is_dir($path)) {
-                $result = $callback($path, $element);
-
-                if ($result !== null) {
-                    foreach ($result as $item) {
-                        yield $item;
-                    }
-                }
-            }
-        }
-    }
-
-    protected function getPackage(string $directory, array $data): array
-    {
-        return [
-            'name' => $data['name'],
-            'children' => [],
-        ];
-    }
-
-    protected function scanDirectories(string $directory): iterable
-    {
-        $mainPackage = null;
-        $composerPath = $directory.DIRECTORY_SEPARATOR.$this->composerFile;
-
-        if (file_exists($composerPath)) {
-            $data = json_decode(file_get_contents($composerPath), true);
-            $mainPackage = $this->getPackage($directory, $data);
-        }
-
-        foreach ($this->mapDirectories($directory, function (string $path) {
-            return $this->scanDirectories($path);
-        }) as $package) {
-            if ($mainPackage) {
-                $mainPackage['children'][] = $package;
-
-                continue;
-            }
-
-            yield $package;
-        }
-
-        if ($mainPackage) {
-            yield $mainPackage;
-        }
-    }
-}
+}

src/Phug/Split/Command/Dist.php

@@ -33,7 +33,7 @@ class Dist extends Analyze
     public $gitCredentials = '';
 
     /**
-     * @param Split $cli
+     * @param Split|SimpleCli $cli
      *
      * @return bool
      */
@@ -111,7 +111,7 @@ protected function distributePackage(Split $cli, array $package, string $branch)
 
         $cli->gray();
         $this->git("clone $url $directory");
-        $cli->ungray();
+        $cli->discolor();
 
         $cli->chdir($directory);
 
@@ -122,8 +122,8 @@ protected function distributePackage(Split $cli, array $package, string $branch)
         $cli->writeLine("git checkout$option $branch", 'light_green');
         $cli->gray();
         $this->git("checkout$option $branch");
-        $cli->ungray();
+        $cli->discolor();
 
         return true;
     }
-}
+}

src/Phug/Split/Command/Update.php

@@ -43,6 +43,16 @@ protected function getPackage(string $directory, array $data): array
         ];
     }
 
+    /**
+     * Get list of commit to replay.
+     *
+     * @param Split  $cli
+     * @param string $hash
+     *
+     * @throws Exception
+     *
+     * @return Log
+     */
     protected function getReplayLog(Split $cli, string $hash): Log
     {
         $max = $this->maximumCommitsReplay;
@@ -74,6 +84,8 @@ protected function setGitCommitter(Author $author): void
     }
 
     /**
+     * Distribute and update the sub-package.
+     *
      * @param Split $cli
      * @param array $package
      * @param string $branch
@@ -115,12 +127,14 @@ protected function distributePackage(Split $cli, array $package, string $branch)
                 $this->setGitCommitter($commit->getCommit()->getAuthor());
                 $author = $commit->getAuthor();
 
+                $commitMessageFile = sys_get_temp_dir().'/commit-message-'.mt_rand(0, 99999999);
+                file_put_contents($commitMessageFile, $commit->getMessage()."\n\n".$this->hashPrefix.$hash);
                 $this->git('add .');
-                $this->git('commit', [
-                    'message' => $commit->getMessage()."\n\n".$this->hashPrefix.$hash,
+                $this->git('commit --file='.escapeshellarg($commitMessageFile), [
                     'author' => $author,
                     'date' => $author->getDate(),
                 ], '2>&1');
+                unlink($commitMessageFile);
 
                 if (!$this->noPush) {
                     $name = $package['name'];

src/Phug/Split/Git/Commit.php

@@ -76,7 +76,7 @@ public static function fromGitLogString(string $log): self
                 new Author(trim($matches['commitName']), trim($matches['commitEmail'])),
                 new Date($matches['commitDate']),
             ),
-            preg_replace('/^    /m', '', trim($matches['message']))
+            preg_replace('/^ {4}/m', '', trim($matches['message']))
         );
     }
 

tests/Phug/Command/CommandBaseTest.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Phug\Test\Split\Command;
+
+use Nette\Utils\FileSystem;
+use PHPUnit\Framework\TestCase;
+use Phug\Split\Command\CommandBase;
+use Phug\Split\Command\Copy;
+use ReflectionMethod;
+
+/**
+ * @coversDefaultClass \Phug\Split\Command\CommandBase
+ */
+class CommandBaseTest extends TestCase
+{
+    public function getEscapableStrings()
+    {
+        return [
+            ['foobar'],
+            ["something\\Yoh'la' hop"],
+            ["something\\Yoh\'\"12\"' hop"],
+        ];
+    }
+
+    /**
+     * @dataProvider getEscapableStrings
+     * @covers ::gitEscape
+     */
+    public function testGitEscape(string $string)
+    {
+        $cwd = getcwd();
+        $copy = new Copy();
+        $gitEscape = new ReflectionMethod(CommandBase::class, 'gitEscape');
+        $gitEscape->setAccessible(true);
+        $directory = sys_get_temp_dir().'/split-test-'.mt_rand(0, 9999999);
+        FileSystem::createDir($directory);
+        chdir($directory);
+        shell_exec('git init');
+        file_put_contents('readme.md', '# README');
+        shell_exec('git add readme.md');
+        shell_exec('git commit --message='.$gitEscape->invoke($copy, $string));
+        $log = shell_exec('git log -n 1 2>&1');
+        chdir($cwd);
+        @shell_exec('rmdir /S /Q '.escapeshellarg($directory));
+        @FileSystem::delete($directory);
+
+        $log = explode("\n\n", $log);
+        $log = trim(preg_replace('/^ {4}/m', '', $log[1]));
+
+        $this->assertSame($string, $log);
+    }
+}