blob: 09236e40243f70a071f282e9031f889d7c9ecec5 (
plain)
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
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Tests\Integration;
use PHPUnit\Framework\TestCase;
use Piwik\API\DocumentationGenerator;
use Piwik\API\Proxy;
use Piwik\EventDispatcher;
/**
* @group Core
*/
class DocumentationGeneratorTest extends TestCase
{
public function test_CheckIfModule_ContainsHideAnnotation()
{
$annotation = '@hideExceptForSuperUser test test';
$mock = $this->getMockBuilder('ReflectionClass')
->disableOriginalConstructor()
->setMethods(array('getDocComment'))
->getMock();
$mock->expects($this->once())->method('getDocComment')->willReturn($annotation);
$documentationGenerator = new DocumentationGenerator();
$this->assertTrue($documentationGenerator->checkIfClassCommentContainsHideAnnotation($mock));
}
public function test_CheckDocumentation()
{
$moduleToCheck = 'this is documentation which contains @hideExceptForSuperUser';
$documentationAfterCheck = 'this is documentation which contains ';
$documentationGenerator = new DocumentationGenerator();
$this->assertEquals($documentationGenerator->checkDocumentation($moduleToCheck), $documentationAfterCheck);
}
public function test_CheckIfMethodComment_ContainsHideAnnotation_andText()
{
$annotation = '@hideForAll test test';
EventDispatcher::getInstance()->addObserver('API.DocumentationGenerator.@hideForAll',
function (&$hide) {
$hide = true;
});
$this->assertEquals(Proxy::getInstance()->shouldHideAPIMethod($annotation), true);
}
public function test_CheckIfMethodComment_ContainsHideAnnotation_only()
{
$annotation = '@hideForAll';
EventDispatcher::getInstance()->addObserver('API.DocumentationGenerator.@hideForAll',
function (&$hide) {
$hide = true;
});
$this->assertEquals(Proxy::getInstance()->shouldHideAPIMethod($annotation), true);
}
public function test_CheckIfMethodComment_DoesNotContainHideAnnotation()
{
$annotation = '@not found here';
EventDispatcher::getInstance()->addObserver('API.DocumentationGenerator.@hello',
function (&$hide) {
$hide = true;
});
$this->assertEquals(Proxy::getInstance()->shouldHideAPIMethod($annotation), false);
}
}
|
