Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ script:
if [[ $RUN_RECTOR == true ]]; then
bin/rector process src --set symfony40 --dry-run
composer docs
php bin/check_class_existance_in_yaml_configs.php
php bin/check_services_in_yaml_configs.php
fi

# Eat your own dog food
Expand Down
46 changes: 0 additions & 46 deletions bin/check_class_existance_in_yaml_configs.php

This file was deleted.

127 changes: 127 additions & 0 deletions bin/check_services_in_yaml_configs.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
<?php declare(strict_types=1);

use Nette\Utils\Strings;
use Rector\Exception\ShouldNotHappenException;
use Rector\NodeTypeResolver\ClassExistenceStaticHelper;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\SplFileInfo;
use Symfony\Component\Yaml\Yaml;

require __DIR__ . '/../vendor/autoload.php';

$yamlConfigFileProvider = new YamlConfigFileProvider();
$serviceConfigurationValidator = new ServiceConfigurationValidator();

foreach ($yamlConfigFileProvider->provider() as $configFileInfo) {
$yamlContent = Yaml::parseFile($configFileInfo->getRealPath());
if (! isset($yamlContent['services'])) {
continue;
}

foreach ($yamlContent['services'] as $service => $serviceConfiguration) {
// configuration → skip
if (Strings::startsWith($service, '_')) {
continue;
}

// autodiscovery → skip
if (Strings::endsWith($service, '\\')) {
continue;
}

if (! ClassExistenceStaticHelper::doesClassLikeExist($service)) {
throw new ShouldNotHappenException(sprintf(
'Service "%s" from config "%s" was not found. Check if it really exists or is even autoload, please',
$service,
$configFileInfo->getRealPath()
));
}

$serviceConfigurationValidator->validate($service, $serviceConfiguration, $configFileInfo);
}
}


class YamlConfigFileProvider
{
/**
* @return SplFileInfo[]
*/
public function provider(): array
{
$finder = (new Finder())->name('*.yaml')
->in(__DIR__ . '/../config')
->files();

return iterator_to_array($finder->getIterator());
}
}

class ServiceConfigurationValidator
{
/**
* @param mixed $configuration
*/
public function validate(string $serviceClass, $configuration, SplFileInfo $configFileInfo): void
{
if (! is_array($configuration)) {
return;
}

foreach (array_keys($configuration) as $key) {
if (! $this->isArgumentName($key)) {
continue;
}

$constructorParameterNames = $this->resolveClassConstructorArgumentNames($serviceClass);
if (in_array($key, $constructorParameterNames, true)) {
continue;
}

throw new ShouldNotHappenException(sprintf(
'Service "%s" has unused argument "%s" in config "%s".%sCorrect it to one of existing arguments "%s".',
$serviceClass,
$key,
$configFileInfo->getRealPath(),
PHP_EOL,
implode('", "', $constructorParameterNames)
));
}
}

/**
* @param mixed $key
*/
private function isArgumentName($key): bool
{
if (! is_string($key)) {
return false;
}

return Strings::startsWith($key, '$');
}

/**
* @return string[]
*/
private function resolveClassConstructorArgumentNames(string $class): array
{
$reflectionClass = new ReflectionClass($class);
$constructorReflection = $reflectionClass->getConstructor();

if ($constructorReflection === null) {
return [];
}

$constructorParameterNames = [];
foreach ($constructorReflection->getParameters() as $parameterReflection) {
$constructorParameterNames[] = '$' . $parameterReflection->getName();
}

sort($constructorParameterNames);

return $constructorParameterNames;
}
}

echo 'All configs have existing services - good job!' . PHP_EOL;
3 changes: 2 additions & 1 deletion config/set/jms/jms-decouple.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
services:
Rector\Rector\Property\InjectAnnotationClassRector:
$annotationClass: 'JMS\DiExtraBundle\Annotation\Inject'
$annotationClasses:
- 'JMS\DiExtraBundle\Annotation\Inject'
3 changes: 2 additions & 1 deletion config/set/php-di/php-di-decouple.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
services:
Rector\Rector\Property\InjectAnnotationClassRector:
$annotationClass: 'Inject'
$annotationClasses:
- 'DI\Annotation\Inject'