Graviton\CoreBundle\Composer\ScriptHandlerBase

Complexity

Total Complexity

6

Size/Duplication

Total Lines	80
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getOptions()	0	6	1
B	executeCommand()	0	24	3
A	getPhp()	0	11	2

<?php
/**
 * composer scripthandler base class
 */

namespace Graviton\CoreBundle\Composer;

use Symfony\Component\Process\Process;
use Symfony\Component\Process\PhpExecutableFinder;
use Composer\Script\CommandEvent;

/**
 * Base class for Composer ScriptHandlers
 *
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
abstract class ScriptHandlerBase

ScriptHandlerBase does not seem to conform to the naming convention (Utils?$).

{
    /**
     * Composer variables are declared static so that an event could update
     * a composer.json and set new options, making them immediately available
     * to forthcoming listeners.
     */
    protected static $options = array(
        'symfony-app-dir' => 'app',
    );

    /**
     * Returns some options - adapted from Sensio DistributionBundle Command
     *
     * @param CommandEvent $event Event
     *
     * @return array Options
     */
    protected static function getOptions(CommandEvent $event)
    {
        $options = array_merge(self::$options, $event->getComposer()->getPackage()->getExtra());
        $options['process-timeout'] = $event->getComposer()->getConfig()->get('process-timeout');
        return $options;
    }

    /**
     * Executes a command
     *
     * @param CommandEvent $event      Event
     * @param string       $consoleDir Console dir
     * @param string       $cmd        Command
     * @param int          $timeout    Timeout
     *
     * @return void
     */
    protected static function executeCommand(CommandEvent $event, $consoleDir, $cmd, $timeout = 300)
    {
        $php = escapeshellarg(self::getPhp(false));
        $console = escapeshellarg($consoleDir.'/console');
        if ($event->getIO()->isDecorated()) {
            $console .= ' --ansi';
        }

        $process = new Process($php.' '.$console.' '.$cmd, null, null, null, $timeout);
        $process->run(
            function ($type, $buffer) use ($event) {
                $event->getIO()->write($buffer, false);
            }
        );

        if (!$process->isSuccessful()) {
            throw new \RuntimeException(
                sprintf(
                    'An error occurred when executing the "%s" command.',
                    escapeshellarg($cmd)
                )
            );
        }
    }


    /**
     * Finds the path to the php executable
     *
     * @param bool $includeArgs include args
     *
     * @return bool|false|null|string path

Consider making the return type a bit more specific; maybe use string.

     */
    protected static function getPhp($includeArgs = true)
    {
        $phpFinder = new PhpExecutableFinder();
        if (!$phpPath = $phpFinder->find($includeArgs)) {
            throw new \RuntimeException(
                'The php executable could not be found, add it to your PATH environment variable and try again'
            );
        }

        return $phpPath;
    }
}