MergePlugin::onDependencySolve() - Code Metrics - Inspection of "Use dev mode flag from event in onDependencySolve..." - wikimedia/composer-merge-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#123)

by Bryan

created 2016-07-04 00:17 UTC

MergePlugin::onDependencySolve() B

↳ Parent: MergePlugin

Complexity

Conditions	4
Paths	6

Size

Total Lines	23
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	17
CRAP Score	4

Importance

Changes	9
Bugs	0	Features	2

Metric	Value
c	9
b	0
f	2
dl	0
loc	23
ccs	17
cts	17
cp	1
rs	8.7972
cc	4
eloc	11
nc	6
nop	1
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;

use Wikimedia\Composer\Merge\ExtraPackage;
use Wikimedia\Composer\Merge\MissingFileException;
use Wikimedia\Composer\Merge\PluginState;

use Composer\Composer;
use Composer\DependencyResolver\Operation\InstallOperation;
use Composer\EventDispatcher\EventSubscriberInterface;
use Composer\Factory;
use Composer\Installer;
use Composer\Installer\InstallerEvent;
use Composer\Installer\InstallerEvents;
use Composer\Installer\PackageEvent;
use Composer\Installer\PackageEvents;
use Composer\IO\IOInterface;
use Composer\Package\RootPackageInterface;
use Composer\Plugin\PluginInterface;
use Composer\Script\Event;
use Composer\Script\ScriptEvents;

/**
 * Composer plugin that allows merging multiple composer.json files.
 *
 * When installed, this plugin will look for a "merge-plugin" key in the
 * composer configuration's "extra" section. The value for this key is
 * a set of options configuring the plugin.
 *
 * An "include" setting is required. The value of this setting can be 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 compser execution.
 *
 * The "autoload", "autoload-dev", "conflict", "provide", "replace",
 * "repositories", "require", "require-dev", and "suggest" 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.
 *
 * If included files specify conflicting package versions for "require" or
 * "require-dev", the normal Composer dependency solver process will be used
 * to attempt to resolve the conflict. Specifying the 'replace' key as true will
 * change this default behaviour so that the last-defined version of a package
 * will win, allowing for force-overrides of package defines.
 *
 * By default the "extra" section is not merged. This can be enabled by
 * setitng the 'merge-extra' key to true. In normal mode, when the same key is
 * found in both the original and the imported extra section, the version in
 * the original config is used and the imported version is skipped. If
 * 'replace' mode is active, this behaviour changes so the imported version of
 * the key is used, replacing the version in the original config.
 *
 *
 * @code
 * {
 *     "require": {
 *         "wikimedia/composer-merge-plugin": "dev-master"
 *     },
 *     "extra": {
 *         "merge-plugin": {
 *             "include": [
 *                 "composer.local.json"
 *             ]
 *         }
 *     }
 * }
 * @endcode
 *
 * @author Bryan Davis <[email protected]>
 */
class MergePlugin implements PluginInterface, EventSubscriberInterface
{

    /**
     * Offical package name
     */
    const PACKAGE_NAME = 'wikimedia/composer-merge-plugin';

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

    /**
     * @var PluginState $state
     */
    protected $state;

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

    /**
     * Files that have already been processed
     *
     * @var string[] $loadedFiles
     */
    protected $loadedFiles = array();

    /**
     * {@inheritdoc}
     */
    public function activate(Composer $composer, IOInterface $io)
    {
        $this->composer = $composer;
        $this->state = new PluginState($this->composer);
        $this->logger = new Logger('merge-plugin', $io);
    }

    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents()
    {
        return array(
            InstallerEvents::PRE_DEPENDENCIES_SOLVING => 'onDependencySolve',
            PackageEvents::POST_PACKAGE_INSTALL => 'onPostPackageInstall',
            ScriptEvents::POST_INSTALL_CMD => 'onPostInstallOrUpdate',
            ScriptEvents::POST_UPDATE_CMD => 'onPostInstallOrUpdate',
            ScriptEvents::PRE_AUTOLOAD_DUMP => 'onInstallUpdateOrDump',
            ScriptEvents::PRE_INSTALL_CMD => 'onInstallUpdateOrDump',
            ScriptEvents::PRE_UPDATE_CMD => 'onInstallUpdateOrDump',
        );
    }

    /**
     * Handle an event callback for an install, update or dump command by
     * checking for "merge-plugin" in the "extra" data and merging package
     * contents if found.
     *
     * @param Event $event
     */
    public function onInstallUpdateOrDump(Event $event)
    {
        $this->state->loadSettings();
        $this->state->setDevMode($event->isDevMode());
        $this->mergeFiles($this->state->getIncludes(), false);
        $this->mergeFiles($this->state->getRequires(), true);

        if ($event->getName() === ScriptEvents::PRE_AUTOLOAD_DUMP) {
            $this->state->setDumpAutoloader(true);
            $flags = $event->getFlags();
            if (isset($flags['optimize'])) {
                $this->state->setOptimizeAutoloader($flags['optimize']);
            }
        }
    }

    /**
     * Find configuration files matching the configured glob patterns and
     * merge their contents with the master package.
     *
     * @param array $patterns List of files/glob patterns
     * @param bool $required Are the patterns required to match files?
     * @throws MissingFileException when required and a pattern returns no
     *      results
     */
    protected function mergeFiles(array $patterns, $required = false)
    {
        $root = $this->composer->getPackage();

        $files = array_map(
            function ($files, $pattern) use ($required) {
                if ($required && !$files) {
                    throw new MissingFileException(
                        "merge-plugin: No files matched required '{$pattern}'"
                    );
                }
                return $files;
            },
            array_map('glob', $patterns),
            $patterns
        );

        foreach (array_reduce($files, 'array_merge', array()) as $path) {
            $this->mergeFile($root, $path);
        }
    }

    /**
     * Read a JSON file and merge its contents
     *
     * @param RootPackageInterface $root
     * @param string $path
     */
    protected function mergeFile(RootPackageInterface $root, $path)
    {
        if (isset($this->loadedFiles[$path])) {
            $this->logger->debug("Already merged <comment>$path</comment>");
            return;
        } else {
            $this->loadedFiles[$path] = true;
        }
        $this->logger->info("Loading <comment>{$path}</comment>...");

        $package = new ExtraPackage($path, $this->composer, $this->logger);
        $package->mergeInto($root, $this->state);

        if ($this->state->recurseIncludes()) {
            $this->mergeFiles($package->getIncludes(), false);
            $this->mergeFiles($package->getRequires(), true);
        }
    }

    /**
     * Handle an event callback for pre-dependency solving phase of an install
     * or update by adding any duplicate package dependencies found during
     * initial merge processing to the request that will be processed by the
     * dependency solver.
     *
     * @param InstallerEvent $event
     */
    public function onDependencySolve(InstallerEvent $event)
    {
        $request = $event->getRequest();
        foreach ($this->state->getDuplicateLinks('require') as $link) {
            $this->logger->info(
                "Adding dependency <comment>{$link}</comment>"
            );
            $request->install($link->getTarget(), $link->getConstraint());
        }

        // Issue #113: Check devMode of event rather than our global state.
        // Composer fires the PRE_DEPENDENCIES_SOLVING event twice for
        // `--no-dev` operations to decide which packages are dev only
        // requirements.
        if ($event->isDevMode()) {
            foreach ($this->state->getDuplicateLinks('require-dev') as $link) {
                $this->logger->info(
                    "Adding dev dependency <comment>{$link}</comment>"
                );
                $request->install($link->getTarget(), $link->getConstraint());
            }
        }
    }

    /**
     * Handle an event callback following installation of a new package by
     * checking to see if the package that was installed was our plugin.
     *
     * @param PackageEvent $event
     */
    public function onPostPackageInstall(PackageEvent $event)
    {
        $op = $event->getOperation();
        if ($op instanceof InstallOperation) {
            $package = $op->getPackage()->getName();
            if ($package === self::PACKAGE_NAME) {
                $this->logger->info('composer-merge-plugin installed');
                $this->state->setFirstInstall(true);
                $this->state->setLocked(
                    $event->getComposer()->getLocker()->isLocked()
                );
            }
        }
    }

    /**
     * Handle an event callback following an install or update command. If our
     * plugin was installed during the run then trigger an update command to
     * process any merge-patterns in the current config.
     *
     * @param Event $event
     */
    public function onPostInstallOrUpdate(Event $event)
    {
        // @codeCoverageIgnoreStart
        if ($this->state->isFirstInstall()) {
            $this->state->setFirstInstall(false);
            $this->logger->info(
                '<comment>' .
                'Running additional update to apply merge settings' .
                '</comment>'
            );

            $config = $this->composer->getConfig();

            $preferSource = $config->get('preferred-install') == 'source';
            $preferDist = $config->get('preferred-install') == 'dist';

            $installer = Installer::create(
                $event->getIO(),
                // Create a new Composer instance to ensure full processing of
                // the merged files.
                Factory::create($event->getIO(), null, false)
            );

            $installer->setPreferSource($preferSource);
            $installer->setPreferDist($preferDist);
            $installer->setDevMode($event->isDevMode());
            $installer->setDumpAutoloader($this->state->shouldDumpAutoloader());
            $installer->setOptimizeAutoloader(
                $this->state->shouldOptimizeAutoloader()
            );

            if ($this->state->forceUpdate()) {
                // Force update mode so that new packages are processed rather
                // than just telling the user that composer.json and
                // composer.lock don't match.
                $installer->setUpdate(true);
            }

            $installer->run();
        }
        // @codeCoverageIgnoreEnd
    }
}
// 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;
12
13		use Wikimedia\Composer\Merge\ExtraPackage;
14		use Wikimedia\Composer\Merge\MissingFileException;
15		use Wikimedia\Composer\Merge\PluginState;
16
17		use Composer\Composer;
18		use Composer\DependencyResolver\Operation\InstallOperation;
19		use Composer\EventDispatcher\EventSubscriberInterface;
20		use Composer\Factory;
21		use Composer\Installer;
22		use Composer\Installer\InstallerEvent;
23		use Composer\Installer\InstallerEvents;
24		use Composer\Installer\PackageEvent;
25		use Composer\Installer\PackageEvents;
26		use Composer\IO\IOInterface;
27		use Composer\Package\RootPackageInterface;
28		use Composer\Plugin\PluginInterface;
29		use Composer\Script\Event;
30		use Composer\Script\ScriptEvents;
31
32		/**
33		* Composer plugin that allows merging multiple composer.json files.
34		*
35		* When installed, this plugin will look for a "merge-plugin" key in the
36		* composer configuration's "extra" section. The value for this key is
37		* a set of options configuring the plugin.
38		*
39		* An "include" setting is required. The value of this setting can be either
40		* a single value or an array of values. Each value is treated as a glob()
41		* pattern identifying additional composer.json style configuration files to
42		* merge into the configuration for the current compser execution.
43		*
44		* The "autoload", "autoload-dev", "conflict", "provide", "replace",
45		* "repositories", "require", "require-dev", and "suggest" sections of the
46		* found configuration files will be merged into the root package
47		* configuration as though they were directly included in the top-level
48		* composer.json file.
49		*
50		* If included files specify conflicting package versions for "require" or
51		* "require-dev", the normal Composer dependency solver process will be used
52		* to attempt to resolve the conflict. Specifying the 'replace' key as true will
53		* change this default behaviour so that the last-defined version of a package
54		* will win, allowing for force-overrides of package defines.
55		*
56		* By default the "extra" section is not merged. This can be enabled by
57		* setitng the 'merge-extra' key to true. In normal mode, when the same key is
58		* found in both the original and the imported extra section, the version in
59		* the original config is used and the imported version is skipped. If
60		* 'replace' mode is active, this behaviour changes so the imported version of
61		* the key is used, replacing the version in the original config.
62		*
63		*
64		* @code
65		* {
66		* "require": {
67		* "wikimedia/composer-merge-plugin": "dev-master"
68		* },
69		* "extra": {
70		* "merge-plugin": {
71		* "include": [
72		* "composer.local.json"
73		* ]
74		* }
75		* }
76		* }
77		* @endcode
78		*
79		* @author Bryan Davis <[email protected]>
80		*/
81		class MergePlugin implements PluginInterface, EventSubscriberInterface
82		{
83
84		/**
85		* Offical package name
86		*/
87		const PACKAGE_NAME = 'wikimedia/composer-merge-plugin';
88
89		/**
90		* @var Composer $composer
91		*/
92		protected $composer;
93
94		/**
95		* @var PluginState $state
96		*/
97		protected $state;
98
99		/**
100		* @var Logger $logger
101		*/
102		protected $logger;
103
104		/**
105		* Files that have already been processed
106		*
107		* @var string[] $loadedFiles
108		*/
109		protected $loadedFiles = array();
110
111		/**
112		* {@inheritdoc}
113		*/
114	120	public function activate(Composer $composer, IOInterface $io)
115		{
116	120	$this->composer = $composer;
117	120	$this->state = new PluginState($this->composer);
118	120	$this->logger = new Logger('merge-plugin', $io);
119	120	}
120
121		/**
122		* {@inheritdoc}
123		*/
124	5	public static function getSubscribedEvents()
125		{
126		return array(
127	5	InstallerEvents::PRE_DEPENDENCIES_SOLVING => 'onDependencySolve',
128	5	PackageEvents::POST_PACKAGE_INSTALL => 'onPostPackageInstall',
129	5	ScriptEvents::POST_INSTALL_CMD => 'onPostInstallOrUpdate',
130	5	ScriptEvents::POST_UPDATE_CMD => 'onPostInstallOrUpdate',
131	5	ScriptEvents::PRE_AUTOLOAD_DUMP => 'onInstallUpdateOrDump',
132	5	ScriptEvents::PRE_INSTALL_CMD => 'onInstallUpdateOrDump',
133	5	ScriptEvents::PRE_UPDATE_CMD => 'onInstallUpdateOrDump',
134	5	);
135		}
136
137		/**
138		* Handle an event callback for an install, update or dump command by
139		* checking for "merge-plugin" in the "extra" data and merging package
140		* contents if found.
141		*
142		* @param Event $event
143		*/
144	100	public function onInstallUpdateOrDump(Event $event)
145		{
146	100	$this->state->loadSettings();
147	100	$this->state->setDevMode($event->isDevMode());
148	100	$this->mergeFiles($this->state->getIncludes(), false);
149	100	$this->mergeFiles($this->state->getRequires(), true);
150
151	95	if ($event->getName() === ScriptEvents::PRE_AUTOLOAD_DUMP) {
152	95	$this->state->setDumpAutoloader(true);
153	95	$flags = $event->getFlags();
154	95	if (isset($flags['optimize'])) {
155	95	$this->state->setOptimizeAutoloader($flags['optimize']);
156	95	}
157	95	}
158	95	}
159
160		/**
161		* Find configuration files matching the configured glob patterns and
162		* merge their contents with the master package.
163		*
164		* @param array $patterns List of files/glob patterns
165		* @param bool $required Are the patterns required to match files?
166		* @throws MissingFileException when required and a pattern returns no
167		* results
168		*/
169	100	protected function mergeFiles(array $patterns, $required = false)
170		{
171	100	$root = $this->composer->getPackage();
172
173	100	$files = array_map(
174	100	function ($files, $pattern) use ($required) {
175	100	if ($required && !$files) {
176	5	throw new MissingFileException(
177	5	"merge-plugin: No files matched required '{$pattern}'"
178	5	);
179		}
180	95	return $files;
181	100	},
182	100	array_map('glob', $patterns),
183		$patterns
184	100	);
185
186	100	foreach (array_reduce($files, 'array_merge', array()) as $path) {
187	95	$this->mergeFile($root, $path);
188	100	}
189	100	}
190
191		/**
192		* Read a JSON file and merge its contents
193		*
194		* @param RootPackageInterface $root
195		* @param string $path
196		*/
197	95	protected function mergeFile(RootPackageInterface $root, $path)
198		{
199	95	if (isset($this->loadedFiles[$path])) {
200	95	$this->logger->debug("Already merged <comment>$path</comment>");
201	95	return;
202		} else {
203	95	$this->loadedFiles[$path] = true;
204		}
205	95	$this->logger->info("Loading <comment>{$path}</comment>...");
206
207	95	$package = new ExtraPackage($path, $this->composer, $this->logger);
208	95	$package->mergeInto($root, $this->state);
209
210	95	if ($this->state->recurseIncludes()) {
211	90	$this->mergeFiles($package->getIncludes(), false);
212	90	$this->mergeFiles($package->getRequires(), true);
213	90	}
214	95	}
215
216		/**
217		* Handle an event callback for pre-dependency solving phase of an install
218		* or update by adding any duplicate package dependencies found during
219		* initial merge processing to the request that will be processed by the
220		* dependency solver.
221		*
222		* @param InstallerEvent $event
223		*/
224	95	public function onDependencySolve(InstallerEvent $event)
225		{
226	95	$request = $event->getRequest();
227	95	foreach ($this->state->getDuplicateLinks('require') as $link) {
228	15	$this->logger->info(
229	15	"Adding dependency <comment>{$link}</comment>"
230	15	);
231	15	$request->install($link->getTarget(), $link->getConstraint());
232	95	}
233	95
234	90	// Issue #113: Check devMode of event rather than our global state.
235	5	// Composer fires the PRE_DEPENDENCIES_SOLVING event twice for
236	5	// `--no-dev` operations to decide which packages are dev only
237	5	// requirements.
238	5	if ($event->isDevMode()) {
239	90	foreach ($this->state->getDuplicateLinks('require-dev') as $link) {
240	90	$this->logger->info(
241	95	"Adding dev dependency <comment>{$link}</comment>"
242		);
243		$request->install($link->getTarget(), $link->getConstraint());
244		}
245		}
246		}
247
248		/**
249	15	* Handle an event callback following installation of a new package by
250		* checking to see if the package that was installed was our plugin.
251	15	*
252	15	* @param PackageEvent $event
253	15	*/
254	15	public function onPostPackageInstall(PackageEvent $event)
255	10	{
256	10	$op = $event->getOperation();
257	10	if ($op instanceof InstallOperation) {
258	10	$package = $op->getPackage()->getName();
259	10	if ($package === self::PACKAGE_NAME) {
260	10	$this->logger->info('composer-merge-plugin installed');
261	15	$this->state->setFirstInstall(true);
262	15	$this->state->setLocked(
263		$event->getComposer()->getLocker()->isLocked()
264		);
265		}
266		}
267		}
268
269		/**
270		* Handle an event callback following an install or update command. If our
271	95	* plugin was installed during the run then trigger an update command to
272		* process any merge-patterns in the current config.
273		*
274		* @param Event $event
275		*/
276		public function onPostInstallOrUpdate(Event $event)
277		{
278		// @codeCoverageIgnoreStart
279		if ($this->state->isFirstInstall()) {
280		$this->state->setFirstInstall(false);
281		$this->logger->info(
282		'<comment>' .
283		'Running additional update to apply merge settings' .
284		'</comment>'
285		);
286
287		$config = $this->composer->getConfig();
288
289		$preferSource = $config->get('preferred-install') == 'source';
290		$preferDist = $config->get('preferred-install') == 'dist';
291
292		$installer = Installer::create(
293		$event->getIO(),
294		// Create a new Composer instance to ensure full processing of
295		// the merged files.
296		Factory::create($event->getIO(), null, false)
297		);
298
299		$installer->setPreferSource($preferSource);
300		$installer->setPreferDist($preferDist);
301		$installer->setDevMode($event->isDevMode());
302		$installer->setDumpAutoloader($this->state->shouldDumpAutoloader());
303		$installer->setOptimizeAutoloader(
304		$this->state->shouldOptimizeAutoloader()
305		);
306
307		if ($this->state->forceUpdate()) {
308		// Force update mode so that new packages are processed rather
309		// than just telling the user that composer.json and
310		// composer.lock don't match.
311		$installer->setUpdate(true);
312	95	}
313
314		$installer->run();
315		}
316		// @codeCoverageIgnoreEnd
317		}
318		}
319		// vim:sw=4:ts=4:sts=4:et:
320

wikimedia / composer-merge-plugin

Pull Request — master (#123)

MergePlugin::onDependencySolve() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like