Commit 7485eaa5 authored by alexpott's avatar alexpott

Issue #2608174 by webflo, hussainweb: Update composer-merge-plugin to latest version

parent ec438eb4
......@@ -5,7 +5,7 @@
"license": "GPL-2.0+",
"require": {
"composer/installers": "^1.0.21",
"wikimedia/composer-merge-plugin": "^1.3.0"
"wikimedia/composer-merge-plugin": "~1.3"
},
"replace": {
"drupal/core": "~8.0"
......
......@@ -4,8 +4,8 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
"This file is @generated automatically"
],
"hash": "2be29019515c847055593ea41b88475d",
"content-hash": "f38613812a285c03a1a18458384fe0b1",
"hash": "dac77f10c1f7585fd1f7344c6a376338",
"content-hash": "73cbcb262208c5d802cb528279f2a95c",
"packages": [
{
"name": "composer/installers",
......@@ -1980,16 +1980,16 @@
},
{
"name": "wikimedia/composer-merge-plugin",
"version": "dev-master",
"version": "v1.3.0",
"source": {
"type": "git",
"url": "https://github.com/wikimedia/composer-merge-plugin.git",
"reference": "47bb3388cfeae41a38087ac8465a7d08fa92ea2e"
"reference": "bfed1f8d4eb97e9ba80eee57ea46229d7e5364d9"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/wikimedia/composer-merge-plugin/zipball/f770a4dd9771041f713f5ba3d8e4ba702015653d",
"reference": "47bb3388cfeae41a38087ac8465a7d08fa92ea2e",
"url": "https://api.github.com/repos/wikimedia/composer-merge-plugin/zipball/bfed1f8d4eb97e9ba80eee57ea46229d7e5364d9",
"reference": "bfed1f8d4eb97e9ba80eee57ea46229d7e5364d9",
"shasum": ""
},
"require": {
......@@ -1999,8 +1999,7 @@
"require-dev": {
"composer/composer": "1.0.*@dev",
"jakub-onderka/php-parallel-lint": "~0.8",
"phpspec/prophecy-phpunit": "~1.0",
"phpunit/phpunit": "~4.0",
"phpunit/phpunit": "~4.8|~5.0",
"squizlabs/php_codesniffer": "~2.1.0"
},
"type": "composer-plugin",
......@@ -2026,7 +2025,7 @@
}
],
"description": "Composer plugin to merge multiple composer.json files",
"time": "2015-09-22 21:14:25"
"time": "2015-11-06 20:31:16"
},
{
"name": "zendframework/zend-diactoros",
......
......@@ -96,58 +96,6 @@
"zikula"
]
},
{
"name": "wikimedia/composer-merge-plugin",
"version": "dev-master",
"version_normalized": "9999999-dev",
"source": {
"type": "git",
"url": "https://github.com/wikimedia/composer-merge-plugin.git",
"reference": "47bb3388cfeae41a38087ac8465a7d08fa92ea2e"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/wikimedia/composer-merge-plugin/zipball/f770a4dd9771041f713f5ba3d8e4ba702015653d",
"reference": "47bb3388cfeae41a38087ac8465a7d08fa92ea2e",
"shasum": ""
},
"require": {
"composer-plugin-api": "^1.0",
"php": ">=5.3.2"
},
"require-dev": {
"composer/composer": "1.0.*@dev",
"jakub-onderka/php-parallel-lint": "~0.8",
"phpspec/prophecy-phpunit": "~1.0",
"phpunit/phpunit": "~4.0",
"squizlabs/php_codesniffer": "~2.1.0"
},
"time": "2015-09-22 21:14:25",
"type": "composer-plugin",
"extra": {
"branch-alias": {
"dev-master": "1.3.x-dev"
},
"class": "Wikimedia\\Composer\\MergePlugin"
},
"installation-source": "dist",
"autoload": {
"psr-4": {
"Wikimedia\\Composer\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Bryan Davis",
"email": "bd808@wikimedia.org"
}
],
"description": "Composer plugin to merge multiple composer.json files"
},
{
"name": "composer/semver",
"version": "1.0.0",
......@@ -3858,5 +3806,56 @@
"keywords": [
"templating"
]
},
{
"name": "wikimedia/composer-merge-plugin",
"version": "v1.3.0",
"version_normalized": "1.3.0.0",
"source": {
"type": "git",
"url": "https://github.com/wikimedia/composer-merge-plugin.git",
"reference": "bfed1f8d4eb97e9ba80eee57ea46229d7e5364d9"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/wikimedia/composer-merge-plugin/zipball/bfed1f8d4eb97e9ba80eee57ea46229d7e5364d9",
"reference": "bfed1f8d4eb97e9ba80eee57ea46229d7e5364d9",
"shasum": ""
},
"require": {
"composer-plugin-api": "^1.0",
"php": ">=5.3.2"
},
"require-dev": {
"composer/composer": "1.0.*@dev",
"jakub-onderka/php-parallel-lint": "~0.8",
"phpunit/phpunit": "~4.8|~5.0",
"squizlabs/php_codesniffer": "~2.1.0"
},
"time": "2015-11-06 20:31:16",
"type": "composer-plugin",
"extra": {
"branch-alias": {
"dev-master": "1.3.x-dev"
},
"class": "Wikimedia\\Composer\\MergePlugin"
},
"installation-source": "dist",
"autoload": {
"psr-4": {
"Wikimedia\\Composer\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Bryan Davis",
"email": "bd808@wikimedia.org"
}
],
"description": "Composer plugin to merge multiple composer.json files"
}
]
{
"phabricator.uri" : "https://phabricator.wikimedia.org/",
"repository.callsign" : "GCMP",
"history.immutable" : false,
"unit.engine": "PhpunitTestEngine"
}
{
"exclude": "(^vendor/)",
"linters": {
"php": {
"type": "php",
"include": "(\\.php$)"
},
"json": {
"type": "json",
"include": "(\\.json$)"
}
}
}
[![Latest Stable Version](https://img.shields.io/packagist/v/wikimedia/composer-merge-plugin.svg?style=flat)](https://packagist.org/packages/wikimedia/composer-merge-plugin) [![License](https://img.shields.io/packagist/l/wikimedia/composer-merge-plugin.svg?style=flat)](https://github.com/wikimedia/composer-merge-plugin/blob/master/LICENSE)
[![Build Status](https://img.shields.io/travis/wikimedia/composer-merge-plugin.svg?style=flat)](https://travis-ci.org/wikimedia/composer-merge-plugin)
[![Code Coverage](https://img.shields.io/scrutinizer/coverage/g/wikimedia/composer-merge-plugin/master.svg?style=flat)](https://scrutinizer-ci.com/g/wikimedia/composer-merge-plugin/?branch=master)
[![Latest Stable Version]](https://packagist.org/packages/wikimedia/composer-merge-plugin) [![License]](https://github.com/wikimedia/composer-merge-plugin/blob/master/LICENSE)
[![Build Status]](https://travis-ci.org/wikimedia/composer-merge-plugin)
[![Code Coverage]](https://scrutinizer-ci.com/g/wikimedia/composer-merge-plugin/?branch=master)
Composer Merge Plugin
=====================
Merge one or more additional composer.json files at [Composer] runtime.
Merge multiple composer.json files at [Composer] runtime.
Composer Merge Plugin is intended to allow easier dependency management for
applications which ship a composer.json file and expect some deployments to
install additional Composer managed libraries. It does this by allowing the
application's top level `composer.json` file to provide a list of optional
additional configuration files. When Composer is run it will parse these files
and merge their configuration into the base configuration. This combined
configuration will allow downloading additional libraries and generating the
autoloader. It was specifically created to help with installation of
[MediaWiki] which has core Composer managed library requirements and optional
libraries and extensions which may also be managed via Composer.
and merge their configuration settings into the base configuration. This
combined configuration will then be used when downloading additional libraries
and generating the autoloader.
Composer Merge Plugin was created to help with installation of [MediaWiki]
which has core library requirements as well as optional libraries and
extensions which may be managed via Composer.
Installation
------------
```
$ composer require wikimedia/composer-merge-plugin
```
......@@ -40,58 +43,101 @@ Usage
"composer.local.json",
"extensions/*/composer.json"
],
"recurse": false,
"require": [
"submodule/composer.json"
],
"recurse": true,
"replace": false,
"merge-dev": true,
"merge-extra": false
}
}
}
```
The `include` key can specify either a single value or an array of values.
Each value is treated as a `glob()` pattern identifying additional
composer.json style configuration files to merge into the configuration for
the current Composer execution. By default the merge plugin is recursive, if
an included file also has a "merge-plugin" section it will also be processed.
This functionality can be disabled by setting `"recurse": false` inside the
"merge-plugin" section.
These sections of the found configuration files will be merged into the root
package configuration as though they were directly included in the top-level
composer.json file:
Plugin configuration
--------------------
The plugin reads its configuration from the `merge-plugin` section of your
composer.json's `extra` section. An `include` setting is required to tell
Composer Merge Plugin which file(s) to merge.
### include
The `include` setting can specify either a single value or an array of values.
Each value is treated as a PHP `glob()` pattern identifying additional
composer.json style configuration files to merge into the root package
configuration for the current Composer execution.
The following sections of the found configuration files will be merged into
the Composer root package configuration as though they were directly included
in the top-level composer.json file:
* [autoload](https://getcomposer.org/doc/04-schema.md#autoload)
* [autoload-dev](https://getcomposer.org/doc/04-schema.md#autoload-dev)
(optional, see [merge-dev](#merge-dev) below)
* [conflict](https://getcomposer.org/doc/04-schema.md#conflict)
* [provide](https://getcomposer.org/doc/04-schema.md#provide)
* [replace](https://getcomposer.org/doc/04-schema.md#replace)
* [repositories](https://getcomposer.org/doc/04-schema.md#repositories)
* [require](https://getcomposer.org/doc/04-schema.md#require)
* [require-dev](https://getcomposer.org/doc/04-schema.md#require-dev)
(optional, see [merge-dev](#merge-dev) below)
* [suggest](https://getcomposer.org/doc/04-schema.md#suggest)
* [extra](https://getcomposer.org/doc/04-schema.md#extra)
(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
a `merge-plugin` section it will also be processed. This functionality can be
disabled by adding a `"recurse": false` setting.
A `"merge-extra": true` setting enables the merging of the "extra" section of
included files as well. The normal merge mode for the extra section is to
accept the first version of any key found (e.g. a key in the master config
wins over the version found in an imported config). If `replace` mode is
active (see below) then this behavior changes and the last found key will win
(the key in the master config is replaced by the key in the imported config).
Note that the `merge-plugin` key itself is excluded from this merge process.
Your mileage with merging the extra section will vary depending on the plugins
being used and the order in which they are processed by Composer.
By default, Composer's normal conflict resolution engine is used to determine
which version of a package should be installed if multiple files specify the
same package. A `"replace": true` setting can be provided inside the
"merge-plugin" section to change to a "last version specified wins" conflict
resolution strategy. In this mode, duplicate package declarations in merged
files will overwrite the declarations made in earlier files. Files are loaded
in the order specified in the `include` section with globbed files being
loaded in alphabetical order.
### replace
By default, Composer's conflict resolution engine is used to determine which
version of a package should be installed when multiple files specify the same
package. A `"replace": true` setting can be provided to change to a "last
version specified wins" conflict resolution strategy. In this mode, duplicate
package declarations found in merged files will overwrite the declarations
made by earlier files. Files are loaded in the order specified by the
`include` setting with globbed files being processed in alphabetical order.
### merge-dev
By default, `autoload-dev` and `require-dev` sections of included files are
merged. A `"merge-dev": false` setting will disable this behavior.
### merge-extra
A `"merge-extra": true` setting enables the merging the contents of the
`extra` section of included files as well. The normal merge mode for the extra
section is to accept the first version of any key found (e.g. a key in the
master config wins over the version found in any imported config). If
`replace` mode is active ([see above](#replace)) then this behavior changes
and the last key found will win (e.g. the key in the master config is replaced
by the key in the imported config). The usefulness of merging the extra
section will vary depending on the Composer plugins being used and the order
in which they are processed by Composer.
Note that `merge-plugin` sections are excluded from the merge process, but are
always processed by the plugin unless [recursion](#recurse) is disabled.
Running tests
-------------
```
$ composer install
$ composer test
......@@ -100,6 +146,7 @@ $ composer test
Contributing
------------
Bug, feature requests and other issues should be reported to the [GitHub
project]. We accept code and documentation contributions via Pull Requests on
GitHub as well.
......@@ -119,6 +166,7 @@ GitHub as well.
License
-------
Composer Merge plugin is licensed under the MIT license. See the `LICENSE`
file for more details.
......@@ -129,3 +177,7 @@ file for more details.
[GitHub project]: https://github.com/wikimedia/composer-merge-plugin
[PSR-2 Coding Standard]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
[PHP Code Sniffer]: http://pear.php.net/package/PHP_CodeSniffer
[Latest Stable Version]: https://img.shields.io/packagist/v/wikimedia/composer-merge-plugin.svg?style=flat
[License]: https://img.shields.io/packagist/l/wikimedia/composer-merge-plugin.svg?style=flat
[Build Status]: https://img.shields.io/travis/wikimedia/composer-merge-plugin.svg?style=flat
[Code Coverage]: https://img.shields.io/scrutinizer/coverage/g/wikimedia/composer-merge-plugin/master.svg?style=flat
......@@ -18,8 +18,7 @@
"require-dev": {
"composer/composer": "1.0.*@dev",
"jakub-onderka/php-parallel-lint": "~0.8",
"phpspec/prophecy-phpunit": "~1.0",
"phpunit/phpunit": "~4.0",
"phpunit/phpunit": "~4.8|~5.0",
"squizlabs/php_codesniffer": "~2.1.0"
},
"autoload": {
......
......@@ -42,24 +42,60 @@ public function __construct($name, IOInterface $io)
/**
* Log a debug message
*
* Messages will be output at the "very verbose" logging level (eg `-vv`
* needed on the Composer command).
*
* @param string $message
*/
public function debug($message)
{
if ($this->inputOutput->isVeryVerbose()) {
$message = " <info>[{$this->name}]</info> {$message}";
$this->log($message);
}
}
/**
* Log an informative message
*
* Messages will be output at the "verbose" logging level (eg `-v` needed
* on the Composer command).
*
* @param string $message
*/
public function debug($message)
public function info($message)
{
if ($this->inputOutput->isVerbose()) {
$message = " <info>[{$this->name}]</info> {$message}";
$this->log($message);
}
}
if (method_exists($this->inputOutput, 'writeError')) {
$this->inputOutput->writeError($message);
} else {
// @codeCoverageIgnoreStart
// Backwards compatiblity for Composer before cb336a5
$this->inputOutput->write($message);
// @codeCoverageIgnoreEnd
}
/**
* Log a warning message
*
* @param string $message
*/
public function warning($message)
{
$message = " <error>[{$this->name}]</error> {$message}";
$this->log($message);
}
/**
* Write a message
*
* @param string $message
*/
protected function log($message)
{
if (method_exists($this->inputOutput, 'writeError')) {
$this->inputOutput->writeError($message);
} else {
// @codeCoverageIgnoreStart
// Backwards compatiblity for Composer before cb336a5
$this->inputOutput->write($message);
// @codeCoverageIgnoreEnd
}
}
}
......
......@@ -16,13 +16,17 @@
use Composer\Json\JsonFile;
use Composer\Package\BasePackage;
use Composer\Package\CompletePackage;
use Composer\Package\Link;
use Composer\Package\Loader\ArrayLoader;
use Composer\Package\RootAliasPackage;
use Composer\Package\RootPackage;
use Composer\Package\RootPackageInterface;
use Composer\Package\Version\VersionParser;
use UnexpectedValueException;
/**
* Processing for a composer.json file that will be merged into a RootPackage
* Processing for a composer.json file that will be merged into
* a RootPackageInterface
*
* @author Bryan Davis <bd808@bd808.com>
*/
......@@ -79,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.
*
......@@ -123,25 +138,30 @@ protected function loadPackage($json)
}
/**
* Merge this package into a RootPackage
* Merge this package into a RootPackageInterface
*
* @param RootPackage $root
* @param RootPackageInterface $root
* @param PluginState $state
*/
public function mergeInto(RootPackage $root, PluginState $state)
public function mergeInto(RootPackageInterface $root, PluginState $state)
{
$this->addRepositories($root);
$this->mergeRequires($root, $state);
$this->mergeDevRequires($root, $state);
$this->mergeRequires('require', $root, $state);
if ($state->isDevMode()) {
$this->mergeRequires('require-dev', $root, $state);
}
$this->mergePackageLinks('conflict', $root);
$this->mergePackageLinks('replace', $root);
$this->mergePackageLinks('provide', $root);
$this->mergeConflicts($root);
$this->mergeReplaces($root);
$this->mergeProvides($root);
$this->mergeSuggests($root);
$this->mergeAutoload($root);
$this->mergeDevAutoload($root);
$this->mergeAutoload('autoload', $root);
if ($state->isDevMode()) {
$this->mergeAutoload('devAutoload', $root);
}
$this->mergeExtra($root, $state);
}
......@@ -150,9 +170,9 @@ public function mergeInto(RootPackage $root, PluginState $state)
* Add a collection of repositories described by the given configuration
* to the given package and the global repository manager.
*
* @param RootPackage $root
* @param RootPackageInterface $root
*/
protected function addRepositories(RootPackage $root)
protected function addRepositories(RootPackageInterface $root)
{
if (!isset($this->json['repositories'])) {
return;
......@@ -164,7 +184,7 @@ protected function addRepositories(RootPackage $root)
if (!isset($repoJson['type'])) {
continue;
}
$this->logger->debug("Adding {$repoJson['type']} repository");
$this->logger->info("Adding {$repoJson['type']} repository");
$repo = $repoManager->createRepository(
$repoJson['type'],
$repoJson
......@@ -173,125 +193,102 @@ protected function addRepositories(RootPackage $root)
$newRepos[] = $repo;
}
$root->setRepositories(array_merge(
$unwrapped = self::unwrapIfNeeded($root, 'setRepositories');
$unwrapped->setRepositories(array_merge(
$newRepos,
$root->getRepositories()
));
}
/**
* Merge require into a RootPackage
* Merge require or require-dev into a RootPackageInterface
*
* @param RootPackage $root
* @param string $type 'require' or 'require-dev'
* @param RootPackageInterface $root
* @param PluginState $state
*/
protected function mergeRequires(RootPackage $root, PluginState $state)
{
$requires = $this->package->getRequires();
protected function mergeRequires(
$type,
RootPackageInterface $root,
PluginState $state
) {
$linkType = BasePackage::$supportedLinkTypes[$type];
$getter = 'get' . ucfirst($linkType['method']);
$setter = 'set' . ucfirst($linkType['method']);
$requires = $this->package->{$getter}();
if (empty($requires)) {
return;
}
$this->mergeStabilityFlags($root, $requires);
$dups = array();
$root->setRequires($this->mergeLinks(
$root->getRequires(),
$requires = $this->replaceSelfVersionDependencies(
$type,
$requires,
$state->replaceDuplicateLinks(),
$dups
));
$state->addDuplicateLinks('require', $dups);
}
/**
* Merge require-dev into RootPackage
*
* @param RootPackage $root
* @param PluginState $state
*/
protected function mergeDevRequires(RootPackage $root, PluginState $state)
{
$requires = $this->package->getDevRequires();
if (empty($requires)) {
return;
}
$this->mergeStabilityFlags($root, $requires);
$root
);
$dups = array();
$root->setDevRequires($this->mergeLinks(
$root->getDevRequires(),
$root->{$setter}($this->mergeOrDefer(
$type,
$root->{$getter}(),
$requires,
$state->replaceDuplicateLinks(),
$dups
$state
));
$state->addDuplicateLinks('require-dev', $dups);
}
/**
* Merge two collections of package links and collect duplicates for
* subsequent processing.
*
* @param string $type 'require' or 'require-dev'
* @param array $origin Primary collection
* @param array $merge Additional collection
* @param bool $replace Replace exising links?
* @param array &dups Duplicate storage
* @param PluginState $state
* @return array Merged collection
*/
protected function mergeLinks(
protected function mergeOrDefer(
$type,
array $origin,
array $merge,
$replace,
array &$dups
$state
) {
$dups = array();
foreach ($merge as $name => $link) {
if (!isset($origin[$name]) || $replace) {
$this->logger->debug("Merging <comment>{$name}</comment>");
if (!isset($origin[$name]) || $state->replaceDuplicateLinks()) {
$this->logger->info("Merging <comment>{$name}</comment>");
$origin[$name] = $link;
} else {
// Defer to solver.
$this->logger->debug(
$this->logger->info(
"Deferring duplicate <comment>{$name}</comment>"
);
$dups[] = $link;
}
}
$state->addDuplicateLinks($type, $dups);
return $origin;
}
/**
* Merge autoload into a RootPackage
* Merge autoload or autoload-dev into a RootPackageInterface
*
* @param RootPackage $root
* @param string $type 'autoload' or 'devAutoload'
* @param RootPackageInterface $root
*/
protected function mergeAutoload(RootPackage $root)
protected function mergeAutoload($type, RootPackageInterface $root)
{
$autoload = $this->package->getAutoload();
if (empty($autoload)) {
return;
}
$root->setAutoload(array_merge_recursive(
$root->getAutoload(),
$this->fixRelativePaths($autoload)
));
}
$getter = 'get' . ucfirst($type);
$setter = 'set' . ucfirst($type);
/**
* Merge autoload-dev into a RootPackage
*
* @param RootPackage $root
*/
protected function mergeDevAutoload(RootPackage $root)
{
$autoload = $this->package->getDevAutoload();
$autoload = $this->package->{$getter}();
if (empty($autoload)) {