ValidateRegistrationFile::__construct() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

ValidateRegistrationFile::__construct() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: ValidateRegistrationFile

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php


require_once __DIR__ . '/Maintenance.php';

use Composer\Spdx\SpdxLicenses;
use JsonSchema\Validator;

class ValidateRegistrationFile extends Maintenance {
	public function __construct() {
		parent::__construct();
		$this->addArg( 'path', 'Path to extension.json/skin.json file.', true );
	}
	public function execute() {
		if ( !class_exists( Validator::class ) ) {
			$this->error( 'The JsonSchema library cannot be found, please install it through composer.', 1 );
		} elseif ( !class_exists( SpdxLicenses::class ) ) {
			$this->error(
				'The spdx-licenses library cannot be found, please install it through composer.', 1
			);
		}

		$path = $this->getArg( 0 );
		$data = json_decode( file_get_contents( $path ) );
		if ( !is_object( $data ) ) {
			$this->error( "$path is not a valid JSON file.", 1 );
		}
		if ( !isset( $data->manifest_version ) ) {
			$this->output( "Warning: No manifest_version set, assuming 1.\n" );
			// For backwards-compatability assume 1
			$data->manifest_version = 1;
		}
		$version = $data->manifest_version;
		if ( $version !== ExtensionRegistry::MANIFEST_VERSION ) {
			$schemaPath = dirname( __DIR__ ) . "/docs/extension.schema.v$version.json";
		} else {
			$schemaPath = dirname( __DIR__ ) . '/docs/extension.schema.json';
		}

		if ( $version < ExtensionRegistry::OLDEST_MANIFEST_VERSION
			|| $version > ExtensionRegistry::MANIFEST_VERSION
		) {
			$this->error( "Error: $path is using a non-supported schema version, it should use "
				. ExtensionRegistry::MANIFEST_VERSION, 1 );
		} elseif ( $version < ExtensionRegistry::MANIFEST_VERSION ) {
			$this->output( "Warning: $path is using a deprecated schema, and should be updated to "
				. ExtensionRegistry::MANIFEST_VERSION . "\n" );
		}

		$licenseError = false;
		// Check if it's a string, if not, schema validation will display an error
		if ( isset( $data->{'license-name'} ) && is_string( $data->{'license-name'} ) ) {
			$licenses = new SpdxLicenses();
			$valid = $licenses->validate( $data->{'license-name'} );
			if ( !$valid ) {
				$licenseError = '[license-name] Invalid SPDX license identifier, '
					. 'see <https://spdx.org/licenses/>';
			}
		}

		$validator = new Validator;
		$validator->check( $data, (object)[ '$ref' => 'file://' . $schemaPath ] );
		if ( $validator->isValid() && !$licenseError ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$this->output( "$path validates against the version $version schema!\n" );
		} else {
			foreach ( $validator->getErrors() as $error ) {
				$this->output( "[{$error['property']}] {$error['message']}\n" );
			}
			if ( $licenseError ) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
				$this->output( "$licenseError\n" );
			}
			$this->error( "$path does not validate.", 1 );
		}
	}
}

$maintClass = 'ValidateRegistrationFile';
require_once RUN_MAINTENANCE_IF_MAIN;


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-23 18:14 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 8 and the first side effect is on line 3. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3			require_once __DIR__ . '/Maintenance.php';
4
5			use Composer\Spdx\SpdxLicenses;
6			use JsonSchema\Validator;
7
8			class ValidateRegistrationFile extends Maintenance {
9			public function __construct() {
10			parent::__construct();
11			$this->addArg( 'path', 'Path to extension.json/skin.json file.', true );
12			}
13			public function execute() {
14			if ( !class_exists( Validator::class ) ) {
15			$this->error( 'The JsonSchema library cannot be found, please install it through composer.', 1 );
16			} elseif ( !class_exists( SpdxLicenses::class ) ) {
17			$this->error(
18			'The spdx-licenses library cannot be found, please install it through composer.', 1
19			);
20			}
21
22			$path = $this->getArg( 0 );
23			$data = json_decode( file_get_contents( $path ) );
24			if ( !is_object( $data ) ) {
25			$this->error( "$path is not a valid JSON file.", 1 );
26			}
27			if ( !isset( $data->manifest_version ) ) {
28			$this->output( "Warning: No manifest_version set, assuming 1.\n" );
29			// For backwards-compatability assume 1
30			$data->manifest_version = 1;
31			}
32			$version = $data->manifest_version;
33			if ( $version !== ExtensionRegistry::MANIFEST_VERSION ) {
34			$schemaPath = dirname( __DIR__ ) . "/docs/extension.schema.v$version.json";
35			} else {
36			$schemaPath = dirname( __DIR__ ) . '/docs/extension.schema.json';
37			}
38
39			if ( $version < ExtensionRegistry::OLDEST_MANIFEST_VERSION
40			\|\| $version > ExtensionRegistry::MANIFEST_VERSION
41			) {
42			$this->error( "Error: $path is using a non-supported schema version, it should use "
43			. ExtensionRegistry::MANIFEST_VERSION, 1 );
44			} elseif ( $version < ExtensionRegistry::MANIFEST_VERSION ) {
45			$this->output( "Warning: $path is using a deprecated schema, and should be updated to "
46			. ExtensionRegistry::MANIFEST_VERSION . "\n" );
47			}
48
49			$licenseError = false;
50			// Check if it's a string, if not, schema validation will display an error
51			if ( isset( $data->{'license-name'} ) && is_string( $data->{'license-name'} ) ) {
52			$licenses = new SpdxLicenses();
53			$valid = $licenses->validate( $data->{'license-name'} );
54			if ( !$valid ) {
55			$licenseError = '[license-name] Invalid SPDX license identifier, '
56			. 'see <https://spdx.org/licenses/>';
57			}
58			}
59
60			$validator = new Validator;
61			$validator->check( $data, (object)[ '$ref' => 'file://' . $schemaPath ] );
62			if ( $validator->isValid() && !$licenseError ) {
			0 ignored issues – show Bug Best Practice introduced 2016-09-29 17:29 UTC by Report Bug Copy Issue Report The expression `$licenseError` of type `string\|false` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== false` 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...
63			$this->output( "$path validates against the version $version schema!\n" );
64			} else {
65			foreach ( $validator->getErrors() as $error ) {
66			$this->output( "[{$error['property']}] {$error['message']}\n" );
67			}
68			if ( $licenseError ) {
			0 ignored issues – show Bug Best Practice introduced 2016-09-29 17:29 UTC by Report Bug Copy Issue Report The expression `$licenseError` of type `string\|false` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== false` 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...
69			$this->output( "$licenseError\n" );
70			}
71			$this->error( "$path does not validate.", 1 );
72			}
73			}
74			}
75
76			$maintClass = 'ValidateRegistrationFile';
77			require_once RUN_MAINTENANCE_IF_MAIN;
78

wikimedia / mediawiki

ValidateRegistrationFile::__construct() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ValidateRegistrationFile::__construct() A
last analyzed 2016-11-13 17:42 UTC