xref: /webtrees/tests/app/Elements/XrefSourceTest.php (revision f0c88a961929e1d14256ee4286994384bb29fbc1)

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2022 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

namespace Fisharebest\Webtrees\Elements;

use DOMDocument;
use Fisharebest\Webtrees\Factories\SourceFactory;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Source;
use Fisharebest\Webtrees\TestCase;
use Fisharebest\Webtrees\Tree;
use Psr\Http\Message\ServerRequestInterface;

use function app;

/**
 * Test harness for the class XrefSource
 *
 * @covers \Fisharebest\Webtrees\Elements\AbstractElement
 * @covers \Fisharebest\Webtrees\Elements\AbstractXrefElement
 * @covers \Fisharebest\Webtrees\Elements\XrefSource
 */
class XrefSourceTest extends TestCase
{
    /**
     * @return void
     */
    public function testEdit(): void
    {
        $element = new XrefSource('');

        $tree = $this->createMock(Tree::class);

        $factory = $this->createMock(SourceFactory::class);

        $factory->expects(self::once())
            ->method('make')
            ->willReturn(null);

        Registry::sourceFactory($factory);

        $request = self::createRequest();

        app()->instance(ServerRequestInterface::class, $request);

        $html = $element->edit('some-id', 'some-name', '@X123@', $tree);
        $dom  = new DOMDocument();
        $dom->loadHTML($html);

        $select_nodes = $dom->getElementsByTagName('select');
        self::assertEquals(1, $select_nodes->count());

        $option_nodes = $select_nodes[0]->getElementsByTagName('option');
        self::assertEquals(1, $option_nodes->count());
    }

    /**
     * @return void
     */
    public function testEditInlineSource(): void
    {
        $element = new XrefSource('');

        $tree = $this->createMock(Tree::class);

        $request = self::createRequest();

        app()->instance(ServerRequestInterface::class, $request);

        $html = $element->edit('some-id', 'some-name', 'An inline source', $tree);
        $dom  = new DOMDocument();
        $dom->loadHTML($html);

        $textarea_nodes = $dom->getElementsByTagName('textarea');
        self::assertEquals(1, $textarea_nodes->count());
    }

    /**
     * @return void
     */
    public function testEscape(): void
    {
        $element = new XrefSource('');

        self::assertSame('@X123@', $element->escape('@X123@'));
    }

    /**
     * @return void
     */
    public function testValueXrefLink(): void
    {
        $element = new XrefSource('');

        $record = $this->createMock(Source::class);

        $record->expects(self::once())
            ->method('fullName')
            ->willReturn('Full Name');

        $record->expects(self::once())
            ->method('url')
            ->willReturn('https://url');

        $tree = $this->createMock(Tree::class);

        $factory = $this->createMock(SourceFactory::class);

        $factory->expects(self::once())
            ->method('make')
            ->willReturn($record);


        Registry::sourceFactory($factory);

        self::assertSame('<a href="https://url">Full Name</a>', $element->value('@X123@', $tree));
    }

    /**
     * @return void
     */
    public function testValueXrefLinkWithInvalidXref(): void
    {
        $element = new XrefSource('');

        $tree = $this->createMock(Tree::class);

        self::assertSame('<span class="error">@invalid@</span>', $element->value('@invalid@', $tree));
    }

    /**
     * @return void
     */
    public function testValueXrefLinkWithInlineData(): void
    {
        $element = new XrefSource('');

        $tree = $this->createMock(Tree::class);

        self::assertSame('<p>invalid</p>', $element->value('invalid', $tree));
    }

    /**
     * @return void
     */
    public function testValueXrefLinkWithMissingRecord(): void
    {
        $element = new XrefSource('');

        $tree = $this->createMock(Tree::class);

        $factory = $this->createMock(SourceFactory::class);

        $factory->expects(self::once())
            ->method('make')
            ->willReturn(null);

        Registry::sourceFactory($factory);

        self::assertSame('<span class="error">@X321@</span>', $element->value('@X321@', $tree));
    }
}