Completed
Pull Request — master (#1)
by Abdul Malik
03:31
created

Installer::getVersions()   B

Complexity

Conditions 5
Paths 10

Size

Total Lines 16
Code Lines 9

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 30

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 16
ccs 0
cts 10
cp 0
rs 8.8571
cc 5
eloc 9
nc 10
nop 2
crap 30
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 samsonasik/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 VERSIONS = %s;
33
34
    private function __construct()
35
    {
36
    }
37
38
    /**
39
     * @throws \OutOfBoundsException if a version cannot be located
40
     */
41
    public static function getVersion($packageName)
42
    {
43
        $selfVersion = self::VERSIONS;
44
45
        if (isset($selfVersion[$packageName])) {
46
            throw new \OutOfBoundsException(
47
                'Required package "' . $packageName . '" is not installed: cannot detect its version'
48
            );
49
        }
50
51
        return $selfVersion[$packageName];
52
    }
53
}
54
55
PHP;
56
57
    /**
58
     * {@inheritDoc}
59
     */
60
    public function activate(Composer $composer, IOInterface $io)
61
    {
62
        $composer->getEventDispatcher()->addSubscriber($this);
63
    }
64
65
    /**
66
     * {@inheritDoc}
67
     */
68
    public static function getSubscribedEvents()
69
    {
70
        return [
71
            ScriptEvents::POST_INSTALL_CMD => 'dumpVersionsClass',
72
            ScriptEvents::POST_UPDATE_CMD  => 'dumpVersionsClass',
73
        ];
74
    }
75
76
    /**
77
     * @param Event $composerEvent
78
     *
79
     * @return void
80
     *
81
     * @throws \RuntimeException
82
     */
83
    public static function dumpVersionsClass(Event $composerEvent)
84
    {
85
        $io = $composerEvent->getIO();
86
87
        $io->write('<info>samsonasik/package-versions:</info>  Generating version class...');
88
89
        $composer = $composerEvent->getComposer();
90
91
        self::writeVersionClassToFile(
92
            self::generateVersionsClass($composer),
93
            $composer->getConfig(),
94
            $composer->getPackage()
95
        );
96
97
        $io->write('<info>samsonasik/package-versions:</info> ...done generating version class');
98
    }
99
100
    private static function generateVersionsClass(Composer $composer)
101
    {
102
        return sprintf(
103
            self::$generatedClassTemplate,
104
            'fin' . 'al ' . 'cla' . 'ss ' . 'Versions', // note: workaround for regex-based code parsers :-(
105
            var_export(iterator_to_array(self::getVersions($composer->getLocker(), $composer->getPackage())), true)
106
        );
107
    }
108
109
    /**
110
     * @param string               $versionClassSource
111
     * @param Config               $composerConfig
112
     * @param RootPackageInterface $rootPackage
113
     *
114
     * @return void
115
     *
116
     * @throws \RuntimeException
117
     */
118
    private static function writeVersionClassToFile(
119
        $versionClassSource,
120
        Config $composerConfig,
121
        RootPackageInterface $rootPackage
122
    ) {
123
        file_put_contents(
124
            self::locateRootPackageInstallPath($composerConfig, $rootPackage)
125
            . '/src/PackageVersions/Versions.php',
126
            $versionClassSource,
127
            0664
128
        );
129
    }
130
131
    /**
132
     * @param Config               $composerConfig
133
     * @param RootPackageInterface $rootPackage
134
     *
135
     * @return string
136
     *
137
     * @throws \RuntimeException
138
     */
139
    private static function locateRootPackageInstallPath(
140
        Config $composerConfig,
141
        RootPackageInterface $rootPackage
142
    ) {
143
        if ('samsonasik/package-versions' === self::getRootPackageAlias($rootPackage)->getName()) {
144
            return dirname($composerConfig->get('vendor-dir'));
145
        }
146
147
        return $composerConfig->get('vendor-dir') . '/samsonasik/package-versions';
148
    }
149
150
    private static function getRootPackageAlias(RootPackageInterface $rootPackage)
151
    {
152
        $package = $rootPackage;
153
154
        while ($package instanceof AliasPackage) {
155
            $package = $package->getAliasOf();
156
        }
157
158
        return $package;
159
    }
160
161
    /**
162
     * @param Locker               $locker
163
     * @param RootPackageInterface $rootPackage
164
     *
165
     * @return \Generator|\string[]
166
     */
167
    private static function getVersions(Locker $locker, RootPackageInterface $rootPackage)
168
    {
169
        $lockData = $locker->getLockData();
170
171
        $lockData['packages-dev'] = isset($lockData['packages-dev']) ? $lockData['packages-dev'] : [];
172
173
        foreach (array_merge($lockData['packages'], $lockData['packages-dev']) as $package) {
174
            yield $package['name'] => $package['version'] . '@' . (
175
                isset($package['source']['reference'])
176
                    ? $package['source']['reference']
177
                    : (isset($package['dist']['reference']) ? $package['dist']['reference'] : '')
178
            );
179
        }
180
181
        yield $rootPackage->getName() => $rootPackage->getVersion() . '@' . $rootPackage->getSourceReference();
182
    }
183
}
184