PackageCommandHandler::handleInstall() - Code Metrics - Inspection of "Styleci bridge" - puli/cli - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#21)

by Sullivan

created 2016-06-29 09:16 UTC

PackageCommandHandler::handleInstall() A

↳ Parent: PackageCommandHandler

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes	4
Bugs	1	Features	2

Metric	Value
c	4
b	1
f	2
dl	0
loc	11
ccs	7
cts	7
cp	1
rs	9.4285
cc	2
eloc	7
nc	2
nop	1
crap	2

<?php

/*
 * This file is part of the puli/cli package.
 *
 * (c) Bernhard Schussek <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Puli\Cli\Handler;

use Puli\Cli\Style\PuliTableStyle;
use Puli\Cli\Util\StringUtil;
use Puli\Manager\Api\Environment;
use Puli\Manager\Api\Package\Package;
use Puli\Manager\Api\Package\PackageCollection;
use Puli\Manager\Api\Package\PackageManager;
use Puli\Manager\Api\Package\PackageState;
use RuntimeException;
use Webmozart\Console\Api\Args\Args;
use Webmozart\Console\Api\IO\IO;
use Webmozart\Console\UI\Component\Table;
use Webmozart\Expression\Expr;
use Webmozart\PathUtil\Path;

/**
 * Handles the "package" command.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <[email protected]>
 */
class PackageCommandHandler
{
    /**
     * @var array
     */
    private static $stateStrings = array(
        PackageState::ENABLED => 'enabled',
        PackageState::NOT_FOUND => 'not-found',
        PackageState::NOT_LOADABLE => 'not-loadable',
    );

    /**
     * @var PackageManager
     */
    private $packageManager;

    /**
     * Creates the handler.
     *
     * @param PackageManager $packageManager The package manager.
     */
    public function __construct(PackageManager $packageManager)
    {
        $this->packageManager = $packageManager;
    }

    /**
     * Handles the "package --list" command.
     *
     * @param Args $args The console arguments.
     * @param IO   $io   The I/O.
     *
     * @return int The status code.
     */
    public function handleList(Args $args, IO $io)
    {
        $packages = $this->getSelectedPackages($args);

        if ($args->isOptionSet('format')) {
            $this->printPackagesWithFormat($io, $packages, $args->getOption('format'));
        } else {
            $this->printPackagesByState($io, $packages, $this->getSelectedStates($args));
        }

        return 0;
    }

    /**
     * Handles the "package --install" command.
     *
     * @param Args $args The console arguments.
     *
     * @return int The status code.
     */
    public function handleInstall(Args $args)
    {
        $packageName = $args->getArgument('name');
        $installPath = Path::makeAbsolute($args->getArgument('path'), getcwd());
        $installer = $args->getOption('installer');
        $env = $args->isOptionSet('dev') ? Environment::DEV : Environment::PROD;

        $this->packageManager->installPackage($installPath, $packageName, $installer, $env);

        return 0;
    }

    /**
     * Handles the "package --rename" command.
     *
     * @param Args $args The console arguments.
     *
     * @return int The status code.
     */
    public function handleRename(Args $args)
    {
        $packageName = $args->getArgument('name');
        $newName = $args->getArgument('new-name');

        $this->packageManager->renamePackage($packageName, $newName);

        return 0;
    }

    /**
     * Handles the "package --delete" command.
     *
     * @param Args $args The console arguments.
     *
     * @return int The status code.
     */
    public function handleDelete(Args $args)
    {
        $packageName = $args->getArgument('name');

        if (!$this->packageManager->hasPackage($packageName)) {
            throw new RuntimeException(sprintf(
                'The package "%s" is not installed.',
                $packageName
            ));
        }

        $this->packageManager->removePackage($packageName);

        return 0;
    }

    /**
     * Handles the "package --clean" command.
     *
     * @param Args $args The console arguments.
     * @param IO   $io   The I/O.
     *
     * @return int The status code.
     */
    public function handleClean(Args $args, IO $io)

    {
        $expr = Expr::method('getState', Expr::same(PackageState::NOT_FOUND));

        foreach ($this->packageManager->findPackages($expr) as $package) {
            $io->writeLine('Removing '.$package->getName());
            $this->packageManager->removePackage($package->getName());
        }

        return 0;
    }

    /**
     * Returns the package states that should be displayed for the given
     * console arguments.
     *
     * @param Args $args The console arguments.
     *
     * @return int[] A list of {@link PackageState} constants.
     */
    private function getSelectedStates(Args $args)
    {
        $states = array();

        if ($args->isOptionSet('enabled')) {
            $states[] = PackageState::ENABLED;
        }

        if ($args->isOptionSet('not-found')) {
            $states[] = PackageState::NOT_FOUND;
        }

        if ($args->isOptionSet('not-loadable')) {
            $states[] = PackageState::NOT_LOADABLE;
        }

        return $states ?: PackageState::all();
    }

    /**
     * Returns the packages that should be displayed for the given console
     * arguments.
     *
     * @param Args $args The console arguments.
     *
     * @return PackageCollection The packages.
     */
    private function getSelectedPackages(Args $args)
    {
        $states = $this->getSelectedStates($args);
        $expr = Expr::true();
        $envs = array();

        if ($states !== PackageState::all()) {
            $expr = $expr->andMethod('getState', Expr::in($states));
        }

        if ($args->isOptionSet('installer')) {
            $expr = $expr->andMethod('getInstallInfo', Expr::method('getInstallerName', Expr::same($args->getOption('installer'))));
        }

        if ($args->isOptionSet('prod')) {
            $envs[] = Environment::PROD;
        }

        if ($args->isOptionSet('dev')) {
            $envs[] = Environment::DEV;
        }

        if (count($envs) > 0) {
            $expr = $expr->andMethod('getInstallInfo', Expr::method('getEnvironment', Expr::in($envs)));
        }

        return $this->packageManager->findPackages($expr);
    }

    /**
     * Prints packages with intermediate headers for the package states.
     *
     * @param IO                $io       The I/O.
     * @param PackageCollection $packages The packages to print.
     * @param int[]             $states   The states to print.
     */
    private function printPackagesByState(IO $io, PackageCollection $packages, array $states)
    {
        $printStates = count($states) > 1;

        foreach ($states as $state) {
            $filteredPackages = array_filter($packages->toArray(), function (Package $package) use ($state) {
                return $state === $package->getState();
            });

            if (0 === count($filteredPackages)) {
                continue;
            }

            if ($printStates) {
                $this->printPackageState($io, $state);
            }

            if (PackageState::NOT_LOADABLE === $state) {
                $this->printNotLoadablePackages($io, $filteredPackages, $printStates);
            } else {
                $styleTag = PackageState::ENABLED === $state ? null : 'bad';
                $this->printPackageTable($io, $filteredPackages, $styleTag, $printStates);
            }

            if ($printStates) {
                $io->writeLine('');
            }
        }
    }

    /**
     * Prints packages using the given format.
     *
     * @param IO                $io       The I/O.
     * @param PackageCollection $packages The packages to print.
     * @param string            $format   The format string.
     */
    private function printPackagesWithFormat(IO $io, PackageCollection $packages, $format)
    {
        foreach ($packages as $package) {
            $installInfo = $package->getInstallInfo();

            $io->writeLine(strtr($format, array(
                '%name%' => $package->getName(),
                '%installer%' => $installInfo ? $installInfo->getInstallerName() : '',
                '%install_path%' => $package->getInstallPath(),
                '%state%' => self::$stateStrings[$package->getState()],
                '%env%' => $installInfo ? $installInfo->getEnvironment() : Environment::PROD,
            )));
        }
    }

    /**
     * Prints the heading for a given package state.
     *
     * @param IO  $io           The I/O.
     * @param int $packageState The {@link PackageState} constant.
     */
    private function printPackageState(IO $io, $packageState)

    {
        switch ($packageState) {
            case PackageState::ENABLED:
                $io->writeLine('The following packages are currently enabled:');
                $io->writeLine('');

                return;
            case PackageState::NOT_FOUND:
                $io->writeLine('The following packages could not be found:');
                $io->writeLine(' (use "puli package --clean" to remove)');
                $io->writeLine('');

                return;
            case PackageState::NOT_LOADABLE:
                $io->writeLine('The following packages could not be loaded:');
                $io->writeLine('');

                return;
        }
    }

    /**
     * Prints a list of packages in a table.
     *
     * @param IO          $io       The I/O.
     * @param Package[]   $packages The packages.
     * @param string|null $styleTag The tag used to style the output. If `null`,
     *                              the default colors are used.
     * @param bool        $indent   Whether to indent the output.
     */
    private function printPackageTable(IO $io, array $packages, $styleTag = null, $indent = false)
    {
        $table = new Table(PuliTableStyle::borderless());
        $table->setHeaderRow(array('Package Name', 'Installer', 'Env', 'Install Path'));

        $installerTag = $styleTag ?: 'c1';
        $envTag = $styleTag ?: 'c1';
        $pathTag = $styleTag ?: 'c2';

        ksort($packages);

        foreach ($packages as $package) {
            $packageName = $package->getName();
            $installInfo = $package->getInstallInfo();
            $installPath = $installInfo ? $installInfo->getInstallPath() : '.';
            $installer = $installInfo ? $installInfo->getInstallerName() : '';
            $env = $installInfo ? $installInfo->getEnvironment() : Environment::PROD;

            $table->addRow(array(
                $styleTag ? sprintf('<%s>%s</%s>', $styleTag, $packageName, $styleTag) : $packageName,
                $installer ? sprintf('<%s>%s</%s>', $installerTag, $installer, $installerTag) : '',
                sprintf('<%s>%s</%s>', $envTag, $env, $envTag),
                sprintf('<%s>%s</%s>', $pathTag, $installPath, $pathTag),
            ));
        }

        $table->render($io, $indent ? 4 : 0);
    }

    /**
     * Prints not-loadable packages in a table.
     *
     * @param IO        $io       The I/O.
     * @param Package[] $packages The not-loadable packages.
     * @param bool      $indent   Whether to indent the output.
     */
    private function printNotLoadablePackages(IO $io, array $packages, $indent = false)
    {
        $rootDir = $this->packageManager->getContext()->getRootDirectory();
        $table = new Table(PuliTableStyle::borderless());
        $table->setHeaderRow(array('Package Name', 'Error'));

        ksort($packages);

        foreach ($packages as $package) {
            $packageName = $package->getName();
            $loadErrors = $package->getLoadErrors();
            $errorMessage = '';

            foreach ($loadErrors as $loadError) {
                $errorMessage .= StringUtil::getShortClassName(get_class($loadError)).': '.$loadError->getMessage()."\n";
            }

            $errorMessage = rtrim($errorMessage);

            if (!$errorMessage) {
                $errorMessage = 'Unknown error.';
            }

            // Remove root directory
            $errorMessage = str_replace($rootDir.'/', '', $errorMessage);

            $table->addRow(array(
                sprintf('<bad>%s</bad>', $packageName),
                sprintf('<bad>%s</bad>', $errorMessage),
            ));
        }

        $table->render($io, $indent ? 4 : 0);
    }
}


1			<?php
2
3			/*
4			* This file is part of the puli/cli package.
5			*
6			* (c) Bernhard Schussek <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Puli\Cli\Handler;
13
14			use Puli\Cli\Style\PuliTableStyle;
15			use Puli\Cli\Util\StringUtil;
16			use Puli\Manager\Api\Environment;
17			use Puli\Manager\Api\Package\Package;
18			use Puli\Manager\Api\Package\PackageCollection;
19			use Puli\Manager\Api\Package\PackageManager;
20			use Puli\Manager\Api\Package\PackageState;
21			use RuntimeException;
22			use Webmozart\Console\Api\Args\Args;
23			use Webmozart\Console\Api\IO\IO;
24			use Webmozart\Console\UI\Component\Table;
25			use Webmozart\Expression\Expr;
26			use Webmozart\PathUtil\Path;
27
28			/**
29			* Handles the "package" command.
30			*
31			* @since 1.0
32			*
33			* @author Bernhard Schussek <[email protected]>
34			*/
35			class PackageCommandHandler
36			{
37			/**
38			* @var array
39			*/
40			private static $stateStrings = array(
41			PackageState::ENABLED => 'enabled',
42			PackageState::NOT_FOUND => 'not-found',
43			PackageState::NOT_LOADABLE => 'not-loadable',
44			);
45
46			/**
47			* @var PackageManager
48			*/
49			private $packageManager;
50
51			/**
52			* Creates the handler.
53			*
54			* @param PackageManager $packageManager The package manager.
55			*/
56	20		public function __construct(PackageManager $packageManager)
57			{
58	20		$this->packageManager = $packageManager;
59	20		}
60
61			/**
62			* Handles the "package --list" command.
63			*
64			* @param Args $args The console arguments.
65			* @param IO $io The I/O.
66			*
67			* @return int The status code.
68			*/
69	11		public function handleList(Args $args, IO $io)
70			{
71	11		$packages = $this->getSelectedPackages($args);
72
73	11		if ($args->isOptionSet('format')) {
74	1		$this->printPackagesWithFormat($io, $packages, $args->getOption('format'));
75			} else {
76	10		$this->printPackagesByState($io, $packages, $this->getSelectedStates($args));
77			}
78
79	11		return 0;
80			}
81
82			/**
83			* Handles the "package --install" command.
84			*
85			* @param Args $args The console arguments.
86			*
87			* @return int The status code.
88			*/
89	5		public function handleInstall(Args $args)
90			{
91	5		$packageName = $args->getArgument('name');
92	5		$installPath = Path::makeAbsolute($args->getArgument('path'), getcwd());
93	5		$installer = $args->getOption('installer');
94	5		$env = $args->isOptionSet('dev') ? Environment::DEV : Environment::PROD;
95
96	5		$this->packageManager->installPackage($installPath, $packageName, $installer, $env);
97
98	5		return 0;
99			}
100
101			/**
102			* Handles the "package --rename" command.
103			*
104			* @param Args $args The console arguments.
105			*
106			* @return int The status code.
107			*/
108	1		public function handleRename(Args $args)
109			{
110	1		$packageName = $args->getArgument('name');
111	1		$newName = $args->getArgument('new-name');
112
113	1		$this->packageManager->renamePackage($packageName, $newName);
114
115	1		return 0;
116			}
117
118			/**
119			* Handles the "package --delete" command.
120			*
121			* @param Args $args The console arguments.
122			*
123			* @return int The status code.
124			*/
125	2		public function handleDelete(Args $args)
126			{
127	2		$packageName = $args->getArgument('name');
128
129	2		if (!$this->packageManager->hasPackage($packageName)) {
130	1		throw new RuntimeException(sprintf(
131	1		'The package "%s" is not installed.',
132			$packageName
133			));
134			}
135
136	1		$this->packageManager->removePackage($packageName);
137
138	1		return 0;
139			}
140
141			/**
142			* Handles the "package --clean" command.
143			*
144			* @param Args $args The console arguments.
145			* @param IO $io The I/O.
146			*
147			* @return int The status code.
148			*/
149	1		public function handleClean(Args $args, IO $io)
			0 ignored issues – show Unused Code introduced 2015-12-06 22:45 UTC by Report Bug Copy Issue Report The parameter `$args` 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...
150			{
151	1		$expr = Expr::method('getState', Expr::same(PackageState::NOT_FOUND));
152
153	1		foreach ($this->packageManager->findPackages($expr) as $package) {
154	1		$io->writeLine('Removing '.$package->getName());
155	1		$this->packageManager->removePackage($package->getName());
156			}
157
158	1		return 0;
159			}
160
161			/**
162			* Returns the package states that should be displayed for the given
163			* console arguments.
164			*
165			* @param Args $args The console arguments.
166			*
167			* @return int[] A list of {@link PackageState} constants.
168			*/
169	11		private function getSelectedStates(Args $args)
170			{
171	11		$states = array();
172
173	11		if ($args->isOptionSet('enabled')) {
174	3		$states[] = PackageState::ENABLED;
175			}
176
177	11		if ($args->isOptionSet('not-found')) {
178	2		$states[] = PackageState::NOT_FOUND;
179			}
180
181	11		if ($args->isOptionSet('not-loadable')) {
182	1		$states[] = PackageState::NOT_LOADABLE;
183			}
184
185	11		return $states ?: PackageState::all();
186			}
187
188			/**
189			* Returns the packages that should be displayed for the given console
190			* arguments.
191			*
192			* @param Args $args The console arguments.
193			*
194			* @return PackageCollection The packages.
195			*/
196	11		private function getSelectedPackages(Args $args)
197			{
198	11		$states = $this->getSelectedStates($args);
199	11		$expr = Expr::true();
200	11		$envs = array();
201
202	11		if ($states !== PackageState::all()) {
203	5		$expr = $expr->andMethod('getState', Expr::in($states));
204			}
205
206	11		if ($args->isOptionSet('installer')) {
207	2		$expr = $expr->andMethod('getInstallInfo', Expr::method('getInstallerName', Expr::same($args->getOption('installer'))));
208			}
209
210	11		if ($args->isOptionSet('prod')) {
211	2		$envs[] = Environment::PROD;
212			}
213
214	11		if ($args->isOptionSet('dev')) {
215	2		$envs[] = Environment::DEV;
216			}
217
218	11		if (count($envs) > 0) {
219	3		$expr = $expr->andMethod('getInstallInfo', Expr::method('getEnvironment', Expr::in($envs)));
220			}
221
222	11		return $this->packageManager->findPackages($expr);
223			}
224
225			/**
226			* Prints packages with intermediate headers for the package states.
227			*
228			* @param IO $io The I/O.
229			* @param PackageCollection $packages The packages to print.
230			* @param int[] $states The states to print.
231			*/
232	10		private function printPackagesByState(IO $io, PackageCollection $packages, array $states)
233			{
234	10		$printStates = count($states) > 1;
235
236	10		foreach ($states as $state) {
237	10		$filteredPackages = array_filter($packages->toArray(), function (Package $package) use ($state) {
238	10		return $state === $package->getState();
239	10		});
240
241	10		if (0 === count($filteredPackages)) {
242	2		continue;
243			}
244
245	10		if ($printStates) {
246	6		$this->printPackageState($io, $state);
247			}
248
249	10		if (PackageState::NOT_LOADABLE === $state) {
250	5		$this->printNotLoadablePackages($io, $filteredPackages, $printStates);
251			} else {
252	9		$styleTag = PackageState::ENABLED === $state ? null : 'bad';
253	9		$this->printPackageTable($io, $filteredPackages, $styleTag, $printStates);
254			}
255
256	10		if ($printStates) {
257	10		$io->writeLine('');
258			}
259			}
260	10		}
261
262			/**
263			* Prints packages using the given format.
264			*
265			* @param IO $io The I/O.
266			* @param PackageCollection $packages The packages to print.
267			* @param string $format The format string.
268			*/
269	1		private function printPackagesWithFormat(IO $io, PackageCollection $packages, $format)
270			{
271	1		foreach ($packages as $package) {
272	1		$installInfo = $package->getInstallInfo();
273
274	1		$io->writeLine(strtr($format, array(
275	1		'%name%' => $package->getName(),
276	1		'%installer%' => $installInfo ? $installInfo->getInstallerName() : '',
277	1		'%install_path%' => $package->getInstallPath(),
278	1		'%state%' => self::$stateStrings[$package->getState()],
279	1		'%env%' => $installInfo ? $installInfo->getEnvironment() : Environment::PROD,
280			)));
281			}
282	1		}
283
284			/**
285			* Prints the heading for a given package state.
286			*
287			* @param IO $io The I/O.
288			* @param int $packageState The {@link PackageState} constant.
289			*/
290	6	View Code Duplication	private function printPackageState(IO $io, $packageState)
			0 ignored issues – show Duplication introduced 2015-12-06 22:45 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
291			{
292			switch ($packageState) {
293	6		case PackageState::ENABLED:
294	6		$io->writeLine('The following packages are currently enabled:');
295	6		$io->writeLine('');
296
297	6		return;
298	5		case PackageState::NOT_FOUND:
299	4		$io->writeLine('The following packages could not be found:');
300	4		$io->writeLine(' (use "puli package --clean" to remove)');
301	4		$io->writeLine('');
302
303	4		return;
304	4		case PackageState::NOT_LOADABLE:
305	4		$io->writeLine('The following packages could not be loaded:');
306	4		$io->writeLine('');
307
308	4		return;
309			}
310			}
311
312			/**
313			* Prints a list of packages in a table.
314			*
315			* @param IO $io The I/O.
316			* @param Package[] $packages The packages.
317			* @param string\|null $styleTag The tag used to style the output. If `null`,
318			* the default colors are used.
319			* @param bool $indent Whether to indent the output.
320			*/
321	9		private function printPackageTable(IO $io, array $packages, $styleTag = null, $indent = false)
322			{
323	9		$table = new Table(PuliTableStyle::borderless());
324	9		$table->setHeaderRow(array('Package Name', 'Installer', 'Env', 'Install Path'));
325
326	9		$installerTag = $styleTag ?: 'c1';
327	9		$envTag = $styleTag ?: 'c1';
328	9		$pathTag = $styleTag ?: 'c2';
329
330	9		ksort($packages);
331
332	9		foreach ($packages as $package) {
333	9		$packageName = $package->getName();
334	9		$installInfo = $package->getInstallInfo();
335	9		$installPath = $installInfo ? $installInfo->getInstallPath() : '.';
336	9		$installer = $installInfo ? $installInfo->getInstallerName() : '';
337	9		$env = $installInfo ? $installInfo->getEnvironment() : Environment::PROD;
338
339	9		$table->addRow(array(
340	9		$styleTag ? sprintf('<%s>%s</%s>', $styleTag, $packageName, $styleTag) : $packageName,
341	9		$installer ? sprintf('<%s>%s</%s>', $installerTag, $installer, $installerTag) : '',
342	9		sprintf('<%s>%s</%s>', $envTag, $env, $envTag),
343	9		sprintf('<%s>%s</%s>', $pathTag, $installPath, $pathTag),
344			));
345			}
346
347	9		$table->render($io, $indent ? 4 : 0);
348	9		}
349
350			/**
351			* Prints not-loadable packages in a table.
352			*
353			* @param IO $io The I/O.
354			* @param Package[] $packages The not-loadable packages.
355			* @param bool $indent Whether to indent the output.
356			*/
357	5		private function printNotLoadablePackages(IO $io, array $packages, $indent = false)
358			{
359	5		$rootDir = $this->packageManager->getContext()->getRootDirectory();
360	5		$table = new Table(PuliTableStyle::borderless());
361	5		$table->setHeaderRow(array('Package Name', 'Error'));
362
363	5		ksort($packages);
364
365	5		foreach ($packages as $package) {
366	5		$packageName = $package->getName();
367	5		$loadErrors = $package->getLoadErrors();
368	5		$errorMessage = '';
369
370	5		foreach ($loadErrors as $loadError) {
371	5		$errorMessage .= StringUtil::getShortClassName(get_class($loadError)).': '.$loadError->getMessage()."\n";
372			}
373
374	5		$errorMessage = rtrim($errorMessage);
375
376	5		if (!$errorMessage) {
377			$errorMessage = 'Unknown error.';
378			}
379
380			// Remove root directory
381	5		$errorMessage = str_replace($rootDir.'/', '', $errorMessage);
382
383	5		$table->addRow(array(
384	5		sprintf('<bad>%s</bad>', $packageName),
385	5		sprintf('<bad>%s</bad>', $errorMessage),
386			));
387			}
388
389	5		$table->render($io, $indent ? 4 : 0);
390	5		}
391			}
392

puli / cli

Pull Request — master (#21)

PackageCommandHandler::handleInstall() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like