Hyde\Framework\Testing\Unit\DocumentationPageTest

Complexity

Total Complexity

14

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	test_can_get_documentation_output_path_with_custom_output_directory()	0	5	1
A	test_can_get_online_source_path_with_source_file_location_base()	0	5	1
A	test_can_get_current_page_path()	0	8	1
A	test_can_get_documentation_output_path_with_trailing_slashes()	0	14	2
A	test_can_get_online_source_path()	0	4	1
A	test_home_method_returns_null_when_there_is_no_index_page()	0	3	1
A	test_can_generate_table_of_contents()	0	4	1
A	test_can_get_online_source_path_with_trailing_slash()	0	9	1
A	test_get_source_path_returns_qualified_basename()	0	5	1
A	test_home_method_returns_docs_index_route_when_it_exists()	0	6	1
A	test_get_source_path_returns_qualified_basename_for_nested_page()	0	5	1
A	test_can_get_documentation_output_path()	0	3	1
A	test_has_table_of_contents()	0	9	1

<?php

namespace Hyde\Framework\Testing\Unit;

use Hyde\Framework\Hyde;
use Hyde\Framework\HydeServiceProvider;
use Hyde\Framework\Models\Pages\DocumentationPage;
use Hyde\Framework\Models\Route;
use Hyde\Testing\TestCase;
use Illuminate\Support\Facades\Config;

/**
 * @covers \Hyde\Framework\Models\Pages\DocumentationPage
 */
class DocumentationPageTest extends TestCase
{
    public function test_can_generate_table_of_contents()
    {
        $page = (new DocumentationPage([], '# Foo'));
        $this->assertIsString($page->getTableOfContents());
    }

    public function test_can_get_current_page_path()
    {
        $page = (new DocumentationPage([], '', '', 'foo'));
        $this->assertEquals('docs/foo', $page->getCurrentPagePath());

        config(['docs.output_directory' => 'documentation/latest/']);
        (new HydeServiceProvider($this->app))->register();
        $this->assertEquals('documentation/latest/foo', $page->getCurrentPagePath());
    }

    public function test_can_get_online_source_path()
    {
        $page = (new DocumentationPage([], ''));
        $this->assertFalse($page->getOnlineSourcePath());
    }

    public function test_can_get_online_source_path_with_source_file_location_base()
    {
        config(['docs.source_file_location_base' => 'docs.example.com/edit']);
        $page = (new DocumentationPage([], '', '', 'foo'));
        $this->assertEquals('docs.example.com/edit/foo.md', $page->getOnlineSourcePath());
    }

    public function test_can_get_online_source_path_with_trailing_slash()
    {
        $page = (new DocumentationPage([], '', '', 'foo'));

        config(['docs.source_file_location_base' => 'edit/']);
        $this->assertEquals('edit/foo.md', $page->getOnlineSourcePath());

        config(['docs.source_file_location_base' => 'edit']);
        $this->assertEquals('edit/foo.md', $page->getOnlineSourcePath());
    }

    public function test_can_get_documentation_output_path()
    {
        $this->assertEquals('docs', DocumentationPage::getOutputDirectory());
    }

    public function test_can_get_documentation_output_path_with_custom_output_directory()
    {
        config(['docs.output_directory' => 'foo']);
        (new HydeServiceProvider($this->app))->register();
        $this->assertEquals('foo', DocumentationPage::getOutputDirectory());
    }

    public function test_can_get_documentation_output_path_with_trailing_slashes()
    {
        $tests = [
            'foo',
            'foo/',
            'foo//',
            'foo\\',
            '/foo/',
        ];

        foreach ($tests as $test) {
            config(['docs.output_directory' => $test]);
            (new HydeServiceProvider($this->app))->register();
            $this->assertEquals('foo', DocumentationPage::getOutputDirectory());
        }
    }

    public function test_get_source_path_returns_qualified_basename()
    {
        $this->assertEquals(
            DocumentationPage::qualifyBasename('foo'),
            (new DocumentationPage(slug: 'foo'))->getSourcePath()
        );
    }

    public function test_get_source_path_returns_qualified_basename_for_nested_page()
    {
        $this->assertEquals(
            DocumentationPage::qualifyBasename('foo/bar'),
            (new DocumentationPage(slug: 'foo/bar'))->getSourcePath()
        );
    }

    public function test_home_method_returns_null_when_there_is_no_index_page()
    {
        $this->assertNull(DocumentationPage::home());
    }

    public function test_home_method_returns_docs_index_route_when_it_exists()
    {
        Hyde::touch('_docs/index.md');
        $this->assertInstanceOf(Route::class, DocumentationPage::home());
        $this->assertEquals(Route::get('docs/index'), DocumentationPage::home());
        Hyde::unlink('_docs/index.md');
    }

    public function test_has_table_of_contents()
    {
        $this->assertIsBool(DocumentationPage::hasTableOfContents());

        Config::set('docs.table_of_contents.enabled', true);
        $this->assertTrue(DocumentationPage::hasTableOfContents());

        Config::set('docs.table_of_contents.enabled', false);
        $this->assertFalse(DocumentationPage::hasTableOfContents());
    }
}