Robo\RoboFileFixture

Complexity

Total Complexity

21

Size/Duplication

Total Lines	215
Duplicated Lines	4.19 %

Coupling/Cohesion

Components	2
Dependencies	11

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	testStyleInjector()	0	9	1
A	hookCommandEvent()	0	4	1
A	testCommandEvent()	0	4	1
A	hookPostCommand()	0	4	1
A	testCustomEvent()	0	10	2
A	hookOne()	0	4	1
A	hookTwo()	0	4	1
A	testSimpleList()	0	5	1
A	testExec()	0	4	1
A	testVerbosityThreshold()	0	17	1
A	testSymfony()	9	9	2
A	testArrayArgs()	0	4	1
A	testSymfonyStyle()	0	9	1
A	testError()	0	5	1
A	testException()	0	7	2
A	testStopOnFail()	0	13	1
A	testVerbosity()	0	12	1
A	testDeploy()	0	10	1

<?php

namespace Robo;

use Psr\Log\LoggerAwareTrait;
use Psr\Log\LoggerAwareInterface;

use Consolidation\AnnotatedCommand\Events\CustomEventAwareInterface;
use Consolidation\AnnotatedCommand\Events\CustomEventAwareTrait;
use Consolidation\OutputFormatters\StructuredData\PropertyList;
use Robo\Contract\VerbosityThresholdInterface;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;

/**
 * RoboFile under test: a fixture containing some commands to use with tests.
 */
class RoboFileFixture extends \Robo\Tasks implements LoggerAwareInterface, CustomEventAwareInterface
{
    use LoggerAwareTrait;
    use CustomEventAwareTrait;

    /**
     * Demonstrate Robo variable argument passing.
     *
     * @param array $a
     *   A list of commandline parameters.
     */
    public function testArrayArgs(array $a)
    {
        $this->say("The parameters passed are:\n" . var_export($a, true));
    }

    /**
     * Demonstrate use of SymfonyStyle
     */
    public function testSymfonyStyle()
    {
        $this->io()->title('My Title');

The method Robo\Common\IO::io() has been deprecated with message: Use a style injector instead

        $this->io()->section('Section 1');

The method Robo\Common\IO::io() has been deprecated with message: Use a style injector instead

        $this->io()->text('Some text in section one.');

The method Robo\Common\IO::io() has been deprecated with message: Use a style injector instead

        $this->io()->comment('This is just an example of different styles.');

The method Robo\Common\IO::io() has been deprecated with message: Use a style injector instead

        $this->io()->section('Section 2');

The method Robo\Common\IO::io() has been deprecated with message: Use a style injector instead

        $this->io()->text('Some text in section two.');

The method Robo\Common\IO::io() has been deprecated with message: Use a style injector instead

    }

    /**
     * Demonstrate use of SymfonyStyle with a style injector
     */
    public function testStyleInjector(SymfonyStyle $io)
    {
        $io->title('My Title');
        $io->section('Section 1');
        $io->text('Some text in section one printed via injected io object.');
        $io->comment('This is just an example of different styles.');
        $io->section('Section 2');
        $io->text('Some text in section two.');
    }

    /**
     * @hook command-event test:command-event
     */
    public function hookCommandEvent()
    {
        $this->io()->text('This is the command-event hook for the test:command-event command.');

The method Robo\Common\IO::io() has been deprecated with message: Use a style injector instead

    }

    public function testCommandEvent()
    {
        $this->io()->text('This is the main method for the test:command-event command.');

The method Robo\Common\IO::io() has been deprecated with message: Use a style injector instead

    }

    /**
     * @hook post-command test:command-event
     */
    public function hookPostCommand()
    {
        $this->io()->text('This is the post-command hook for the test:command-event command.');

The method Robo\Common\IO::io() has been deprecated with message: Use a style injector instead

    }

    /**
     * This command uses a custom event 'custom-event' to collect data.  Note that
     * the event handlers will not be found unless the hook manager is
     * injected into this command handler object via `setHookManager()`
     * (defined in CustomEventAwareTrait). The Robo DI container does this
     * for us through inflection.
     *
     * @command test:custom-event
     */
    public function testCustomEvent()
    {
        $myEventHandlers = $this->getCustomEventHandlers('custom-event');
        $result = [];
        foreach ($myEventHandlers as $handler) {
            $result[] = $handler();
        }
        sort($result);
        return implode(',', $result);
    }

    /**
     * @hook on-event custom-event
     */
    public function hookOne()
    {
        return 'one';
    }

    /**
     * @hook on-event custom-event
     */
    public function hookTwo()
    {
        return 'two';
    }

    /**
     * Test handling of options
     *
     * @field-labels
     *   a: A
     *   b: B
     */
    public function testSimpleList($options = ['a' => '1', 'b' => '2', 'format' => 'yaml'])
    {
        $result = ['a' => $options['a'], 'b' => $options['b']];
        return new PropertyList($result);
    }

    /**
     * Demonstrate Robo error output and command failure.
     */
    public function testError()
    {
        $this->io()->text(var_export(\Robo\Robo::config()->export(), true));

The method Robo\Common\IO::io() has been deprecated with message: Use a style injector instead

        return $this->taskExec('ls xyzzy' . date('U'))->dir('/tmp')->run();

The method dir does only exist in Robo\Task\Base\Exec, but not in Robo\Collection\CollectionBuilder.

    }

    public function testExec()
    {
        return $this->taskExec('pwd')->run();
    }

    /**
     * Demonstrate what happens when a command or a task
     * throws an exception.  Note that typically, Robo commands
     * should return Result objects rather than throw exceptions.
     */
    public function testException($options = ['task' => false])
    {
        if (!$options['task']) {
            throw new \RuntimeException('Command failed with an exception.');
        }
        throw new \RuntimeException('Task failed with an exception.');
    }

    public function testStopOnFail()
    {
        $this->stopOnFail();
        $this->collectionBuilder()

The method taskExec does not exist on object<Robo\Collection\CollectionBuilder>? Since you implemented __call, maybe consider adding a @method annotation.

            ->taskExec('ls xyzzy' . date('U'))
                ->dir('/tmp')
            ->run();

        // stopOnFail() should cause the failed task to throw an exception,
        // so we should not get here, and instead exit the program with a
        // non-zero status.
        return 0;
    }

    public function testVerbosity()
    {
        $this->output()->writeln('This command will print more information at higher verbosity levels.');
        $this->output()->writeln('Try running with -v, -vv or -vvv');
        $this->output()->writeln('The current verbosity level is ' . $this->output()->getVerbosity());
        $this->output()->writeln('This is a verbose message (-v).', OutputInterface::VERBOSITY_VERBOSE);
        $this->output()->writeln('This is a very verbose message (-vv).', OutputInterface::VERBOSITY_VERY_VERBOSE);
        $this->output()->writeln('This is a debug message (-vvv).', OutputInterface::VERBOSITY_DEBUG);
        $this->logger->warning('This is a warning log message.');
        $this->logger->notice('This is a notice log message.');
        $this->logger->debug('This is a debug log message.');
    }

    public function testVerbosityThreshold()
    {
        $this->output()->writeln('This command will print more information at higher verbosity levels.');
        $this->output()->writeln('Try running with -v, -vv or -vvv');

        return $this->collectionBuilder()

The method taskExec does not exist on object<Robo\Collection\CollectionBuilder>? Since you implemented __call, maybe consider adding a @method annotation.

            ->setVerbosityThreshold(VerbosityThresholdInterface::VERBOSITY_VERBOSE)
            ->taskExec('echo verbose or higher')
                ->interactive(false)
            ->taskExec('echo very verbose or higher')
                ->interactive(false)
                ->setVerbosityThreshold(VerbosityThresholdInterface::VERBOSITY_VERY_VERBOSE)
            ->taskExec('echo always printed')
                ->interactive(false)
                ->setVerbosityThreshold(VerbosityThresholdInterface::VERBOSITY_NORMAL)
            ->run();
    }

    public function testDeploy()
    {
        $gitTask = $this->taskGitStack()

The method pull does only exist in Robo\Task\Vcs\GitStack, but not in Robo\Collection\CollectionBuilder.

            ->pull();

        $this->taskSshExec('mysite.com')

The method remoteDir does only exist in Robo\Task\Remote\Ssh, but not in Robo\Collection\CollectionBuilder.

            ->remoteDir('/var/www/somesite')
            ->exec($gitTask)
            ->run();
    }

    /**
     * Demonstrate use of Symfony $input object in Robo in place of
     * the usual "parameter arguments".
     *
     * @param InputInterface $input
     * @arg array $a A list of commandline parameters.
     * @option foo
     * @default a []
     * @default foo []
     */
    public function testSymfony(InputInterface $input)

This method seems to be duplicated in your project.

    {
        $a = $input->getArgument('a');
        $this->say("The parameters passed are:\n" . var_export($a, true));
        $foo = $input->getOption('foo');
        if (!empty($foo)) {
            $this->say("The options passed via --foo are:\n" . var_export($foo, true));
        }
    }
}