UpdateDatabaseCommand::execute() - Code Metrics - Inspection of "Merge pull request #19 from peter-gribanov/extract..." - gpslab/geoip2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f1b31f...5a2174 )

by Peter

created 2020-01-21 11:52 UTC

UpdateDatabaseCommand::execute() B

↳ Parent: UpdateDatabaseCommand

Complexity

Conditions	8
Paths	10

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	72

Importance

Changes

Metric	Value
dl	0
loc	85
ccs	0
cts	46
cp	0
rs	7.0828
c	0
b	0
f	0
cc	8
nc	10
nop	2
crap	72

How to fix Long Method

<?php
/**
 * GpsLab component.
 *
 * @author    Peter Gribanov <[email protected]>
 * @copyright Copyright (c) 2017, Peter Gribanov
 * @license   http://opensource.org/licenses/MIT
 */

namespace GpsLab\Bundle\GeoIP2Bundle\Command;

use GpsLab\Component\Compressor\CompressorInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Stopwatch\Stopwatch;
use Symfony\Component\Stopwatch\StopwatchEvent;

class UpdateDatabaseCommand extends Command
{
    /**
     * @var Stopwatch
     */
    private $stopwatch;

    /**
     * @var Filesystem
     */
    private $fs;

    /**
     * @var string
     */
    private $url;

    /**
     * @var string
     */
    private $cache;

    /**
     * @param Filesystem $fs
     * @param Stopwatch $stopwatch
     * @param CompressorInterface $compressor
     * @param string $url
     * @param string $cache
     */
    public function __construct(Filesystem $fs, Stopwatch $stopwatch, CompressorInterface $compressor, $url, $cache)

    {
        $this->fs = $fs;
        $this->url = $url;
        $this->cache = $cache;
        $this->stopwatch = $stopwatch;
        parent::__construct();
    }

    protected function configure()
    {
        $this
            ->setName('geoip2:update')
            ->setDescription('Downloads and update the GeoIP2 database')
            ->addArgument(
                'url',
                InputArgument::OPTIONAL,
                'URL to downloaded GeoIP2 database',
                $this->url
            )
            ->addArgument(
                'target',
                InputArgument::OPTIONAL,
                'Target download path',
                $this->cache
            )
        ;
    }

    /**
     * @param InputInterface $input
     * @param OutputInterface $output
     *
     * @return int
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $io = new SymfonyStyle($input, $output);
        $url = $input->getArgument('url');
        $target = $input->getArgument('target');

        $io->title('Update the GeoIP2 database');
        $this->stopwatch->start('update');

        $tmp_zip = sys_get_temp_dir().'/GeoLite2.tar.gz';
        $tmp_unzip = sys_get_temp_dir().'/GeoLite2.tar';
        $tmp_untar = sys_get_temp_dir().'/GeoLite2';

        // remove old files and folders for correct overwrite it
        $this->fs->remove([$tmp_zip, $tmp_unzip, $tmp_untar]);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $io->comment(sprintf('Beginning download of file <info>%s</info>', $url));

        file_put_contents($tmp_zip, fopen($url, 'rb'));

        $io->comment(sprintf('Download complete to <info>%s</info>', $tmp_zip));
        $io->comment(sprintf('De-compressing file to <info>%s</info>', $tmp_unzip));

        $this->fs->mkdir(dirname($target), 0777);

        // decompress gz file
        $phar = new \PharData($tmp_zip);
        $phar->decompress();

        $io->comment('Decompression complete');
        $io->comment(sprintf('Extract tar file to <info>%s</info>', $tmp_untar));

        // extract tar archive
        $phar = new \PharData($tmp_unzip);
        $phar->extractTo($tmp_untar);

        $io->comment('Tar archive extracted');

        // find database in archive
        $database = '';
        foreach (scandir($tmp_untar) as $folder) {
            $path = $tmp_untar.'/'.$folder;

            // find folder with database
            // expected something like that "GeoLite2-City_20200114"
            if (
                preg_match('/^(?<database>.+)_(?<year>\d{4})(?<month>\d{2})(?<day>\d{2})$/', $folder, $match) &&
                is_dir($path)
            ) {
                // find database in folder
                // expected something like that "GeoLite2-City.mmdb"
                foreach (scandir($path) as $filename) {
                    $file = $path.'/'.$filename;

                    if (strpos($filename, $match['database']) === 0 && is_file($file)) {
                        $io->comment(sprintf(
                            'Found <info>%s</info> database updated at <info>%s-%s-%s</info>',
                            $match['database'],
                            $match['year'],
                            $match['month'],
                            $match['day']
                        ));

                        $database = $file;
                    }
                }
            }
        }

        if (!$database) {
            throw new \RuntimeException('Not found GeoLite2 database in archive.');
        }

        $this->fs->copy($database, $target, true);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $this->fs->chmod($target, 0777);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $this->fs->remove([$tmp_zip, $tmp_unzip, $tmp_untar]);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $io->comment(sprintf('Database moved to <info>%s</info>', $target));

        $io->success('Finished downloading');

        $this->stopwatch($io, $this->stopwatch->stop('update'));

        return 0;
    }

    /**
     * @param SymfonyStyle $io
     * @param StopwatchEvent $event
     */
    private function stopwatch(SymfonyStyle $io, StopwatchEvent $event)
    {
        $io->writeln([
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            sprintf('Time: <info>%.2F</info> s.', $event->getDuration() / 1000),
            sprintf('Memory: <info>%.2F</info> MiB.', $event->getMemory() / 1024 / 1024),
        ]);
    }
}


1			<?php
2			/**
3			* GpsLab component.
4			*
5			* @author Peter Gribanov <[email protected]>
6			* @copyright Copyright (c) 2017, Peter Gribanov
7			* @license http://opensource.org/licenses/MIT
8			*/
9
10			namespace GpsLab\Bundle\GeoIP2Bundle\Command;
11
12			use GpsLab\Component\Compressor\CompressorInterface;
13			use Symfony\Component\Console\Command\Command;
14			use Symfony\Component\Console\Input\InputArgument;
15			use Symfony\Component\Console\Input\InputInterface;
16			use Symfony\Component\Console\Output\OutputInterface;
17			use Symfony\Component\Console\Style\SymfonyStyle;
18			use Symfony\Component\Filesystem\Filesystem;
19			use Symfony\Component\Stopwatch\Stopwatch;
20			use Symfony\Component\Stopwatch\StopwatchEvent;
21
22			class UpdateDatabaseCommand extends Command
23			{
24			/**
25			* @var Stopwatch
26			*/
27			private $stopwatch;
28
29			/**
30			* @var Filesystem
31			*/
32			private $fs;
33
34			/**
35			* @var string
36			*/
37			private $url;
38
39			/**
40			* @var string
41			*/
42			private $cache;
43
44			/**
45			* @param Filesystem $fs
46			* @param Stopwatch $stopwatch
47			* @param CompressorInterface $compressor
48			* @param string $url
49			* @param string $cache
50			*/
51			public function __construct(Filesystem $fs, Stopwatch $stopwatch, CompressorInterface $compressor, $url, $cache)
			0 ignored issues – show Unused Code introduced 2020-01-21 10:27 UTC by Report Bug Copy Issue Report The parameter `$compressor` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
52			{
53			$this->fs = $fs;
54			$this->url = $url;
55			$this->cache = $cache;
56			$this->stopwatch = $stopwatch;
57			parent::__construct();
58			}
59
60			protected function configure()
61			{
62			$this
63			->setName('geoip2:update')
64			->setDescription('Downloads and update the GeoIP2 database')
65			->addArgument(
66			'url',
67			InputArgument::OPTIONAL,
68			'URL to downloaded GeoIP2 database',
69			$this->url
70			)
71			->addArgument(
72			'target',
73			InputArgument::OPTIONAL,
74			'Target download path',
75			$this->cache
76			)
77			;
78			}
79
80			/**
81			* @param InputInterface $input
82			* @param OutputInterface $output
83			*
84			* @return int
85			*/
86			protected function execute(InputInterface $input, OutputInterface $output)
87			{
88			$io = new SymfonyStyle($input, $output);
89			$url = $input->getArgument('url');
90			$target = $input->getArgument('target');
91
92			$io->title('Update the GeoIP2 database');
93			$this->stopwatch->start('update');
94
95			$tmp_zip = sys_get_temp_dir().'/GeoLite2.tar.gz';
96			$tmp_unzip = sys_get_temp_dir().'/GeoLite2.tar';
97			$tmp_untar = sys_get_temp_dir().'/GeoLite2';
98
99			// remove old files and folders for correct overwrite it
100			$this->fs->remove([$tmp_zip, $tmp_unzip, $tmp_untar]);
			0 ignored issues – show Documentation introduced 2020-01-21 10:27 UTC by Report Bug Copy Issue Report `array($tmp_zip, $tmp_unzip, $tmp_untar)` is of type `array<integer,string,{"0..."string","2":"string"}>`, but the function expects a `string\|object<Symfony\Co...nt\Filesystem\iterable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
101
102			$io->comment(sprintf('Beginning download of file <info>%s</info>', $url));
103
104			file_put_contents($tmp_zip, fopen($url, 'rb'));
105
106			$io->comment(sprintf('Download complete to <info>%s</info>', $tmp_zip));
107			$io->comment(sprintf('De-compressing file to <info>%s</info>', $tmp_unzip));
108
109			$this->fs->mkdir(dirname($target), 0777);
110
111			// decompress gz file
112			$phar = new \PharData($tmp_zip);
113			$phar->decompress();
114
115			$io->comment('Decompression complete');
116			$io->comment(sprintf('Extract tar file to <info>%s</info>', $tmp_untar));
117
118			// extract tar archive
119			$phar = new \PharData($tmp_unzip);
120			$phar->extractTo($tmp_untar);
121
122			$io->comment('Tar archive extracted');
123
124			// find database in archive
125			$database = '';
126			foreach (scandir($tmp_untar) as $folder) {
127			$path = $tmp_untar.'/'.$folder;
128
129			// find folder with database
130			// expected something like that "GeoLite2-City_20200114"
131			if (
132			preg_match('/^(?<database>.+)_(?<year>\d{4})(?<month>\d{2})(?<day>\d{2})$/', $folder, $match) &&
133			is_dir($path)
134			) {
135			// find database in folder
136			// expected something like that "GeoLite2-City.mmdb"
137			foreach (scandir($path) as $filename) {
138			$file = $path.'/'.$filename;
139
140			if (strpos($filename, $match['database']) === 0 && is_file($file)) {
141			$io->comment(sprintf(
142			'Found <info>%s</info> database updated at <info>%s-%s-%s</info>',
143			$match['database'],
144			$match['year'],
145			$match['month'],
146			$match['day']
147			));
148
149			$database = $file;
150			}
151			}
152			}
153			}
154
155			if (!$database) {
156			throw new \RuntimeException('Not found GeoLite2 database in archive.');
157			}
158
159			$this->fs->copy($database, $target, true);
			0 ignored issues – show Bug introduced 2020-01-21 10:27 UTC by Report Bug Copy Issue Report It seems like `$target` defined by `$input->getArgument('target')` on line `90` can also be of type `array<integer,string>` or `null`; however, `Symfony\Component\Filesystem\Filesystem::copy()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
160			$this->fs->chmod($target, 0777);
			0 ignored issues – show Bug introduced 2019-02-08 11:53 UTC by Report Bug Copy Issue Report It seems like `$target` defined by `$input->getArgument('target')` on line `90` can also be of type `array<integer,string>` or `null`; however, `Symfony\Component\Filesystem\Filesystem::chmod()` does only seem to accept `string\|object<Symfony\Co...nt\Filesystem\iterable>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
161			$this->fs->remove([$tmp_zip, $tmp_unzip, $tmp_untar]);
			0 ignored issues – show Documentation introduced 2020-01-21 10:27 UTC by Report Bug Copy Issue Report `array($tmp_zip, $tmp_unzip, $tmp_untar)` is of type `array<integer,string,{"0..."string","2":"string"}>`, but the function expects a `string\|object<Symfony\Co...nt\Filesystem\iterable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
162
163			$io->comment(sprintf('Database moved to <info>%s</info>', $target));
164
165			$io->success('Finished downloading');
166
167			$this->stopwatch($io, $this->stopwatch->stop('update'));
168
169			return 0;
170			}
171
172			/**
173			* @param SymfonyStyle $io
174			* @param StopwatchEvent $event
175			*/
176			private function stopwatch(SymfonyStyle $io, StopwatchEvent $event)
177			{
178			$io->writeln([
			0 ignored issues – show Documentation introduced 2019-02-12 08:17 UTC by Report Bug Copy Issue Report `array(sprintf('Time: <in...emory() / 1024 / 1024))` is of type `array<integer,string,{"0":"string","1":"string"}>`, but the function expects a `string\|object<Symfony\Co...onsole\Output\iterable>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
179			sprintf('Time: <info>%.2F</info> s.', $event->getDuration() / 1000),
180			sprintf('Memory: <info>%.2F</info> MiB.', $event->getMemory() / 1024 / 1024),
181			]);
182			}
183			}
184

gpslab / geoip2

Push — master ( f1b31f...5a2174 )

UpdateDatabaseCommand::execute() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like