netresearch / kite

src/Workflow/Composer/Checkout.php

<?php
/**
 * See class comment
 *
 * PHP Version 5
 *
 * @category   Netresearch
 * @package    Netresearch\Kite\Workflow
 * @subpackage Composer
 * @author     Christian Opitz <christian.opitz@netresearch.de>
 * @license    http://www.netresearch.de Netresearch Copyright
 * @link       http://www.netresearch.de
 */

namespace Netresearch\Kite\Workflow\Composer;
use Netresearch\Kite\Exception;
use Netresearch\Kite\Service\Composer\Package;

/**
 * Checkout a branch and eventually merge it with the previously checked out branch
 *
 * @category   Netresearch
 * @package    Netresearch\Kite\Workflow
 * @subpackage Composer
 * @author     Christian Opitz <christian.opitz@netresearch.de>
 * @license    http://www.netresearch.de Netresearch Copyright
 * @link       http://www.netresearch.de
 */
class Checkout extends Base
{
    /**
     * Configures the arguments/options
     *
     * @return array
     */
    protected function configureVariables()
    {
        return array(
            'branch' => array(
                'type' => 'string|array',
                'label' => 'The branch(es) to check out (fallback is always master)',
                'argument' => true,
                'required' => true
            ),
            'merge' => array(
                'type' => 'bool',
                'label' => 'Whether to merge the checked out branch with the previously checked out branch',
                'option' => true,
                'shortcut' => 'm'
            ),
            'create' => array(
                'type' => 'bool',
                'label' => 'Create branch if not exists',
                'option' => true,
                'shortcut' => 'c'
            ),
            '--'
        ) + parent::configureVariables();
    }

    /**
     * Override to assemble the tasks
     *
     * @return void
     */
    public function assemble()
    {
        $this->callback(
            function () {
                $this->checkoutPackages(
                    array_unique(array_merge((array) $this->get('branch'), ['master'])),
                    $this->get('merge'),
                    $this->get('create')
                );
            }
        );
    }

    /**
     * Go through all packages and check it out in the first matching branch
     *
     * @param array $branches The branches to try
     * @param bool  $merge    Whether to merge the new branch with the previously
     *                        checked out branch
     * @param bool  $create   Create branch if not exists
     *
     * @throws Exception\MissingVariableException
     *
     * @return void
     */
    protected function checkoutPackages(array $branches, $merge = false, $create = false)
    {
        /* @var $packages \Netresearch\Kite\Service\Composer\Package[] */
        $packages = array();
        foreach ($this->getPackages() as $package) {
            foreach ($branches as $branch) {
                $oldBranch = $package->branch;
                if ($this->checkoutPackage($package, $branch, $create) !== false) {
                    $packages[$package->name] = $package;
                    if ($merge && $oldBranch !== $branch) {
                        $this->mergePackage($package, $oldBranch);
                    }
                    continue 2;
                }
            }
        }

        if (!$packages) {

The expression $packages of type array<*,Netresearch\Kite\Service\Composer\Package> is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            $lastBranch = array_pop($branches);
            $message = 'Could not find branch ';
            if ($branches) {

The expression $branches of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                $message .= implode(', ', $branches) . ' or ';
            }
            $message .= $lastBranch . ' in any installed package';
            $this->console->output("<warning>$message</warning>");
            return;
        }

        $this->rewriteRequirements($packages, $merge);
        $this->pushPackages();

        // Each package containing one of the branches should now be checked out in
        // this branch. Anyway we do a composer update in order to update lock file
        // and eventually changed dependencies
        $this->doComposerUpdate();
    }
}

?>