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
|
<?php
namespace LaminasTest\Code\Generator;
use Laminas\Code\Generator\DocBlock\Tag;
use Laminas\Code\Generator\DocBlock\Tag\AuthorTag;
use Laminas\Code\Generator\DocBlock\Tag\LicenseTag;
use Laminas\Code\Generator\DocBlock\Tag\ParamTag;
use Laminas\Code\Generator\DocBlock\Tag\ReturnTag;
use Laminas\Code\Generator\DocBlockGenerator;
use Laminas\Code\Reflection\DocBlockReflection;
use PHPUnit\Framework\TestCase;
/**
* @group Laminas_Code_Generator
* @group Laminas_Code_Generator_Php
*/
class DocBlockGeneratorTest extends TestCase
{
/** @var DocBlockGenerator */
protected $docBlockGenerator;
/** @var DocBlockGenerator */
protected $reflectionDocBlockGenerator;
protected function setUp(): void
{
$this->docBlockGenerator = $this->docBlockGenerator = new DocBlockGenerator();
$reflectionDocBlock = new DocBlockReflection(
'/**
* Short Description
* Long Description
* @param string $foo comment
* @author Laminas <laminas@zend.com>
* @license http://license The License
* @return int
*/'
);
$this->reflectionDocBlockGenerator = DocBlockGenerator::fromReflection($reflectionDocBlock);
}
public function testCanPassTagsToConstructor()
{
$docBlockGenerator = new DocBlockGenerator(null, null, [
['name' => 'foo'],
]);
$tags = $docBlockGenerator->getTags();
self::assertCount(1, $tags);
self::assertSame('foo', $tags[0]->getName());
}
public function testShortDescriptionGetterAndSetter()
{
$this->docBlockGenerator->setShortDescription('Short Description');
self::assertSame('Short Description', $this->docBlockGenerator->getShortDescription());
}
public function testLongDescriptionGetterAndSetter()
{
$this->docBlockGenerator->setLongDescription('Long Description');
self::assertSame('Long Description', $this->docBlockGenerator->getLongDescription());
}
public function testTagGettersAndSetters()
{
$paramTag = new Tag\ParamTag();
$paramTag->setDatatype('string');
$returnTag = new Tag\ReturnTag();
$returnTag->setDatatype('int');
$this->docBlockGenerator->setTag(['name' => 'blah']);
$this->docBlockGenerator->setTag($paramTag);
$this->docBlockGenerator->setTag($returnTag);
self::assertCount(3, $this->docBlockGenerator->getTags());
$target = <<<EOS
/**
* @blah
* @param string
* @return int
*/
EOS;
self::assertSame($target, $this->docBlockGenerator->generate());
}
public function testGenerationOfDocBlock()
{
$this->docBlockGenerator->setShortDescription('@var Foo this is foo bar');
$expected = '/**' . DocBlockGenerator::LINE_FEED . ' * @var Foo this is foo bar'
. DocBlockGenerator::LINE_FEED . ' */' . DocBlockGenerator::LINE_FEED;
self::assertSame($expected, $this->docBlockGenerator->generate());
}
public function testCreateFromArray()
{
$docBlock = DocBlockGenerator::fromArray([
'shortdescription' => 'foo',
'longdescription' => 'bar',
'tags' => [
[
'name' => 'foo',
'description' => 'bar',
],
],
]);
self::assertSame('foo', $docBlock->getShortDescription());
self::assertSame('bar', $docBlock->getLongDescription());
self::assertCount(1, $docBlock->getTags());
}
/**
* @group #3753
*/
public function testGenerateWordWrapIsEnabledByDefault()
{
$largeStr = '@var This is a very large string that will be wrapped if it contains more than 80 characters';
$this->docBlockGenerator->setLongDescription($largeStr);
$expected = '/**' . DocBlockGenerator::LINE_FEED
. ' * @var This is a very large string that will be wrapped if it contains more than'
. DocBlockGenerator::LINE_FEED . ' * 80 characters' . DocBlockGenerator::LINE_FEED
. ' */' . DocBlockGenerator::LINE_FEED;
self::assertSame($expected, $this->docBlockGenerator->generate());
}
/**
* @group #3753
*/
public function testGenerateWithWordWrapDisabled()
{
$largeStr = '@var This is a very large string that will not be wrapped if it contains more than 80 characters';
$this->docBlockGenerator->setLongDescription($largeStr);
$this->docBlockGenerator->setWordWrap(false);
$expected = '/**' . DocBlockGenerator::LINE_FEED
. ' * @var This is a very large string that will not be wrapped if it contains more than'
. ' 80 characters' . DocBlockGenerator::LINE_FEED . ' */' . DocBlockGenerator::LINE_FEED;
self::assertSame($expected, $this->docBlockGenerator->generate());
}
public function testDocBlockFromReflectionLongDescription()
{
self::assertSame('Long Description', $this->reflectionDocBlockGenerator->getLongDescription());
}
public function testDocBlockFromReflectionShortDescription()
{
self::assertSame('Short Description', $this->reflectionDocBlockGenerator->getShortDescription());
}
public function testDocBlockFromReflectionTagsCount()
{
self::assertCount(4, $this->reflectionDocBlockGenerator->getTags());
}
/**
* @depends testDocBlockFromReflectionTagsCount
*/
public function testDocBlockFromReflectionParamTag()
{
$tags = $this->reflectionDocBlockGenerator->getTags();
self::assertInstanceOf(ParamTag::class, $tags[0]);
}
/**
* @depends testDocBlockFromReflectionTagsCount
*/
public function testDocBlockFromReflectionAuthorTag()
{
$tags = $this->reflectionDocBlockGenerator->getTags();
self::assertInstanceOf(AuthorTag::class, $tags[1]);
}
/**
* @depends testDocBlockFromReflectionTagsCount
*/
public function testDocBlockFromReflectionLicenseTag()
{
$tags = $this->reflectionDocBlockGenerator->getTags();
self::assertInstanceOf(LicenseTag::class, $tags[2]);
}
/**
* @depends testDocBlockFromReflectionTagsCount
*/
public function testDocBlockFromReflectionReturnTag()
{
$tags = $this->reflectionDocBlockGenerator->getTags();
self::assertInstanceOf(ReturnTag::class, $tags[3]);
}
public function testGenerateOmitsLongDescriptionWithTags(): void
{
$generator = new DocBlockGenerator(
"foo",
null,
[new Tag\GenericTag("var", "array")],
);
$expected = '/**' . DocBlockGenerator::LINE_FEED
. ' * foo' . DocBlockGenerator::LINE_FEED
. ' *' . DocBlockGenerator::LINE_FEED
. ' * @var array' . DocBlockGenerator::LINE_FEED
. ' */' . DocBlockGenerator::LINE_FEED;
self::assertSame($expected, $generator->generate());
}
}
|
