MergePlugin::activate() - Code Metrics - Inspection of "Support for composer PluginEvents::INIT event." - wikimedia/composer-merge-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#117)

by Fabian

created 2016-06-30 15:43 UTC

MergePlugin::activate() A

↳ Parent: MergePlugin

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes	5
Bugs	0	Features	0

Metric	Value
c	5
b	0
f	0
dl	0
loc	6
ccs	6
cts	6
cp	1
rs	9.4285
cc	1
eloc	4
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;

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\Event as BaseEvent;
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 as ScriptEvent;
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';

    /**
     * Name of the composer 1.1 init event.
     */
    const COMPAT_PLUGINEVENTS_INIT = 'init';

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

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

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

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

    /**
     * Files that have already been partially processed
     *
     * @var string[] $partiallyLoadedFiles
     */
    protected $partiallyLoadedFiles = 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(
            // Use our own constant to make this event optional. Once
            // composer-1.1 is required, this can use PluginEvents::INIT
            // instead.
            self::COMPAT_PLUGINEVENTS_INIT => 'onInit',
            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 initialization.
     *
     * @param \Composer\EventDispatcher\Event $event
     */
    public function onInit(BaseEvent $event)

    {
        $this->state->loadSettings();
        // It is not possible to know if the user specified --dev or --no-dev
        // so assume it is false. The dev section will be merged later when
        // the other events fire.
        $this->state->setDevMode(false);
        $this->mergeFiles($this->state->getIncludes(), false);
        $this->mergeFiles($this->state->getRequires(), true);
    }

    /**
     * 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 ScriptEvent $event
     */
    public function onInstallUpdateOrDump(ScriptEvent $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]) ||
            (isset($this->partiallyLoadedFiles[$path]) && !$this->state->isDevMode())) {
            $this->logger->debug("Already merged <comment>$path</comment> completely");
            return;
        }

        $this->logger->info("Loading <comment>{$path}</comment>...");

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

        // If something was already loaded, merge just the dev section.
        if (isset($this->partiallyLoadedFiles[$path])) {
            $package->mergeDev($root, $this->state);
        } else {
            $package->mergeInto($root, $this->state);
        }

        if ($this->state->isDevMode()) {
            $this->loadedFiles[$path] = true;
        } else {
            $this->partiallyLoadedFiles[$path] = true;
        }

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

wikimedia / composer-merge-plugin

Pull Request — master (#117)

MergePlugin::activate() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like