Plugin::processPackage() - Code Metrics - Inspection of "REDONE to create separate manageable configs" - hiqdev/composer-extension-plugin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ae9b23...5e93ea )

by Andrii

created 2016-04-13 10:04 UTC

Plugin::processPackage() D

↳ Parent: Plugin

Complexity

Conditions	9
Paths	32

Size

Total Lines	31
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	90

Importance

Changes	7
Bugs	2	Features	0

Metric	Value
c	7
b	2
f	0
dl	0
loc	31
ccs	0
cts	21
cp	0
rs	4.909
cc	9
eloc	20
nc	32
nop	1
crap	90

<?php

/*
 * Composer plugin for Yii extensions
 *
 * @link      https://github.com/hiqdev/composer-extension-plugin
 * @package   composer-extension-plugin
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2016, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\composerextensionplugin;

use Composer\Composer;
use Composer\EventDispatcher\EventSubscriberInterface;
use Composer\IO\IOInterface;
use Composer\Package\PackageInterface;
use Composer\Package\RootPackageInterface;
use Composer\Plugin\PluginInterface;
use Composer\Script\Event;
use Composer\Script\ScriptEvents;
use Composer\Util\Filesystem;

/**
 * Plugin class.
 *
 * @author Andrii Vasyliev <[email protected]>
 */
class Plugin implements PluginInterface, EventSubscriberInterface
{
    const PACKAGE_TYPE          = 'yii2-extension';
    const EXTRA_OPTION_NAME     = 'extension-plugin';
    const YII2_EXTENSIONS_FILE  = 'yiisoft/extensions.php';
    const OUTPUT_PATH           = 'hiqdev';
    const BASE_DIR_SAMPLE       = '<base-dir>';
    const VENDOR_DIR_SAMPLE     = '<base-dir>/vendor';

    /**
     * @var PackageInterface[] the array of active composer packages
     */
    protected $packages;

    /**
     * @var string absolute path to the package base directory.
     */
    protected $baseDir;

    /**
     * @var string absolute path to vendor directory.
     */
    protected $vendorDir;

    /**
     * @var Filesystem utility
     */
    protected $filesystem;

    /**
     * @var array whole data
     */
    protected $data = [
        'extensions' => [],
        'aliases' => [
            '@vendor' => self::VENDOR_DIR_SAMPLE,
        ],
    ];

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

    /**
     * @var IOInterface
     */
    public $io;

    /**
     * Initializes the plugin object with the passed $composer and $io.
     * @param Composer $composer
     * @param IOInterface $io
     */
    public function activate(Composer $composer, IOInterface $io)
    {
        $this->composer = $composer;
        $this->io = $io;
    }

    /**
     * Returns list of events the plugin is subscribed to.
     * @return array list of events
     */
    public static function getSubscribedEvents()
    {
        return [
            ScriptEvents::POST_AUTOLOAD_DUMP => [
                ['onPostAutoloadDump', 0],
            ],
        ];
    }

    /**
     * Simply rewrites extensions file from scratch.
     * @param Event $event
     */
    public function onPostAutoloadDump(Event $event)

    {
        $this->io->writeError('<info>Generating extensions files</info>');
        $this->processPackage($this->composer->getPackage());
        foreach ($this->getPackages() as $package) {
            if ($package instanceof \Composer\Package\CompletePackageInterface) {
                $this->processPackage($package);
            }
        }

    //  $this->saveFile(static::YII2_EXTENSIONS_FILE, $this->data['extensions']);

        $this->saveFile(static::YII2_EXTENSIONS_FILE, []);
        foreach ($this->data as $name => $data) {
            $this->saveFile($this->buildOutputPath($name), $data);
        }
    }

    public function buildOutputPath($name)
    {
        return static::OUTPUT_PATH . DIRECTORY_SEPARATOR . $name . '.php';
    }

    /**
     * Writes file.
     * @param string $file
     * @param array $data
     */
    protected function saveFile($file, array $data)
    {
        $path = $this->getVendorDir() . '/' . $file;
        if (!file_exists(dirname($path))) {
            mkdir(dirname($path), 0777, true);
        }
        $array = str_replace("'" . self::BASE_DIR_SAMPLE, '$baseDir . \'', var_export($data, true));
        file_put_contents($path, "<?php\n\n\$baseDir = dirname(dirname(__DIR__));\n\nreturn $array;\n");
    }

    /**
     * Scans the given package and collects extensions data.
     * @param PackageInterface $package
     */
    public function processPackage(PackageInterface $package)
    {
        $extra = $package->getExtra();
        $files = isset($extra[self::EXTRA_OPTION_NAME]) ? $extra[self::EXTRA_OPTION_NAME] : [];
        if ($package->getType() !== self::PACKAGE_TYPE && empty($files)) {
            return;
        }

        $extension = [
            'name'    => $package->getName(),
            'version' => $package->getVersion(),
        ];
        if ($package->getVersion() === '9999999-dev') {
            $reference = $package->getSourceReference() ?: $package->getDistReference();
            if ($reference) {
                $extension['reference'] = $reference;
            }
        }
        $this->data['extensions'][$package->getName()] = $extension;

        $this->data['aliases'] = array_merge(
            $this->data['aliases'],
            $this->prepareAliases($package, 'psr-0'),
            $this->prepareAliases($package, 'psr-4')
        );

        foreach ($files as $name => $path) {
            $config = $this->readExtraConfig($package, $path);
            $this->data[$name] = isset($this->data[$name]) ? static::mergeConfig($this->data[$name], $config) : $config;
        }
    }

    /**
     * Merges two or more arrays into one recursively.
     * Based on Yii2 yii\helpers\BaseArrayHelper::merge.
     * @param array $a array to be merged to
     * @param array $b array to be merged from
     * @return array the merged array
     */
    public static function mergeConfig($a, $b)

    {
        $args = func_get_args();
        $res = array_shift($args);
        foreach ($args as $items) {
            if (!is_array($items)) {
                continue;
            }
            foreach ($items as $k => $v) {
                if (is_int($k)) {
                    if (isset($res[$k])) {
                        $res[] = $v;
                    } else {
                        $res[$k] = $v;
                    }
                } elseif (is_array($v) && isset($res[$k]) && is_array($res[$k])) {
                    $res[$k] = self::mergeConfig($res[$k], $v);
                } else {
                    $res[$k] = $v;
                }
            }
        }

        return $res;
    }

    /**
     * Read extra config.
     * @param string $file
     * @return array
     */
    protected function readExtraConfig(PackageInterface $package, $file)
    {
        $path = $this->preparePath($package, $file);
        if (!file_exists($path)) {
            $this->io->writeError('<error>Non existent extraconfig file</error> ' . $file . ' in ' . $package->getName());
            exit(1);

        }
        return require $path;
    }

    /**
     * Prepare aliases.
     *
     * @param PackageInterface $package
     * @param string 'psr-0' or 'psr-4'
     * @return array
     */
    protected function prepareAliases(PackageInterface $package, $psr)
    {
        $autoload = $package->getAutoload();
        if (empty($autoload[$psr])) {
            return [];
        }

        $aliases = [];
        foreach ($autoload[$psr] as $name => $path) {
            if (is_array($path)) {
                // ignore psr-4 autoload specifications with multiple search paths
                // we can not convert them into aliases as they are ambiguous
                continue;
            }
            $name = str_replace('\\', '/', trim($name, '\\'));
            $path = $this->preparePath($package, $path);
            $path = $this->substitutePath($path, $this->getBaseDir(), self::BASE_DIR_SAMPLE);
            if ('psr-0' === $psr) {
                $path .= '/' . $name;
            }
            $aliases["@$name"] = $path;
        }

        return $aliases;
    }

    /**
     * Substitute path with alias if applicable.
     * @param string $path
     * @param string $dir
     * @param string $alias
     * @return string
     */
    public function substitutePath($path, $dir, $alias)
    {
        return (substr($path, 0, strlen($dir) + 1) === $dir . '/') ? $alias . substr($path, strlen($dir)) : $path;
    }

    public function preparePath(PackageInterface $package, $path)
    {
        if (!$this->getFilesystem()->isAbsolutePath($path)) {
            $prefix = $package instanceof RootPackageInterface ? $this->getBaseDir() : $this->getVendorDir() . '/' . $package->getPrettyName();
            $path = $prefix . '/' . $path;
        }

        return $this->getFilesystem()->normalizePath($path);
    }

    /**
     * Sets [[packages]].
     * @param PackageInterface[] $packages
     */
    public function setPackages(array $packages)
    {
        $this->packages = $packages;
    }

    /**
     * Gets [[packages]].
     * @return \Composer\Package\PackageInterface[]
     */
    public function getPackages()
    {
        if ($this->packages === null) {
            $this->packages = $this->composer->getRepositoryManager()->getLocalRepository()->getCanonicalPackages();
        }

        return $this->packages;
    }

    /**
     * Get absolute path to package base dir.
     * @return string
     */
    public function getBaseDir()
    {
        if ($this->baseDir === null) {
            $this->baseDir = dirname($this->getVendorDir());
        }

        return $this->baseDir;
    }

    /**
     * Get absolute path to composer vendor dir.
     * @return string
     */
    public function getVendorDir()
    {
        if ($this->vendorDir === null) {
            $dir = $this->composer->getConfig()->get('vendor-dir', '/');
            $this->vendorDir = $this->getFilesystem()->normalizePath($dir);
        }

        return $this->vendorDir;
    }

    /**
     * Getter for filesystem utility.
     * @return Filesystem
     */
    public function getFilesystem()
    {
        if ($this->filesystem === null) {
            $this->filesystem = new Filesystem();
        }

        return $this->filesystem;
    }
}


1		<?php
2
3		/*
4		* Composer plugin for Yii extensions
5		*
6		* @link https://github.com/hiqdev/composer-extension-plugin
7		* @package composer-extension-plugin
8		* @license BSD-3-Clause
9		* @copyright Copyright (c) 2016, HiQDev (http://hiqdev.com/)
10		*/
11
12		namespace hiqdev\composerextensionplugin;
13
14		use Composer\Composer;
15		use Composer\EventDispatcher\EventSubscriberInterface;
16		use Composer\IO\IOInterface;
17		use Composer\Package\PackageInterface;
18		use Composer\Package\RootPackageInterface;
19		use Composer\Plugin\PluginInterface;
20		use Composer\Script\Event;
21		use Composer\Script\ScriptEvents;
22		use Composer\Util\Filesystem;
23
24		/**
25		* Plugin class.
26		*
27		* @author Andrii Vasyliev <[email protected]>
28		*/
29		class Plugin implements PluginInterface, EventSubscriberInterface
30		{
31		const PACKAGE_TYPE = 'yii2-extension';
32		const EXTRA_OPTION_NAME = 'extension-plugin';
33		const YII2_EXTENSIONS_FILE = 'yiisoft/extensions.php';
34		const OUTPUT_PATH = 'hiqdev';
35		const BASE_DIR_SAMPLE = '<base-dir>';
36		const VENDOR_DIR_SAMPLE = '<base-dir>/vendor';
37
38		/**
39		* @var PackageInterface[] the array of active composer packages
40		*/
41		protected $packages;
42
43		/**
44		* @var string absolute path to the package base directory.
45		*/
46		protected $baseDir;
47
48		/**
49		* @var string absolute path to vendor directory.
50		*/
51		protected $vendorDir;
52
53		/**
54		* @var Filesystem utility
55		*/
56		protected $filesystem;
57
58		/**
59		* @var array whole data
60		*/
61		protected $data = [
62		'extensions' => [],
63		'aliases' => [
64		'@vendor' => self::VENDOR_DIR_SAMPLE,
65		],
66		];
67
68		/**
69		* @var Composer instance
70		*/
71		protected $composer;
72
73		/**
74		* @var IOInterface
75		*/
76		public $io;
77
78		/**
79		* Initializes the plugin object with the passed $composer and $io.
80		* @param Composer $composer
81		* @param IOInterface $io
82		*/
83		public function activate(Composer $composer, IOInterface $io)
84		{
85		$this->composer = $composer;
86		$this->io = $io;
87		}
88	2
89		/**
90	2	* Returns list of events the plugin is subscribed to.
91	2	* @return array list of events
92	2	*/
93		public static function getSubscribedEvents()
94		{
95		return [
96		ScriptEvents::POST_AUTOLOAD_DUMP => [
97		['onPostAutoloadDump', 0],
98	1	],
99		];
100		}
101	1
102	1	/**
103	1	* Simply rewrites extensions file from scratch.
104	1	* @param Event $event
105		*/
106		public function onPostAutoloadDump(Event $event)
		0 ignored issues – show Unused Code introduced 2016-03-11 05:56 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...
107		{
108		$this->io->writeError('<info>Generating extensions files</info>');
109		$this->processPackage($this->composer->getPackage());
110		foreach ($this->getPackages() as $package) {
111		if ($package instanceof \Composer\Package\CompletePackageInterface) {
112		$this->processPackage($package);
113		}
114		}
115
116		// $this->saveFile(static::YII2_EXTENSIONS_FILE, $this->data['extensions']);
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-21 14:58 UTC by Report Bug Copy Issue Report `73%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
117		$this->saveFile(static::YII2_EXTENSIONS_FILE, []);
118		foreach ($this->data as $name => $data) {
119		$this->saveFile($this->buildOutputPath($name), $data);
120		}
121		}
122
123		public function buildOutputPath($name)
124		{
125		return static::OUTPUT_PATH . DIRECTORY_SEPARATOR . $name . '.php';
126		}
127
128		/**
129		* Writes file.
130		* @param string $file
131		* @param array $data
132		*/
133		protected function saveFile($file, array $data)
134		{
135		$path = $this->getVendorDir() . '/' . $file;
136		if (!file_exists(dirname($path))) {
137		mkdir(dirname($path), 0777, true);
138		}
139		$array = str_replace("'" . self::BASE_DIR_SAMPLE, '$baseDir . \'', var_export($data, true));
140		file_put_contents($path, "<?php\n\n\$baseDir = dirname(dirname(__DIR__));\n\nreturn $array;\n");
141		}
142
143		/**
144		* Scans the given package and collects extensions data.
145		* @param PackageInterface $package
146		*/
147		public function processPackage(PackageInterface $package)
148		{
149		$extra = $package->getExtra();
150		$files = isset($extra[self::EXTRA_OPTION_NAME]) ? $extra[self::EXTRA_OPTION_NAME] : [];
151		if ($package->getType() !== self::PACKAGE_TYPE && empty($files)) {
152		return;
153		}
154
155		$extension = [
156		'name' => $package->getName(),
157		'version' => $package->getVersion(),
158		];
159		if ($package->getVersion() === '9999999-dev') {
160		$reference = $package->getSourceReference() ?: $package->getDistReference();
161		if ($reference) {
162		$extension['reference'] = $reference;
163		}
164		}
165		$this->data['extensions'][$package->getName()] = $extension;
166
167		$this->data['aliases'] = array_merge(
168		$this->data['aliases'],
169		$this->prepareAliases($package, 'psr-0'),
170		$this->prepareAliases($package, 'psr-4')
171		);
172
173		foreach ($files as $name => $path) {
174		$config = $this->readExtraConfig($package, $path);
175		$this->data[$name] = isset($this->data[$name]) ? static::mergeConfig($this->data[$name], $config) : $config;
176		}
177		}
178
179		/**
180		* Merges two or more arrays into one recursively.
181		* Based on Yii2 yii\helpers\BaseArrayHelper::merge.
182		* @param array $a array to be merged to
183		* @param array $b array to be merged from
184		* @return array the merged array
185		*/
186		public static function mergeConfig($a, $b)
		0 ignored issues – show Unused Code introduced 2016-03-30 12:22 UTC by Report Bug Copy Issue Report The parameter `$a` 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... Unused Code introduced 2016-03-30 12:22 UTC by Report Bug Copy Issue Report The parameter `$b` 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...
187		{
188		$args = func_get_args();
189		$res = array_shift($args);
190		foreach ($args as $items) {
191		if (!is_array($items)) {
192		continue;
193		}
194		foreach ($items as $k => $v) {
195		if (is_int($k)) {
196		if (isset($res[$k])) {
197		$res[] = $v;
198		} else {
199		$res[$k] = $v;
200		}
201		} elseif (is_array($v) && isset($res[$k]) && is_array($res[$k])) {
202		$res[$k] = self::mergeConfig($res[$k], $v);
203		} else {
204		$res[$k] = $v;
205		}
206		}
207		}
208
209		return $res;
210		}
211
212		/**
213		* Read extra config.
214		* @param string $file
215		* @return array
216		*/
217		protected function readExtraConfig(PackageInterface $package, $file)
218		{
219		$path = $this->preparePath($package, $file);
220		if (!file_exists($path)) {
221		$this->io->writeError('<error>Non existent extraconfig file</error> ' . $file . ' in ' . $package->getName());
222		exit(1);
		0 ignored issues – show Coding Style Compatibility introduced 2016-03-11 05:56 UTC by Report Bug Copy Issue Report The method `readExtraConfig()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
223		}
224		return require $path;
225		}
226
227		/**
228		* Prepare aliases.
229		*
230		* @param PackageInterface $package
231		* @param string 'psr-0' or 'psr-4'
232		* @return array
233		*/
234		protected function prepareAliases(PackageInterface $package, $psr)
235		{
236		$autoload = $package->getAutoload();
237		if (empty($autoload[$psr])) {
238		return [];
239		}
240
241		$aliases = [];
242		foreach ($autoload[$psr] as $name => $path) {
243		if (is_array($path)) {
244		// ignore psr-4 autoload specifications with multiple search paths
245		// we can not convert them into aliases as they are ambiguous
246		continue;
247		}
248		$name = str_replace('\\', '/', trim($name, '\\'));
249		$path = $this->preparePath($package, $path);
250		$path = $this->substitutePath($path, $this->getBaseDir(), self::BASE_DIR_SAMPLE);
251		if ('psr-0' === $psr) {
252		$path .= '/' . $name;
253		}
254		$aliases["@$name"] = $path;
255		}
256
257		return $aliases;
258		}
259
260		/**
261		* Substitute path with alias if applicable.
262		* @param string $path
263		* @param string $dir
264		* @param string $alias
265		* @return string
266		*/
267		public function substitutePath($path, $dir, $alias)
268		{
269		return (substr($path, 0, strlen($dir) + 1) === $dir . '/') ? $alias . substr($path, strlen($dir)) : $path;
270		}
271
272		public function preparePath(PackageInterface $package, $path)
273		{
274		if (!$this->getFilesystem()->isAbsolutePath($path)) {
275		$prefix = $package instanceof RootPackageInterface ? $this->getBaseDir() : $this->getVendorDir() . '/' . $package->getPrettyName();
276		$path = $prefix . '/' . $path;
277		}
278
279		return $this->getFilesystem()->normalizePath($path);
280		}
281
282		/**
283		* Sets [[packages]].
284		* @param PackageInterface[] $packages
285		*/
286		public function setPackages(array $packages)
287		{
288		$this->packages = $packages;
289	2	}
290
291	2	/**
292	2	* Gets [[packages]].
293		* @return \Composer\Package\PackageInterface[]
294		*/
295		public function getPackages()
296		{
297		if ($this->packages === null) {
298	1	$this->packages = $this->composer->getRepositoryManager()->getLocalRepository()->getCanonicalPackages();
299		}
300	1
301		return $this->packages;
302		}
303
304	1	/**
305		* Get absolute path to package base dir.
306		* @return string
307		*/
308		public function getBaseDir()
309		{
310		if ($this->baseDir === null) {
311		$this->baseDir = dirname($this->getVendorDir());
312		}
313
314		return $this->baseDir;
315		}
316
317		/**
318		* Get absolute path to composer vendor dir.
319		* @return string
320		*/
321		public function getVendorDir()
322		{
323		if ($this->vendorDir === null) {
324		$dir = $this->composer->getConfig()->get('vendor-dir', '/');
325		$this->vendorDir = $this->getFilesystem()->normalizePath($dir);
326		}
327
328		return $this->vendorDir;
329		}
330
331		/**
332		* Getter for filesystem utility.
333		* @return Filesystem
334		*/
335		public function getFilesystem()
336		{
337		if ($this->filesystem === null) {
338		$this->filesystem = new Filesystem();
339		}
340
341		return $this->filesystem;
342		}
343		}
344

hiqdev / composer-extension-plugin

Push — master ( ae9b23...5e93ea )

Plugin::processPackage() D

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like