SelfUpdateCommand::configure() - Code Metrics - Inspection of "add self update command for phar generation" - lucascherifi/gitaski - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d496e0...ff8215 )

by Lucas

created 2016-04-15 19:04 UTC

SelfUpdateCommand::configure() A

↳ Parent: SelfUpdateCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	6
rs	9.4285
cc	1
eloc	4
nc	1
nop	0

<?php

namespace Kasifi\Gitaski\Command;

use Exception;
use Humbug\SelfUpdate\Updater;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;

class SelfUpdateCommand extends Command
{
    /**
     * return void
     */
    protected function configure()
    {
        $this
            ->setName('self-update')
            ->setDescription('Self update of Gitaski binary.');
    }

    /**
     * @param InputInterface  $input
     * @param OutputInterface $output
     *
     * @return void
     * @throws Exception
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {

        $updater = new Updater();
        $updater->getStrategy()->setPharUrl('http://lucascherifi.github.io/gitaski/gitaski.phar');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
        $updater->getStrategy()->setVersionUrl('http://lucascherifi.github.io/gitaski/gitaski.phar.version');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
        $io = new SymfonyStyle($input, $output);
        try {
            $result = $updater->update();
            if (!$result) {
                $io = new SymfonyStyle($input, $output);
                $io->success('No update needed.');
                exit(0);

            }
            $new = $updater->getNewVersion();
            $old = $updater->getOldVersion();
            $io->success(sprintf('Updated from %s to %s', $old, $new));
            exit(0);

        } catch (\Exception $e) {
            $io->error($e->getMessage());
            exit(1);

        }
    }
}

Push — master ( d496e0...ff8215 )

SelfUpdateCommand::configure() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

1			<?php
2
3			namespace Kasifi\Gitaski\Command;
4
5			use Exception;
6			use Humbug\SelfUpdate\Updater;
7			use Symfony\Component\Console\Command\Command;
8			use Symfony\Component\Console\Input\InputArgument;
9			use Symfony\Component\Console\Input\InputInterface;
10			use Symfony\Component\Console\Input\InputOption;
11			use Symfony\Component\Console\Output\OutputInterface;
12			use Symfony\Component\Console\Style\SymfonyStyle;
13
14			class SelfUpdateCommand extends Command
15			{
16			/**
17			* return void
18			*/
19			protected function configure()
20			{
21			$this
22			->setName('self-update')
23			->setDescription('Self update of Gitaski binary.');
24			}
25
26			/**
27			* @param InputInterface $input
28			* @param OutputInterface $output
29			*
30			* @return void
31			* @throws Exception
32			*/
33			protected function execute(InputInterface $input, OutputInterface $output)
34			{
35
36			$updater = new Updater();
37			$updater->getStrategy()->setPharUrl('http://lucascherifi.github.io/gitaski/gitaski.phar');
			0 ignored issues – show Bug introduced 2016-04-15 19:06 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Humbug\SelfUpdate\Strategy\StrategyInterface` as the method `setPharUrl()` does only exist in the following implementations of said interface: `Humbug\SelfUpdate\Strategy\ShaStrategy`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
38			$updater->getStrategy()->setVersionUrl('http://lucascherifi.github.io/gitaski/gitaski.phar.version');
			0 ignored issues – show Bug introduced 2016-04-15 19:06 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Humbug\SelfUpdate\Strategy\StrategyInterface` as the method `setVersionUrl()` does only exist in the following implementations of said interface: `Humbug\SelfUpdate\Strategy\ShaStrategy`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
39			$io = new SymfonyStyle($input, $output);
40			try {
41			$result = $updater->update();
42			if (!$result) {
43			$io = new SymfonyStyle($input, $output);
44			$io->success('No update needed.');
45			exit(0);
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-15 19:06 UTC by Report Bug Copy Issue Report The method `execute()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
46			}
47			$new = $updater->getNewVersion();
48			$old = $updater->getOldVersion();
49			$io->success(sprintf('Updated from %s to %s', $old, $new));
50			exit(0);
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-15 19:06 UTC by Report Bug Copy Issue Report The method `execute()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
51			} catch (\Exception $e) {
52			$io->error($e->getMessage());
53			exit(1);
			0 ignored issues – show Coding Style Compatibility introduced 2016-04-15 19:06 UTC by Report Bug Copy Issue Report The method `execute()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
54			}
55			}
56			}

lucascherifi / gitaski

Push — master ( d496e0...ff8215 )

SelfUpdateCommand::configure() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like