Newer
Older
Daniel Hürtgen
committed
<?php
namespace Higidi\ComposerPhpCSStandardsPlugin;
use Composer\Composer;
Daniel Hürtgen
committed
use Composer\Installer\BinaryInstaller;
use Composer\Installer\LibraryInstaller;
use Composer\Package\PackageInterface;
use Composer\Repository\InstalledRepositoryInterface;
Daniel Hürtgen
committed
use Composer\Util\Filesystem;
use Higidi\ComposerPhpCSStandardsPlugin\PHPCodeSniffer\Standard;
use Higidi\ComposerPhpCSStandardsPlugin\PHPCodeSniffer\Standards;
use Symfony\Component\Filesystem\Filesystem as SymfonyFilesystem;
use Symfony\Component\Finder\Finder;
Daniel Hürtgen
committed
class Installer extends LibraryInstaller
{
const TYPE = 'phpcodesniffer-standard';
Daniel Hürtgen
committed
/**
* Initializes library installer.
*
* @param IOInterface $io
* @param Composer $composer
* @param string $type
* @param Filesystem $filesystem
Daniel Hürtgen
committed
* @param BinaryInstaller $binaryInstaller
*/
public function __construct(
IOInterface $io,
Composer $composer,
$type = self::TYPE,
Filesystem $filesystem = null,
BinaryInstaller $binaryInstaller = null
) {
parent::__construct($io, $composer, $type, $filesystem, $binaryInstaller);
}
/**
* {@inheritDoc}
*/
public function isInstalled(InstalledRepositoryInterface $repo, PackageInterface $package)
{
if (!parent::isInstalled($repo, $package)) {
return false;
$sourceStandards = $this->getSourceStandards($package);
$destinationStandards = $this->getDestinationStandards($repo);
foreach ($sourceStandards as $sourceStandard) {
if (!$destinationStandards->hasStandard($sourceStandard)
|| !$this->compareStandards($sourceStandard, $destinationStandards->getStandard($sourceStandard))
) {
}
/**
* {@inheritDoc}
*/
public function install(InstalledRepositoryInterface $repo, PackageInterface $package)
{
parent::install($repo, $package);
$this->installStandards($repo, $package);
}
/**
* {@inheritDoc}
*/
public function update(InstalledRepositoryInterface $repo, PackageInterface $initial, PackageInterface $target)
{
parent::update($repo, $initial, $target);
$this->installStandards($repo, $target, $initial ? false : true);
}
/**
* {@inheritDoc}
*/
public function uninstall(InstalledRepositoryInterface $repo, PackageInterface $package)
{
if (!$repo->hasPackage($package)) {
throw new \InvalidArgumentException('Package is not installed: ' . $package);
}
$this->removeStandards($repo, $package);
parent::uninstall($repo, $package);
}
/**
* @param InstalledRepositoryInterface $repo
* @param PackageInterface $package
* @param bool $override
* @return void
*/
protected function installStandards(
InstalledRepositoryInterface $repo,
PackageInterface $package,
$override = false
) {
$filesystem = new SymfonyFilesystem();
$sourceStandards = $this->getSourceStandards($package);
$destStandardsBasePath = $this->getPHPCodeSnifferStandardsBasePath($repo);
$this->io->writeError(' Installing PHP-CodeSniffer Standards:', false);
foreach ($sourceStandards as $sourceStandard) {
$this->io->writeError(sprintf(' <info>%s</info>', $sourceStandard->getName()));
$sourcePath = $sourceStandard->getPath();
$destPath = $destStandardsBasePath . DIRECTORY_SEPARATOR . $sourceStandard->getName();
$filesystem->mirror($sourcePath, $destPath, null, array('override' => $override));
}
}
/**
* @param InstalledRepositoryInterface $repo
* @param PackageInterface $package
* @return void
*/
protected function removeStandards(InstalledRepositoryInterface $repo, PackageInterface $package)
{
$sourceStandards = $this->getSourceStandards($package);
$destinationStandards = $this->getDestinationStandards($repo);
$this->io->writeError(' Removing PHP-CodeSniffer Standards:', false);
foreach ($sourceStandards as $sourceStandard) {
if (!$destinationStandards->hasStandard($sourceStandard)) {
continue;
}
$this->io->writeError(sprintf(' <info>%s</info>', $sourceStandard->getName()));
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
$destinationStandard = $destinationStandards->getStandard($sourceStandard);
$this->filesystem->removeDirectory($destinationStandard->getPath());
}
}
/**
* Get source (provided by the composer package) standards for package.
*
* @param PackageInterface $package
* @return Standards
*/
protected function getSourceStandards(PackageInterface $package)
{
$basePath = $this->getInstallPath($package);
return $this->findStandards($basePath);
}
/**
* Get destination (provided by PHPCodeSniffer) standards.
*
* @param InstalledRepositoryInterface $repo
* @return Standards
*/
protected function getDestinationStandards(InstalledRepositoryInterface $repo)
{
$basePath = $this->getPHPCodeSnifferInstallPath($repo);
return $this->findStandards($basePath);
}
/**
* @param Standard $source
* @param Standard $destination
* @return bool
*/
protected function compareStandards(Standard $source, Standard $destination)
{
return $source->getName() === $destination->getName()
&& sha1_file($source->getRuleSetXmlPath()) === sha1_file($destination->getRuleSetXmlPath());
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
}
/**
* @param string $basePath
* @return Standards
*/
protected function findStandards($basePath)
{
$standards = new Standards();
$finder = new Finder();
$finder
->in($basePath . '/**/Standards/*/')
->files()->name('ruleset.xml');
foreach ($finder as $ruleSetFile) {
$standard = new Standard($ruleSetFile->getPath());
$standards->addStandard($standard);
}
return $standards;
}
/**
* @param InstalledRepositoryInterface $repo
* @return string
*/
protected function getPHPCodeSnifferStandardsBasePath(InstalledRepositoryInterface $repo)
{
$package = $this->getPHPCodeSnifferPackage($repo);
$basePath = $this->getInstallPath($package);
return $basePath . DIRECTORY_SEPARATOR . 'CodeSniffer' . DIRECTORY_SEPARATOR . 'Standards';
}
/**
* @param InstalledRepositoryInterface $repo
* @return PackageInterface
*/
protected function getPHPCodeSnifferPackage(InstalledRepositoryInterface $repo)
{
$packageKey = 'squizlabs/php_codesniffer';
$package = $repo->findPackage($packageKey, '*');
if (!$package) {
throw new \RuntimeException(sprintf('Package "%s" not installed.', $packageKey));
}
return $package;
}
/**
* @param InstalledRepositoryInterface $repo
* @return string
*/
protected function getPHPCodeSnifferInstallPath(InstalledRepositoryInterface $repo)
{
return $this->getInstallPath($this->getPHPCodeSnifferPackage($repo));
}
/**
* {@inheritDoc}
*/
public function supports($packageType)
{
$secondaryPackageTypes = array('phpcodesniffer-standards');
$deprecatedPackageTypes = array('php-codesniffer-standards');
return parent::supports($packageType)
|| in_array($packageType, array_merge($secondaryPackageTypes, $deprecatedPackageTypes));