DetectCommand::ask() - Code Metrics - Inspection of "[WIP] Stabilization" - owncloud/updater - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#222)

by Victor

created 2016-02-06 10:37 UTC

DetectCommand::ask() A

↳ Parent: DetectCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	11
ccs	0
cts	10
cp	0
rs	9.4285
cc	1
eloc	8
nc	1
nop	2
crap	2

<?php
/**
 * @author Victor Dubiniuk <[email protected]>
 *
 * @copyright Copyright (c) 2015, ownCloud, Inc.
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace Owncloud\Updater\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\Question\ChoiceQuestion;
use GuzzleHttp\Event\ProgressEvent;
use Owncloud\Updater\Utils\Fetcher;
use Owncloud\Updater\Utils\ConfigReader;
use \Owncloud\Updater\Controller\DownloadController;

class DetectCommand extends Command {

	/**
	 * @var Fetcher $fetcher
	 */
	protected $fetcher;

	/**
	 * @var ConfigReader $configReader
	 */
	protected $configReader;

	/**
	 *
	 */
	protected $output;

	/**
	 * Constructor
	 *
	 * @param Fetcher $fetcher
	 * @param ConfigReader $configReader
	 */
	public function __construct(Fetcher $fetcher, ConfigReader $configReader){
		parent::__construct();
		$this->fetcher = $fetcher;
		$this->configReader = $configReader;
	}

	protected function configure(){
		$this
				->setName('upgrade:detect')
				->setDescription('Detect
- 1. currently existing code, 
- 2. version in config.php, 
- 3. online available verison.
(ASK) what to do? (download, upgrade, abort, …)')
				->addOption(
						'exit-if-none', null, InputOption::VALUE_NONE, 'exit with non-zero status code if new version is not found'
				)
				->addOption(
						'only-check', null, InputOption::VALUE_NONE, 'Only check if update is available'
				)
		;
		;
	}

	protected function execute(InputInterface $input, OutputInterface $output){
		$registry = $this->container['utils.registry'];
		$registry->set('feed', false);

		$fsHelper = $this->container['utils.filesystemhelper'];
		$downloadController = new DownloadController($this->fetcher, $registry, $fsHelper);
		try {
			$currentVersion = $this->configReader->getByPath('system.version');
			if (!strlen($currentVersion)){
				throw new \UnexpectedValueException('Could not detect installed version.');
			}

			$this->getApplication()->getLogger()->info('ownCloud ' . $currentVersion . ' found');
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.
    }
}
			$output->writeln('Current version is ' . $currentVersion);

			$feedData = $downloadController->checkFeed();
			if (!$feedData['success']){
				// Network errors, etc
				$output->writeln("Can't fetch feed.");
				$output->writeln($feedData['exception']->getMessage());
				$this->getApplication()->logException($feedData['exception']);
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.
    }
}
				// Return a number to stop the queue
				return $input->getOption('exit-if-none') ? 4 : null;
			}

			$feed = $feedData['data']['feed'];
			if (!$feed->isValid()){
				// Feed is empty. Means there are no updates
				$output->writeln('No updates found online.');
				return $input->getOption('exit-if-none') ? 4 : null;
			}

			$registry->set('feed', $feed);
			$output->writeln($feed->getVersionString() . ' is found online');

			if ($input->getOption('only-check')){
				return;
			}

			$action = $this->ask($input, $output);
			if ($action === 'abort'){
				$output->writeln('Exiting on user command.');
				return 128;
			}

			$this->output = $output;
			$packageData = $downloadController->downloadOwncloud([$this, 'progress']);
			//Empty line, in order not to overwrite the progress message
			$this->output->writeln('');
			if (!$packageData['success']){
				$registry->set('feed', null);
				throw $packageData['exception'];
			}
	
			if ($action === 'download'){
				$output->writeln('Downloading has been completed. Exiting.');
				return 64;
			}
		} catch (\Exception $e){
			$this->getApplication()->getLogger()->error($e->getMessage());
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.
    }
}
			return 2;
		}
	}

	/**
	 * Ask what to do
	 * @param InputInterface $input
	 * @param OutputInterface $output
	 * @return string
	 */
	public function ask(InputInterface $input, OutputInterface $output){
		$helper = $this->getHelper('question');
		$question = new ChoiceQuestion(
			'What would you do next?',
			['download', 'upgrade', 'abort'],
			'1'
		);
		$action = $helper->ask($input, $output, $question);

		return $action;
	}

	/**
	 * Callback to output download progress
	 * @param ProgressEvent $e
	 */
	public function progress(ProgressEvent $e){
		if ($e->downloadSize){
			$percent = intval(100 * $e->downloaded / $e->downloadSize );
			$percentString = $percent . '%';
			$this->output->write( 'Downloaded ' . $percentString . ' (' . $e->downloaded . ' of ' . $e->downloadSize . ")\r");
		}
	}
}


1			<?php
2			/**
3			* @author Victor Dubiniuk <[email protected]>
4			*
5			* @copyright Copyright (c) 2015, ownCloud, Inc.
6			* @license AGPL-3.0
7			*
8			* This code is free software: you can redistribute it and/or modify
9			* it under the terms of the GNU Affero General Public License, version 3,
10			* as published by the Free Software Foundation.
11			*
12			* This program is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU Affero General Public License for more details.
16			*
17			* You should have received a copy of the GNU Affero General Public License, version 3,
18			* along with this program. If not, see <http://www.gnu.org/licenses/>
19			*
20			*/
21
22			namespace Owncloud\Updater\Command;
23
24			use Symfony\Component\Console\Input\InputArgument;
25			use Symfony\Component\Console\Input\InputInterface;
26			use Symfony\Component\Console\Input\InputOption;
27			use Symfony\Component\Console\Output\OutputInterface;
28			use Symfony\Component\Console\Question\ChoiceQuestion;
29			use GuzzleHttp\Event\ProgressEvent;
30			use Owncloud\Updater\Utils\Fetcher;
31			use Owncloud\Updater\Utils\ConfigReader;
32			use \Owncloud\Updater\Controller\DownloadController;
33
34			class DetectCommand extends Command {
35
36			/**
37			* @var Fetcher $fetcher
38			*/
39			protected $fetcher;
40
41			/**
42			* @var ConfigReader $configReader
43			*/
44			protected $configReader;
45
46			/**
47			*
48			*/
49			protected $output;
50
51			/**
52			* Constructor
53			*
54			* @param Fetcher $fetcher
55			* @param ConfigReader $configReader
56			*/
57			public function __construct(Fetcher $fetcher, ConfigReader $configReader){
58			parent::__construct();
59			$this->fetcher = $fetcher;
60			$this->configReader = $configReader;
61			}
62
63			protected function configure(){
64			$this
65			->setName('upgrade:detect')
66			->setDescription('Detect
67			- 1. currently existing code,
68			- 2. version in config.php,
69			- 3. online available verison.
70			(ASK) what to do? (download, upgrade, abort, …)')
71			->addOption(
72			'exit-if-none', null, InputOption::VALUE_NONE, 'exit with non-zero status code if new version is not found'
73			)
74			->addOption(
75			'only-check', null, InputOption::VALUE_NONE, 'Only check if update is available'
76			)
77			;
78			;
79			}
80
81			protected function execute(InputInterface $input, OutputInterface $output){
82			$registry = $this->container['utils.registry'];
83			$registry->set('feed', false);
84
85			$fsHelper = $this->container['utils.filesystemhelper'];
86			$downloadController = new DownloadController($this->fetcher, $registry, $fsHelper);
87			try {
88			$currentVersion = $this->configReader->getByPath('system.version');
89			if (!strlen($currentVersion)){
90			throw new \UnexpectedValueException('Could not detect installed version.');
91			}
92
93			$this->getApplication()->getLogger()->info('ownCloud ' . $currentVersion . ' found');
			0 ignored issues – show Bug introduced 2015-12-21 09:30 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Console\Application` as the method `getLogger()` does only exist in the following sub-classes of `Symfony\Component\Console\Application`: `Owncloud\Updater\Console\Application`. 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...
94			$output->writeln('Current version is ' . $currentVersion);
95
96			$feedData = $downloadController->checkFeed();
97			if (!$feedData['success']){
98			// Network errors, etc
99			$output->writeln("Can't fetch feed.");
100			$output->writeln($feedData['exception']->getMessage());
101			$this->getApplication()->logException($feedData['exception']);
			0 ignored issues – show Bug introduced 2016-01-30 15:52 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Console\Application` as the method `logException()` does only exist in the following sub-classes of `Symfony\Component\Console\Application`: `Owncloud\Updater\Console\Application`. 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...
102			// Return a number to stop the queue
103			return $input->getOption('exit-if-none') ? 4 : null;
104			}
105
106			$feed = $feedData['data']['feed'];
107			if (!$feed->isValid()){
108			// Feed is empty. Means there are no updates
109			$output->writeln('No updates found online.');
110			return $input->getOption('exit-if-none') ? 4 : null;
111			}
112
113			$registry->set('feed', $feed);
114			$output->writeln($feed->getVersionString() . ' is found online');
115
116			if ($input->getOption('only-check')){
117			return;
118			}
119
120			$action = $this->ask($input, $output);
121			if ($action === 'abort'){
122			$output->writeln('Exiting on user command.');
123			return 128;
124			}
125
126			$this->output = $output;
127			$packageData = $downloadController->downloadOwncloud([$this, 'progress']);
128			//Empty line, in order not to overwrite the progress message
129			$this->output->writeln('');
130			if (!$packageData['success']){
131			$registry->set('feed', null);
132			throw $packageData['exception'];
133			}
134
135			if ($action === 'download'){
136			$output->writeln('Downloading has been completed. Exiting.');
137			return 64;
138			}
139			} catch (\Exception $e){
140			$this->getApplication()->getLogger()->error($e->getMessage());
			0 ignored issues – show Bug introduced 2015-12-21 09:30 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Console\Application` as the method `getLogger()` does only exist in the following sub-classes of `Symfony\Component\Console\Application`: `Owncloud\Updater\Console\Application`. 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...
141			return 2;
142			}
143			}
144
145			/**
146			* Ask what to do
147			* @param InputInterface $input
148			* @param OutputInterface $output
149			* @return string
150			*/
151			public function ask(InputInterface $input, OutputInterface $output){
152			$helper = $this->getHelper('question');
153			$question = new ChoiceQuestion(
154			'What would you do next?',
155			['download', 'upgrade', 'abort'],
156			'1'
157			);
158			$action = $helper->ask($input, $output, $question);
159
160			return $action;
161			}
162
163			/**
164			* Callback to output download progress
165			* @param ProgressEvent $e
166			*/
167			public function progress(ProgressEvent $e){
168			if ($e->downloadSize){
169			$percent = intval(100 * $e->downloaded / $e->downloadSize );
170			$percentString = $percent . '%';
171			$this->output->write( 'Downloaded ' . $percentString . ' (' . $e->downloaded . ' of ' . $e->downloadSize . ")\r");
172			}
173			}
174			}
175

owncloud / updater

Pull Request — master (#222)

DetectCommand::ask() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like