Skip to content

Commit

Permalink
Windows環境で発生する問題を回避するためにCS FixerでProxyを生成するように変更
Browse files Browse the repository at this point in the history 
See zendframework/zend-code#111
  • Loading branch information
@kiy0taka
kiy0taka committed Oct 13, 2017
1 parent 837bcf7 commit 7cb1f37
Show file tree
Hide file tree
Showing 2 changed files with 197 additions and 41 deletions.
122 changes: 81 additions & 41 deletions src/Eccube/Service/EntityProxyService.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,12 @@
use Eccube\Annotation\EntityExtension;
use Eccube\Annotation\Inject;
use Eccube\Annotation\Service;
use PhpCsFixer\Tokenizer\CT;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Finder\Finder;
use Zend\Code\Generator\ClassGenerator;
use Zend\Code\Generator\FileGenerator;
use Zend\Code\Reflection\ClassReflection;

/**
Expand Down Expand Up @@ -71,40 +72,24 @@ public function generate($includesDirs, $excludeDirs, $outputDir, OutputInterfac
foreach ($targetEntities as $targetEntity) {
$traits = isset($addTraits[$targetEntity]) ? $addTraits[$targetEntity] : [];
$rc = new ClassReflection($targetEntity);
$generator = ClassGenerator::fromReflection($rc);
$uses = FileGenerator::fromReflectedFileName($rc->getFileName())->getUses();

foreach ($uses as $use) {
$generator->addUse($use[0], $use[1]);
}
$entityTokens = Tokens::fromCode(file_get_contents($rc->getFileName()));

if (isset($removeTrails[$targetEntity])) {
foreach ($removeTrails[$targetEntity] as $trait) {
$this->removePropertiesFromProxy($trait, $generator);
$this->removeTrait($entityTokens, $trait);
}
}

foreach ($traits as $trait) {
$this->removePropertiesFromProxy($trait, $generator);
$generator->addTrait('\\' . $trait);
}

// extendしたクラスが相対パスになるので
$extendClass = $generator->getExtendedClass();
$generator->setExtendedClass('\\'.$extendClass);

// interfaceが相対パスになるので
$interfaces = $generator->getImplementedInterfaces();
foreach ($interfaces as &$interface) {
$interface = '\\'.$interface;
$this->addTrait($entityTokens, $trait);
}
$generator->setImplementedInterfaces($interfaces);

$file = basename($rc->getFileName());

$code = $generator->generate();
$code = $entityTokens->generateCode();
$generatedFiles[] = $outputFile = $outputDir.'/'.$file;
file_put_contents($outputFile, '<?php '.PHP_EOL.$code);
file_put_contents($outputFile, $code);
$output->writeln('gen -> '.$outputFile);
}

Expand Down Expand Up @@ -169,29 +154,84 @@ private function scanTraits($dirSets)
}

/**
* @param $trait
* @param $generator
* EntityにTraitを追加.
*
* @param $entityTokens Tokens Entityのトークン
* @param $trait string 追加するTraitのFQCN
*/
private function removePropertiesFromProxy($trait, $generator)
private function addTrait($entityTokens, $trait)
{
$rt = new ClassReflection($trait);
foreach ($rt->getProperties() as $prop) {
// すでにProxyがある場合, $generatorにuse XxxTrait;が存在せず,
// traitに定義されているフィールド,メソッドがクラス側に追加されてしまう
if ($generator->hasProperty($prop->getName())) {
// $generator->removeProperty()はzend-code 2.6.3 では未実装なのでリフレクションで削除.
$generatorRefObj = new \ReflectionObject($generator);
$generatorRefProp = $generatorRefObj->getProperty('properties');
$generatorRefProp->setAccessible(true);
$properies = $generatorRefProp->getValue($generator);
unset($properies[$prop->getName()]);
$generatorRefProp->setValue($generator, $properies);
$newTraitTokens = $this->convertFQCNToTokens($trait);

// Traitのuse句があるかどうか
$useTraitIndex = $entityTokens->getNextTokenOfKind(0, [[CT::T_USE_TRAIT]]);

if ($useTraitIndex > 0) {
$useTraitEndIndex = $entityTokens->getNextTokenOfKind($useTraitIndex, [';']);
$alreadyUseTrait = $entityTokens->findSequence($newTraitTokens, $useTraitIndex, $useTraitEndIndex);
if (is_null($alreadyUseTrait)) {
$entityTokens->insertAt($useTraitEndIndex, array_merge(
[new Token(','), new Token([T_WHITESPACE, ' '])],
$newTraitTokens
));
}
} else {
$useTraitTokens = array_merge(
[
new Token([T_WHITESPACE, PHP_EOL.' ']),
new Token([CT::T_USE_TRAIT, 'use']),
new Token([T_WHITESPACE, ' '])
],
$newTraitTokens,
[new Token(';'), new Token([T_WHITESPACE, PHP_EOL])]);

// `class X extens AbstractEntity {`の後にtraitを追加
$classTokens = $entityTokens->findSequence([[T_CLASS], [T_STRING]]);
$classTokenEnd = $entityTokens->getNextTokenOfKind(array_keys($classTokens)[0], ['{']);
$entityTokens->insertAt($classTokenEnd + 1, $useTraitTokens);
}
foreach ($rt->getMethods() as $method) {
if ($generator->hasMethod($method->getName())) {
$generator->removeMethod($method->getName());
}

/**
* EntityからTraitを削除.
* @param $entityTokens Tokens Entityのトークン
* @param $trait string 削除するTraitのFQCN
*/
private function removeTrait($entityTokens, $trait)
{
$useTraitIndex = $entityTokens->getNextTokenOfKind(0, [[CT::T_USE_TRAIT]]);
if ($useTraitIndex > 0) {
$useTraitEndIndex = $entityTokens->getNextTokenOfKind($useTraitIndex, [';']);
$traitsTokens = array_slice($entityTokens->toArray(), $useTraitIndex + 1, $useTraitEndIndex - $useTraitIndex - 1);

// Trait名の配列に変換
$traitNames = explode(',', implode(array_map(function($token) {
return $token->getContent();
}, array_filter($traitsTokens, function($token) {
return $token->getId() != T_WHITESPACE;
}))));

array_splice($traitNames, array_search($trait, $traitNames), 1);

// use句をすべて削除
$entityTokens->clearRange($useTraitIndex, $useTraitEndIndex + 1);

// traitを追加し直す
foreach ($traitNames as $t) {
$this->addTrait($entityTokens, $t);
}
}
}

private function convertFQCNToTokens($fqcn)
{
$result = [];
foreach (explode('\\', $fqcn) as $part) {
if ($part) {
$result[] = new Token([T_NS_SEPARATOR, '\\']);
$result[] = new Token([T_STRING, $part]);
}
}
return $result;
}
}
116 changes: 116 additions & 0 deletions tests/Eccube/Tests/Service/EntityProxyServiceTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,122 @@ public function testGenerateExcluded()
$tokens = Tokens::fromCode(file_get_contents($generatedFile));
self::assertNull($tokens->findSequence($traitTokens), 'Traitが外されているはず');
}

public function testAddTrait()
{

$entityTokens = Tokens::fromCode(<<< EOT
<?php
class EntityProxyServiceTest_Entity extends \\Eccube\\Entity\\AbstractEntity
{
}
EOT
);
$method = new \ReflectionMethod(EntityProxyService::class, 'addTrait');
$method->setAccessible(true);
$method->invoke(new EntityProxyService(), $entityTokens, '\\Eccube\\Tests\\Service\\EntityProxyServiceTest_Trait');

$traitTokens = [
[CT::T_USE_TRAIT],
[T_NS_SEPARATOR],
[T_STRING, 'Eccube'],
[T_NS_SEPARATOR],
[T_STRING, 'Tests'],
[T_NS_SEPARATOR],
[T_STRING, 'Service'],
[T_NS_SEPARATOR],
[T_STRING, 'EntityProxyServiceTest_Trait'],
];

self::assertNotNull($entityTokens->findSequence($traitTokens), 'Traitはあるはず');
}

public function testAddMoreTrait()
{

$entityTokens = Tokens::fromCode(<<< EOT
<?php
class EntityProxyServiceTest_Entity extends \\Eccube\\Entity\\AbstractEntity
{
use \\Eccube\\Tests\\Service\\EntityProxyServiceTest_Trait;
}
EOT
);
$method = new \ReflectionMethod(EntityProxyService::class, 'addTrait');
$method->setAccessible(true);
$method->invoke(new EntityProxyService(), $entityTokens, '\\Eccube\\Tests\\Service\\EntityProxyServiceTest_ExTrait');

$traitTokens = [
[CT::T_USE_TRAIT],
[T_NS_SEPARATOR],
[T_STRING, 'Eccube'],
[T_NS_SEPARATOR],
[T_STRING, 'Tests'],
[T_NS_SEPARATOR],
[T_STRING, 'Service'],
[T_NS_SEPARATOR],
[T_STRING, 'EntityProxyServiceTest_Trait'],
',',
[T_NS_SEPARATOR],
[T_STRING, 'Eccube'],
[T_NS_SEPARATOR],
[T_STRING, 'Tests'],
[T_NS_SEPARATOR],
[T_STRING, 'Service'],
[T_NS_SEPARATOR],
[T_STRING, 'EntityProxyServiceTest_ExTrait'],
];

self::assertNotNull($entityTokens->findSequence($traitTokens), 'Traitはあるはず');
}

public function testRemoveTrait()
{
$entityTokens = Tokens::fromCode(<<< EOT
<?php
class EntityProxyServiceTest_Entity extends \\Eccube\\Entity\\AbstractEntity
{
use \\Eccube\\Tests\\Service\\EntityProxyServiceTest_Trait, \\Eccube\\Tests\\Service\\EntityProxyServiceTest_ExTrait;
}
EOT
);
$method = new \ReflectionMethod(EntityProxyService::class, 'removeTrait');
$method->setAccessible(true);
$method->invoke(new EntityProxyService(), $entityTokens, '\\Eccube\\Tests\\Service\\EntityProxyServiceTest_ExTrait');

$traitTokens = [
[CT::T_USE_TRAIT],
[T_NS_SEPARATOR],
[T_STRING, 'Eccube'],
[T_NS_SEPARATOR],
[T_STRING, 'Tests'],
[T_NS_SEPARATOR],
[T_STRING, 'Service'],
[T_NS_SEPARATOR],
[T_STRING, 'EntityProxyServiceTest_Trait'],
';'
];

self::assertNotNull($entityTokens->findSequence($traitTokens), 'Traitが削除されているはず');
}

public function testRemoveLastTrait()
{
$entityTokens = Tokens::fromCode(<<< EOT
<?php
class EntityProxyServiceTest_Entity extends \\Eccube\\Entity\\AbstractEntity
{
use \\Eccube\\Tests\\Service\\EntityProxyServiceTest_Trait;
}
EOT
);
$method = new \ReflectionMethod(EntityProxyService::class, 'removeTrait');
$method->setAccessible(true);
$method->invoke(new EntityProxyService(), $entityTokens, '\\Eccube\\Tests\\Service\\EntityProxyServiceTest_Trait');

self::assertNull($entityTokens->getNextTokenOfKind(0, [CT::T_USE_TRAIT]), 'Traitのuse句が削除されているはず');
}

}

/**
Expand Down

0 comments on commit 7cb1f37

Please sign in to comment.