silverstripe-docsviewer/tests/DocumentationPageTest.php

<?php

/**
 * @package docsviewer
 * @subpackage tests
 */
class DocumentationPageTest extends SapphireTest
{
    protected $entity;

    public function setUp()
    {
        parent::setUp();

        $this->entity = new DocumentationEntity('doctest');
        $this->entity->setPath(DOCSVIEWER_PATH . '/tests/docs/en/');
        $this->entity->setVersion('2.4');
        $this->entity->setLanguage('en');

        Config::nest();

        // explicitly use dev/docs. Custom paths should be tested separately
        Config::inst()->update('DocumentationViewer', 'link_base', 'dev/docs/');

        $manifest = new DocumentationManifest(true);
    }

    public function tearDown()
    {
        parent::tearDown();

        Config::unnest();
    }

    public function testGetLink()
    {
        $page = new DocumentationPage(
            $this->entity,
            'test.md',
            DOCSVIEWER_PATH . '/tests/docs/en/test.md'
        );

        // single layer
        $this->assertEquals(
            'dev/docs/en/doctest/2.4/test/',
            $page->Link(),
            'The page link should have no extension and have a language'
        );

        $page = new DocumentationFolder(
            $this->entity,
            'sort',
            DOCSVIEWER_PATH . '/tests/docs/en/sort/'
        );

        $this->assertEquals('dev/docs/en/doctest/2.4/sort/', $page->Link());

        $page = new DocumentationFolder(
            $this->entity,
            '1-basic.md',
            DOCSVIEWER_PATH . '/tests/docs/en/sort/1-basic.md'
        );

        $this->assertEquals('dev/docs/en/doctest/2.4/sort/basic/', $page->Link());
    }

    public function testGetBreadcrumbTitle()
    {
        $page = new DocumentationPage(
            $this->entity,
            'test.md',
            DOCSVIEWER_PATH . '/tests/docs/en/test.md'
        );

        $this->assertEquals("Test - Doctest", $page->getBreadcrumbTitle());

        $page = new DocumentationFolder(
            $this->entity,
            '1-basic.md',
            DOCSVIEWER_PATH . '/tests/docs/en/sort/1-basic.md'
        );

        $this->assertEquals('Basic - Sort - Doctest', $page->getBreadcrumbTitle());

        $page = new DocumentationFolder(
            $this->entity,
            '',
            DOCSVIEWER_PATH . '/tests/docs/en/sort/'
        );

        $this->assertEquals('Sort - Doctest', $page->getBreadcrumbTitle());
    }

    public function testGetCanonicalUrl()
    {
        $page = new DocumentationPage(
            $this->entity,
            'file.md',
            DOCSVIEWER_PATH . '/tests/docs/en/test/file.md'
        );

        $this->assertContains(
            'dev/docs/en/test/file/',
            $page->getCanonicalUrl(),
            'Canonical URL is determined, set and returned'
        );

        $page->setCanonicalUrl('some-other-url');
        $this->assertSame('some-other-url', $page->getCanonicalUrl(), 'Canonical URL can be adjusted via public API');
    }
}