1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace PackageVersions; |
4
|
|
|
|
5
|
|
|
use Composer\Composer; |
6
|
|
|
use Composer\Config; |
7
|
|
|
use Composer\EventDispatcher\EventSubscriberInterface; |
8
|
|
|
use Composer\IO\IOInterface; |
9
|
|
|
use Composer\Package\AliasPackage; |
10
|
|
|
use Composer\Package\Locker; |
11
|
|
|
use Composer\Package\PackageInterface; |
12
|
|
|
use Composer\Package\RootPackageInterface; |
13
|
|
|
use Composer\Plugin\PluginInterface; |
14
|
|
|
use Composer\Script\Event; |
15
|
|
|
use Composer\Script\ScriptEvents; |
16
|
|
|
|
17
|
|
|
final class Installer implements PluginInterface, EventSubscriberInterface |
18
|
|
|
{ |
19
|
|
|
private static $generatedClassTemplate = <<<'PHP' |
20
|
|
|
<?php |
21
|
|
|
|
22
|
|
|
namespace PackageVersions; |
23
|
|
|
|
24
|
|
|
/** |
25
|
|
|
* This class is generated by ocramius/package-versions, specifically by |
26
|
|
|
* @see \PackageVersions\Installer |
27
|
|
|
* |
28
|
|
|
* This file is overwritten at every run of `composer install` or `composer update`. |
29
|
|
|
*/ |
30
|
|
|
%s |
31
|
|
|
{ |
32
|
|
|
const ROOT_PACKAGE_NAME = '%s'; |
33
|
|
|
const VERSIONS = %s; |
34
|
|
|
|
35
|
|
|
private function __construct() |
36
|
|
|
{ |
37
|
|
|
} |
38
|
|
|
|
39
|
|
|
/** |
40
|
|
|
* @throws \OutOfBoundsException if a version cannot be located |
41
|
|
|
*/ |
42
|
|
|
public static function getVersion(string $packageName) : string |
43
|
|
|
{ |
44
|
|
|
if (isset(self::VERSIONS[$packageName])) { |
45
|
|
|
return self::VERSIONS[$packageName]; |
46
|
|
|
} |
47
|
|
|
|
48
|
|
|
throw new \OutOfBoundsException( |
49
|
|
|
'Required package "' . $packageName . '" is not installed: cannot detect its version' |
50
|
|
|
); |
51
|
|
|
} |
52
|
|
|
} |
53
|
|
|
|
54
|
|
|
PHP; |
55
|
|
|
|
56
|
|
|
/** |
57
|
|
|
* {@inheritDoc} |
58
|
|
|
*/ |
59
|
|
|
public function activate(Composer $composer, IOInterface $io) : void |
60
|
|
|
{ |
61
|
|
|
// Nothing to do here, as all features are provided through event listeners |
62
|
|
|
} |
63
|
|
|
|
64
|
|
|
/** |
65
|
|
|
* {@inheritDoc} |
66
|
|
|
*/ |
67
|
1 |
|
public static function getSubscribedEvents() : array |
68
|
|
|
{ |
69
|
|
|
return [ |
70
|
1 |
|
ScriptEvents::POST_INSTALL_CMD => 'dumpVersionsClass', |
71
|
1 |
|
ScriptEvents::POST_UPDATE_CMD => 'dumpVersionsClass', |
72
|
|
|
]; |
73
|
|
|
} |
74
|
|
|
|
75
|
|
|
/** |
76
|
|
|
* @throws \RuntimeException |
77
|
|
|
*/ |
78
|
13 |
|
public static function dumpVersionsClass(Event $composerEvent) : void |
79
|
|
|
{ |
80
|
13 |
|
$composer = $composerEvent->getComposer(); |
81
|
13 |
|
$rootPackage = $composer->getPackage(); |
82
|
13 |
|
$versions = iterator_to_array(self::getVersions($composer->getLocker(), $rootPackage)); |
83
|
|
|
|
84
|
13 |
|
if (!array_key_exists('ocramius/package-versions', $versions)) { |
85
|
|
|
//plugin must be globally installed - we only want to generate versions for projects which specifically |
86
|
|
|
//require ocramius/package-versions |
87
|
1 |
|
return; |
88
|
|
|
} |
89
|
|
|
|
90
|
12 |
|
$versionClass = self::generateVersionsClass($rootPackage->getName(), $versions); |
91
|
|
|
|
92
|
12 |
|
self::writeVersionClassToFile($versionClass, $composer, $composerEvent->getIO()); |
93
|
12 |
|
} |
94
|
|
|
|
95
|
12 |
|
private static function generateVersionsClass(string $rootPackageName, array $versions) : string |
96
|
|
|
{ |
97
|
12 |
|
return sprintf( |
98
|
12 |
|
self::$generatedClassTemplate, |
99
|
12 |
|
'fin' . 'al ' . 'cla' . 'ss ' . 'Versions', // note: workaround for regex-based code parsers :-( |
100
|
12 |
|
$rootPackageName, |
101
|
12 |
|
var_export($versions, true) |
102
|
|
|
); |
103
|
|
|
} |
104
|
|
|
|
105
|
|
|
/** |
106
|
|
|
* @throws \RuntimeException |
107
|
|
|
*/ |
108
|
12 |
|
private static function writeVersionClassToFile(string $versionClassSource, Composer $composer, IOInterface $io) : void |
109
|
|
|
{ |
110
|
12 |
|
$installPath = self::locateRootPackageInstallPath($composer->getConfig(), $composer->getPackage()) |
111
|
12 |
|
. '/src/PackageVersions/Versions.php'; |
112
|
|
|
|
113
|
12 |
|
if (! file_exists(dirname($installPath))) { |
114
|
1 |
|
$io->write('<info>ocramius/package-versions:</info> Package not found (probably scheduled for removal); generation of version class skipped.'); |
115
|
|
|
|
116
|
1 |
|
return; |
117
|
|
|
} |
118
|
|
|
|
119
|
11 |
|
$io->write('<info>ocramius/package-versions:</info> Generating version class...'); |
120
|
|
|
|
121
|
11 |
|
file_put_contents($installPath, $versionClassSource); |
122
|
11 |
|
chmod($installPath, 0664); |
123
|
|
|
|
124
|
11 |
|
$io->write('<info>ocramius/package-versions:</info> ...done generating version class'); |
125
|
11 |
|
} |
126
|
|
|
|
127
|
|
|
/** |
128
|
|
|
* @throws \RuntimeException |
129
|
|
|
*/ |
130
|
12 |
|
private static function locateRootPackageInstallPath( |
131
|
|
|
Config $composerConfig, |
132
|
|
|
RootPackageInterface $rootPackage |
133
|
|
|
) : string { |
134
|
12 |
|
if ('ocramius/package-versions' === self::getRootPackageAlias($rootPackage)->getName()) { |
135
|
3 |
|
return dirname($composerConfig->get('vendor-dir')); |
136
|
|
|
} |
137
|
|
|
|
138
|
9 |
|
return $composerConfig->get('vendor-dir') . '/ocramius/package-versions'; |
139
|
|
|
} |
140
|
|
|
|
141
|
12 |
|
private static function getRootPackageAlias(RootPackageInterface $rootPackage) : PackageInterface |
142
|
|
|
{ |
143
|
12 |
|
$package = $rootPackage; |
144
|
|
|
|
145
|
12 |
|
while ($package instanceof AliasPackage) { |
146
|
4 |
|
$package = $package->getAliasOf(); |
147
|
|
|
} |
148
|
|
|
|
149
|
12 |
|
return $package; |
150
|
|
|
} |
151
|
|
|
|
152
|
|
|
/** |
153
|
|
|
* @return \Generator|\string[] |
154
|
|
|
*/ |
155
|
13 |
|
private static function getVersions(Locker $locker, RootPackageInterface $rootPackage) : \Generator |
156
|
|
|
{ |
157
|
13 |
|
$lockData = $locker->getLockData(); |
158
|
|
|
|
159
|
13 |
|
$lockData['packages-dev'] = $lockData['packages-dev'] ?? []; |
160
|
|
|
|
161
|
13 |
|
foreach (array_merge($lockData['packages'], $lockData['packages-dev']) as $package) { |
162
|
13 |
|
yield $package['name'] => $package['version'] . '@' . ( |
163
|
13 |
|
$package['source']['reference']?? $package['dist']['reference'] ?? '' |
164
|
|
|
); |
165
|
|
|
} |
166
|
|
|
|
167
|
13 |
|
foreach ($rootPackage->getReplaces() as $replace) { |
168
|
4 |
|
$version = $replace->getPrettyConstraint(); |
169
|
4 |
|
if ($version === 'self.version') { |
170
|
4 |
|
$version = $rootPackage->getPrettyVersion(); |
171
|
|
|
} |
172
|
|
|
|
173
|
4 |
|
yield $replace->getTarget() => $version . '@' . $rootPackage->getSourceReference(); |
174
|
|
|
} |
175
|
|
|
|
176
|
13 |
|
yield $rootPackage->getName() => $rootPackage->getPrettyVersion() . '@' . $rootPackage->getSourceReference(); |
177
|
13 |
|
} |
178
|
|
|
} |
179
|
|
|
|