Merge pull request wikimedia#43 from bd808/issue/41

Better support for initial install of plugin

Author: legoktm

example/composer.json

@@ -9,7 +9,10 @@
  "wikimedia/composer-merge-plugin": "*@dev"
  },
  "config": {
- "preferred-install": "source"
+ "preferred-install": "source",
+ "classmap-authoritative": true,
+ "prepend-autoloader": false,
+ "optimize-autoloader": true
  },
  "extra": {
  "merge-plugin": {

src/MergePlugin.php

@@ -11,7 +11,7 @@
 namespace Wikimedia\Composer;
 
 use Composer\Composer;
-use Composer\Config;
+use Composer\DependencyResolver\Operation\InstallOperation;
 use Composer\EventDispatcher\EventSubscriberInterface;
 use Composer\Factory;
 use Composer\Installer;
@@ -115,10 +115,26 @@ class MergePlugin implements PluginInterface, EventSubscriberInterface
  protected $loadedFiles = array();
 
  /**
+ * Is this the first time that our plugin has been installed?
+ *
  * @var bool $pluginFirstInstall
  */
  protected $pluginFirstInstall;
 
+ /**
+ * Is the autoloader file supposed to be written out?
+ *
+ * @var bool $dumpAutoloader
+ */
+ protected $dumpAutoloader;
+
+ /**
+ * Is the autoloader file supposed to be optimized?
+ *
+ * @var bool $optimizeAutoloader
+ */
+ protected $optimizeAutoloader;
+
  /**
  * {@inheritdoc}
  */
@@ -136,23 +152,23 @@ public static function getSubscribedEvents()
  {
  return array(
  InstallerEvents::PRE_DEPENDENCIES_SOLVING => 'onDependencySolve',
- ScriptEvents::PRE_INSTALL_CMD => 'onInstallOrUpdate',
- ScriptEvents::PRE_UPDATE_CMD => 'onInstallOrUpdate',
- ScriptEvents::PRE_AUTOLOAD_DUMP => 'onInstallOrUpdate',
  PackageEvents::POST_PACKAGE_INSTALL => 'onPostPackageInstall',
  ScriptEvents::POST_INSTALL_CMD => 'onPostInstallOrUpdate',
  ScriptEvents::POST_UPDATE_CMD => 'onPostInstallOrUpdate',
+ ScriptEvents::PRE_AUTOLOAD_DUMP => 'onInstallUpdateOrDump',
+ ScriptEvents::PRE_INSTALL_CMD => 'onInstallUpdateOrDump',
+ ScriptEvents::PRE_UPDATE_CMD => 'onInstallUpdateOrDump',
  );
  }
 
  /**
- * Handle an event callback for an install or update command by checking
- * for "merge-patterns" in the "extra" data and merging package contents
- * if found.
+ * Handle an event callback for an install, update or dump command by
+ * checking for "merge-patterns" in the "extra" data and merging package
+ * contents if found.
  *
  * @param Event $event
  */
- public function onInstallOrUpdate(Event $event)
+ public function onInstallUpdateOrDump(Event $event)
  {
  $config = $this->readConfig($this->getRootPackage());
  if (isset($config['recurse'])) {
@@ -167,6 +183,14 @@ public function onInstallOrUpdate(Event $event)
  $this->devMode = $event->isDevMode();
  $this->mergePackages($config);
  }
+
+ if ($event->getName() === ScriptEvents::PRE_AUTOLOAD_DUMP) {
+ $this->dumpAutoloader = true;
+ $flags = $event->getFlags();
+ if (isset($flags['optimize'])) {
+ $this->optimizeAutoloader = $flags['optimize'];
+ }
+ }
  }
 
  /**
@@ -432,7 +456,14 @@ protected function mergeLinks(array $origin, array $merge, array &$dups)
  public function onDependencySolve(InstallerEvent $event)
  {
  if (empty($this->duplicateLinks)) {
+ // @codeCoverageIgnoreStart
+ // We shouldn't really ever be able to get here as this event is
+ // triggered inside Composer\Installer and should have been
+ // preceded by a pre-install or pre-update event but better to
+ // have an unneeded check than to break with some future change in
+ // the event system.
  return;
+ // @codeCoverageIgnoreEnd
  }
 
  $request = $event->getRequest();
@@ -456,10 +487,13 @@ public function onDependencySolve(InstallerEvent $event)
  */
  public function onPostPackageInstall(PackageEvent $event)
  {
- $package = $event->getOperation()->getPackage()->getName();
- if ($package === self::PACKAGE_NAME) {
- $this->debug('composer-merge-plugin installed');
- $this->pluginFirstInstall = true;
+ $op = $event->getOperation();
+ if ($op instanceof InstallOperation) {
+ $package = $op->getPackage()->getName();
+ if ($package === self::PACKAGE_NAME) {
+ $this->debug('composer-merge-plugin installed');
+ $this->pluginFirstInstall = true;
+ }
  }
  }
 
@@ -490,19 +524,28 @@ public function onPostInstallOrUpdate(Event $event)
  '</comment>'
  );
 
+ $config = $this->composer->getConfig();
+
+ $preferSource = $config->get('preferred-install') == 'source';
+ $preferDist = $config->get('preferred-install') == 'dist';
+
  $installer = Installer::create(
  $event->getIO(),
  // Create a new Composer instance to ensure full processing of
  // the merged files.
  Factory::create($event->getIO(), null, false)
  );
 
+ $installer->setPreferSource($preferSource);
+ $installer->setPreferDist($preferDist);
+ $installer->setDevMode($event->isDevMode());
+ $installer->setDumpAutoloader($this->dumpAutoloader);
+ $installer->setOptimizeAutoloader($this->optimizeAutoloader);
+
  // Force update mode so that new packages are processed rather
  // than just telling the user that composer.json and composer.lock
  // don't match.
  $installer->setUpdate(true);
- $installer->setDevMode($event->isDevMode());
- // TODO: can we set more flags to match the current run?
 
  $installer->run();
  }

tests/phpunit/MergePluginTest.php

@@ -19,10 +19,10 @@
 use Composer\Package\BasePackage;
 use Composer\Package\Package;
 use Composer\Package\RootPackage;
-use Composer\Script\CommandEvent;
+use Composer\Script\Event;
 use Composer\Script\ScriptEvents;
 use Prophecy\Argument;
-use \ReflectionMethod;
+use ReflectionMethod;
 
 /**
  * @covers Wikimedia\Composer\MergePlugin
@@ -96,9 +96,17 @@ function ($args) use ($that) {
  }
  );
 
+ $root->getSuggests()->shouldBeCalled();
+ $root->setSuggests(Argument::type('array'))->will(
+ function ($args) use ($that) {
+ $suggest = $args[0];
+ $that->assertEquals(1, count($suggest));
+ $that->assertArrayHasKey('ext-apc', $suggest);
+ }
+ );
+
  $root->getDevRequires()->shouldNotBeCalled();
  $root->getRepositories()->shouldNotBeCalled();
- $root->getSuggests()->shouldNotBeCalled();
 
  $extraInstalls = $this->triggerPlugin($root->reveal(), $dir);
 
@@ -215,8 +223,9 @@ function ($args) use ($that) {
 
  $extraInstalls = $this->triggerPlugin($root->reveal(), $dir);
 
- $this->assertEquals(1, count($extraInstalls));
+ $this->assertEquals(2, count($extraInstalls));
  $this->assertEquals('monolog/monolog', $extraInstalls[0][0]);
+ $this->assertEquals('foo', $extraInstalls[1][0]);
  }
 
  /**
@@ -434,15 +443,15 @@ protected function triggerPlugin($package, $directory)
  chdir($directory);
  $this->composer->getPackage()->willReturn($package);
 
- $event = new CommandEvent(
+ $event = new Event(
  ScriptEvents::PRE_INSTALL_CMD,
  $this->composer->reveal(),
  $this->io->reveal(),
  true, //dev mode
  array(),
  array()
  );
- $this->fixture->onInstallOrUpdate($event);
+ $this->fixture->onInstallUpdateOrDump($event);
 
  $requestInstalls = array();
  $request = $this->prophesize('Composer\DependencyResolver\Request');
@@ -465,6 +474,27 @@ function ($args) use (&$requestInstalls) {
  );
 
  $this->fixture->onDependencySolve($event);
+
+ $event = new Event(
+ ScriptEvents::PRE_AUTOLOAD_DUMP,
+ $this->composer->reveal(),
+ $this->io->reveal(),
+ true, //dev mode
+ array(),
+ array( 'optimize' => true )
+ );
+ $this->fixture->onInstallUpdateOrDump($event);
+
+ $event = new Event(
+ ScriptEvents::POST_INSTALL_CMD,
+ $this->composer->reveal(),
+ $this->io->reveal(),
+ true, //dev mode
+ array(),
+ array()
+ );
+ $this->fixture->onPostInstallOrUpdate($event);
+
  return $requestInstalls;
  }
 

tests/phpunit/fixtures/testOneMergeNoConflicts/composer.local.json

@@ -1,5 +1,8 @@
 {
  "require": {
  "monolog/monolog": "~1.0"
+ },
+ "suggest": {
+ "ext-apc": "caching is good"
  }
 }

tests/phpunit/fixtures/testOneMergeWithConflicts/composer.local.json

@@ -3,6 +3,7 @@
  "monolog/monolog": "1.10.0"
  },
  "require-dev": {
+ "foo": "^1.0",
  "xyzzy": "dev-master"
  }
 }