CheckComposerLockUpToDate::execute()   C
last analyzed

Complexity

Conditions 7
Paths 24

Size

Total Lines 45
Code Lines 30

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 7
eloc 30
nc 24
nop 0
dl 0
loc 45
rs 6.7272
c 0
b 0
f 0
1
<?php
0 ignored issues
show
Coding Style Compatibility introduced by
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 12 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
/**
6
 * Checks whether your composer-installed dependencies are up to date
7
 *
8
 * Composer creates a "composer.lock" file which specifies which versions are installed
9
 * (via `composer install`). It has a hash, which can be compared to the value of
10
 * the composer.json file to see if dependencies are up to date.
11
 */
12
class CheckComposerLockUpToDate extends Maintenance {
13
	public function __construct() {
14
		parent::__construct();
15
		$this->addDescription(
16
			'Checks whether your composer.lock file is up to date with the current composer.json' );
17
	}
18
19
	public function execute() {
20
		global $IP;
21
		$lockLocation = "$IP/composer.lock";
22
		$jsonLocation = "$IP/composer.json";
23
		if ( !file_exists( $lockLocation ) ) {
24
			// Maybe they're using mediawiki/vendor?
25
			$lockLocation = "$IP/vendor/composer.lock";
26
			if ( !file_exists( $lockLocation ) ) {
27
				$this->error(
28
					'Could not find composer.lock file. Have you run "composer install"?',
29
					1
30
				);
31
			}
32
		}
33
34
		$lock = new ComposerLock( $lockLocation );
35
		$json = new ComposerJson( $jsonLocation );
36
37
		// Check all the dependencies to see if any are old
38
		$found = false;
39
		$installed = $lock->getInstalledDependencies();
40
		foreach ( $json->getRequiredDependencies() as $name => $version ) {
41
			if ( isset( $installed[$name] ) ) {
42
				if ( $installed[$name]['version'] !== $version ) {
43
					$this->output(
44
						"$name: {$installed[$name]['version']} installed, $version required.\n"
45
					);
46
					$found = true;
47
				}
48
			} else {
49
				$this->output( "$name: not installed, $version required.\n" );
50
				$found = true;
51
			}
52
		}
53
		if ( $found ) {
54
			$this->error(
55
				'Error: your composer.lock file is not up to date. ' .
56
					'Run "composer update" to install newer dependencies',
57
				1
58
			);
59
		} else {
60
			// We couldn't find any out-of-date dependencies, so assume everything is ok!
61
			$this->output( "Your composer.lock file is up to date with current dependencies!\n" );
62
		}
63
	}
64
}
65
66
$maintClass = 'CheckComposerLockUpToDate';
67
require_once RUN_MAINTENANCE_IF_MAIN;
68