Application::getSelfPackage() - Code Metrics - Inspection of "TORG-148: Determine application information when k..." - netresearch/kite - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 23e3c6...05dd66 )

unknown

created 2016-04-19 12:32 UTC

Application::getSelfPackage() D

↳ Parent: Application

Complexity

Conditions	9
Paths	22

Size

Total Lines	33
Code Lines	24

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	33
rs	4.909
cc	9
eloc	24
nc	22
nop	0

<?php
/**
 * See class comment
 *
 * PHP Version 5
 *
 * @category   Netresearch
 * @package    Netresearch\Kite
 * @subpackage Console
 * @author     Christian Opitz <[email protected]>
 * @license    http://www.netresearch.de Netresearch Copyright
 * @link       http://www.netresearch.de
 */

namespace Netresearch\Kite\Console;
use Netresearch\Kite\Console\Command\LogCommand;
use Netresearch\Kite\Console\Output\ConsoleOutput;
use Netresearch\Kite\Console\Output\Output;
use Netresearch\Kite\Exception;
use Netresearch\Kite\Service\Config;
use Netresearch\Kite\Console\Command\JobCommand;
use Netresearch\Kite\Service\Factory;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\StringInput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Process\Process;

/**
 * Kite application
 *
 * @category   Netresearch
 * @package    Netresearch\Kite
 * @subpackage Console
 * @author     Christian Opitz <[email protected]>
 * @license    http://www.netresearch.de Netresearch Copyright
 * @link       http://www.netresearch.de
 */
class Application extends \Symfony\Component\Console\Application
{
    /**
     * @var \Netresearch\Kite\Service\Config
     */
    protected $config;

    /**
     * @var Output
     */
    protected $output;

    /**
     * Application constructor.
     */
    public function __construct()
    {
        $this->output = new ConsoleOutput();
        $this->output->setTerminalDimensions($this->getTerminalDimensions());

        $this->loadConfig();

        parent::__construct('Kite');
    }

    /**
     * Load the configuration
     *
     * @return void
     */
    protected function loadConfig()
    {
        $this->config = new Config();

        $expectedFile = 'kite.php';
        $app = null;
        $indicators = [
            'TYPO3' => ['typo3conf', 'Kite.php'],
            'Magento' => ['app/etc', 'kite.php'],
        ];
        foreach ($indicators as $appName => $dirAndFile) {
            list($dir, $file) = $dirAndFile;
            if (is_dir($dir)) {
                $app = $appName;
                $expectedFile = $dir . '/' . $file;
                break;
            }
        }

        try {
            $this->config->loadConfigFile($expectedFile);
        } catch (\Exception $e) {
            if ($app) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
                $message = [
                    'You appear to be in a ' . $app . ' root directory but',
                    'there is no kite config file at the expected',
                    'location (' . $expectedFile . ').'
                ];
            } else {
                $message = [
                    'You are either not in an application root directory or',
                    'you have no appropriate config file yet.',
                    '',
                    'The config file path is expected to be:',
                ];
                foreach ($indicators as $appName => $dirAndFile) {
                    $message[] = '  - "' . implode('/', $dirAndFile) . '" for ' . $appName . ' applications or';
                }
                $message[] = '  - "' . $expectedFile . '" for any other application';
            }
            $lMax = 0;
            foreach ($message as $line) {
                if (($l = strlen($line)) > $lMax) {
                    $lMax = $l;
                }
            }
            $this->output->writeln('<warning>' . str_repeat(' ', $lMax + 4) . '</warning>');
            foreach ($message as $line) {
                $line = str_pad($line, $lMax + 2);
                $this->output->writeln("<warning>  $line</warning>");
            }
            $this->output->writeln('<warning>' . str_repeat(' ', $lMax + 4) . '</warning>');
        }
    }

    /**
     * Gets the help message.
     *
     * @return string A help message.
     */
    public function getHelp()
    {
        $help
            = " _  ___ _       \n"
            . "| |/ /_| |_ ___\n"
            . "| ' /| | __/ _ \\\n"
            . "| . \\| | |_| __/\n"
            . "|_|\\_|_|\\__\\___|\n\n"
            . $this->getLongVersion() . "\n\n"
            . $this->getSelfPackage()->description;

        return $help;
    }

    /**
     * Returns the long version of the application.
     *
     * @return string The long application version
     */
    public function getLongVersion()
    {
        $package = $this->getSelfPackage();
        $v = "<info>Kite</info> version <comment>{$package->version}</comment>";
        if (isset($package->source)) {
            $v .= " <comment>({$package->source->reference})</comment>";
        }
        $v .= ' ' . $package->time;
        return $v;
    }

    /**
     * Get package info from composer.lock
     *
     * @return object
     */
    protected function getSelfPackage()
    {
        static $package = null;
        if (!$package) {
            $files = [__DIR__ . '/../../../../composer/installed.json', __DIR__ . '/vendor/composer/installed.json'];
            foreach ($files as $file) {
                if (file_exists($file)) {
                    $installed = json_decode(file_get_contents($file));
                    foreach ($installed as $candidate) {
                        if (substr($candidate->name, -5) === '/kite') {
                            $package = $candidate;
                            break 2;
                        }
                    }
                }
            }
            if (!$package) {
                $kitePath = dirname(dirname(__DIR__));
                $process = new Process('git symbolic-ref -q --short HEAD || git describe --tags --exact-match; git rev-parse HEAD; git show -s --format=%ct HEAD', $kitePath);
                $process->run();
                if ($output = $process->getOutput()) {
                    $package = json_decode(file_get_contents($kitePath . '/composer.json'));
                    list($name, $revision, $tstamp) = explode("\n", trim($output), 3);
                    $package->version = preg_match('/^v?[0-9]+\.[0-9]+\.[0-9]+(-[a-z0-9]+)?$/i', $name) ? $name : 'dev-' . $name;
                    $package->source = (object) ['reference' => $revision];
                    $package->time = date('Y-m-d H:i:s', $tstamp);
                } else {
                    throw new Exception('Could not determine self version');
                }
            }
        }
        return $package;
    }

    /**
     * Add workflow option
     *
     * @return \Symfony\Component\Console\Input\InputDefinition
     */
    protected function getDefaultInputDefinition()
// 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);
    }
}
    {
        $definition = parent::getDefaultInputDefinition();
        $definition->addOption(new InputOption('workflow', null, InputOption::VALUE_OPTIONAL, 'Run a workflow on the fly'));

        if (isset($_SERVER['HOME']) && is_writable($_SERVER['HOME'])) {
            $debugDir = $_SERVER['HOME'] . '/.kite/log';
        } else {
            $debugDir = false;
        }
        $definition->addOption(
            new InputOption(
                'debug-dir', null, InputOption::VALUE_OPTIONAL,
                "Path to directory to which to dump the debug output file",
                $debugDir
            )
        );
        return $definition;
    }

    /**
     * Runs the current application.
     *
     * @param InputInterface $input An Input instance
     *
     * @return int 0 if everything went fine, or an error code
     */
    public function run(InputInterface $input = null)
    {
        return parent::run($input, $this->output);
    }


    /**
     * Create job on the fly when workflow option is present
     *
     * @param InputInterface  $input  The input
     * @param OutputInterface $output The output
     *
     * @return int
     */
    public function doRun(InputInterface $input, OutputInterface $output)
    {
        if ($input->hasParameterOption('--workflow')) {
            $strInput = (string) $input;
            if ($this->getCommandName($input) === 'help') {
                $strInput = str_replace('help ', '', $strInput);
                $strInput .= ' --help';
            }
            $workflow = $input->getParameterOption('--workflow');
            $jobName = 'generic:workflow:' . $workflow;
            $this->config->configureJob($jobName, array('workflow' => $workflow));
class User
{
    private $email;

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

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
            $command = new JobCommand($jobName, $this->config);
            $this->add($command);

            $parameterOption = '--workflow=' . $workflow;
            $input = new StringInput(
                rtrim(
                    $jobName . ' ' .
                    str_replace(
                        array(
                            $parameterOption . ' ',
                            ' ' . $parameterOption,
                            $parameterOption
                        ), '', $strInput
                    )
                )
            );
        }
        return parent::doRun($input, $output);
    }


    /**
     * Gets the default commands that should always be available.
     *
     * @return Command[] An array of default Command instances
     */
    protected function getDefaultCommands()
    {
        $commands = parent::getDefaultCommands();
        $commands[] = new LogCommand();

        foreach ($this->config->getJobConfiguration() as $name => $configuration) {
            $commands[] = new JobCommand($name, $this->config);
        }

        return $commands;
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());
}
    }
}
?>



1			<?php
2			/**
3			* See class comment
4			*
5			* PHP Version 5
6			*
7			* @category Netresearch
8			* @package Netresearch\Kite
9			* @subpackage Console
10			* @author Christian Opitz <[email protected]>
11			* @license http://www.netresearch.de Netresearch Copyright
12			* @link http://www.netresearch.de
13			*/
14
15			namespace Netresearch\Kite\Console;
16			use Netresearch\Kite\Console\Command\LogCommand;
17			use Netresearch\Kite\Console\Output\ConsoleOutput;
18			use Netresearch\Kite\Console\Output\Output;
19			use Netresearch\Kite\Exception;
20			use Netresearch\Kite\Service\Config;
21			use Netresearch\Kite\Console\Command\JobCommand;
22			use Netresearch\Kite\Service\Factory;
23			use Symfony\Component\Console\Command\Command;
24			use Symfony\Component\Console\Input\InputInterface;
25			use Symfony\Component\Console\Input\InputOption;
26			use Symfony\Component\Console\Input\StringInput;
27			use Symfony\Component\Console\Output\OutputInterface;
28			use Symfony\Component\Process\Process;
29
30			/**
31			* Kite application
32			*
33			* @category Netresearch
34			* @package Netresearch\Kite
35			* @subpackage Console
36			* @author Christian Opitz <[email protected]>
37			* @license http://www.netresearch.de Netresearch Copyright
38			* @link http://www.netresearch.de
39			*/
40			class Application extends \Symfony\Component\Console\Application
41			{
42			/**
43			* @var \Netresearch\Kite\Service\Config
44			*/
45			protected $config;
46
47			/**
48			* @var Output
49			*/
50			protected $output;
51
52			/**
53			* Application constructor.
54			*/
55			public function __construct()
56			{
57			$this->output = new ConsoleOutput();
58			$this->output->setTerminalDimensions($this->getTerminalDimensions());
59
60			$this->loadConfig();
61
62			parent::__construct('Kite');
63			}
64
65			/**
66			* Load the configuration
67			*
68			* @return void
69			*/
70			protected function loadConfig()
71			{
72			$this->config = new Config();
73
74			$expectedFile = 'kite.php';
75			$app = null;
76			$indicators = [
77			'TYPO3' => ['typo3conf', 'Kite.php'],
78			'Magento' => ['app/etc', 'kite.php'],
79			];
80			foreach ($indicators as $appName => $dirAndFile) {
81			list($dir, $file) = $dirAndFile;
82			if (is_dir($dir)) {
83			$app = $appName;
84			$expectedFile = $dir . '/' . $file;
85			break;
86			}
87			}
88
89			try {
90			$this->config->loadConfigFile($expectedFile);
91			} catch (\Exception $e) {
92			if ($app) {
			0 ignored issues – show Bug Best Practice introduced 2016-03-18 14:36 UTC by Report Bug Copy Issue Report The expression `$app` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
93			$message = [
94			'You appear to be in a ' . $app . ' root directory but',
95			'there is no kite config file at the expected',
96			'location (' . $expectedFile . ').'
97			];
98			} else {
99			$message = [
100			'You are either not in an application root directory or',
101			'you have no appropriate config file yet.',
102			'',
103			'The config file path is expected to be:',
104			];
105			foreach ($indicators as $appName => $dirAndFile) {
106			$message[] = ' - "' . implode('/', $dirAndFile) . '" for ' . $appName . ' applications or';
107			}
108			$message[] = ' - "' . $expectedFile . '" for any other application';
109			}
110			$lMax = 0;
111			foreach ($message as $line) {
112			if (($l = strlen($line)) > $lMax) {
113			$lMax = $l;
114			}
115			}
116			$this->output->writeln('<warning>' . str_repeat(' ', $lMax + 4) . '</warning>');
117			foreach ($message as $line) {
118			$line = str_pad($line, $lMax + 2);
119			$this->output->writeln("<warning> $line</warning>");
120			}
121			$this->output->writeln('<warning>' . str_repeat(' ', $lMax + 4) . '</warning>');
122			}
123			}
124
125			/**
126			* Gets the help message.
127			*
128			* @return string A help message.
129			*/
130			public function getHelp()
131			{
132			$help
133			= " _ ___ _ \n"
134			. "\| \|/ /_\| \|_ ___\n"
135			. "\| ' /\| \| __/ _ \\\n"
136			. "\| . \\\| \| \|_\| __/\n"
137			. "\|_\|\\_\|_\|\\__\\___\|\n\n"
138			. $this->getLongVersion() . "\n\n"
139			. $this->getSelfPackage()->description;
140
141			return $help;
142			}
143
144			/**
145			* Returns the long version of the application.
146			*
147			* @return string The long application version
148			*/
149			public function getLongVersion()
150			{
151			$package = $this->getSelfPackage();
152			$v = "<info>Kite</info> version <comment>{$package->version}</comment>";
153			if (isset($package->source)) {
154			$v .= " <comment>({$package->source->reference})</comment>";
155			}
156			$v .= ' ' . $package->time;
157			return $v;
158			}
159
160			/**
161			* Get package info from composer.lock
162			*
163			* @return object
164			*/
165			protected function getSelfPackage()
166			{
167			static $package = null;
168			if (!$package) {
169			$files = [__DIR__ . '/../../../../composer/installed.json', __DIR__ . '/vendor/composer/installed.json'];
170			foreach ($files as $file) {
171			if (file_exists($file)) {
172			$installed = json_decode(file_get_contents($file));
173			foreach ($installed as $candidate) {
174			if (substr($candidate->name, -5) === '/kite') {
175			$package = $candidate;
176			break 2;
177			}
178			}
179			}
180			}
181			if (!$package) {
182			$kitePath = dirname(dirname(__DIR__));
183			$process = new Process('git symbolic-ref -q --short HEAD \|\| git describe --tags --exact-match; git rev-parse HEAD; git show -s --format=%ct HEAD', $kitePath);
184			$process->run();
185			if ($output = $process->getOutput()) {
186			$package = json_decode(file_get_contents($kitePath . '/composer.json'));
187			list($name, $revision, $tstamp) = explode("\n", trim($output), 3);
188			$package->version = preg_match('/^v?[0-9]+\.[0-9]+\.[0-9]+(-[a-z0-9]+)?$/i', $name) ? $name : 'dev-' . $name;
189			$package->source = (object) ['reference' => $revision];
190			$package->time = date('Y-m-d H:i:s', $tstamp);
191			} else {
192			throw new Exception('Could not determine self version');
193			}
194			}
195			}
196			return $package;
197			}
198
199			/**
200			* Add workflow option
201			*
202			* @return \Symfony\Component\Console\Input\InputDefinition
203			*/
204			protected function getDefaultInputDefinition()
			0 ignored issues – show Coding Style introduced 2016-03-18 14:36 UTC by Report Bug Copy Issue Report `getDefaultInputDefinition` uses the super-global variable `$_SERVER` 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...
205			{
206			$definition = parent::getDefaultInputDefinition();
207			$definition->addOption(new InputOption('workflow', null, InputOption::VALUE_OPTIONAL, 'Run a workflow on the fly'));
208
209			if (isset($_SERVER['HOME']) && is_writable($_SERVER['HOME'])) {
210			$debugDir = $_SERVER['HOME'] . '/.kite/log';
211			} else {
212			$debugDir = false;
213			}
214			$definition->addOption(
215			new InputOption(
216			'debug-dir', null, InputOption::VALUE_OPTIONAL,
217			"Path to directory to which to dump the debug output file",
218			$debugDir
219			)
220			);
221			return $definition;
222			}
223
224			/**
225			* Runs the current application.
226			*
227			* @param InputInterface $input An Input instance
228			*
229			* @return int 0 if everything went fine, or an error code
230			*/
231			public function run(InputInterface $input = null)
232			{
233			return parent::run($input, $this->output);
234			}
235
236
237			/**
238			* Create job on the fly when workflow option is present
239			*
240			* @param InputInterface $input The input
241			* @param OutputInterface $output The output
242			*
243			* @return int
244			*/
245			public function doRun(InputInterface $input, OutputInterface $output)
246			{
247			if ($input->hasParameterOption('--workflow')) {
248			$strInput = (string) $input;
249			if ($this->getCommandName($input) === 'help') {
250			$strInput = str_replace('help ', '', $strInput);
251			$strInput .= ' --help';
252			}
253			$workflow = $input->getParameterOption('--workflow');
254			$jobName = 'generic:workflow:' . $workflow;
255			$this->config->configureJob($jobName, array('workflow' => $workflow));
			0 ignored issues – show Unused Code introduced 2016-03-18 14:36 UTC by Report Bug Copy Issue Report The call to the method `Netresearch\Kite\Service\Config::configureJob()` 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...
256			$command = new JobCommand($jobName, $this->config);
257			$this->add($command);
258
259			$parameterOption = '--workflow=' . $workflow;
260			$input = new StringInput(
261			rtrim(
262			$jobName . ' ' .
263			str_replace(
264			array(
265			$parameterOption . ' ',
266			' ' . $parameterOption,
267			$parameterOption
268			), '', $strInput
269			)
270			)
271			);
272			}
273			return parent::doRun($input, $output);
274			}
275
276
277			/**
278			* Gets the default commands that should always be available.
279			*
280			* @return Command[] An array of default Command instances
281			*/
282			protected function getDefaultCommands()
283			{
284			$commands = parent::getDefaultCommands();
285			$commands[] = new LogCommand();
286
287			foreach ($this->config->getJobConfiguration() as $name => $configuration) {
288			$commands[] = new JobCommand($name, $this->config);
289			}
290
291			return $commands;
			0 ignored issues – show Best Practice introduced 2016-03-18 14:36 UTC by Report Bug Copy Issue Report The expression `return $commands;` seems to be an `array`, but some of its elements' types (`Netresearch\Kite\Console...sole\Command\JobCommand`) 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...
292			}
293			}
294			?>
			1 ignored issue – show Best Practice introduced 2016-03-18 14:36 UTC by Report Bug Copy Issue Report It is not recommended to use PHP's closing tag `?>` in files other than templates. Using a closing tag in PHP files that only contain PHP code is not recommended as you might accidentally add whitespace after the closing tag which would then be output by PHP. This can cause severe problems, for example headers cannot be sent anymore. A simple precaution is to leave off the closing tag as it is not required, and it also has no negative effects whatsoever. Loading history...
295

netresearch / kite

GitHub Access Token became invalid

Push — master ( 23e3c6...05dd66 )

Application::getSelfPackage() D

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like