ExtraPackage::mergeDevInto() - Code Metrics - wikimedia/composer-merge-plugin - Measure and Improve Code Quality continuously with Scrutinizer

ExtraPackage::mergeDevInto() A
last analyzed 2020-03-31 02:48 UTC

↳ Parent: ExtraPackage

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	5
cts	5
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2
crap	1

<?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);
        $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 array $json
     * @return CompletePackage
     */
    protected function loadPackage(array $json)
    {
        $loader = new ArrayLoader();
        $package = $loader->load($json);
        // @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->prependRepositories($root);

        $this->mergeRequires('require', $root, $state);

        $this->mergePackageLinks('conflict', $root);
        $this->mergePackageLinks('replace', $root);
        $this->mergePackageLinks('provide', $root);

        $this->mergeSuggests($root);

        $this->mergeAutoload('autoload', $root);

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

        $this->mergeScripts($root, $state);

        if ($state->isDevMode()) {
            $this->mergeDevInto($root, $state);
        } else {
            $this->mergeReferences($root);
        }
    }

    /**
     * Merge just the dev portion into a RootPackageInterface
     *
     * @param RootPackageInterface $root
     * @param PluginState $state
     */
    public function mergeDevInto(RootPackageInterface $root, PluginState $state)
    {
        $this->mergeRequires('require-dev', $root, $state);
        $this->mergeAutoload('devAutoload', $root);
        $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 prependRepositories(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("Prepending {$repoJson['type']} repository");
            $repo = $repoManager->createRepository(
                $repoJson['type'],
                $repoJson
            );
            $repoManager->prependRepository($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
    ) {
        if ($state->ignoreDuplicateLinks() && $state->replaceDuplicateLinks()) {
            $this->logger->warning("Both replace and ignore-duplicates are true. These are mutually exclusive.");
            $this->logger->warning("Duplicate packages will be ignored.");
        }

        $dups = array();
        foreach ($merge as $name => $link) {
            if (isset($origin[$name]) && $state->ignoreDuplicateLinks()) {
                $this->logger->info("Ignoring duplicate <comment>{$name}</comment>");
                continue;
            } elseif (!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(
                self::mergeExtraArray($state->shouldMergeExtraDeep(), $rootExtra, $extra)
            );
        } else {
            if (!$state->shouldMergeExtraDeep()) {
                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(
                self::mergeExtraArray($state->shouldMergeExtraDeep(), $extra, $rootExtra)
            );
        }
    }

    /**
     * Merge scripts config into a RootPackageInterface
     *
     * @param RootPackageInterface $root
     * @param PluginState $state
     */
    public function mergeScripts(RootPackageInterface $root, PluginState $state)
    {
        $scripts = $this->package->getScripts();
        if (!$state->shouldMergeScripts() || empty($scripts)) {
            return;
        }

        $rootScripts = $root->getScripts();
        $unwrapped = self::unwrapIfNeeded($root, 'setScripts');

        if ($state->replaceDuplicateLinks()) {
            $unwrapped->setScripts(
                array_merge($rootScripts, $scripts)
            );
        } else {
            $unwrapped->setScripts(
                array_merge($scripts, $rootScripts)
            );
        }
    }

    /**
     * Merges two arrays either via arrayMergeDeep or via array_merge.
     *
     * @param bool $mergeDeep
     * @param array $array1
     * @param array $array2
     * @return array
     */
    public static function mergeExtraArray($mergeDeep, $array1, $array2)
    {
        if ($mergeDeep) {
            return NestedArray::mergeDeep($array1, $array2);
        }

        return array_merge($array1, $array2);
    }

    /**
     * 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	170	public function __construct($path, Composer $composer, Logger $logger)
72		{
73	170	$this->path = $path;
74	170	$this->composer = $composer;
75	170	$this->logger = $logger;
76	170	$this->json = $this->readPackageJson($path);
77	170	$this->package = $this->loadPackage($this->json);
78	170	$this->versionParser = new VersionParser();
79	170	}
80
81		/**
82		* Get list of additional packages to include if precessing recursively.
83		*
84		* @return array
85		*/
86	165	public function getIncludes()
87		{
88	165	return isset($this->json['extra']['merge-plugin']['include']) ?
89	165	$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	165	public function getRequires()
98		{
99	165	return isset($this->json['extra']['merge-plugin']['require']) ?
100	165	$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	170	protected function readPackageJson($path)
115		{
116	170	$file = new JsonFile($path);
117	170	$json = $file->read();
118	170	if (!isset($json['name'])) {
119	160	$json['name'] = 'merge-plugin/' .
120	160	strtr($path, DIRECTORY_SEPARATOR, '-');
121	32	}
122	170	if (!isset($json['version'])) {
123	170	$json['version'] = '1.0.0';
124	34	}
125	170	return $json;
126		}
127
128		/**
129		* @param array $json
130		* @return CompletePackage
131		*/
132	170	protected function loadPackage(array $json)
133		{
134	170	$loader = new ArrayLoader();
135	170	$package = $loader->load($json);
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	170	return $package;
145		}
146
147		/**
148		* Merge this package into a RootPackageInterface
149		*
150		* @param RootPackageInterface $root
151		* @param PluginState $state
152		*/
153	170	public function mergeInto(RootPackageInterface $root, PluginState $state)
154		{
155	170	$this->prependRepositories($root);
156
157	170	$this->mergeRequires('require', $root, $state);
158
159	170	$this->mergePackageLinks('conflict', $root);
160	170	$this->mergePackageLinks('replace', $root);
161	170	$this->mergePackageLinks('provide', $root);
162
163	170	$this->mergeSuggests($root);
164
165	170	$this->mergeAutoload('autoload', $root);
166
167	170	$this->mergeExtra($root, $state);
168
169	170	$this->mergeScripts($root, $state);
170
171	170	if ($state->isDevMode()) {
172	95	$this->mergeDevInto($root, $state);
173	19	} else {
174	75	$this->mergeReferences($root);
175		}
176	170	}
177
178		/**
179		* Merge just the dev portion into a RootPackageInterface
180		*
181		* @param RootPackageInterface $root
182		* @param PluginState $state
183		*/
184	165	public function mergeDevInto(RootPackageInterface $root, PluginState $state)
185		{
186	165	$this->mergeRequires('require-dev', $root, $state);
187	165	$this->mergeAutoload('devAutoload', $root);
188	165	$this->mergeReferences($root);
189	165	}
190
191		/**
192		* Add a collection of repositories described by the given configuration
193		* to the given package and the global repository manager.
194		*
195		* @param RootPackageInterface $root
196		*/
197	170	protected function prependRepositories(RootPackageInterface $root)
198		{
199	170	if (!isset($this->json['repositories'])) {
200	150	return;
201		}
202	20	$repoManager = $this->composer->getRepositoryManager();
203	20	$newRepos = array();
204
205	20	foreach ($this->json['repositories'] as $repoJson) {
206	20	if (!isset($repoJson['type'])) {
207	15	continue;
208		}
209	20	$this->logger->info("Prepending {$repoJson['type']} repository");
210	20	$repo = $repoManager->createRepository(
211	20	$repoJson['type'],
212	8	$repoJson
213	4	);
214	20	$repoManager->prependRepository($repo);
215	20	$newRepos[] = $repo;
216	4	}
217
218	20	$unwrapped = self::unwrapIfNeeded($root, 'setRepositories');
219	20	$unwrapped->setRepositories(array_merge(
220	20	$newRepos,
221	20	$root->getRepositories()
222	4	));
223	20	}
224
225		/**
226		* Merge require or require-dev into a RootPackageInterface
227		*
228		* @param string $type 'require' or 'require-dev'
229		* @param RootPackageInterface $root
230		* @param PluginState $state
231		*/
232	170	protected function mergeRequires(
233		$type,
234		RootPackageInterface $root,
235		PluginState $state
236		) {
237	170	$linkType = BasePackage::$supportedLinkTypes[$type];
238	170	$getter = 'get' . ucfirst($linkType['method']);
239	170	$setter = 'set' . ucfirst($linkType['method']);
240
241	170	$requires = $this->package->{$getter}();
242	170	if (empty($requires)) {
243	135	return;
244		}
245
246	95	$this->mergeStabilityFlags($root, $requires);
247
248	95	$requires = $this->replaceSelfVersionDependencies(
249	95	$type,
250	57	$requires,
251	38	$root
252	19	);
253
254	95	$root->{$setter}($this->mergeOrDefer(
255	95	$type,
256	95	$root->{$getter}(),
257	57	$requires,
258	38	$state
259	19	));
260	95	}
261
262		/**
263		* Merge two collections of package links and collect duplicates for
264		* subsequent processing.
265		*
266		* @param string $type 'require' or 'require-dev'
267		* @param array $origin Primary collection
268		* @param array $merge Additional collection
269		* @param PluginState $state
270		* @return array Merged collection
271		*/
272	95	protected function mergeOrDefer(
273		$type,
274		array $origin,
275		array $merge,
276		$state
277		) {
278	95	if ($state->ignoreDuplicateLinks() && $state->replaceDuplicateLinks()) {
279	5	$this->logger->warning("Both replace and ignore-duplicates are true. These are mutually exclusive.");
280	5	$this->logger->warning("Duplicate packages will be ignored.");
281	1	}
282
283	95	$dups = array();
284	95	foreach ($merge as $name => $link) {
285	95	if (isset($origin[$name]) && $state->ignoreDuplicateLinks()) {
286	10	$this->logger->info("Ignoring duplicate <comment>{$name}</comment>");
287	10	continue;
288	85	} elseif (!isset($origin[$name]) \|\| $state->replaceDuplicateLinks()) {
289	85	$this->logger->info("Merging <comment>{$name}</comment>");
290	85	$origin[$name] = $link;
291	17	} else {
292		// Defer to solver.
293	25	$this->logger->info(
294	25	"Deferring duplicate <comment>{$name}</comment>"
295	5	);
296	37	$dups[] = $link;
297		}
298	19	}
299	95	$state->addDuplicateLinks($type, $dups);
300	95	return $origin;
301		}
302
303		/**
304		* Merge autoload or autoload-dev into a RootPackageInterface
305		*
306		* @param string $type 'autoload' or 'devAutoload'
307		* @param RootPackageInterface $root
308		*/
309	170	protected function mergeAutoload($type, RootPackageInterface $root)
310		{
311	170	$getter = 'get' . ucfirst($type);
312	170	$setter = 'set' . ucfirst($type);
313
314	170	$autoload = $this->package->{$getter}();
315	170	if (empty($autoload)) {
316	160	return;
317		}
318
319	15	$unwrapped = self::unwrapIfNeeded($root, $setter);
320	15	$unwrapped->{$setter}(array_merge_recursive(
321	15	$root->{$getter}(),
322	15	$this->fixRelativePaths($autoload)
323	3	));
324	15	}
325
326		/**
327		* Fix a collection of paths that are relative to this package to be
328		* relative to the base package.
329		*
330		* @param array $paths
331		* @return array
332		*/
333	15	protected function fixRelativePaths(array $paths)
334		{
335	15	$base = dirname($this->path);
336	15	$base = ($base === '.') ? '' : "{$base}/";
337
338	15	array_walk_recursive(
339	15	$paths,
340	12	function (&$path) use ($base) {
341	15	$path = "{$base}{$path}";
342	15	}
343	3	);
344	15	return $paths;
345		}
346
347		/**
348		* Extract and merge stability flags from the given collection of
349		* requires and merge them into a RootPackageInterface
350		*
351		* @param RootPackageInterface $root
352		* @param array $requires
353		*/
354	95	protected function mergeStabilityFlags(
355		RootPackageInterface $root,
356		array $requires
357		) {
358	95	$flags = $root->getStabilityFlags();
359	95	$sf = new StabilityFlags($flags, $root->getMinimumStability());
360
361	95	$unwrapped = self::unwrapIfNeeded($root, 'setStabilityFlags');
362	95	$unwrapped->setStabilityFlags(array_merge(
363	95	$flags,
364	95	$sf->extractAll($requires)
365	19	));
366	95	}
367
368		/**
369		* Merge package links of the given type into a RootPackageInterface
370		*
371		* @param string $type 'conflict', 'replace' or 'provide'
372		* @param RootPackageInterface $root
373		*/
374	170	protected function mergePackageLinks($type, RootPackageInterface $root)
375		{
376	170	$linkType = BasePackage::$supportedLinkTypes[$type];
377	170	$getter = 'get' . ucfirst($linkType['method']);
378	170	$setter = 'set' . ucfirst($linkType['method']);
379
380	170	$links = $this->package->{$getter}();
381	170	if (!empty($links)) {
382	30	$unwrapped = self::unwrapIfNeeded($root, $setter);
383		// @codeCoverageIgnoreStart
384		if ($root !== $unwrapped) {
385		$this->logger->warning(
386		'This Composer version does not support ' .
387		"'{$type}' merging for aliased packages."
388		);
389		}
390		// @codeCoverageIgnoreEnd
391	30	$unwrapped->{$setter}(array_merge(
392	30	$root->{$getter}(),
393	30	$this->replaceSelfVersionDependencies($type, $links, $root)
394	6	));
395	6	}
396	170	}
397
398		/**
399		* Merge suggested packages into a RootPackageInterface
400		*
401		* @param RootPackageInterface $root
402		*/
403	170	protected function mergeSuggests(RootPackageInterface $root)
404		{
405	170	$suggests = $this->package->getSuggests();
406	170	if (!empty($suggests)) {
407	15	$unwrapped = self::unwrapIfNeeded($root, 'setSuggests');
408	15	$unwrapped->setSuggests(array_merge(
409	15	$root->getSuggests(),
410	6	$suggests
411	3	));
412	3	}
413	170	}
414
415		/**
416		* Merge extra config into a RootPackageInterface
417		*
418		* @param RootPackageInterface $root
419		* @param PluginState $state
420		*/
421	170	public function mergeExtra(RootPackageInterface $root, PluginState $state)
422		{
423	170	$extra = $this->package->getExtra();
424	170	unset($extra['merge-plugin']);
425	170	if (!$state->shouldMergeExtra() \|\| empty($extra)) {
426	140	return;
427		}
428
429	30	$rootExtra = $root->getExtra();
430	30	$unwrapped = self::unwrapIfNeeded($root, 'setExtra');
431
432	30	if ($state->replaceDuplicateLinks()) {
433	10	$unwrapped->setExtra(
434	10	self::mergeExtraArray($state->shouldMergeExtraDeep(), $rootExtra, $extra)
435	2	);
436	2	} else {
437	20	if (!$state->shouldMergeExtraDeep()) {
438	15	foreach (array_intersect(
439	15	array_keys($extra),
440	15	array_keys($rootExtra)
441	3	) as $key) {
442	5	$this->logger->info(
443	5	"Ignoring duplicate <comment>{$key}</comment> in ".
444	5	"<comment>{$this->path}</comment> extra config."
445	1	);
446	3	}
447	3	}
448	20	$unwrapped->setExtra(
449	20	self::mergeExtraArray($state->shouldMergeExtraDeep(), $extra, $rootExtra)
450	4	);
451		}
452	30	}
453
454		/**
455		* Merge scripts config into a RootPackageInterface
456		*
457		* @param RootPackageInterface $root
458		* @param PluginState $state
459		*/
460	170	public function mergeScripts(RootPackageInterface $root, PluginState $state)
461		{
462	170	$scripts = $this->package->getScripts();
463	170	if (!$state->shouldMergeScripts() \|\| empty($scripts)) {
464	150	return;
465		}
466
467	20	$rootScripts = $root->getScripts();
468	20	$unwrapped = self::unwrapIfNeeded($root, 'setScripts');
469
470	20	if ($state->replaceDuplicateLinks()) {
471	5	$unwrapped->setScripts(
472	5	array_merge($rootScripts, $scripts)
473	1	);
474	1	} else {
475	15	$unwrapped->setScripts(
476	15	array_merge($scripts, $rootScripts)
477	3	);
478		}
479	20	}
480
481		/**
482		* Merges two arrays either via arrayMergeDeep or via array_merge.
483		*
484		* @param bool $mergeDeep
485		* @param array $array1
486		* @param array $array2
487		* @return array
488		*/
489	30	public static function mergeExtraArray($mergeDeep, $array1, $array2)
490		{
491	30	if ($mergeDeep) {
492	10	return NestedArray::mergeDeep($array1, $array2);
493		}
494
495	20	return array_merge($array1, $array2);
496		}
497
498		/**
499		* Update Links with a 'self.version' constraint with the root package's
500		* version.
501		*
502		* @param string $type Link type
503		* @param array $links
504		* @param RootPackageInterface $root
505		* @return array
506		*/
507	110	protected function replaceSelfVersionDependencies(
508		$type,
509		array $links,
510		RootPackageInterface $root
511		) {
512	110	$linkType = BasePackage::$supportedLinkTypes[$type];
513	110	$version = $root->getVersion();
514	110	$prettyVersion = $root->getPrettyVersion();
515	110	$vp = $this->versionParser;
516
517	110	$method = 'get' . ucfirst($linkType['method']);
518	110	$packages = $root->$method();
519
520	110	return array_map(
521	110	function ($link) use ($linkType, $version, $prettyVersion, $vp, $packages) {
522	110	if ('self.version' === $link->getPrettyConstraint()) {
523	15	if (isset($packages[$link->getSource()])) {
524		/** @var Link $package */
525	10	$package = $packages[$link->getSource()];
526	10	return new Link(
527	10	$link->getSource(),
528	10	$link->getTarget(),
529	10	$vp->parseConstraints($package->getConstraint()->getPrettyString()),
530	10	$linkType['description'],
531	10	$package->getPrettyConstraint()
532	2	);
533		}
534
535	5	return new Link(
536	5	$link->getSource(),
537	5	$link->getTarget(),
538	5	$vp->parseConstraints($version),
539	5	$linkType['description'],
540	2	$prettyVersion
541	1	);
542		}
543	110	return $link;
544	110	},
545	44	$links
546	22	);
547		}
548
549		/**
550		* Get a full featured Package from a RootPackageInterface.
551		*
552		* In Composer versions before 599ad77 the RootPackageInterface only
553		* defines a sub-set of operations needed by composer-merge-plugin and
554		* RootAliasPackage only implemented those methods defined by the
555		* interface. Most of the unimplemented methods in RootAliasPackage can be
556		* worked around because the getter methods that are implemented proxy to
557		* the aliased package which we can modify by unwrapping. The exception
558		* being modifying the 'conflicts', 'provides' and 'replaces' collections.
559		* We have no way to actually modify those collections unfortunately in
560		* older versions of Composer.
561		*
562		* @param RootPackageInterface $root
563		* @param string $method Method needed
564		* @return RootPackageInterface\|RootPackage
565		*/
566	170	public static function unwrapIfNeeded(
567		RootPackageInterface $root,
568		$method = 'setExtra'
569		) {
570		// @codeCoverageIgnoreStart
571		if ($root instanceof RootAliasPackage &&
572		!method_exists($root, $method)
573		) {
574		// Unwrap and return the aliased RootPackage.
575		$root = $root->getAliasOf();
576		}
577		// @codeCoverageIgnoreEnd
578	170	return $root;
579		}
580
581		/**
582		* Update the root packages reference information.
583		*
584		* @param RootPackageInterface $root
585		*/
586	170	protected function mergeReferences(RootPackageInterface $root)
587		{
588		// Merge source reference information for merged packages.
589		// @see RootPackageLoader::load
590	170	$references = array();
591	170	$unwrapped = $this->unwrapIfNeeded($root, 'setReferences');
592	170	foreach (array('require', 'require-dev') as $linkType) {
593	170	$linkInfo = BasePackage::$supportedLinkTypes[$linkType];
594	170	$method = 'get'.ucfirst($linkInfo['method']);
595	170	$links = array();
596	170	foreach ($unwrapped->$method() as $link) {
597	65	$links[$link->getTarget()] = $link->getConstraint()->getPrettyString();
598	34	}
599	170	$references = $this->extractReferences($links, $references);
600	34	}
601	170	$unwrapped->setReferences($references);
602	170	}
603
604		/**
605		* Extract vcs revision from version constraint (dev-master#abc123.
606		*
607		* @param array $requires
608		* @param array $references
609		* @return array
610		* @see RootPackageLoader::extractReferences()
611		*/
612	170	protected function extractReferences(array $requires, array $references)
613		{
614	170	foreach ($requires as $reqName => $reqVersion) {
615	65	$reqVersion = preg_replace('{^([^,\s@]+) as .+$}', '$1', $reqVersion);
616	65	$stabilityName = VersionParser::parseStability($reqVersion);
617		if (preg_match('{^[^,\s@]+?#([a-f0-9]+)$}', $reqVersion, $match) &&
618	65	$stabilityName === 'dev'
619	52	) {
620	13	$name = strtolower($reqName);
621	15	$references[$name] = $match[1];
622	25	}
623	3	}
624	34
625		return $references;
626	170	}
627		}
628		// vim:sw=4:ts=4:sts=4:et:
629

wikimedia / composer-merge-plugin

ExtraPackage::mergeDevInto() A last analyzed 2020-03-31 02:48 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ExtraPackage::mergeDevInto() A
last analyzed 2020-03-31 02:48 UTC