File size: 2,377 Bytes
bf8c0ce | 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 | <?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://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;
use ReflectionClass;
/**
* @group Core
*/
class DocumentationGeneratorTest extends TestCase
{
public function testCheckIfModuleContainsHideAnnotation()
{
$reflection = new ReflectionClass(DocumentationGenerator::class);
$documentationGenerator = new DocumentationGenerator();
$this->assertTrue($documentationGenerator->checkIfClassCommentContainsHideAnnotation($reflection));
}
public function testCheckDocumentation()
{
$moduleToCheck = 'this is documentation which contains @hideExceptForSuperUser';
$documentationAfterCheck = 'this is documentation which contains ';
$documentationGenerator = new DocumentationGenerator();
$this->assertEquals($documentationGenerator->checkDocumentation($moduleToCheck), $documentationAfterCheck);
}
public function testCheckIfMethodCommentContainsHideAnnotationAndText()
{
$annotation = '@hideForAll test test';
EventDispatcher::getInstance()->addObserver(
'API.DocumentationGenerator.@hideForAll',
function (&$hide) {
$hide = true;
}
);
$this->assertEquals(Proxy::getInstance()->shouldHideAPIMethod($annotation), true);
}
public function testCheckIfMethodCommentContainsHideAnnotationOnly()
{
$annotation = '@hideForAll';
EventDispatcher::getInstance()->addObserver(
'API.DocumentationGenerator.@hideForAll',
function (&$hide) {
$hide = true;
}
);
$this->assertEquals(Proxy::getInstance()->shouldHideAPIMethod($annotation), true);
}
public function testCheckIfMethodCommentDoesNotContainHideAnnotation()
{
$annotation = '@not found here';
EventDispatcher::getInstance()->addObserver(
'API.DocumentationGenerator.@hello',
function (&$hide) {
$hide = true;
}
);
$this->assertEquals(Proxy::getInstance()->shouldHideAPIMethod($annotation), false);
}
}
|