More refactoring

getkirby · Feb 6, 2019 · 162497e · 162497e
1 parent 8f75f1b
commit 162497e
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 96 deletions.
diff --git a/src/ComposerInstaller/Installer.php b/src/ComposerInstaller/Installer.php
@@ -22,9 +22,9 @@ class Installer extends LibraryInstaller
      * @param  string $packageType
      * @return bool
      */
-    public function supports($packageType)
+    public function supports($packageType): bool
     {
-        throw new RuntimeException('This method needs to be overridden.');
+        throw new RuntimeException('This method needs to be overridden.'); // @codeCoverageIgnore
     }
 
     /**
@@ -73,9 +73,7 @@ protected function postInstall(PackageInterface $package)
         if (is_dir($packageVendorDir)) {
             $success = $this->filesystem->removeDirectory($packageVendorDir);
             if (!$success) {
-                // @codeCoverageIgnoreStart
-                throw new RuntimeException('Could not completely delete ' . $path . ', aborting.');
-                // @codeCoverageIgnoreEnd
+                throw new RuntimeException('Could not completely delete ' . $path . ', aborting.'); // @codeCoverageIgnore
             }
         }
     }

diff --git a/src/ComposerInstaller/Plugin.php b/src/ComposerInstaller/Plugin.php
@@ -23,10 +23,8 @@ class Plugin implements PluginInterface
      */
     public function activate(Composer $composer, IOInterface $io)
     {
-        $cmsInstaller = new CmsInstaller($io, $composer);
-        $composer->getInstallationManager()->addInstaller($cmsInstaller);
-
-        $pluginInstaller = new PluginInstaller($io, $composer);
-        $composer->getInstallationManager()->addInstaller($pluginInstaller);
+        $installationManager = $composer->getInstallationManager();
+        $installationManager->addInstaller(new CmsInstaller($io, $composer));
+        $installationManager->addInstaller(new PluginInstaller($io, $composer));
     }
 }
diff --git a/src/ComposerInstaller/PluginInstaller.php b/src/ComposerInstaller/PluginInstaller.php
@@ -33,7 +33,7 @@ public function supports($packageType): bool
     public function getInstallPath(PackageInterface $package): string
     {
         // place into `vendor` directory as usual if Pluginkit is not supported
-        if (!$this->supportsPluginkit($package)) {
+        if ($this->supportsPluginkit($package) !== true) {
             return parent::getInstallPath($package);
         }
 
@@ -73,7 +73,7 @@ public function getInstallPath(PackageInterface $package): string
     protected function postInstall(PackageInterface $package)
     {
         // only continue if Pluginkit is supported
-        if (!$this->supportsPluginkit($package)) {
+        if ($this->supportsPluginkit($package) !== true) {
             return;
         }
 
@@ -82,8 +82,8 @@ protected function postInstall(PackageInterface $package)
 
     /**
      * Checks if the package has explicitly required this installer;
-     * otherwise the installer will fall back to the behavior of the LibraryInstaller
-     * (Pluginkit is not yet supported by the plugin)
+     * otherwise (if the Pluginkit is not yet supported by the plugin)
+     * the installer will fall back to the behavior of the LibraryInstaller
      *
      * @param  PackageInterface $package
      * @return bool

diff --git a/tests/ComposerInstaller/CmsInstallerTest.php b/tests/ComposerInstaller/CmsInstallerTest.php
@@ -3,7 +3,6 @@
 namespace Kirby\ComposerInstaller;
 
 use Composer\Package\Package;
-use Composer\Package\RootPackage;
 use Composer\Repository\InstalledArrayRepository;
 
 class CmsInstallerTest extends InstallerTestCase
@@ -30,11 +29,9 @@ public function testGetInstallPathDefault()
 
     public function testGetInstallPathCustomPaths()
     {
-        $rootPackage = new RootPackage('getkirby/amazing-site', '1.0.0.0', '1.0.0');
-        $rootPackage->setExtra([
+        $this->initRootPackage()->setExtra([
             'kirby-cms-path' => 'cms'
         ]);
-        $this->composer->setPackage($rootPackage);
 
         $package = $this->cmsPackageFactory();
         $this->assertEquals('cms', $this->installer->getInstallPath($package));
@@ -46,11 +43,9 @@ public function testGetInstallPathCustomPaths()
      */
     public function testGetInstallPathUnsafe1()
     {
-        $rootPackage = new RootPackage('getkirby/amazing-site', '1.0.0.0', '1.0.0');
-        $rootPackage->setExtra([
+        $this->initRootPackage()->setExtra([
             'kirby-cms-path' => '.'
         ]);
-        $this->composer->setPackage($rootPackage);
 
         $package = $this->cmsPackageFactory();
         $this->installer->getInstallPath($package);
@@ -62,17 +57,9 @@ public function testGetInstallPathUnsafe1()
      */
     public function testGetInstallPathUnsafe2()
     {
-        $rootPackage = new RootPackage('getkirby/amazing-site', '1.0.0.0', '1.0.0');
-        $rootPackage->setExtra([
+        $this->initRootPackage()->setExtra([
             'kirby-cms-path' => 'vendor'
         ]);
-        $this->composer->setPackage($rootPackage);
-
-        $this->composer->getConfig()->merge([
-            'config' => [
-                'vendor-dir' => 'vendor'
-            ]
-        ]);
 
         $package = $this->cmsPackageFactory();
         $this->installer->getInstallPath($package);
@@ -84,11 +71,9 @@ public function testGetInstallPathUnsafe2()
      */
     public function testGetInstallPathUnsafe3()
     {
-        $rootPackage = new RootPackage('getkirby/amazing-site', '1.0.0.0', '1.0.0');
-        $rootPackage->setExtra([
+        $this->initRootPackage()->setExtra([
             'kirby-cms-path' => 'custom-vendor'
         ]);
-        $this->composer->setPackage($rootPackage);
 
         $package = $this->cmsPackageFactory();
         $this->assertEquals('custom-vendor', $this->installer->getInstallPath($package));
@@ -105,9 +90,6 @@ public function testGetInstallPathUnsafe3()
 
     public function testInstall()
     {
-        $rootPackage = new RootPackage('getkirby/amazing-site', '1.0.0.0', '1.0.0');
-        $this->composer->setPackage($rootPackage);
-
         $package = $this->cmsPackageFactory();
         $this->assertEquals('kirby', $this->installer->getInstallPath($package));
         $this->installer->install(new InstalledArrayRepository(), $package);
@@ -116,13 +98,10 @@ public function testInstall()
         $this->assertDirectoryNotExists($this->testDir . '/kirby/vendor');
     }
 
-    public function testUpdateCode()
+    public function testUpdate()
     {
         $repo = new InstalledArrayRepository();
 
-        $rootPackage = new RootPackage('getkirby/amazing-site', '1.0.0.0', '1.0.0');
-        $this->composer->setPackage($rootPackage);
-
         $initial = $this->cmsPackageFactory();
         $this->assertEquals('kirby', $this->installer->getInstallPath($initial));
         $this->installer->install($repo, $initial);
@@ -131,8 +110,10 @@ public function testUpdateCode()
         $this->assertFileExists($this->testDir . '/kirby/vendor-created.txt');
         $this->assertDirectoryNotExists($this->testDir . '/kirby/vendor');
 
-        unlink($this->testDir . '/kirby/index.php');
+        $this->filesystem->emptyDirectory($this->testDir . '/kirby');
         $this->assertFileNotExists($this->testDir . '/kirby/index.php');
+        $this->assertFileNotExists($this->testDir . '/kirby/vendor-created.txt');
+        $this->assertDirectoryNotExists($this->testDir . '/kirby/vendor');
 
         $target = $this->cmsPackageFactory();
         $this->assertEquals('kirby', $this->installer->getInstallPath($target));
@@ -154,7 +135,7 @@ protected function cmsPackageFactory(): Package
         $package->setInstallationSource('dist');
         $package->setDistType('mock');
         $package->setExtra([
-            'with-vendor-dir' => true
+            'with-vendor-dir' => true // tell the MockDownloader to create a `vendor` dir
         ]);
 
         return $package;

diff --git a/tests/ComposerInstaller/InstallerTestCase.php b/tests/ComposerInstaller/InstallerTestCase.php
@@ -8,15 +8,18 @@
 use Composer\Config;
 use Composer\Downloader\DownloadManager;
 use Composer\IO\NullIO;
+use Composer\Package\RootPackage;
 use Composer\Util\Filesystem;
 
 class InstallerTestCase extends TestCase
 {
     protected $testDir;
-    protected $io;
+
     protected $composer;
     protected $filesystem;
     protected $installer;
+    protected $io;
+    protected $rootPackage;
 
     public function setUp()
     {
@@ -32,14 +35,25 @@ public function setUp()
         $this->composer->setDownloadManager($downloadManager);
 
         // initialize test dir and switch to it to make relative paths work
-        if (!is_dir($this->testDir)) {
-            $this->filesystem->ensureDirectoryExists($this->testDir);
-        }
+        $this->filesystem->ensureDirectoryExists($this->testDir);
         chdir($this->testDir);
     }
 
     public function tearDown()
     {
         $this->filesystem->removeDirectory($this->testDir);
     }
+
+    /**
+     * Initializes a root Kirby site package and returns it
+     *
+     * @return RootPackage
+     */
+    public function initRootPackage(): RootPackage
+    {
+        $rootPackage = new RootPackage('getkirby/amazing-site', '1.0.0.0', '1.0.0');
+        $this->composer->setPackage($rootPackage);
+
+        return $rootPackage;
+    }
 }