archived-doctrine-website/tests/Docs/RST/RSTBuilderTest.php

<?php

declare(strict_types=1);

namespace Doctrine\Website\Tests\Docs\RST;

use Doctrine\RST\Builder;
use Doctrine\RST\Document;
use Doctrine\Website\Docs\RST\RSTBuilder;
use Doctrine\Website\Docs\RST\RSTCopier;
use Doctrine\Website\Docs\RST\RSTFileRepository;
use Doctrine\Website\Docs\RST\RSTLanguage;
use Doctrine\Website\Docs\RST\RSTPostBuildProcessor;
use Doctrine\Website\Model\Project;
use Doctrine\Website\Model\ProjectVersion;
use Doctrine\Website\Tests\TestCase;
use PHPUnit\Framework\MockObject\MockObject;
use Symfony\Component\Filesystem\Filesystem;

class RSTBuilderTest extends TestCase
{
    /** @var RSTFileRepository|MockObject */
    private $rstFileRepository;

    /** @var RSTCopier|MockObject */
    private $rstCopier;

    /** @var Builder|MockObject */
    private $builder;

    /** @var RSTPostBuildProcessor|MockObject */
    private $rstPostBuildProcessor;

    /** @var Filesystem|MockObject */
    private $filesystem;

    /** @var string */
    private $sourcePath;

    /** @var string */
    private $docsPath;

    /** @var RSTBuilder */
    private $rstBuilder;

    protected function setUp() : void
    {
        $this->rstFileRepository     = $this->createMock(RSTFileRepository::class);
        $this->rstCopier             = $this->createMock(RSTCopier::class);
        $this->builder               = $this->createMock(Builder::class);
        $this->rstPostBuildProcessor = $this->createMock(RSTPostBuildProcessor::class);
        $this->filesystem            = $this->createMock(Filesystem::class);
        $this->sourcePath            = '/source';
        $this->docsPath              = '/docs';

        $this->rstBuilder = new RSTBuilder(
            $this->rstFileRepository,
            $this->rstCopier,
            $this->builder,
            $this->rstPostBuildProcessor,
            $this->filesystem,
            $this->sourcePath,
            $this->docsPath
        );
    }

    public function testBuildRSTDocs() : void
    {
        $project = new Project([
            'slug' => 'project-slug',
            'docsSlug' => 'docs-slug',
        ]);
        $version = new ProjectVersion(['slug' => 'version-slug']);

        $this->rstCopier->expects(self::once())
            ->method('copyRst')
            ->with($project, $version);

        $this->rstFileRepository->expects(self::once())
            ->method('findFiles')
            ->with('/source/projects/docs-slug/en/version-slug')
            ->willReturn(['/test1', '/test2']);

        $this->filesystem->expects(self::once())
            ->method('remove')
            ->with(['/test1', '/test2']);

        $this->builder->expects(self::once())
            ->method('recreate')
            ->willReturn($this->builder);

        $this->builder->expects(self::once())
            ->method('build')
            ->with(
                '/docs/docs-slug/en/version-slug',
                '/source/projects/docs-slug/en/version-slug',
                false
            );

        $this->rstPostBuildProcessor->expects(self::once())
            ->method('postRstBuild')
            ->with($project, $version);

        $document1 = $this->createMock(Document::class);
        $document2 = $this->createMock(Document::class);

        $documents = [$document1, $document2];

        $this->builder->expects(self::once())
            ->method('getDocuments')
            ->willReturn($documents);

        $english = new RSTLanguage('en', '/en');

        self::assertSame($documents, $this->rstBuilder->buildRSTDocs($project, $version, $english));
    }
}