GzJsonImportCommand::configure() - Code Metrics - JeroenDeDauw/Replicator - Measure and Improve Code Quality continuously with Scrutinizer

GzJsonImportCommand::configure() A
last analyzed 2019-04-21 21:30 UTC

↳ Parent: GzJsonImportCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	18
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	24
ccs	18
cts	18
cp	1
rs	9.536
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?php

namespace Queryr\Replicator\Cli\Command;

use Queryr\Replicator\Cli\Import\PagesImporterCli;
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 Wikibase\JsonDumpReader\JsonDumpFactory;
use Wikibase\JsonDumpReader\SeekableDumpReader;

/**
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < [email protected] >
 */
class GzJsonImportCommand extends ImportCommandBase {

	protected function configure() {
		$this->setName( 'import:gz' );
		$this->setDescription( 'Imports entities from a gzip compressed JSON dump' );

		$this->addArgument(
			'file',
			InputArgument::REQUIRED,
			'Full path of the gz JSON dump file'
		);

		$this->addOption(
			'continue',
			'c',
			InputOption::VALUE_OPTIONAL,
			'The position to resume import from'
		);

		$this->addOption(
			'max',
			'm',
			InputOption::VALUE_OPTIONAL,
			'The maximum number of entities to import'
		);
	}

	protected function executeCommand( InputInterface $input, OutputInterface $output ) {
		$dumpReader = ( new JsonDumpFactory() )->newGzDumpReader(
			$input->getArgument( 'file' ),

			is_numeric( $input->getOption( 'continue' ) ) ? (int)$input->getOption( 'continue' ) : 0
		);

		$importer = new PagesImporterCli(
			$input,
			$output,
			$this->factory,
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
			function() use ( $output, $dumpReader ) {
				$output->writeln( "\n" );
				$output->writeln( "<info>Import process aborted</info>" );
				$output->writeln( "<comment>To resume, run with</comment> --continue=" . $dumpReader->getPosition() );
			}
		);

		$iterator = $this->factory->newJsonEntityPageIterator( $dumpReader );

		if ( is_numeric( $input->getOption( 'max' ) ) ) {
			$iterator = new \LimitIterator( $iterator, 0, (int)$input->getOption( 'max' ) );
		}

		$importer->runImport( $iterator );

		$this->outputMaxContinuation( $input, $output, $dumpReader );
	}

	private function outputMaxContinuation( InputInterface $input, OutputInterface $output, SeekableDumpReader $reader ) {
		if ( is_numeric( $input->getOption( 'max' ) ) ) {
			$output->writeln(
				"\n<comment>To continue from current position, run with</comment> --continue=" . $reader->getPosition()
			);
		}
	}

}


1		<?php
2
3		namespace Queryr\Replicator\Cli\Command;
4
5		use Queryr\Replicator\Cli\Import\PagesImporterCli;
6		use Symfony\Component\Console\Input\InputArgument;
7		use Symfony\Component\Console\Input\InputInterface;
8		use Symfony\Component\Console\Input\InputOption;
9		use Symfony\Component\Console\Output\OutputInterface;
10		use Wikibase\JsonDumpReader\JsonDumpFactory;
11		use Wikibase\JsonDumpReader\SeekableDumpReader;
12
13		/**
14		* @licence GNU GPL v2+
15		* @author Jeroen De Dauw < [email protected] >
16		*/
17		class GzJsonImportCommand extends ImportCommandBase {
18
19	4	protected function configure() {
20	4	$this->setName( 'import:gz' );
21	4	$this->setDescription( 'Imports entities from a gzip compressed JSON dump' );
22
23	4	$this->addArgument(
24	4	'file',
25	4	InputArgument::REQUIRED,
26	4	'Full path of the gz JSON dump file'
27		);
28
29	4	$this->addOption(
30	4	'continue',
31	4	'c',
32	4	InputOption::VALUE_OPTIONAL,
33	4	'The position to resume import from'
34		);
35
36	4	$this->addOption(
37	4	'max',
38	4	'm',
39	4	InputOption::VALUE_OPTIONAL,
40	4	'The maximum number of entities to import'
41		);
42	4	}
43
44	4	protected function executeCommand( InputInterface $input, OutputInterface $output ) {
45	4	$dumpReader = ( new JsonDumpFactory() )->newGzDumpReader(
46	4	$input->getArgument( 'file' ),
		0 ignored issues – show Bug introduced 2019-04-21 21:30 UTC by Report Bug Copy Issue Report It seems like `$input->getArgument('file')` targeting `Symfony\Component\Consol...nterface::getArgument()` can also be of type `array<integer,string>` or `null`; however, `Wikibase\JsonDumpReader\...tory::newGzDumpReader()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
47	4	is_numeric( $input->getOption( 'continue' ) ) ? (int)$input->getOption( 'continue' ) : 0
48		);
49
50	4	$importer = new PagesImporterCli(
51	4	$input,
52	4	$output,
53	4	$this->factory,
		0 ignored issues – show Bug introduced 2016-01-09 20:24 UTC by Report Bug Copy Issue Report It seems like `$this->factory` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
54	4	function() use ( $output, $dumpReader ) {
55		$output->writeln( "\n" );
56		$output->writeln( "<info>Import process aborted</info>" );
57		$output->writeln( "<comment>To resume, run with</comment> --continue=" . $dumpReader->getPosition() );
58	4	}
59		);
60
61	4	$iterator = $this->factory->newJsonEntityPageIterator( $dumpReader );
62
63	4	if ( is_numeric( $input->getOption( 'max' ) ) ) {
64	2	$iterator = new \LimitIterator( $iterator, 0, (int)$input->getOption( 'max' ) );
65		}
66
67	4	$importer->runImport( $iterator );
68
69	4	$this->outputMaxContinuation( $input, $output, $dumpReader );
70	4	}
71
72	4	private function outputMaxContinuation( InputInterface $input, OutputInterface $output, SeekableDumpReader $reader ) {
73	4	if ( is_numeric( $input->getOption( 'max' ) ) ) {
74	2	$output->writeln(
75	2	"\n<comment>To continue from current position, run with</comment> --continue=" . $reader->getPosition()
76		);
77		}
78	4	}
79
80		}
81

JeroenDeDauw / Replicator

GzJsonImportCommand::configure() A last analyzed 2019-04-21 21:30 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

GzJsonImportCommand::configure() A
last analyzed 2019-04-21 21:30 UTC