Merge pull request wikimedia#93 from bd808/feature/require

Add support for required files

Author: legoktm

README.md

@@ -43,6 +43,9 @@ Usage
  "composer.local.json",
  "extensions/*/composer.json"
  ],
+ "require": [
+ "submodule/composer.json"
+ ],
  "recurse": true,
  "replace": false,
  "merge-dev": true,
@@ -87,6 +90,11 @@ in the top-level composer.json file:
  (optional, see [merge-extra](#merge-extra) below)
 
 
+### require
+
+The `require` setting is identical to `[include](#include)` except when
+a pattern fails to match at least one file then it will cause an error.
+
 ### recurse
 
 By default the merge plugin is recursive; if an included file has

src/Merge/ExtraPackage.php

@@ -83,6 +83,17 @@ public function getIncludes()
  $this->json['extra']['merge-plugin']['include'] : array();
  }
 
+ /**
+ * Get list of additional packages to require if precessing recursively.
+ *
+ * @return array
+ */
+ public function getRequires()
+ {
+ return isset($this->json['extra']['merge-plugin']['require']) ?
+ $this->json['extra']['merge-plugin']['require'] : array();
+ }
+
  /**
  * Read the contents of a composer.json style file into an array.
  *

src/Merge/MissingFileException.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * This file is part of the Composer Merge plugin.
+ *
+ * Copyright (C) 2015 Bryan Davis, Wikimedia Foundation, and contributors
+ *
+ * This software may be modified and distributed under the terms of the MIT
+ * license. See the LICENSE file for details.
+ */
+
+namespace Wikimedia\Composer\Merge;
+
+/**
+ * @author Bryan Davis <bd808@bd808.com>
+ */
+class MissingFileException extends \RuntimeException
+{
+}

src/Merge/PluginState.php

@@ -29,6 +29,11 @@ class PluginState
  */
  protected $includes = array();
 
+ /**
+ * @var array $requires
+ */
+ protected $requires = array();
+
  /**
  * @var array $duplicateLinks
  */
@@ -106,6 +111,7 @@ public function loadSettings()
  $config = array_merge(
  array(
  'include' => array(),
+ 'require' => array(),
  'recurse' => true,
  'replace' => false,
  'merge-dev' => true,
@@ -116,6 +122,8 @@ public function loadSettings()
 
  $this->includes = (is_array($config['include'])) ?
  $config['include'] : array($config['include']);
+ $this->requires = (is_array($config['require'])) ?
+ $config['require'] : array($config['require']);
  $this->recurse = (bool)$config['recurse'];
  $this->replace = (bool)$config['replace'];
  $this->mergeDev = (bool)$config['merge-dev'];
@@ -132,6 +140,16 @@ public function getIncludes()
  return $this->includes;
  }
 
+ /**
+ * Get list of filenames and/or glob patterns to require
+ *
+ * @return array
+ */
+ public function getRequires()
+ {
+ return $this->requires;
+ }
+
  /**
  * Set the first install flag
  *

src/MergePlugin.php

@@ -11,6 +11,7 @@
 namespace Wikimedia\Composer;
 
 use Wikimedia\Composer\Merge\ExtraPackage;
+use Wikimedia\Composer\Merge\MissingFileException;
 use Wikimedia\Composer\Merge\PluginState;
 
 use Composer\Composer;
@@ -144,7 +145,8 @@ public function onInstallUpdateOrDump(Event $event)
  {
  $this->state->loadSettings();
  $this->state->setDevMode($event->isDevMode());
- $this->mergeIncludes($this->state->getIncludes());
+ $this->mergeFiles($this->state->getIncludes(), false);
+ $this->mergeFiles($this->state->getRequires(), true);
 
  if ($event->getName() === ScriptEvents::PRE_AUTOLOAD_DUMP) {
  $this->state->setDumpAutoloader(true);
@@ -159,16 +161,29 @@ public function onInstallUpdateOrDump(Event $event)
  * Find configuration files matching the configured glob patterns and
  * merge their contents with the master package.
  *
- * @param array $includes List of files/glob patterns
+ * @param array $patterns List of files/glob patterns
+ * @param bool $required Are the patterns required to match files?
+ * @throws MissingFileException when required and a pattern returns no
+ * results
  */
- protected function mergeIncludes(array $includes)
+ protected function mergeFiles(array $patterns, $required = false)
  {
  $root = $this->composer->getPackage();
- foreach (array_reduce(
- array_map('glob', $includes),
- 'array_merge',
- array()
- ) as $path) {
+
+ $files = array_map(
+ function ($files, $pattern) use ($required) {
+ if ($required && !$files) {
+ throw new MissingFileException(
+ "merge-plugin: No files matched required '{$pattern}'"
+ );
+ }
+ return $files;
+ },
+ array_map('glob', $patterns),
+ $patterns
+ );
+
+ foreach (array_reduce($files, 'array_merge', array()) as $path) {
  $this->mergeFile($root, $path);
  }
  }
@@ -193,7 +208,8 @@ protected function mergeFile(RootPackageInterface $root, $path)
  $package->mergeInto($root, $this->state);
 
  if ($this->state->recurseIncludes()) {
- $this->mergeIncludes($package->getIncludes());
+ $this->mergeFiles($package->getIncludes(), false);
+ $this->mergeFiles($package->getRequires(), true);
  }
  }
 

tests/phpunit/MergePluginTest.php

@@ -188,7 +188,6 @@ function ($args) use ($that) {
  }
 
 
-
  /**
  * Given a root package with no requires
  * and a composer.local.json with one require, which includes a composer.local.2.json
@@ -225,6 +224,7 @@ function ($args) use (&$packages) {
  $this->assertEquals(0, count($extraInstalls));
  }
 
+
  /**
  * Given a root package with no requires that disables recursion
  * and a composer.local.json with one require, which includes a composer.local.2.json
@@ -261,6 +261,7 @@ function ($args) use (&$packages) {
  $this->assertEquals(0, count($extraInstalls));
  }
 
+
  /**
  * Given a root package with requires
  * and a composer.local.json with requires
@@ -311,6 +312,7 @@ function ($args) use ($that) {
  $this->assertEquals('foo', $extraInstalls[1][0]);
  }
 
+
  /**
  * Given a root package
  * and a composer.local.json with a repository
@@ -391,6 +393,7 @@ function ($args) use ($that) {
  $this->assertEquals(0, count($extraInstalls));
  }
 
+
  /**
  * Given a root package
  * and a composer.local.json with required packages
@@ -449,6 +452,7 @@ function ($args) use ($that, &$expects) {
  $this->assertEquals(0, count($extraInstalls));
  }
 
+
  public function testMergedAutoload()
  {
  $that = $this;
@@ -528,6 +532,7 @@ function ($args) use ($that) {
  );
  }
 
+
  /**
  * Given a root package with an extra section
  * and a composer.local.json with an extra section with no conflicting keys
@@ -564,6 +569,7 @@ function ($args) use ($that) {
  $this->assertEquals(0, count($extraInstalls));
  }
 
+
  /**
  * Given a root package with an extra section
  * and a composer.local.json with an extra section with a conflicting key
@@ -600,6 +606,7 @@ function ($args) use ($that) {
  $this->assertEquals(0, count($extraInstalls));
  }
 
+
  /**
  * Given a root package with an extra section
  * and replace mode is active
@@ -637,6 +644,7 @@ function ($args) use ($that) {
  $this->assertEquals(0, count($extraInstalls));
  }
 
+
  /**
  * @dataProvider provideOnPostPackageInstall
  * @param string $package Package installed
@@ -665,6 +673,7 @@ public function testOnPostPackageInstall($package, $first, $locked)
  $this->assertEquals($locked, $this->getState()->isLocked());
  }
 
+
  public function provideOnPostPackageInstall()
  {
  return array(
@@ -674,6 +683,7 @@ public function provideOnPostPackageInstall()
  );
  }
 
+
  /**
  * Given a root package with a branch alias
  * When the plugin is run
@@ -768,6 +778,7 @@ function ($args) use ($that, &$expects) {
  $extraInstalls = $this->triggerPlugin($root->reveal(), $dir);
  }
 
+
  /**
  * Test replace link with self.version as version constraint.
  */
@@ -856,6 +867,7 @@ function ($args) use ($that, &$expects) {
  $extraInstalls = $this->triggerPlugin($root->reveal(), $dir);
  }
 
+
  /**
  * Given a root package with merge-dev=false
  * and an include with require-dev and autoload-dev sections
@@ -884,6 +896,39 @@ function ($args) use ($that) {
  }
 
 
+ /**
+ * @expectedException \Wikimedia\Composer\Merge\MissingFileException
+ */
+ public function testMissingRequireThrowsException()
+ {
+ $dir = $this->fixtureDir(__FUNCTION__);
+ $root = $this->rootFromJson("{$dir}/composer.json");
+ $root->getRequires()->shouldNotBeCalled();
+ $this->triggerPlugin($root->reveal(), $dir);
+ }
+
+
+ public function testRequire()
+ {
+ $that = $this;
+ $dir = $this->fixtureDir(__FUNCTION__);
+
+ $root = $this->rootFromJson("{$dir}/composer.json");
+
+ $root->setRequires(Argument::type('array'))->will(
+ function ($args) use ($that) {
+ $requires = $args[0];
+ $that->assertEquals(1, count($requires));
+ $that->assertArrayHasKey('monolog/monolog', $requires);
+ }
+ );
+
+ $extraInstalls = $this->triggerPlugin($root->reveal(), $dir);
+
+ $this->assertEquals(0, count($extraInstalls));
+ }
+
+
  /**
  * @param RootPackage $package
  * @param string $directory Working directory for composer run

tests/phpunit/fixtures/testMissingRequireThrowsException/composer.json

@@ -0,0 +1,10 @@
+{
+ "require": {
+ "wikimedia/composer-merge-plugin": "dev-master"
+ },
+ "extra": {
+ "merge-plugin": {
+ "require": "glob/*.json"
+ }
+ }
+}

tests/phpunit/fixtures/testRequire/composer.json

@@ -0,0 +1,7 @@
+{
+ "extra": {
+ "merge-plugin": {
+ "require": "composer.local.json"
+ }
+ }
+}

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

@@ -0,0 +1,5 @@
+{
+ "require": {
+ "monolog/monolog": "^1.0"
+ }
+}