1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 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 170 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 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
|
<?php
namespace LaminasTest\Code\Generator;
use Countable;
use DateTime;
use IteratorAggregate;
use Laminas\Code\Generator\DocBlockGenerator;
use Laminas\Code\Generator\Exception\InvalidArgumentException;
use Laminas\Code\Generator\InterfaceGenerator;
use Laminas\Code\Generator\MethodGenerator;
use Laminas\Code\Generator\PropertyGenerator;
use Laminas\Code\Reflection\ClassReflection;
use LaminasTest\Code\TestAsset\FooInterface;
use PHPUnit\Framework\TestCase;
/**
* @group Laminas_Code_Generator
* @group Laminas_Code_Generator_Php
*/
class InterfaceGeneratorTest extends TestCase
{
public function testAbstractAccessorsReturnsFalse()
{
$classGenerator = new InterfaceGenerator();
self::assertFalse($classGenerator->isAbstract());
$classGenerator->setAbstract(true);
self::assertFalse($classGenerator->isAbstract());
}
public function testExtendedClassAccessors()
{
$classGenerator = new InterfaceGenerator();
$classGenerator->setExtendedClass(DateTime::class);
self::assertNull($classGenerator->getExtendedClass());
}
public function testImplementedInterfacesAccessors()
{
$classGenerator = new InterfaceGenerator();
$classGenerator->setImplementedInterfaces(['Class1', 'Class2']);
self::assertCount(2, $classGenerator->getImplementedInterfaces());
}
public function testPropertyAccessors()
{
$classGenerator1 = new InterfaceGenerator();
$classGenerator2 = new InterfaceGenerator();
$classGenerator1->addProperty('prop3');
$classGenerator2->addProperties([
'propOne',
new PropertyGenerator('propTwo'),
]);
self::assertCount(0, $classGenerator1->getProperties());
self::assertCount(0, $classGenerator2->getProperties());
}
public function testMethodAccessors()
{
$classGenerator = new InterfaceGenerator();
$classGenerator->addMethods([
'methodOne',
new MethodGenerator('methodTwo'),
]);
self::assertCount(2, $classGenerator->getMethods());
self::assertTrue($classGenerator->getMethod('methodOne')->isInterface());
self::assertTrue($classGenerator->getMethod('methodTwo')->isInterface());
}
public function testToString()
{
$classGenerator = InterfaceGenerator::fromArray([
'name' => 'SampleInterface',
'methods' => [
['name' => 'baz'],
],
]);
$expectedOutput = <<<EOS
interface SampleInterface
{
public function baz();
}
EOS;
self::assertSame($expectedOutput, $classGenerator->generate());
}
public function testSetextendedclassShouldIgnoreEmptyClassnameOnGenerate()
{
$classGeneratorClass = new InterfaceGenerator();
$classGeneratorClass
->setName('MyInterface')
->setExtendedClass(null);
$expected = <<<CODE
interface MyInterface
{
}
CODE;
self::assertSame($expected, $classGeneratorClass->generate());
}
public function testSetextendedclassShouldNotIgnoreNonEmptyClassnameOnGenerate()
{
$classGeneratorClass = new InterfaceGenerator();
$classGeneratorClass
->setName('MyInterface')
->setExtendedClass(DateTime::class);
$expected = <<<CODE
interface MyInterface
{
}
CODE;
self::assertSame($expected, $classGeneratorClass->generate());
}
/**
* @group namespace
*/
public function testCodeGenerationShouldTakeIntoAccountNamespacesFromReflection()
{
$reflClass = new ClassReflection(FooInterface::class);
$classGenerator = InterfaceGenerator::fromReflection($reflClass);
self::assertSame('LaminasTest\Code\TestAsset', $classGenerator->getNamespaceName());
self::assertSame('FooInterface', $classGenerator->getName());
$expected = <<<CODE
namespace LaminasTest\Code\TestAsset;
interface FooInterface
{
public const BAR = 5;
public const FOO = 5;
public function fooBarBaz();
}
CODE;
$received = $classGenerator->generate();
self::assertSame($expected, $received, $received);
}
/**
* @group namespace
*/
public function testSetNameShouldDetermineIfNamespaceSegmentIsPresent()
{
$classGeneratorClass = new InterfaceGenerator();
$classGeneratorClass->setName('My\Namespaced\FunClass');
self::assertSame('My\Namespaced', $classGeneratorClass->getNamespaceName());
}
/**
* @group namespace
*/
public function testPassingANamespacedClassnameShouldGenerateANamespaceDeclaration()
{
$classGeneratorClass = new InterfaceGenerator();
$classGeneratorClass->setName('My\Namespaced\FunClass');
$received = $classGeneratorClass->generate();
self::assertStringContainsString('namespace My\Namespaced;', $received, $received);
}
/**
* @group namespace
*/
public function testPassingANamespacedClassnameShouldGenerateAClassnameWithoutItsNamespace()
{
$classGeneratorClass = new InterfaceGenerator();
$classGeneratorClass->setName('My\Namespaced\FunClass');
$received = $classGeneratorClass->generate();
self::assertStringContainsString('interface FunClass', $received, $received);
}
public function testCreateFromArrayWithDocBlockFromArray()
{
$classGenerator = InterfaceGenerator::fromArray([
'name' => 'SampleClass',
'docblock' => [
'shortdescription' => 'foo',
],
]);
$docBlock = $classGenerator->getDocBlock();
self::assertInstanceOf(DocBlockGenerator::class, $docBlock);
}
public function testCreateFromArrayWithDocBlockInstance()
{
$classGenerator = InterfaceGenerator::fromArray([
'name' => 'MyInterface',
'docblock' => new DocBlockGenerator('foo'),
]);
$docBlock = $classGenerator->getDocBlock();
$output = $classGenerator->generate();
$expected = <<<CODE
/**
* foo
*/
interface MyInterface
{
}
CODE;
self::assertInstanceOf(DocBlockGenerator::class, $docBlock);
self::assertSame($expected, $output);
}
public function testGenerateClassAndAddMethod()
{
$classGenerator = new InterfaceGenerator();
$classGenerator->setName('MyInterface');
$classGenerator->addMethod('methodOne');
$expected = <<<CODE
interface MyInterface
{
public function methodOne();
}
CODE;
$output = $classGenerator->generate();
self::assertSame($expected, $output);
}
public function testGenerateImplementsInterface()
{
$classGenerator = new InterfaceGenerator();
$classGenerator->setName('MyCollection');
$classGenerator->addMethod('isEmpty');
$classGenerator->setImplementedInterfaces([Countable::class, IteratorAggregate::class]);
$expected = <<<CODE
interface MyCollection extends Countable, IteratorAggregate
{
public function isEmpty();
}
CODE;
$output = $classGenerator->generate();
self::assertSame($expected, $output);
}
public function testClassNotAnInterfaceException()
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Class LaminasTest\Code\Generator\InterfaceGeneratorTest is not a interface');
InterfaceGenerator::fromReflection(new ClassReflection(self::class));
}
}
|