RoboFile.php

<?php

/**
 * RoboFile.php
 *
 * PHP version 7
 *
 * @author    Tim Wagner <t.wagner@techdivision.com>
 * @copyright 2016 TechDivision GmbH <info@techdivision.com>
 * @license   https://opensource.org/licenses/MIT
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 */

use Lurker\Event\FilesystemEvent;

use Symfony\Component\Finder\Finder;

/**
 * Defines the available build tasks.
 *
 * @author    Tim Wagner <t.wagner@techdivision.com>
 * @copyright 2016 TechDivision GmbH <info@techdivision.com>
 * @license   https://opensource.org/licenses/MIT
 * @link      https://github.com/techdivision/import
 * @link      http://www.techdivision.com
 *
 * @SuppressWarnings(PHPMD)
 */
class RoboFile extends \Robo\Tasks
{

    /**
     * The build properties.
     *
     * @var array
     */
    protected $properties = array(
        'base.dir' => __DIR__,
        'src.dir' => __DIR__ . '/src',
        'dist.dir' => __DIR__ . '/dist',
        'vendor.dir' => __DIR__ . '/vendor',
        'target.dir' => __DIR__ . '/target'
    );

    /**
     * Run's the composer install command.
     *
     * @return \Robo\Result The result
     */
    public function composerInstall()
    {
        // optimize autoloader with custom path
        return $this->taskComposerInstall()
             ->preferDist()
             ->optimizeAutoloader()
             ->run();
    }

    /**
     * Run's the composer update command.
     *
     * @return \Robo\Result The result
     */
    public function composerUpdate()
    {
        // optimize autoloader with custom path
        return $this->taskComposerUpdate()
             ->preferDist()
             ->optimizeAutoloader()
             ->run();
    }

    /**
     * Clean up the environment for a new build.
     *
     * @return \Robo\Result The result
     */
    public function clean()
    {
        return $this->taskDeleteDir($this->properties['target.dir'])->run();
    }

    /**
     * Prepare's the environment for a new build.
     *
     * @return \Robo\Result The result
     */
    public function prepare()
    {
        return $this->taskFileSystemStack()
             ->mkdir($this->properties['dist.dir'])
             ->mkdir($this->properties['target.dir'])
             ->mkdir(sprintf('%s/reports', $this->properties['target.dir']))
             ->run();
    }

    /**
     * Run's the PHPMD.
     *
     * @return \Robo\Result The result
     */
    public function runMd()
    {

        // run the mess detector
        return $this->_exec(
            sprintf(
                '%s/bin/phpmd %s xml phpmd.xml --reportfile %s/reports/pmd.xml --ignore-violations-on-exit',
                $this->properties['vendor.dir'],
                $this->properties['src.dir'],
                $this->properties['target.dir']
            )
        );
    }

    /**
     * Run's the PHPCPD.
     *
     * @return \Robo\Result The result
     */
    public function runCpd()
    {
        // prepare the patterns for the files that has to be ignored
        $ignore = array(
            $this->properties['src.dir'].'/Plugins/MissingOptionValuesPlugin.php',
            $this->properties['src.dir'].'/Loaders/CoreConfigDataLoader.php',
        );
        // run the copy past detector
        return $this->_exec(
            sprintf(
                '%s/bin/phpcpd %s --exclude %s --log-pmd %s/reports/pmd-cpd.xml',
                $this->properties['vendor.dir'],
                $this->properties['src.dir'],
                implode(' --exclude ', $ignore),
                $this->properties['target.dir']
            )
        );
    }

    /**
     * Run's the PHPCodeSniffer.
     *
     * @return \Robo\Result The result
     */
    public function runCs()
    {

        // run the code sniffer
        return $this->_exec(
            sprintf(
                '%s/bin/phpcs -n --report-full --extensions=php --standard=phpcs.xml --report-checkstyle=%s/reports/phpcs.xml %s',
                $this->properties['vendor.dir'],
                $this->properties['target.dir'],
                $this->properties['src.dir']
            )
        );
    }

    /**
     * Run's the PHPUnit tests.
     *
     * @return \Robo\Result The result
     */
    public function runTests()
    {

        // run PHPUnit
        return $this->taskPHPUnit(sprintf('%s/bin/phpunit', $this->properties['vendor.dir']))
             ->configFile('phpunit.xml')
             ->run();
    }

    /**
     * The complete build process.
     *
     * @return void
     */
    public function build()
    {

        // stop the build on first failure of a task
        $this->stopOnFail(true);

        // process the build
        $this->clean();
        $this->prepare();
        $this->runCs();
        $this->runCpd();
        $this->runMd();
        $this->runTests();
    }
}