ExtraPackage::mergeOrDefer() - Code Metrics - Inspection of "Add source reference information for merged packag..." - wikimedia/composer-merge-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#103)

by Florian

created 2016-03-30 16:35 UTC

ExtraPackage::mergeOrDefer() B

↳ Parent: ExtraPackage

Complexity

Conditions	4
Paths	3

Size

Total Lines	22
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	4

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	22
ccs	14
cts	14
cp	1
rs	8.9197
cc	4
eloc	16
nc	3
nop	4
crap	4

<?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;

use Wikimedia\Composer\Logger;

use Composer\Composer;
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 RootPackageInterface
 *
 * @author Bryan Davis <[email protected]>
 */
class ExtraPackage
{

    /**
     * @var Composer $composer
     */
    protected $composer;

    /**
     * @var Logger $logger
     */
    protected $logger;

    /**
     * @var string $path
     */
    protected $path;

    /**
     * @var array $json
     */
    protected $json;

    /**
     * @var CompletePackage $package
     */
    protected $package;

    /**
     * @var VersionParser $versionParser
     */
    protected $versionParser;

    /**
     * @param string $path Path to composer.json file
     * @param Composer $composer
     * @param Logger $logger
     */
    public function __construct($path, Composer $composer, Logger $logger)
    {
        $this->path = $path;
        $this->composer = $composer;
        $this->logger = $logger;
        $this->json = $this->readPackageJson($path);
        $this->package = $this->loadPackage($this->json);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->versionParser = new VersionParser();
    }

    /**
     * Get list of additional packages to include if precessing recursively.
     *
     * @return array
     */
    public function getIncludes()
    {
        return isset($this->json['extra']['merge-plugin']['include']) ?
            $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.
     *
     * The package contents are fixed up to be usable to create a Package
     * object by providing dummy "name" and "version" values if they have not
     * been provided in the file. This is consistent with the default root
     * package loading behavior of Composer.
     *
     * @param string $path
     * @return array
     */
    protected function readPackageJson($path)
    {
        $file = new JsonFile($path);
        $json = $file->read();
        if (!isset($json['name'])) {
            $json['name'] = 'merge-plugin/' .
                strtr($path, DIRECTORY_SEPARATOR, '-');
        }
        if (!isset($json['version'])) {
            $json['version'] = '1.0.0';
        }
        return $json;
    }

    /**
     * @param string $json
     * @return CompletePackage
     */
    protected function loadPackage($json)
    {
        $loader = new ArrayLoader();
        $package = $loader->load($json);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        // @codeCoverageIgnoreStart
        if (!$package instanceof CompletePackage) {
            throw new UnexpectedValueException(
                'Expected instance of CompletePackage, got ' .
                get_class($package)
            );
        }
        // @codeCoverageIgnoreEnd
        return $package;
    }

    /**
     * Merge this package into a RootPackageInterface
     *
     * @param RootPackageInterface $root
     * @param PluginState $state
     */
    public function mergeInto(RootPackageInterface $root, PluginState $state)
    {
        $this->addRepositories($root);

        $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->mergeSuggests($root);

        $this->mergeAutoload('autoload', $root);
        if ($state->isDevMode()) {
            $this->mergeAutoload('devAutoload', $root);
        }

        $this->mergeExtra($root, $state);
        $this->mergeReferences($root);
    }

    /**
     * Add a collection of repositories described by the given configuration
     * to the given package and the global repository manager.
     *
     * @param RootPackageInterface $root
     */
    protected function addRepositories(RootPackageInterface $root)
    {
        if (!isset($this->json['repositories'])) {
            return;
        }
        $repoManager = $this->composer->getRepositoryManager();
        $newRepos = array();

        foreach ($this->json['repositories'] as $repoJson) {
            if (!isset($repoJson['type'])) {
                continue;
            }
            $this->logger->info("Adding {$repoJson['type']} repository");
            $repo = $repoManager->createRepository(
                $repoJson['type'],
                $repoJson
            );
            $repoManager->addRepository($repo);
            $newRepos[] = $repo;
        }

        $unwrapped = self::unwrapIfNeeded($root, 'setRepositories');
        $unwrapped->setRepositories(array_merge(
            $newRepos,
            $root->getRepositories()
        ));
    }

    /**
     * Merge require or require-dev into a RootPackageInterface
     *
     * @param string $type 'require' or 'require-dev'
     * @param RootPackageInterface $root
     * @param PluginState $state
     */
    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);

        $requires = $this->replaceSelfVersionDependencies(
            $type,
            $requires,
            $root
        );

        $root->{$setter}($this->mergeOrDefer(
            $type,
            $root->{$getter}(),
            $requires,
            $state
        ));
    }

    /**
     * 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 PluginState $state
     * @return array Merged collection
     */
    protected function mergeOrDefer(
        $type,
        array $origin,
        array $merge,
        $state
    ) {
        $dups = array();
        foreach ($merge as $name => $link) {
            if (!isset($origin[$name]) || $state->replaceDuplicateLinks()) {
                $this->logger->info("Merging <comment>{$name}</comment>");
                $origin[$name] = $link;
            } else {
                // Defer to solver.
                $this->logger->info(
                    "Deferring duplicate <comment>{$name}</comment>"
                );
                $dups[] = $link;
            }
        }
        $state->addDuplicateLinks($type, $dups);
        return $origin;
    }

    /**
     * Merge autoload or autoload-dev into a RootPackageInterface
     *
     * @param string $type 'autoload' or 'devAutoload'
     * @param RootPackageInterface $root
     */
    protected function mergeAutoload($type, RootPackageInterface $root)
    {
        $getter = 'get' . ucfirst($type);
        $setter = 'set' . ucfirst($type);

        $autoload = $this->package->{$getter}();
        if (empty($autoload)) {
            return;
        }

        $unwrapped = self::unwrapIfNeeded($root, $setter);
        $unwrapped->{$setter}(array_merge_recursive(
            $root->{$getter}(),
            $this->fixRelativePaths($autoload)
        ));
    }

    /**
     * Fix a collection of paths that are relative to this package to be
     * relative to the base package.
     *
     * @param array $paths
     * @return array
     */
    protected function fixRelativePaths(array $paths)
    {
        $base = dirname($this->path);
        $base = ($base === '.') ? '' : "{$base}/";

        array_walk_recursive(
            $paths,
            function (&$path) use ($base) {
                $path = "{$base}{$path}";
            }
        );
        return $paths;
    }

    /**
     * Extract and merge stability flags from the given collection of
     * requires and merge them into a RootPackageInterface
     *
     * @param RootPackageInterface $root
     * @param array $requires
     */
    protected function mergeStabilityFlags(
        RootPackageInterface $root,
        array $requires
    ) {
        $flags = $root->getStabilityFlags();
        $sf = new StabilityFlags($flags, $root->getMinimumStability());

        $unwrapped = self::unwrapIfNeeded($root, 'setStabilityFlags');
        $unwrapped->setStabilityFlags(array_merge(
            $flags,
            $sf->extractAll($requires)
        ));
    }

    /**
     * Merge package links of the given type  into a RootPackageInterface
     *
     * @param string $type 'conflict', 'replace' or 'provide'
     * @param RootPackageInterface $root
     */
    protected function mergePackageLinks($type, RootPackageInterface $root)
    {
        $linkType = BasePackage::$supportedLinkTypes[$type];
        $getter = 'get' . ucfirst($linkType['method']);
        $setter = 'set' . ucfirst($linkType['method']);

        $links = $this->package->{$getter}();
        if (!empty($links)) {
            $unwrapped = self::unwrapIfNeeded($root, $setter);
            // @codeCoverageIgnoreStart
            if ($root !== $unwrapped) {
                $this->logger->warning(
                    'This Composer version does not support ' .
                    "'{$type}' merging for aliased packages."
                );
            }
            // @codeCoverageIgnoreEnd
            $unwrapped->{$setter}(array_merge(
                $root->{$getter}(),
                $this->replaceSelfVersionDependencies($type, $links, $root)
            ));
        }
    }

    /**
     * Merge suggested packages into a RootPackageInterface
     *
     * @param RootPackageInterface $root
     */
    protected function mergeSuggests(RootPackageInterface $root)
    {
        $suggests = $this->package->getSuggests();
        if (!empty($suggests)) {
            $unwrapped = self::unwrapIfNeeded($root, 'setSuggests');
            $unwrapped->setSuggests(array_merge(
                $root->getSuggests(),
                $suggests
            ));
        }
    }

    /**
     * Merge extra config into a RootPackageInterface
     *
     * @param RootPackageInterface $root
     * @param PluginState $state
     */
    public function mergeExtra(RootPackageInterface $root, PluginState $state)
    {
        $extra = $this->package->getExtra();
        unset($extra['merge-plugin']);
        if (!$state->shouldMergeExtra() || empty($extra)) {
            return;
        }

        $rootExtra = $root->getExtra();
        $unwrapped = self::unwrapIfNeeded($root, 'setExtra');

        if ($state->replaceDuplicateLinks()) {
            $unwrapped->setExtra(
                array_merge($rootExtra, $extra)
            );

        } else {
            foreach (array_intersect(
                array_keys($extra),
                array_keys($rootExtra)
            ) as $key) {
                $this->logger->info(
                    "Ignoring duplicate <comment>{$key}</comment> in ".
                    "<comment>{$this->path}</comment> extra config."
                );
            }
            $unwrapped->setExtra(
                array_merge($extra, $rootExtra)
            );
        }
    }

    /**
     * Update Links with a 'self.version' constraint with the root package's
     * version.
     *
     * @param string $type Link type
     * @param array $links
     * @param RootPackageInterface $root
     * @return array
     */
    protected function replaceSelfVersionDependencies(
        $type,
        array $links,
        RootPackageInterface $root
    ) {
        $linkType = BasePackage::$supportedLinkTypes[$type];
        $version = $root->getVersion();
        $prettyVersion = $root->getPrettyVersion();
        $vp = $this->versionParser;

        $method = 'get' . ucfirst($linkType['method']);
        $packages = $root->$method();

        return array_map(
            function ($link) use ($linkType, $version, $prettyVersion, $vp, $packages) {
                if ('self.version' === $link->getPrettyConstraint()) {
                    if (isset($packages[$link->getSource()])) {
                        /** @var Link $package */
                        $package = $packages[$link->getSource()];
                        return new Link(
                            $link->getSource(),
                            $link->getTarget(),
                            $vp->parseConstraints($package->getConstraint()->getPrettyString()),
                            $linkType['description'],
                            $package->getPrettyConstraint()
                        );
                    }

                    return new Link(
                        $link->getSource(),
                        $link->getTarget(),
                        $vp->parseConstraints($version),
                        $linkType['description'],
                        $prettyVersion
                    );
                }
                return $link;
            },
            $links
        );
    }

    /**
     * Get a full featured Package from a RootPackageInterface.
     *
     * In Composer versions before 599ad77 the RootPackageInterface only
     * defines a sub-set of operations needed by composer-merge-plugin and
     * RootAliasPackage only implemented those methods defined by the
     * interface. Most of the unimplemented methods in RootAliasPackage can be
     * worked around because the getter methods that are implemented proxy to
     * the aliased package which we can modify by unwrapping. The exception
     * being modifying the 'conflicts', 'provides' and 'replaces' collections.
     * We have no way to actually modify those collections unfortunately in
     * older versions of Composer.
     *
     * @param RootPackageInterface $root
     * @param string $method Method needed
     * @return RootPackageInterface|RootPackage
     */
    public static function unwrapIfNeeded(
        RootPackageInterface $root,
        $method = 'setExtra'
    ) {
        // @codeCoverageIgnoreStart
        if ($root instanceof RootAliasPackage &&
            !method_exists($root, $method)
        ) {
            // Unwrap and return the aliased RootPackage.
            $root = $root->getAliasOf();
        }
        // @codeCoverageIgnoreEnd
        return $root;
    }

    /**
     * Update the root packages reference information.
     *
     * @param RootPackageInterface $root
     */
    protected function mergeReferences(RootPackageInterface $root) {
        // Merge source reference information for merged packages.
        // @see RootPackageLoader::load
        $references = array();
        $unwrapped = $this->unwrapIfNeeded($root, 'setReferences');
        foreach (array('require', 'require-dev') as $linkType) {
            $linkInfo = BasePackage::$supportedLinkTypes[$linkType];
            $method = 'get'.ucfirst($linkInfo['method']);
            $links = array();
            foreach ($unwrapped->$method() as $link) {
                $links[$link->getTarget()] = $link->getConstraint()->getPrettyString();
            }
            $references = $this->extractReferences($links, $references);
        }
        $unwrapped->setReferences($references);
    }

    /**
     * Extract vcs revision from version constraint (dev-master#abc123.
     *
     * @param array $requires
     * @param array $references
     * @return array
     * @see RootPackageLoader::extractReferences()
     */
    protected function extractReferences(array $requires, array $references)
    {
        foreach ($requires as $reqName => $reqVersion) {
            $reqVersion = preg_replace('{^([^,\s@]+) as .+$}', '$1', $reqVersion);
            $stabilityName = VersionParser::parseStability($reqVersion);
            if (
                preg_match('{^[^,\s@]+?#([a-f0-9]+)$}', $reqVersion, $match) &&
                $stabilityName === 'dev'
            ) {
                $name = strtolower($reqName);
                $references[$name] = $match[1];
            }
        }

        return $references;
    }
}
// vim:sw=4:ts=4:sts=4:et:


1		<?php
2		/**
3		* This file is part of the Composer Merge plugin.
4		*
5		* Copyright (C) 2015 Bryan Davis, Wikimedia Foundation, and contributors
6		*
7		* This software may be modified and distributed under the terms of the MIT
8		* license. See the LICENSE file for details.
9		*/
10
11		namespace Wikimedia\Composer\Merge;
12
13		use Wikimedia\Composer\Logger;
14
15		use Composer\Composer;
16		use Composer\Json\JsonFile;
17		use Composer\Package\BasePackage;
18		use Composer\Package\CompletePackage;
19		use Composer\Package\Link;
20		use Composer\Package\Loader\ArrayLoader;
21		use Composer\Package\RootAliasPackage;
22		use Composer\Package\RootPackage;
23		use Composer\Package\RootPackageInterface;
24		use Composer\Package\Version\VersionParser;
25		use UnexpectedValueException;
26
27		/**
28		* Processing for a composer.json file that will be merged into
29		* a RootPackageInterface
30		*
31		* @author Bryan Davis <[email protected]>
32		*/
33		class ExtraPackage
34		{
35
36		/**
37		* @var Composer $composer
38		*/
39		protected $composer;
40
41		/**
42		* @var Logger $logger
43		*/
44		protected $logger;
45
46		/**
47		* @var string $path
48		*/
49		protected $path;
50
51		/**
52		* @var array $json
53		*/
54		protected $json;
55
56		/**
57		* @var CompletePackage $package
58		*/
59		protected $package;
60
61		/**
62		* @var VersionParser $versionParser
63		*/
64		protected $versionParser;
65
66		/**
67		* @param string $path Path to composer.json file
68		* @param Composer $composer
69		* @param Logger $logger
70		*/
71	95	public function __construct($path, Composer $composer, Logger $logger)
72		{
73	95	$this->path = $path;
74	95	$this->composer = $composer;
75	95	$this->logger = $logger;
76	95	$this->json = $this->readPackageJson($path);
77	95	$this->package = $this->loadPackage($this->json);
		0 ignored issues – show Documentation introduced 2015-11-25 01:55 UTC by Report Bug Copy Issue Report `$this->json` is of type `array`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
78	95	$this->versionParser = new VersionParser();
79	95	}
80
81		/**
82		* Get list of additional packages to include if precessing recursively.
83		*
84		* @return array
85		*/
86	90	public function getIncludes()
87		{
88	90	return isset($this->json['extra']['merge-plugin']['include']) ?
89	90	$this->json['extra']['merge-plugin']['include'] : array();
90		}
91
92		/**
93		* Get list of additional packages to require if precessing recursively.
94		*
95		* @return array
96		*/
97	90	public function getRequires()
98		{
99	90	return isset($this->json['extra']['merge-plugin']['require']) ?
100	90	$this->json['extra']['merge-plugin']['require'] : array();
101		}
102
103		/**
104		* Read the contents of a composer.json style file into an array.
105		*
106		* The package contents are fixed up to be usable to create a Package
107		* object by providing dummy "name" and "version" values if they have not
108		* been provided in the file. This is consistent with the default root
109		* package loading behavior of Composer.
110		*
111		* @param string $path
112		* @return array
113		*/
114	95	protected function readPackageJson($path)
115		{
116	95	$file = new JsonFile($path);
117	95	$json = $file->read();
118	95	if (!isset($json['name'])) {
119	90	$json['name'] = 'merge-plugin/' .
120	90	strtr($path, DIRECTORY_SEPARATOR, '-');
121	90	}
122	95	if (!isset($json['version'])) {
123	95	$json['version'] = '1.0.0';
124	95	}
125	95	return $json;
126		}
127
128		/**
129		* @param string $json
130		* @return CompletePackage
131		*/
132	95	protected function loadPackage($json)
133		{
134	95	$loader = new ArrayLoader();
135	95	$package = $loader->load($json);
		0 ignored issues – show Documentation introduced 2015-11-25 01:55 UTC by Report Bug Copy Issue Report `$json` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
136		// @codeCoverageIgnoreStart
137		if (!$package instanceof CompletePackage) {
138		throw new UnexpectedValueException(
139		'Expected instance of CompletePackage, got ' .
140		get_class($package)
141		);
142		}
143		// @codeCoverageIgnoreEnd
144	95	return $package;
145		}
146
147		/**
148		* Merge this package into a RootPackageInterface
149		*
150		* @param RootPackageInterface $root
151		* @param PluginState $state
152		*/
153	95	public function mergeInto(RootPackageInterface $root, PluginState $state)
154		{
155	95	$this->addRepositories($root);
156
157	95	$this->mergeRequires('require', $root, $state);
158	95	if ($state->isDevMode()) {
159	90	$this->mergeRequires('require-dev', $root, $state);
160	90	}
161
162	95	$this->mergePackageLinks('conflict', $root);
163	95	$this->mergePackageLinks('replace', $root);
164	95	$this->mergePackageLinks('provide', $root);
165
166	95	$this->mergeSuggests($root);
167
168	95	$this->mergeAutoload('autoload', $root);
169	95	if ($state->isDevMode()) {
170	90	$this->mergeAutoload('devAutoload', $root);
171	90	}
172
173	95	$this->mergeExtra($root, $state);
174	95	$this->mergeReferences($root);
175	95	}
176
177		/**
178		* Add a collection of repositories described by the given configuration
179		* to the given package and the global repository manager.
180		*
181		* @param RootPackageInterface $root
182		*/
183	95	protected function addRepositories(RootPackageInterface $root)
184		{
185	95	if (!isset($this->json['repositories'])) {
186	85	return;
187		}
188	10	$repoManager = $this->composer->getRepositoryManager();
189	10	$newRepos = array();
190
191	10	foreach ($this->json['repositories'] as $repoJson) {
192	10	if (!isset($repoJson['type'])) {
193	10	continue;
194		}
195	10	$this->logger->info("Adding {$repoJson['type']} repository");
196	10	$repo = $repoManager->createRepository(
197	10	$repoJson['type'],
198		$repoJson
199	10	);
200	10	$repoManager->addRepository($repo);
201	10	$newRepos[] = $repo;
202	10	}
203
204	10	$unwrapped = self::unwrapIfNeeded($root, 'setRepositories');
205	10	$unwrapped->setRepositories(array_merge(
206	10	$newRepos,
207	10	$root->getRepositories()
208	10	));
209	10	}
210
211		/**
212		* Merge require or require-dev into a RootPackageInterface
213		*
214		* @param string $type 'require' or 'require-dev'
215		* @param RootPackageInterface $root
216		* @param PluginState $state
217		*/
218	95	protected function mergeRequires(
219		$type,
220		RootPackageInterface $root,
221		PluginState $state
222		) {
223	95	$linkType = BasePackage::$supportedLinkTypes[$type];
224	95	$getter = 'get' . ucfirst($linkType['method']);
225	95	$setter = 'set' . ucfirst($linkType['method']);
226
227	95	$requires = $this->package->{$getter}();
228	95	if (empty($requires)) {
229	75	return;
230		}
231
232	65	$this->mergeStabilityFlags($root, $requires);
233
234	65	$requires = $this->replaceSelfVersionDependencies(
235	65	$type,
236	65	$requires,
237		$root
238	65	);
239
240	65	$root->{$setter}($this->mergeOrDefer(
241	65	$type,
242	65	$root->{$getter}(),
243	65	$requires,
244		$state
245	65	));
246	65	}
247
248		/**
249		* Merge two collections of package links and collect duplicates for
250		* subsequent processing.
251		*
252		* @param string $type 'require' or 'require-dev'
253		* @param array $origin Primary collection
254		* @param array $merge Additional collection
255		* @param PluginState $state
256		* @return array Merged collection
257		*/
258	65	protected function mergeOrDefer(
259		$type,
260		array $origin,
261		array $merge,
262		$state
263		) {
264	65	$dups = array();
265	65	foreach ($merge as $name => $link) {
266	65	if (!isset($origin[$name]) \|\| $state->replaceDuplicateLinks()) {
267	65	$this->logger->info("Merging <comment>{$name}</comment>");
268	65	$origin[$name] = $link;
269	65	} else {
270		// Defer to solver.
271	15	$this->logger->info(
272	15	"Deferring duplicate <comment>{$name}</comment>"
273	15	);
274	15	$dups[] = $link;
275		}
276	65	}
277	65	$state->addDuplicateLinks($type, $dups);
278	65	return $origin;
279		}
280
281		/**
282		* Merge autoload or autoload-dev into a RootPackageInterface
283		*
284		* @param string $type 'autoload' or 'devAutoload'
285		* @param RootPackageInterface $root
286		*/
287	95	protected function mergeAutoload($type, RootPackageInterface $root)
288		{
289	95	$getter = 'get' . ucfirst($type);
290	95	$setter = 'set' . ucfirst($type);
291
292	95	$autoload = $this->package->{$getter}();
293	95	if (empty($autoload)) {
294	90	return;
295		}
296
297	10	$unwrapped = self::unwrapIfNeeded($root, $setter);
298	10	$unwrapped->{$setter}(array_merge_recursive(
299	10	$root->{$getter}(),
300	10	$this->fixRelativePaths($autoload)
301	10	));
302	10	}
303
304		/**
305		* Fix a collection of paths that are relative to this package to be
306		* relative to the base package.
307		*
308		* @param array $paths
309		* @return array
310		*/
311	10	protected function fixRelativePaths(array $paths)
312		{
313	10	$base = dirname($this->path);
314	10	$base = ($base === '.') ? '' : "{$base}/";
315
316	10	array_walk_recursive(
317	10	$paths,
318		function (&$path) use ($base) {
319	10	$path = "{$base}{$path}";
320	10	}
321	10	);
322	10	return $paths;
323		}
324
325		/**
326		* Extract and merge stability flags from the given collection of
327		* requires and merge them into a RootPackageInterface
328		*
329		* @param RootPackageInterface $root
330		* @param array $requires
331		*/
332	65	protected function mergeStabilityFlags(
333		RootPackageInterface $root,
334		array $requires
335		) {
336	65	$flags = $root->getStabilityFlags();
337	65	$sf = new StabilityFlags($flags, $root->getMinimumStability());
338
339	65	$unwrapped = self::unwrapIfNeeded($root, 'setStabilityFlags');
340	65	$unwrapped->setStabilityFlags(array_merge(
341	65	$flags,
342	65	$sf->extractAll($requires)
343	65	));
344	65	}
345
346		/**
347		* Merge package links of the given type into a RootPackageInterface
348		*
349		* @param string $type 'conflict', 'replace' or 'provide'
350		* @param RootPackageInterface $root
351		*/
352	95	protected function mergePackageLinks($type, RootPackageInterface $root)
353		{
354	95	$linkType = BasePackage::$supportedLinkTypes[$type];
355	95	$getter = 'get' . ucfirst($linkType['method']);
356	95	$setter = 'set' . ucfirst($linkType['method']);
357
358	95	$links = $this->package->{$getter}();
359	95	if (!empty($links)) {
360	20	$unwrapped = self::unwrapIfNeeded($root, $setter);
361		// @codeCoverageIgnoreStart
362		if ($root !== $unwrapped) {
363		$this->logger->warning(
364		'This Composer version does not support ' .
365		"'{$type}' merging for aliased packages."
366		);
367		}
368		// @codeCoverageIgnoreEnd
369	20	$unwrapped->{$setter}(array_merge(
370	20	$root->{$getter}(),
371	20	$this->replaceSelfVersionDependencies($type, $links, $root)
372	20	));
373	20	}
374	95	}
375
376		/**
377		* Merge suggested packages into a RootPackageInterface
378		*
379		* @param RootPackageInterface $root
380		*/
381	95	protected function mergeSuggests(RootPackageInterface $root)
382		{
383	95	$suggests = $this->package->getSuggests();
384	95	if (!empty($suggests)) {
385	10	$unwrapped = self::unwrapIfNeeded($root, 'setSuggests');
386	10	$unwrapped->setSuggests(array_merge(
387	10	$root->getSuggests(),
388		$suggests
389	10	));
390	10	}
391	95	}
392
393		/**
394		* Merge extra config into a RootPackageInterface
395		*
396		* @param RootPackageInterface $root
397		* @param PluginState $state
398		*/
399	95	public function mergeExtra(RootPackageInterface $root, PluginState $state)
400		{
401	95	$extra = $this->package->getExtra();
402	95	unset($extra['merge-plugin']);
403	95	if (!$state->shouldMergeExtra() \|\| empty($extra)) {
404	80	return;
405		}
406
407	15	$rootExtra = $root->getExtra();
408	15	$unwrapped = self::unwrapIfNeeded($root, 'setExtra');
409
410	15	if ($state->replaceDuplicateLinks()) {
411	5	$unwrapped->setExtra(
412	5	array_merge($rootExtra, $extra)
413	5	);
414
415	5	} else {
416	10	foreach (array_intersect(
417	10	array_keys($extra),
418	10	array_keys($rootExtra)
419	10	) as $key) {
420	5	$this->logger->info(
421	5	"Ignoring duplicate <comment>{$key}</comment> in ".
422	5	"<comment>{$this->path}</comment> extra config."
423	5	);
424	10	}
425	10	$unwrapped->setExtra(
426	10	array_merge($extra, $rootExtra)
427	10	);
428		}
429	15	}
430
431		/**
432		* Update Links with a 'self.version' constraint with the root package's
433		* version.
434		*
435		* @param string $type Link type
436		* @param array $links
437		* @param RootPackageInterface $root
438		* @return array
439		*/
440	75	protected function replaceSelfVersionDependencies(
441		$type,
442		array $links,
443		RootPackageInterface $root
444		) {
445	75	$linkType = BasePackage::$supportedLinkTypes[$type];
446	75	$version = $root->getVersion();
447	75	$prettyVersion = $root->getPrettyVersion();
448	75	$vp = $this->versionParser;
449
450	75	$method = 'get' . ucfirst($linkType['method']);
451	75	$packages = $root->$method();
452
453	75	return array_map(
454	75	function ($link) use ($linkType, $version, $prettyVersion, $vp, $packages) {
455	75	if ('self.version' === $link->getPrettyConstraint()) {
456	10	if (isset($packages[$link->getSource()])) {
457		/** @var Link $package */
458	5	$package = $packages[$link->getSource()];
459	5	return new Link(
460	5	$link->getSource(),
461	5	$link->getTarget(),
462	5	$vp->parseConstraints($package->getConstraint()->getPrettyString()),
463	5	$linkType['description'],
464	5	$package->getPrettyConstraint()
465	5	);
466		}
467
468	5	return new Link(
469	5	$link->getSource(),
470	5	$link->getTarget(),
471	5	$vp->parseConstraints($version),
472	5	$linkType['description'],
473		$prettyVersion
474	5	);
475		}
476	75	return $link;
477	75	},
478		$links
479	75	);
480		}
481
482		/**
483		* Get a full featured Package from a RootPackageInterface.
484		*
485		* In Composer versions before 599ad77 the RootPackageInterface only
486		* defines a sub-set of operations needed by composer-merge-plugin and
487		* RootAliasPackage only implemented those methods defined by the
488		* interface. Most of the unimplemented methods in RootAliasPackage can be
489		* worked around because the getter methods that are implemented proxy to
490		* the aliased package which we can modify by unwrapping. The exception
491		* being modifying the 'conflicts', 'provides' and 'replaces' collections.
492		* We have no way to actually modify those collections unfortunately in
493		* older versions of Composer.
494		*
495		* @param RootPackageInterface $root
496		* @param string $method Method needed
497		* @return RootPackageInterface\|RootPackage
498		*/
499	95	public static function unwrapIfNeeded(
500		RootPackageInterface $root,
501		$method = 'setExtra'
502		) {
503		// @codeCoverageIgnoreStart
504		if ($root instanceof RootAliasPackage &&
505		!method_exists($root, $method)
506		) {
507		// Unwrap and return the aliased RootPackage.
508		$root = $root->getAliasOf();
509		}
510		// @codeCoverageIgnoreEnd
511	95	return $root;
512		}
513
514		/**
515		* Update the root packages reference information.
516		*
517		* @param RootPackageInterface $root
518		*/
519	95	protected function mergeReferences(RootPackageInterface $root) {
520		// Merge source reference information for merged packages.
521		// @see RootPackageLoader::load
522	95	$references = array();
523	95	$unwrapped = $this->unwrapIfNeeded($root, 'setReferences');
524	95	foreach (array('require', 'require-dev') as $linkType) {
525	95	$linkInfo = BasePackage::$supportedLinkTypes[$linkType];
526	95	$method = 'get'.ucfirst($linkInfo['method']);
527	95	$links = array();
528	95	foreach ($unwrapped->$method() as $link) {
529	35	$links[$link->getTarget()] = $link->getConstraint()->getPrettyString();
530	95	}
531	95	$references = $this->extractReferences($links, $references);
532	95	}
533	95	$unwrapped->setReferences($references);
534	95	}
535
536		/**
537		* Extract vcs revision from version constraint (dev-master#abc123.
538		*
539		* @param array $requires
540		* @param array $references
541		* @return array
542		* @see RootPackageLoader::extractReferences()
543		*/
544	95	protected function extractReferences(array $requires, array $references)
545		{
546	95	foreach ($requires as $reqName => $reqVersion) {
547	35	$reqVersion = preg_replace('{^([^,\s@]+) as .+$}', '$1', $reqVersion);
548	35	$stabilityName = VersionParser::parseStability($reqVersion);
549		if (
550	35	preg_match('{^[^,\s@]+?#([a-f0-9]+)$}', $reqVersion, $match) &&
551		$stabilityName === 'dev'
552	35	) {
553	5	$name = strtolower($reqName);
554	5	$references[$name] = $match[1];
555	5	}
556	95	}
557
558	95	return $references;
559		}
560		}
561		// vim:sw=4:ts=4:sts=4:et:
562

wikimedia / composer-merge-plugin

Pull Request — master (#103)

ExtraPackage::mergeOrDefer() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like