ConsoleApplicationTests::testRunCommandWithoutArguments() - Code Metrics - cubiche/console - Measure and Improve Code Quality continuously with Scrutinizer

testRunCommandWithoutArguments() B
last analyzed 2017-03-16 11:41 UTC

↳ Parent: ConsoleApplicationTests

Complexity

Conditions	1
Paths	1

Size

Total Lines	27
Code Lines	19

Duplication

Lines	27
Ratio	100 %

Importance

Changes

Metric	Value
dl	27
loc	27
rs	8.8571
c	0
b	0
f	0
cc	1
eloc	19
nc	1
nop	0

<?php

/**
 * This file is part of the Cubiche component.
 *
 * Copyright (c) Cubiche
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cubiche\Core\Console\Tests\Units;

use Cubiche\Core\EventBus\Event\EventBus;
use Cubiche\Core\Console\Api\Config\ApplicationConfig;
use Cubiche\Core\Console\ConsoleApplication;
use Cubiche\Core\Console\Tests\Fixtures\Command\BlogService;
use Cubiche\Core\Console\Tests\Fixtures\Command\ChangePostTitleCommand;
use Cubiche\Core\Console\Tests\Fixtures\Command\CreateBlogCommand;
use Cubiche\Core\Console\Tests\Fixtures\Command\CreatePostCommand;
use Cubiche\Core\Console\Tests\Fixtures\Command\PostService;
use Cubiche\Core\Cqrs\Command\CommandBus;
use Cubiche\Core\EventDispatcher\EventInterface;
use Webmozart\Console\Api\Args\Format\Argument;
use Webmozart\Console\Api\IO\Input;
use Webmozart\Console\Api\IO\IO;
use Webmozart\Console\Api\IO\Output;
use Webmozart\Console\Args\ArgvArgs;
use Webmozart\Console\Handler\Help\HelpHandler;
use Webmozart\Console\IO\InputStream\StringInputStream;
use Webmozart\Console\IO\OutputStream\BufferedOutputStream;

/**
 * ConsoleApplicationTests class.
 *
 * $commandBus = CommandBus::create();
 *
 * $postService = new PostService();
 * $commandBus->addHandler(CreateBlogCommand::class, new BlogService());
 * $commandBus->addHandler(CreatePostCommand::class, $postService);
 * $commandBus->addHandler(ChangePostTitleCommand::class, $postService);
 *
 * class SampleApplicationConfig extends DefaultApplicationConfig
 * {
 *     protected function configure()
 *     {
 *         parent::configure();
 *
 *         $this
 *             ->setName('test')
 *             ->setVersion('1.0.0')
 *             ->beginCommand('blog')
 *                 ->setClass(CreateBlogCommand::class)
 *                 ->setDescription('Create a new blog')
 *                 ->addArgument('name', Argument::REQUIRED | Argument::STRING, 'The blog name')
 *             ->end()
 *             ->beginCommand('post')
 *                 ->setDescription('Manage posts')
 *                 ->beginSubCommand('create')
 *                     ->setClass(CreatePostCommand::class)
 *                     ->setDescription('Create a new post')
 *                     ->addArgument('title', Argument::REQUIRED | Argument::STRING, 'The post title')
 *                     ->addArgument('content', Argument::OPTIONAL, 'The post content')
 *                     ->onPreDispatchEvent(function(EventInterface $event, IO $io) {
 *                         $io->writeLine($event->eventName());
 *                     })
 *                 ->end()
 *                 ->beginSubCommand('change')
 *                     ->setClass(ChangePostTitleCommand::class)
 *                     ->setDescription('Change the post title')
 *                     ->addArgument('title', Argument::REQUIRED | Argument::STRING, 'The new post title')
 *                     ->onPostDispatchEvent(function(EventInterface $event, IO $io) {
 *                         $io->writeLine($event->eventName());
 *                     })
 *                 ->end()
 *             ->end()
 *         ;
 *     }
 * }
 *
 * $cli = new ConsoleApplication(new SampleApplicationConfig(), $commandBus);
 * $cli->run();
 */
class ConsoleApplicationTests extends TestCase
{
    /**
     * @return ApplicationConfig
     */
    protected function createConfiguration()
    {
        $config = new ApplicationConfig();
        $config->setCatchExceptions(false);
        $config->setTerminateAfterRun(false);
        $config->setIOFactory(function ($application, $args, $inputStream, $outputStream, $errorStream) {
            return new IO(new Input($inputStream), new Output($outputStream), new Output($errorStream));
        });

        return $config;
    }

    /**
     * @param callable|ApplicationConfig $config
     *
     * @return ConsoleApplication
     */
    protected function createApplication($config)
    {
        $commandBus = CommandBus::create();
        $eventBus = EventBus::create();

        $postService = new PostService($eventBus);

        $commandBus->addHandler(CreateBlogCommand::class, new BlogService($eventBus));
        $commandBus->addHandler(CreatePostCommand::class, $postService);
        $commandBus->addHandler(ChangePostTitleCommand::class, $postService);

        return new ConsoleApplication($config, $commandBus, $eventBus);
    }

    /**
     * Test run help.
     */
    public function testRunHelpCommand()
    {
        $configCallback = function (ApplicationConfig $config) {
            $config
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                ->beginCommand('help')
                    ->markDefault()
                    ->setHandler(function () {
                        return new HelpHandler();
                    })
                ->end()
            ;
        };

        $this
            ->given($config = $this->createConfiguration())
            ->and($configCallback($config))
            ->and($application = $this->createApplication($config))
            ->and($args = new ArgvArgs(array('test', 'help')))
            ->and($input = new StringInputStream(''))
            ->and($output = new BufferedOutputStream())
            ->and($errorOutput = new BufferedOutputStream())
            ->when($application->run($args, $input, $output, $errorOutput))
            ->then()
                ->string($output->fetch())
                    ->constant('<c1>help</c1>')
        ;

        $this
            ->given($config = $this->createConfiguration())
            ->and($configCallback($config))
            ->and($application = $this->createApplication(function () use ($config) {
                return $config;
            }))
            ->and($args = new ArgvArgs(array('test', 'help')))
            ->and($input = new StringInputStream(''))
            ->and($output = new BufferedOutputStream())
            ->and($errorOutput = new BufferedOutputStream())
            ->when($application->run($args, $input, $output, $errorOutput))
            ->then()
                ->string($output->fetch())
                    ->constant('<c1>help</c1>')
        ;
    }

    /**
     * Test run help subcommand.
     */
    public function testRunHelpSubCommand()
    {
        $configCallback = function (ApplicationConfig $config) {
            $config
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                ->beginCommand('post')
                    ->setDescription('Manage posts')
                    ->beginSubCommand('create')
                        ->setClass(CreatePostCommand::class)
                        ->setDescription('Create a new post')
                    ->end()
                    ->beginSubCommand('change')
                        ->setClass(ChangePostTitleCommand::class)
                        ->setDescription('Change the post title')
                    ->end()
                ->end()
                ->beginCommand('help')
                    ->markDefault()
                    ->addArgument('command', Argument::OPTIONAL, 'The command name')
                    ->setHandler(function () {
                        return new HelpHandler();
                    })
                ->end()
            ;
        };

        $this
            ->given($config = $this->createConfiguration())
            ->and($configCallback($config))
            ->and($application = $this->createApplication($config))
            ->and($args = new ArgvArgs(array('test', 'post')))
            ->and($input = new StringInputStream(''))
            ->and($output = new BufferedOutputStream())
            ->and($errorOutput = new BufferedOutputStream())
            ->when($application->run($args, $input, $output, $errorOutput))
            ->then()
                ->string($output->fetch())
                    ->constant('<c1>help</c1>')
        ;
    }

    /**
     * Test run command without class.
     */
    public function testRunCommandWithoutClass()

    {
        $configCallback = function (ApplicationConfig $config) {
            $config
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
                ->beginCommand('create-blog')
                    ->setDescription('Create a new blog')
                    // should set ->setClass()
                ->end()
            ;
        };

        $this
            ->given($config = $this->createConfiguration())
            ->and($configCallback($config))
            ->and($application = $this->createApplication($config))
            ->and($args = new ArgvArgs(array('test', 'create-blog')))
            ->and($input = new StringInputStream(''))
            ->and($output = new BufferedOutputStream())
            ->and($errorOutput = new BufferedOutputStream())
            ->then()
                ->exception(function () use ($application, $args, $input, $output, $errorOutput) {
                    $application->run($args, $input, $output, $errorOutput);
                })
                ->isInstanceOf(\RuntimeException::class)
        ;
    }

    /**
     * Test run command without arguments.
     */
    public function testRunCommandWithoutArguments()

    {
        $configCallback = function (ApplicationConfig $config) {
            $config
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
                ->beginCommand('create-blog')
                    ->setDescription('Create a new blog')
                    ->setClass(CreateBlogCommand::class)
                    // should have ->addArgument('name', Argument::REQUIRED | Argument::STRING, 'The blog name')

                ->end()
            ;
        };

        $this
            ->given($config = $this->createConfiguration())
            ->and($configCallback($config))
            ->and($application = $this->createApplication($config))
            ->and($args = new ArgvArgs(array('test', 'create-blog')))
            ->and($input = new StringInputStream(''))
            ->and($output = new BufferedOutputStream())
            ->and($errorOutput = new BufferedOutputStream())
            ->then()
                ->exception(function () use ($application, $args, $input, $output, $errorOutput) {
                    $application->run($args, $input, $output, $errorOutput);
                })
                ->isInstanceOf(\InvalidArgumentException::class)
        ;
    }

    /**
     * Test run command with default handlers.
     */
    public function testRunCommandWithDefaultHanlder()
    {
        $configCallback = function (ApplicationConfig $config) {
            $config
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                ->beginCommand('create-blog')
                    ->setDescription('Create a new blog')
                    ->setClass(CreateBlogCommand::class)
                    ->addArgument('name', Argument::REQUIRED | Argument::STRING, 'The blog name')
                ->end()
            ;
        };

        $this
            ->given($config = $this->createConfiguration())
            ->and($configCallback($config))
            ->and($application = $this->createApplication($config))
            ->and($args = new ArgvArgs(array('test', 'create-blog', 'foo')))
            ->and($input = new StringInputStream(''))
            ->and($output = new BufferedOutputStream())
            ->and($errorOutput = new BufferedOutputStream())
            ->when($application->run($args, $input, $output, $errorOutput))
            ->then()
                ->string($output->fetch())
                    ->contains('blog was created')
                    ->contains('<c1>blog was created</c1> success')
                    ->contains('name')
        ;
    }

    /**
     * Test run command with custom predispatch handler.
     */
    public function testRunCommandWithCustomPreDispatchHanlder()
    {
        $configCallback = function (ApplicationConfig $config) {
            $config
                ->beginCommand('post')
                    ->setDescription('Manage posts')
                    ->beginSubCommand('create')
                        ->setClass(CreatePostCommand::class)
                        ->setDescription('Create a new post')
                        ->addArgument('title', Argument::REQUIRED | Argument::STRING, 'The post title')
                        ->addArgument('content', Argument::OPTIONAL, 'The post content')
                        ->onPreDispatchEvent(function (EventInterface $event, IO $io) {
                            $io->writeLine('on pre dispatch');
                        })
                    ->end()
                    ->beginSubCommand('change')
                        ->setClass(ChangePostTitleCommand::class)
                        ->setDescription('Change the post title')
                        ->addArgument('title', Argument::REQUIRED | Argument::STRING, 'The new post title')
                        ->onPostDispatchEvent(function (EventInterface $event, IO $io) {
                            $io->writeLine('on post dispatch');
                        })
                    ->end()
                ->end()
            ;
        };

        $this
            ->given($config = $this->createConfiguration())
            ->and($configCallback($config))
            ->and($application = $this->createApplication($config))
            ->and($args = new ArgvArgs(array('test', 'post', 'create', 'foo', 'bar')))
            ->and($input = new StringInputStream(''))
            ->and($output = new BufferedOutputStream())
            ->and($errorOutput = new BufferedOutputStream())
            ->when($application->run($args, $input, $output, $errorOutput))
            ->then()
                ->string($output->fetch())
                    ->contains('on pre dispatch')
                    ->contains('<c1>post was created</c1> success')
        ;

        $this
            ->given($config = $this->createConfiguration())
            ->and($configCallback($config))
            ->and($application = $this->createApplication($config))
            ->and($args = new ArgvArgs(array('test', 'post', 'change', 'baz')))
            ->and($input = new StringInputStream(''))
            ->and($output = new BufferedOutputStream())
            ->and($errorOutput = new BufferedOutputStream())
            ->when($application->run($args, $input, $output, $errorOutput))
            ->then()
                ->string($output->fetch())
                    ->contains('post title was changed')
                    ->contains('on post dispatch')
                    ->contains('title')
        ;
    }
}


testRunCommandWithoutArguments() B
last analyzed 2017-03-16 11:41 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

1		<?php
2
3		/**
4		* This file is part of the Cubiche component.
5		*
6		* Copyright (c) Cubiche
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 Cubiche\Core\Console\Tests\Units;
13
14		use Cubiche\Core\EventBus\Event\EventBus;
15		use Cubiche\Core\Console\Api\Config\ApplicationConfig;
16		use Cubiche\Core\Console\ConsoleApplication;
17		use Cubiche\Core\Console\Tests\Fixtures\Command\BlogService;
18		use Cubiche\Core\Console\Tests\Fixtures\Command\ChangePostTitleCommand;
19		use Cubiche\Core\Console\Tests\Fixtures\Command\CreateBlogCommand;
20		use Cubiche\Core\Console\Tests\Fixtures\Command\CreatePostCommand;
21		use Cubiche\Core\Console\Tests\Fixtures\Command\PostService;
22		use Cubiche\Core\Cqrs\Command\CommandBus;
23		use Cubiche\Core\EventDispatcher\EventInterface;
24		use Webmozart\Console\Api\Args\Format\Argument;
25		use Webmozart\Console\Api\IO\Input;
26		use Webmozart\Console\Api\IO\IO;
27		use Webmozart\Console\Api\IO\Output;
28		use Webmozart\Console\Args\ArgvArgs;
29		use Webmozart\Console\Handler\Help\HelpHandler;
30		use Webmozart\Console\IO\InputStream\StringInputStream;
31		use Webmozart\Console\IO\OutputStream\BufferedOutputStream;
32
33		/**
34		* ConsoleApplicationTests class.
35		*
36		* $commandBus = CommandBus::create();
37		*
38		* $postService = new PostService();
39		* $commandBus->addHandler(CreateBlogCommand::class, new BlogService());
40		* $commandBus->addHandler(CreatePostCommand::class, $postService);
41		* $commandBus->addHandler(ChangePostTitleCommand::class, $postService);
42		*
43		* class SampleApplicationConfig extends DefaultApplicationConfig
44		* {
45		* protected function configure()
46		* {
47		* parent::configure();
48		*
49		* $this
50		* ->setName('test')
51		* ->setVersion('1.0.0')
52		* ->beginCommand('blog')
53		* ->setClass(CreateBlogCommand::class)
54		* ->setDescription('Create a new blog')
55		* ->addArgument('name', Argument::REQUIRED \| Argument::STRING, 'The blog name')
56		* ->end()
57		* ->beginCommand('post')
58		* ->setDescription('Manage posts')
59		* ->beginSubCommand('create')
60		* ->setClass(CreatePostCommand::class)
61		* ->setDescription('Create a new post')
62		* ->addArgument('title', Argument::REQUIRED \| Argument::STRING, 'The post title')
63		* ->addArgument('content', Argument::OPTIONAL, 'The post content')
64		* ->onPreDispatchEvent(function(EventInterface $event, IO $io) {
65		* $io->writeLine($event->eventName());
66		* })
67		* ->end()
68		* ->beginSubCommand('change')
69		* ->setClass(ChangePostTitleCommand::class)
70		* ->setDescription('Change the post title')
71		* ->addArgument('title', Argument::REQUIRED \| Argument::STRING, 'The new post title')
72		* ->onPostDispatchEvent(function(EventInterface $event, IO $io) {
73		* $io->writeLine($event->eventName());
74		* })
75		* ->end()
76		* ->end()
77		* ;
78		* }
79		* }
80		*
81		* $cli = new ConsoleApplication(new SampleApplicationConfig(), $commandBus);
82		* $cli->run();
83		*/
84		class ConsoleApplicationTests extends TestCase
85		{
86		/**
87		* @return ApplicationConfig
88		*/
89		protected function createConfiguration()
90		{
91		$config = new ApplicationConfig();
92		$config->setCatchExceptions(false);
93		$config->setTerminateAfterRun(false);
94		$config->setIOFactory(function ($application, $args, $inputStream, $outputStream, $errorStream) {
95		return new IO(new Input($inputStream), new Output($outputStream), new Output($errorStream));
96		});
97
98		return $config;
99		}
100
101		/**
102		* @param callable\|ApplicationConfig $config
103		*
104		* @return ConsoleApplication
105		*/
106		protected function createApplication($config)
107		{
108		$commandBus = CommandBus::create();
109		$eventBus = EventBus::create();
110
111		$postService = new PostService($eventBus);
112
113		$commandBus->addHandler(CreateBlogCommand::class, new BlogService($eventBus));
114		$commandBus->addHandler(CreatePostCommand::class, $postService);
115		$commandBus->addHandler(ChangePostTitleCommand::class, $postService);
116
117		return new ConsoleApplication($config, $commandBus, $eventBus);
118		}
119
120		/**
121		* Test run help.
122		*/
123		public function testRunHelpCommand()
124		{
125		$configCallback = function (ApplicationConfig $config) {
126		$config
		0 ignored issues – show Bug introduced 2016-10-18 09:51 UTC by Report Bug Copy Issue Report The method `end` does only exist in `Webmozart\Console\Api\Config\CommandConfig`, but not in `Webmozart\Console\Api\Config\ApplicationConfig`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
127		->beginCommand('help')
128		->markDefault()
129		->setHandler(function () {
130		return new HelpHandler();
131		})
132		->end()
133		;
134		};
135
136		$this
137		->given($config = $this->createConfiguration())
138		->and($configCallback($config))
139		->and($application = $this->createApplication($config))
140		->and($args = new ArgvArgs(array('test', 'help')))
141		->and($input = new StringInputStream(''))
142		->and($output = new BufferedOutputStream())
143		->and($errorOutput = new BufferedOutputStream())
144		->when($application->run($args, $input, $output, $errorOutput))
145		->then()
146		->string($output->fetch())
147		->constant('<c1>help</c1>')
148		;
149
150		$this
151		->given($config = $this->createConfiguration())
152		->and($configCallback($config))
153		->and($application = $this->createApplication(function () use ($config) {
154		return $config;
155		}))
156		->and($args = new ArgvArgs(array('test', 'help')))
157		->and($input = new StringInputStream(''))
158		->and($output = new BufferedOutputStream())
159		->and($errorOutput = new BufferedOutputStream())
160		->when($application->run($args, $input, $output, $errorOutput))
161		->then()
162		->string($output->fetch())
163		->constant('<c1>help</c1>')
164		;
165		}
166
167		/**
168		* Test run help subcommand.
169		*/
170		public function testRunHelpSubCommand()
171		{
172		$configCallback = function (ApplicationConfig $config) {
173		$config
		0 ignored issues – show Bug introduced 2016-10-18 09:51 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Webmozart\Console\Api\Config\SubCommandConfig` as the method `setClass()` does only exist in the following sub-classes of `Webmozart\Console\Api\Config\SubCommandConfig`: `Cubiche\Core\Console\Api\Config\SubCommandConfig`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
174		->beginCommand('post')
175		->setDescription('Manage posts')
176		->beginSubCommand('create')
177		->setClass(CreatePostCommand::class)
178		->setDescription('Create a new post')
179		->end()
180		->beginSubCommand('change')
181		->setClass(ChangePostTitleCommand::class)
182		->setDescription('Change the post title')
183		->end()
184		->end()
185		->beginCommand('help')
186		->markDefault()
187		->addArgument('command', Argument::OPTIONAL, 'The command name')
188		->setHandler(function () {
189		return new HelpHandler();
190		})
191		->end()
192		;
193		};
194
195		$this
196		->given($config = $this->createConfiguration())
197		->and($configCallback($config))
198		->and($application = $this->createApplication($config))
199		->and($args = new ArgvArgs(array('test', 'post')))
200		->and($input = new StringInputStream(''))
201		->and($output = new BufferedOutputStream())
202		->and($errorOutput = new BufferedOutputStream())
203		->when($application->run($args, $input, $output, $errorOutput))
204		->then()
205		->string($output->fetch())
206		->constant('<c1>help</c1>')
207		;
208		}
209
210		/**
211		* Test run command without class.
212		*/
213	View Code Duplication	public function testRunCommandWithoutClass()
		0 ignored issues – show Duplication introduced 2016-10-18 09:51 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...
214		{
215		$configCallback = function (ApplicationConfig $config) {
216		$config
		0 ignored issues – show Unused Code introduced 2016-10-18 09:51 UTC by Report Bug Copy Issue Report The call to the method `Cubiche\Core\Console\Api...ig\CommandConfig::end()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
217		->beginCommand('create-blog')
218		->setDescription('Create a new blog')
219		// should set ->setClass()
220		->end()
221		;
222		};
223
224		$this
225		->given($config = $this->createConfiguration())
226		->and($configCallback($config))
227		->and($application = $this->createApplication($config))
228		->and($args = new ArgvArgs(array('test', 'create-blog')))
229		->and($input = new StringInputStream(''))
230		->and($output = new BufferedOutputStream())
231		->and($errorOutput = new BufferedOutputStream())
232		->then()
233		->exception(function () use ($application, $args, $input, $output, $errorOutput) {
234		$application->run($args, $input, $output, $errorOutput);
235		})
236		->isInstanceOf(\RuntimeException::class)
237		;
238		}
239
240		/**
241		* Test run command without arguments.
242		*/
243	View Code Duplication	public function testRunCommandWithoutArguments()
		0 ignored issues – show Duplication introduced 2016-10-18 09:51 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...
244		{
245		$configCallback = function (ApplicationConfig $config) {
246		$config
		0 ignored issues – show Unused Code introduced 2016-10-18 09:51 UTC by Report Bug Copy Issue Report The call to the method `Cubiche\Core\Console\Api...ig\CommandConfig::end()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
247		->beginCommand('create-blog')
248		->setDescription('Create a new blog')
249		->setClass(CreateBlogCommand::class)
250		// should have ->addArgument('name', Argument::REQUIRED \| Argument::STRING, 'The blog name')
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-10-18 09:51 UTC by Report Bug Copy Issue Report `42%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
251		->end()
252		;
253		};
254
255		$this
256		->given($config = $this->createConfiguration())
257		->and($configCallback($config))
258		->and($application = $this->createApplication($config))
259		->and($args = new ArgvArgs(array('test', 'create-blog')))
260		->and($input = new StringInputStream(''))
261		->and($output = new BufferedOutputStream())
262		->and($errorOutput = new BufferedOutputStream())
263		->then()
264		->exception(function () use ($application, $args, $input, $output, $errorOutput) {
265		$application->run($args, $input, $output, $errorOutput);
266		})
267		->isInstanceOf(\InvalidArgumentException::class)
268		;
269		}
270
271		/**
272		* Test run command with default handlers.
273		*/
274		public function testRunCommandWithDefaultHanlder()
275		{
276		$configCallback = function (ApplicationConfig $config) {
277		$config
		0 ignored issues – show Bug introduced 2016-10-18 09:51 UTC by Report Bug Copy Issue Report The method `end` does only exist in `Webmozart\Console\Api\Config\CommandConfig`, but not in `Webmozart\Console\Api\Config\ApplicationConfig`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
278		->beginCommand('create-blog')
279		->setDescription('Create a new blog')
280		->setClass(CreateBlogCommand::class)
281		->addArgument('name', Argument::REQUIRED \| Argument::STRING, 'The blog name')
282		->end()
283		;
284		};
285
286		$this
287		->given($config = $this->createConfiguration())
288		->and($configCallback($config))
289		->and($application = $this->createApplication($config))
290		->and($args = new ArgvArgs(array('test', 'create-blog', 'foo')))
291		->and($input = new StringInputStream(''))
292		->and($output = new BufferedOutputStream())
293		->and($errorOutput = new BufferedOutputStream())
294		->when($application->run($args, $input, $output, $errorOutput))
295		->then()
296		->string($output->fetch())
297		->contains('blog was created')
298		->contains('<c1>blog was created</c1> success')
299		->contains('name')
300		;
301		}
302
303		/**
304		* Test run command with custom predispatch handler.
305		*/
306		public function testRunCommandWithCustomPreDispatchHanlder()
307		{
308		$configCallback = function (ApplicationConfig $config) {
309		$config
310		->beginCommand('post')
311		->setDescription('Manage posts')
312		->beginSubCommand('create')
313		->setClass(CreatePostCommand::class)
314		->setDescription('Create a new post')
315		->addArgument('title', Argument::REQUIRED \| Argument::STRING, 'The post title')
316		->addArgument('content', Argument::OPTIONAL, 'The post content')
317		->onPreDispatchEvent(function (EventInterface $event, IO $io) {
318		$io->writeLine('on pre dispatch');
319		})
320		->end()
321		->beginSubCommand('change')
322		->setClass(ChangePostTitleCommand::class)
323		->setDescription('Change the post title')
324		->addArgument('title', Argument::REQUIRED \| Argument::STRING, 'The new post title')
325		->onPostDispatchEvent(function (EventInterface $event, IO $io) {
326		$io->writeLine('on post dispatch');
327		})
328		->end()
329		->end()
330		;
331		};
332
333		$this
334		->given($config = $this->createConfiguration())
335		->and($configCallback($config))
336		->and($application = $this->createApplication($config))
337		->and($args = new ArgvArgs(array('test', 'post', 'create', 'foo', 'bar')))
338		->and($input = new StringInputStream(''))
339		->and($output = new BufferedOutputStream())
340		->and($errorOutput = new BufferedOutputStream())
341		->when($application->run($args, $input, $output, $errorOutput))
342		->then()
343		->string($output->fetch())
344		->contains('on pre dispatch')
345		->contains('<c1>post was created</c1> success')
346		;
347
348		$this
349		->given($config = $this->createConfiguration())
350		->and($configCallback($config))
351		->and($application = $this->createApplication($config))
352		->and($args = new ArgvArgs(array('test', 'post', 'change', 'baz')))
353		->and($input = new StringInputStream(''))
354		->and($output = new BufferedOutputStream())
355		->and($errorOutput = new BufferedOutputStream())
356		->when($application->run($args, $input, $output, $errorOutput))
357		->then()
358		->string($output->fetch())
359		->contains('post title was changed')
360		->contains('on post dispatch')
361		->contains('title')
362		;
363		}
364		}
365

cubiche / console

testRunCommandWithoutArguments() B last analyzed 2017-03-16 11:41 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

testRunCommandWithoutArguments() B
last analyzed 2017-03-16 11:41 UTC