Application::getNewWorkingDir() - Code Metrics - Inspection of "getting closer to original bower by bugfixing use..." - Bee-Lab/bowerphp - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#148)

unknown

created 2016-06-18 10:50 UTC

Application::getNewWorkingDir() A

↳ Parent: Application

Complexity

Conditions	3
Paths	2

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	9
rs	9.6666
cc	3
eloc	5
nc	2
nop	1

<?php

/*
 * This file is part of Bowerphp.
 *
 * (c) Massimiliano Arione <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Bowerphp\Console;

use Bowerphp\Command;
use Bowerphp\Util\ErrorHandler;
use Symfony\Component\Console\Application as BaseApplication;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * The console application that handles the commands
 * Inspired by Composer https://github.com/composer/composer
 */
class Application extends BaseApplication

{
    /**
     * @var Bowerphp
     */
    protected $bowerphp;

    private static $logo = '    ____                                __
   / __ )____ _      _____  _________  / /_  ____
  / __  / __ \ | /| / / _ \/ ___/ __ \/ __ \/ __ \
 / /_/ / /_/ / |/ |/ /  __/ /  / /_/ / / / / /_/ /
/_____/\____/|__/|__/\___/_/  / .___/_/ /_/ .___/
                             /_/         /_/
';

    /**
     * Constructor
     */
    public function __construct()
    {
        ErrorHandler::register();
        parent::__construct('Bowerphp', '0.5 Powered by BeeLab (bee-lab.net)');
    }

    /**
     * {@inheritdoc}
     */
    public function doRun(InputInterface $input, OutputInterface $output)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        if ($input->hasParameterOption('--profile')) {
            $startTime = microtime(true);
        }
        
        if ($input->hasParameterOption('--token')&&($token = $input->getParameterOption(['--token', '-t']))) {
            putenv("BOWERPHP_TOKEN=$token");
            $GLOBALS['BOWERPHP_TOKEN'] = $token;
        }

        if ($newWorkDir = $this->getNewWorkingDir($input)) {
            $oldWorkingDir = getcwd();
            chdir($newWorkDir);
        }

        $result = $this->symfonyDoRun($input, $output);

        if (isset($oldWorkingDir)) {
            chdir($oldWorkingDir);
        }

        if (isset($startTime)) {
            $output->writeln('<info>Memory usage: ' . round(memory_get_usage() / 1024 / 1024, 2) . 'MB (peak: ' . round(memory_get_peak_usage() / 1024 / 1024, 2) . 'MB), time: ' . round(microtime(true) - $startTime, 2) . 's');
        }

        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function getHelp()
    {
        return self::$logo . parent::getHelp();
    }

    /**
     * {@inheritdoc}
     */
    protected function getDefaultCommands()
    {
        return [
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            new Command\HelpCommand(),
            new Command\CommandListCommand(),
            new Command\HomeCommand(),
            new Command\InfoCommand(),
            new Command\InitCommand(),
            new Command\InstallCommand(),
            new Command\ListCommand(),
            new Command\LookupCommand(),
            new Command\SearchCommand(),
            new Command\UpdateCommand(),
            new Command\UninstallCommand(),
        ];
    }

    /**
     * {@inheritdoc}
     */
    protected function getDefaultInputDefinition()
    {
        $definition = parent::getDefaultInputDefinition();
        $definition->addOption(new InputOption('--token', '-t', InputOption::VALUE_OPTIONAL, 'Pass github token as parameter'));
        $definition->addOption(new InputOption('--profile', null, InputOption::VALUE_NONE, 'Display timing and memory usage information'));
        $definition->addOption(new InputOption('--working-dir', '-d', InputOption::VALUE_REQUIRED, 'If specified, use the given directory as working directory.'));

        return $definition;
    }

    /**
     * {@inheritdoc}
     */
    protected function getDefaultHelperSet()
    {
        $helperSet = parent::getDefaultHelperSet();
        $helperSet->set(new \Bowerphp\Command\Helper\QuestionHelper());

        return $helperSet;
    }

    /**
     * @param  InputInterface    $input
     * @throws \RuntimeException
     */
    private function getNewWorkingDir(InputInterface $input)
    {
        $workingDir = $input->getParameterOption(['--working-dir', '-d']);
        if (false !== $workingDir && !is_dir($workingDir)) {
            throw new \RuntimeException('Invalid working directory specified.');
        }

        return $workingDir;
    }

    /**
     * Copy of original Symfony doRun, to allow a default command
     *
     * @param InputInterface  $input   An Input instance
     * @param OutputInterface $output  An Output instance
     * @param string          $default Default command to execute
     *
     * @return int 0 if everything went fine, or an error code
     * @codeCoverageIgnore
     */
    private function symfonyDoRun(InputInterface $input, OutputInterface $output, $default = 'list-commands')
    {
        if (true === $input->hasParameterOption(['--version', '-V'])) {
            $output->writeln($this->getLongVersion());

            return 0;
        }
        
        $name = $this->getCommandName($input);

        if (true === $input->hasParameterOption(['--help', '-h'])) {
            if (!$name) {
                $name = 'help';
                $input = new ArrayInput(['command' => 'help']);
            } else {
                $this->wantHelps = true;
            }
        }

        if (!$name) {
            $name = $default;
            $input = new ArrayInput(['command' => $default]);
        }

        // the command name MUST be the first element of the input
        $command = $this->find($name);

        $this->runningCommand = $command;
        $exitCode = $this->doRunCommand($command, $input, $output);
        $this->runningCommand = null;

        return $exitCode;
    }
}


1			<?php
2
3			/*
4			* This file is part of Bowerphp.
5			*
6			* (c) Massimiliano Arione <[email protected]>
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 Bowerphp\Console;
13
14			use Bowerphp\Command;
15			use Bowerphp\Util\ErrorHandler;
16			use Symfony\Component\Console\Application as BaseApplication;
17			use Symfony\Component\Console\Input\ArrayInput;
18			use Symfony\Component\Console\Input\InputInterface;
19			use Symfony\Component\Console\Input\InputOption;
20			use Symfony\Component\Console\Output\OutputInterface;
21
22			/**
23			* The console application that handles the commands
24			* Inspired by Composer https://github.com/composer/composer
25			*/
26			class Application extends BaseApplication
			0 ignored issues – show Complexity introduced 2016-03-04 17:28 UTC by Report Bug Copy Issue Report The class Application has a coupling between objects value of 19. Consider to reduce the number of dependencies under 13. Loading history...
27			{
28			/**
29			* @var Bowerphp
30			*/
31			protected $bowerphp;
32
33			private static $logo = ' ____ __
34			/ __ )____ _ _____ _________ / /_ ____
35			/ __ / __ \ \| /\| / / _ \/ ___/ __ \/ __ \/ __ \
36			/ /_/ / /_/ / \|/ \|/ / __/ / / /_/ / / / / /_/ /
37			/_____/\____/\|__/\|__/\___/_/ / .___/_/ /_/ .___/
38			/_/ /_/
39			';
40
41			/**
42			* Constructor
43			*/
44			public function __construct()
45			{
46			ErrorHandler::register();
47			parent::__construct('Bowerphp', '0.5 Powered by BeeLab (bee-lab.net)');
48			}
49
50			/**
51			* {@inheritdoc}
52			*/
53			public function doRun(InputInterface $input, OutputInterface $output)
			0 ignored issues – show Coding Style Naming introduced 2016-06-15 19:06 UTC by Report Bug Copy Issue Report The variable $GLOBALS is not named in camelCase. This check marks variable names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style introduced 2016-06-15 19:06 UTC by Report Bug Copy Issue Report `doRun` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
54			{
55			if ($input->hasParameterOption('--profile')) {
56			$startTime = microtime(true);
57			}
58
59			if ($input->hasParameterOption('--token')&&($token = $input->getParameterOption(['--token', '-t']))) {
60			putenv("BOWERPHP_TOKEN=$token");
61			$GLOBALS['BOWERPHP_TOKEN'] = $token;
62			}
63
64			if ($newWorkDir = $this->getNewWorkingDir($input)) {
65			$oldWorkingDir = getcwd();
66			chdir($newWorkDir);
67			}
68
69			$result = $this->symfonyDoRun($input, $output);
70
71			if (isset($oldWorkingDir)) {
72			chdir($oldWorkingDir);
73			}
74
75			if (isset($startTime)) {
76			$output->writeln('<info>Memory usage: ' . round(memory_get_usage() / 1024 / 1024, 2) . 'MB (peak: ' . round(memory_get_peak_usage() / 1024 / 1024, 2) . 'MB), time: ' . round(microtime(true) - $startTime, 2) . 's');
77			}
78
79			return $result;
80			}
81
82			/**
83			* {@inheritdoc}
84			*/
85			public function getHelp()
86			{
87			return self::$logo . parent::getHelp();
88			}
89
90			/**
91			* {@inheritdoc}
92			*/
93			protected function getDefaultCommands()
94			{
95			return [
			0 ignored issues – show Best Practice introduced 2016-05-24 15:45 UTC by Report Bug Copy Issue Report The expression `return array(new \Bowerp...nd\UninstallCommand());` seems to be an `array`, but some of its elements' types (`Bowerphp\Command\HomeCom...ommand\UninstallCommand`) are incompatible with the return type of the parent method `Symfony\Component\Consol...ion::getDefaultCommands` of type `array<Symfony\Component\...le\Command\ListCommand>`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return 'Johannes'; } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
96			new Command\HelpCommand(),
97			new Command\CommandListCommand(),
98			new Command\HomeCommand(),
99			new Command\InfoCommand(),
100			new Command\InitCommand(),
101			new Command\InstallCommand(),
102			new Command\ListCommand(),
103			new Command\LookupCommand(),
104			new Command\SearchCommand(),
105			new Command\UpdateCommand(),
106			new Command\UninstallCommand(),
107			];
108			}
109
110			/**
111			* {@inheritdoc}
112			*/
113			protected function getDefaultInputDefinition()
114			{
115			$definition = parent::getDefaultInputDefinition();
116			$definition->addOption(new InputOption('--token', '-t', InputOption::VALUE_OPTIONAL, 'Pass github token as parameter'));
117			$definition->addOption(new InputOption('--profile', null, InputOption::VALUE_NONE, 'Display timing and memory usage information'));
118			$definition->addOption(new InputOption('--working-dir', '-d', InputOption::VALUE_REQUIRED, 'If specified, use the given directory as working directory.'));
119
120			return $definition;
121			}
122
123			/**
124			* {@inheritdoc}
125			*/
126			protected function getDefaultHelperSet()
127			{
128			$helperSet = parent::getDefaultHelperSet();
129			$helperSet->set(new \Bowerphp\Command\Helper\QuestionHelper());
130
131			return $helperSet;
132			}
133
134			/**
135			* @param InputInterface $input
136			* @throws \RuntimeException
137			*/
138			private function getNewWorkingDir(InputInterface $input)
139			{
140			$workingDir = $input->getParameterOption(['--working-dir', '-d']);
141			if (false !== $workingDir && !is_dir($workingDir)) {
142			throw new \RuntimeException('Invalid working directory specified.');
143			}
144
145			return $workingDir;
146			}
147
148			/**
149			* Copy of original Symfony doRun, to allow a default command
150			*
151			* @param InputInterface $input An Input instance
152			* @param OutputInterface $output An Output instance
153			* @param string $default Default command to execute
154			*
155			* @return int 0 if everything went fine, or an error code
156			* @codeCoverageIgnore
157			*/
158			private function symfonyDoRun(InputInterface $input, OutputInterface $output, $default = 'list-commands')
159			{
160			if (true === $input->hasParameterOption(['--version', '-V'])) {
161			$output->writeln($this->getLongVersion());
162
163			return 0;
164			}
165
166			$name = $this->getCommandName($input);
167
168			if (true === $input->hasParameterOption(['--help', '-h'])) {
169			if (!$name) {
170			$name = 'help';
171			$input = new ArrayInput(['command' => 'help']);
172			} else {
173			$this->wantHelps = true;
174			}
175			}
176
177			if (!$name) {
178			$name = $default;
179			$input = new ArrayInput(['command' => $default]);
180			}
181
182			// the command name MUST be the first element of the input
183			$command = $this->find($name);
184
185			$this->runningCommand = $command;
186			$exitCode = $this->doRunCommand($command, $input, $output);
187			$this->runningCommand = null;
188
189			return $exitCode;
190			}
191			}
192

Bee-Lab / bowerphp

Pull Request — master (#148)

Application::getNewWorkingDir() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like