Merge pull request phpro#643 from veewee/improve-project-path

veewee · web-flow · commit 162fa62324fe · 2019-05-31T13:11:53.000+02:00
Only show project files when project is in subfolder
diff --git a/resources/config/util.yml b/resources/config/util.yml
@@ -5,6 +5,8 @@ services:
     grumphp.util.filesystem:
         class: GrumPHP\Util\Filesystem
         public: true
+        arguments:
+            - '@config'
 
     grumphp.util.phpversion:
         class: GrumPHP\Util\PhpVersion
@@ -14,3 +16,4 @@ services:
               '7.0': '2018-12-03 23:59:59'
               '7.1': '2019-12-01 23:59:59'
               '7.2': '2020-11-30 23:59:59'
+              '7.3': '2021-12-06 23:59:59'
diff --git a/spec/Console/Helper/PathsHelperSpec.php b/spec/Console/Helper/PathsHelperSpec.php
@@ -16,6 +16,9 @@ class PathsHelperSpec extends ObjectBehavior
     function let(GrumPHP $config, Filesystem $filesystem, ExternalCommand $externalCommandLocator)
     {
         $this->beConstructedWith($config, $filesystem, $externalCommandLocator, '/grumphp.yml');
+
+        $filesystem->getProjectDir()->willReturn('/my/project');
+        $filesystem->getGitDir()->willReturn('/my/project');
     }
 
     function it_is_a_console_helper()
diff --git a/spec/Locator/ChangedFilesSpec.php b/spec/Locator/ChangedFilesSpec.php
@@ -10,13 +10,19 @@
 use GrumPHP\Locator\ChangedFiles;
 use GrumPHP\Util\Filesystem;
 use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
 use Prophecy\Prophet;
 
 class ChangedFilesSpec extends ObjectBehavior
 {
     function let(Repository $repository, Filesystem $filesystem)
     {
         $this->beConstructedWith($repository, $filesystem);
+        $filesystem->makePathRelativeToProjectDir(Argument::type('string'))->will(
+            function (array $arguments): string {
+                return $arguments[0];
+            }
+        );
     }
 
     function it_is_initializable()
diff --git a/spec/Task/CloverCoverageSpec.php b/spec/Task/CloverCoverageSpec.php
@@ -18,7 +18,7 @@ class CloverCoverageSpec extends ObjectBehavior
     function let(GrumPHP $grumPHP)
     {
         $grumPHP->getTaskConfiguration('clover_coverage')->willReturn([]);
-        $this->beConstructedWith($grumPHP, new Filesystem());
+        $this->beConstructedWith($grumPHP, new Filesystem($grumPHP->getWrappedObject()));
     }
 
     function it_is_initializable()
diff --git a/spec/Util/FilesystemSpec.php b/spec/Util/FilesystemSpec.php
diff --git a/src/Composer/DevelopmentIntegrator.php b/src/Composer/DevelopmentIntegrator.php
@@ -7,7 +7,7 @@
 use Composer\Script\Event;
 use GrumPHP\Collection\ProcessArgumentsCollection;
 use GrumPHP\Process\ProcessFactory;
-use GrumPHP\Util\Filesystem;
+use Symfony\Component\Filesystem\Filesystem;
 
 class DevelopmentIntegrator
 {
diff --git a/src/Configuration/ContainerFactory.php b/src/Configuration/ContainerFactory.php
@@ -4,11 +4,11 @@
 
 namespace GrumPHP\Configuration;
 
-use GrumPHP\Util\Filesystem;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass;
+use Symfony\Component\Filesystem\Filesystem;
 
 final class ContainerFactory
 {
@@ -41,6 +41,7 @@ public static function buildFromConfiguration(string $path): ContainerBuilder
         if ($filesystem->exists($path)) {
             $loader->load($path);
         }
+        $container->setParameter('config_file', $path);
 
         // Compile configuration to make sure that tasks are added to the taskrunner
         $container->compile();
diff --git a/src/Configuration/GrumPHP.php b/src/Configuration/GrumPHP.php
@@ -33,6 +33,11 @@ public function getGitDir(): string
         return $this->container->getParameter('git_dir');
     }
 
+    public function getConfigFile(): string
+    {
+        return $this->container->getParameter('config_file');
+    }
+
     public function getHooksDir(): ?string
     {
         return $this->container->getParameter('hooks_dir');
diff --git a/src/Console/Application.php b/src/Console/Application.php
@@ -9,7 +9,6 @@
 use GrumPHP\IO\ConsoleIO;
 use GrumPHP\Locator\ConfigurationFile;
 use GrumPHP\Util\ComposerFile;
-use GrumPHP\Util\Filesystem;
 use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
 use Symfony\Component\Console\Application as SymfonyConsole;
@@ -21,6 +20,7 @@
 use Symfony\Component\Console\Output\ConsoleOutput;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\Filesystem\Filesystem;
 
 class Application extends SymfonyConsole
 {
diff --git a/src/Console/Helper/PathsHelper.php b/src/Console/Helper/PathsHelper.php
@@ -14,6 +14,8 @@
 
 /**
  * This class will return all configured paths relative to the working directory.
+ * @deprecated Try to use Filesystem instead
+ * @see Filesystem
  */
 class PathsHelper extends Helper
 {
@@ -107,23 +109,24 @@ public function getAsciiContent(string $resource): string
     /**
      * This is the directory in which the cli script is initialized.
      * Normally this should be the directory where the composer.json file is located.
+     *
+     * @deprecated use Filesystem::getProjectDir() instead
+     * @see Filesystem::getProjectDir()
      */
     public function getWorkingDir(): string
     {
-        return getcwd();
+        return $this->fileSystem->getProjectDir();
     }
 
     /**
      * Find the relative git directory.
+     *
+     * @deprecated use Filesystem::getRelativeGitDir() instead
+     * @see Filesystem::getRelativeGitDir()
      */
     public function getGitDir(): string
     {
-        $gitDir = $this->config->getGitDir();
-        if (!$this->fileSystem->exists($gitDir)) {
-            throw new RuntimeException('The configured GIT directory could not be found.');
-        }
-
-        return $this->getRelativePath($gitDir);
+        return $this->fileSystem->getRelativeGitDir();
     }
 
     /**
diff --git a/src/Locator/ChangedFiles.php b/src/Locator/ChangedFiles.php
@@ -51,9 +51,7 @@ private function parseFilesFromDiff(Diff $diff): FilesCollection
         $files = [];
         /** @var File $file */
         foreach ($diff->getFiles() as $file) {
-            $fileName = $file->isRename() ? $file->getNewName() : $file->getName();
-            $fileObject = new SplFileInfo($fileName, dirname($fileName), $fileName);
-
+            $fileObject = $this->makeFileRelativeToProjectDir($file);
             if ($file->isDeletion() || !$this->filesystem->exists($fileObject->getPathname())) {
                 continue;
             }
@@ -63,4 +61,13 @@ private function parseFilesFromDiff(Diff $diff): FilesCollection
 
         return new FilesCollection($files);
     }
+
+    private function makeFileRelativeToProjectDir(File $file): SplFileInfo
+    {
+        $filePath = $this->filesystem->makePathRelativeToProjectDir(
+            $file->isRename() ? $file->getNewName() : $file->getName()
+        );
+
+        return new SplFileInfo($filePath, dirname($filePath), $filePath);
+    }
 }
diff --git a/src/Locator/ConfigurationFile.php b/src/Locator/ConfigurationFile.php
@@ -5,7 +5,7 @@
 namespace GrumPHP\Locator;
 
 use GrumPHP\Util\ComposerFile;
-use GrumPHP\Util\Filesystem;
+use Symfony\Component\Filesystem\Filesystem;
 
 class ConfigurationFile
 {
diff --git a/src/Util/Filesystem.php b/src/Util/Filesystem.php
@@ -4,11 +4,23 @@
 
 namespace GrumPHP\Util;
 
+use GrumPHP\Configuration\GrumPHP;
 use SplFileInfo;
+use Symfony\Component\Filesystem\Exception\FileNotFoundException;
 use Symfony\Component\Filesystem\Filesystem as SymfonyFilesystem;
 
 class Filesystem extends SymfonyFilesystem
 {
+    /**
+     * @var GrumPHP
+     */
+    private $config;
+
+    public function __construct(GrumPHP $config)
+    {
+        $this->config = $config;
+    }
+
     public function readFromFileInfo(SplFileInfo $file): string
     {
         $handle = $file->openFile('r');
@@ -19,4 +31,63 @@ public function readFromFileInfo(SplFileInfo $file): string
 
         return $content;
     }
+
+    public function getProjectDir(): string
+    {
+        return dirname($this->config->getConfigFile());
+    }
+
+    public function getGitDir(): string
+    {
+        $gitDir = $this->config->getGitDir();
+        if ($this->isAbsolutePath($gitDir)) {
+            return $gitDir;
+        }
+
+        $relativeGitDir = $this->getProjectDir() . DIRECTORY_SEPARATOR . $this->ltrimSlashes($gitDir);
+
+        return $this->realpath($relativeGitDir);
+    }
+
+    public function getRelativeProjectDir(): string
+    {
+        return $this->makePathRelative(
+            $this->getProjectDir(),
+            $this->getGitDir()
+        );
+    }
+
+    public function getRelativeGitDir(): string
+    {
+        return $this->makePathRelative(
+            $this->getGitDir(),
+            $this->getProjectDir()
+        );
+    }
+
+    public function makePathRelativeToProjectDir(string $filePath): string
+    {
+        $relativeProjectDir = $this->getRelativeProjectDir();
+        $relativePath = preg_replace('#^('.preg_quote($relativeProjectDir, '#').')#', '', $filePath);
+
+        if (strpos($relativePath, './') === 0) {
+            return substr($relativePath, 2);
+        }
+
+        return $relativePath;
+    }
+
+    public function realpath(string $path): string
+    {
+        if (!$this->exists($path)) {
+            throw new FileNotFoundException(sprintf('Path "%s" does not exist.', $path));
+        }
+
+        return realpath($path);
+    }
+
+    private function ltrimSlashes(string $path): string
+    {
+        return ltrim($path, '\\/');
+    }
 }
diff --git a/test/E2E/FolderStructuresTest.php b/test/E2E/FolderStructuresTest.php
@@ -23,11 +23,6 @@ function it_has_all_config_files_in_root_git_dir()
     /** @test */
     function it_has_project_subfolder()
     {
-        $this->markTestSkipped('This flow is broken: make sure paths are relative to the project dir.');
-        // Extra info: the project directory should be removed from the the file paths.
-        // All files outside the project dir should not be passed to grumphp.
-        // This requires some changes in the file locators
-
         $projectDir = $this->mkdir('project');
         $this->initializeComposer($projectDir);
         $grumphpFile = $this->initializeGrumphpConfig($projectDir);
diff --git a/test/Unit/Linter/Json/JsonLinterTest.php b/test/Unit/Linter/Json/JsonLinterTest.php
@@ -3,13 +3,15 @@
 namespace GrumPHPTest\Unit\Linter\Json;
 
 use GrumPHP\Collection\LintErrorsCollection;
+use GrumPHP\Configuration\GrumPHP;
 use GrumPHP\Linter\Json\JsonLinter;
 use GrumPHP\Linter\Json\JsonLintError;
 use GrumPHP\Util\Filesystem;
 use PHPUnit\Framework\TestCase;
 use RuntimeException;
 use Seld\JsonLint\JsonParser;
 use SplFileInfo;
+use Symfony\Component\DependencyInjection\Container;
 
 class JsonLinterTest extends TestCase
 {
@@ -21,7 +23,7 @@ class JsonLinterTest extends TestCase
     protected function setUp(): void
     {
         $this->linter = new JsonLinter(
-            new Filesystem(),
+            new Filesystem(new GrumPHP(new Container())),
             new JsonParser()
         );
     }
diff --git a/test/Unit/Linter/Yaml/YamlLinterTest.php b/test/Unit/Linter/Yaml/YamlLinterTest.php
@@ -3,12 +3,14 @@
 namespace GrumPHPTest\Unit\Linter\Yaml;
 
 use GrumPHP\Collection\LintErrorsCollection;
+use GrumPHP\Configuration\GrumPHP;
 use GrumPHP\Linter\Yaml\YamlLinter;
 use GrumPHP\Linter\Yaml\YamlLintError;
 use GrumPHP\Util\Filesystem;
 use PHPUnit\Framework\TestCase;
 use RuntimeException;
 use SplFileInfo;
+use Symfony\Component\DependencyInjection\Container;
 
 class YamlLinterTest extends TestCase
 {
@@ -20,7 +22,7 @@ class YamlLinterTest extends TestCase
     protected function setUp(): void
     {
         $this->linter = new YamlLinter(
-            new Filesystem()
+            new Filesystem(new GrumPHP(new Container()))
         );
     }
 
diff --git a/test/Unit/Util/FilesystemTest.php b/test/Unit/Util/FilesystemTest.php

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,9 @@ class PathsHelperSpec extends ObjectBehavior`
`16`	`16`	`function let(GrumPHP $config, Filesystem $filesystem, ExternalCommand $externalCommandLocator)`
`17`	`17`	`{`
`18`	`18`	`$this->beConstructedWith($config, $filesystem, $externalCommandLocator, '/grumphp.yml');`
	`19`	`+`
	`20`	`+ $filesystem->getProjectDir()->willReturn('/my/project');`
	`21`	`+ $filesystem->getGitDir()->willReturn('/my/project');`
`19`	`22`	`}`
`20`	`23`
`21`	`24`	`function it_is_a_console_helper()`
Original file line number	Diff line number	Diff line change
`@@ -10,13 +10,19 @@`
`10`	`10`	`use GrumPHP\Locator\ChangedFiles;`
`11`	`11`	`use GrumPHP\Util\Filesystem;`
`12`	`12`	`use PhpSpec\ObjectBehavior;`
	`13`	`+use Prophecy\Argument;`
`13`	`14`	`use Prophecy\Prophet;`
`14`	`15`
`15`	`16`	`class ChangedFilesSpec extends ObjectBehavior`
`16`	`17`	`{`
`17`	`18`	`function let(Repository $repository, Filesystem $filesystem)`
`18`	`19`	`{`
`19`	`20`	`$this->beConstructedWith($repository, $filesystem);`
	`21`	`+ $filesystem->makePathRelativeToProjectDir(Argument::type('string'))->will(`
	`22`	`+ function (array $arguments): string {`
	`23`	`+ return $arguments[0];`
	`24`	`+ }`
	`25`	`+ );`
`20`	`26`	`}`
`21`	`27`
`22`	`28`	`function it_is_initializable()`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ class CloverCoverageSpec extends ObjectBehavior`
`18`	`18`	`function let(GrumPHP $grumPHP)`
`19`	`19`	`{`
`20`	`20`	`$grumPHP->getTaskConfiguration('clover_coverage')->willReturn([]);`
`21`		`- $this->beConstructedWith($grumPHP, new Filesystem());`
	`21`	`+ $this->beConstructedWith($grumPHP, new Filesystem($grumPHP->getWrappedObject()));`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`function it_is_initializable()`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`use Composer\Script\Event;`
`8`	`8`	`use GrumPHP\Collection\ProcessArgumentsCollection;`
`9`	`9`	`use GrumPHP\Process\ProcessFactory;`
`10`		`-use GrumPHP\Util\Filesystem;`
	`10`	`+use Symfony\Component\Filesystem\Filesystem;`
`11`	`11`
`12`	`12`	`class DevelopmentIntegrator`
`13`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,11 @@ public function getGitDir(): string`
`33`	`33`	`return $this->container->getParameter('git_dir');`
`34`	`34`	`}`
`35`	`35`
	`36`	`+ public function getConfigFile(): string`
	`37`	`+ {`
	`38`	`+ return $this->container->getParameter('config_file');`
	`39`	`+ }`
	`40`	`+`
`36`	`41`	`public function getHooksDir(): ?string`
`37`	`42`	`{`
`38`	`43`	`return $this->container->getParameter('hooks_dir');`