Doctrine\Tests\Common\Persistence\Mapping\SymfonyFileLocatorTest

Complexity

Total Complexity

15

Size/Duplication

Total Lines	197
Duplicated Lines	0 %

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	testFindMappingFileWithCustomNsSeparator()	0	9	2
A	testGetPaths()	0	10	1
A	customNamespaceSeparatorProvider()	0	5	1
A	testInvalidCustomNamespaceSeparator()	0	6	1
A	testFileExists()	0	11	1
A	testGetAllClassNames()	0	19	1
A	testGetClassNamesWithCustomNsSeparator()	0	10	1
A	testGetFileExtension()	0	6	1
A	customNamespaceLookupQueryProvider()	0	19	1
A	testGetPrefixes()	0	7	1
A	testFindMappingFile()	0	8	1
A	testFindMappingFileNotFound()	0	10	1

<?php

namespace Doctrine\Tests\Common\Persistence\Mapping;

use Doctrine\Common\Persistence\Mapping\MappingException;
use Doctrine\Tests\DoctrineTestCase;
use Doctrine\Common\Persistence\Mapping\Driver\SymfonyFileLocator;

class SymfonyFileLocatorTest extends DoctrineTestCase
{
    public function testGetPaths()
    {
        $path   = __DIR__ . "/_files";
        $prefix = "Foo";

        $locator = new SymfonyFileLocator([$path => $prefix]);
        self::assertEquals([$path], $locator->getPaths());

        $locator = new SymfonyFileLocator([$path => $prefix]);
        self::assertEquals([$path], $locator->getPaths());
    }

    public function testGetPrefixes()
    {
        $path   = __DIR__ . "/_files";
        $prefix = "Foo";

        $locator = new SymfonyFileLocator([$path => $prefix]);
        self::assertEquals([$path => $prefix], $locator->getNamespacePrefixes());
    }

    public function testGetFileExtension()
    {
        $locator = new SymfonyFileLocator([], ".yml");
        self::assertEquals(".yml", $locator->getFileExtension());
        $locator->setFileExtension(".xml");
        self::assertEquals(".xml", $locator->getFileExtension());
    }

    public function testFileExists()
    {
        $path   = __DIR__ . "/_files";
        $prefix = "Foo";

        $locator = new SymfonyFileLocator([$path => $prefix], ".yml");

        self::assertTrue($locator->fileExists("Foo\stdClass"));
        self::assertTrue($locator->fileExists("Foo\global"));
        self::assertFalse($locator->fileExists("Foo\stdClass2"));
        self::assertFalse($locator->fileExists("Foo\global2"));
    }

    public function testGetAllClassNames()
    {
        $path   = __DIR__ . "/_files";
        $prefix = "Foo";

        $locator       = new SymfonyFileLocator([$path => $prefix], ".yml");
        $allClasses    = $locator->getAllClassNames(null);
        $globalClasses = $locator->getAllClassNames("global");

        $expectedAllClasses    = ["Foo\\Bar\\subDirClass", "Foo\\global", "Foo\\stdClass"];
        $expectedGlobalClasses = ["Foo\\Bar\\subDirClass", "Foo\\stdClass"];

        sort($allClasses);
        sort($globalClasses);
        sort($expectedAllClasses);
        sort($expectedGlobalClasses);

        self::assertEquals($expectedAllClasses, $allClasses);
        self::assertEquals($expectedGlobalClasses, $globalClasses);
    }

    /**
     * @expectedException \InvalidArgumentException
     * @expectedExceptionMessage Namespace separator should not be empty
     */
    public function testInvalidCustomNamespaceSeparator()
    {
        $path   = __DIR__ . "/_files";
        $prefix = "Foo";

        new SymfonyFileLocator([$path => $prefix], ".yml", null);
    }

    public function customNamespaceSeparatorProvider()
    {
        return [
            'directory separator' => [DIRECTORY_SEPARATOR, "/_custom_ns/dir"],
            'default dot separator' => ['.', "/_custom_ns/dot"],
        ];
    }

    /**
     * @dataProvider customNamespaceSeparatorProvider
     *
     * @param $separator string Directory separator to test against
     * @param $dir       string Path to load mapping data from
     *
     * @throws MappingException
     */
    public function testGetClassNamesWithCustomNsSeparator($separator, $dir)
    {
        $path   = __DIR__ . $dir;
        $prefix = "Foo";

        $locator = new SymfonyFileLocator([$path => $prefix], ".yml", $separator);
        $classes = $locator->getAllClassNames(null);
        sort($classes);

        self::assertEquals(["Foo\\stdClass", "Foo\\sub\\subClass", "Foo\\sub\\subsub\\subSubClass"], $classes);
    }

    public function customNamespaceLookupQueryProvider()
    {
        return [
            'directory separator'  => [
                DIRECTORY_SEPARATOR,
                "/_custom_ns/dir",
                [
                    "stdClass.yml"               => "Foo\\stdClass",
                    "sub/subClass.yml"           => "Foo\\sub\\subClass",
                    "sub/subsub/subSubClass.yml" => "Foo\\sub\\subsub\\subSubClass",
                ]
            ],
            'default dot separator' => [
                '.',
                "/_custom_ns/dot",
                [
                    "stdClass.yml"               => "Foo\\stdClass",
                    "sub.subClass.yml"           => "Foo\\sub\\subClass",
                    "sub.subsub.subSubClass.yml" => "Foo\\sub\\subsub\\subSubClass",
                ]
            ],
        ];
    }

    /** @dataProvider customNamespaceLookupQueryProvider
     * @param $separator string Directory separator to test against
     * @param $dir       string Path to load mapping data from
     * @param $files     array  Files to lookup classnames
     *
     * @throws MappingException
     */
    public function testFindMappingFileWithCustomNsSeparator($separator, $dir, $files)
    {
        $path   = __DIR__ . $dir;
        $prefix = "Foo";

        $locator = new SymfonyFileLocator([$path => $prefix], ".yml", $separator);

        foreach ($files as $filePath => $className) {
            self::assertEquals(realpath($path . '/' . $filePath), realpath($locator->findMappingFile($className)));
        }
    }


    public function testFindMappingFile()
    {
        $path   = __DIR__ . "/_files";
        $prefix = "Foo";

        $locator = new SymfonyFileLocator([$path => $prefix], ".yml");

        self::assertEquals(__DIR__ . "/_files/stdClass.yml", $locator->findMappingFile("Foo\\stdClass"));
    }

    public function testFindMappingFileNotFound()
    {
        $path   = __DIR__ . "/_files";
        $prefix = "Foo";

        $locator = new SymfonyFileLocator([$path => $prefix], ".yml");

        $this->expectException(MappingException::class);
        $this->expectExceptionMessage("No mapping file found named 'stdClass2.yml' for class 'Foo\stdClass2'.");
        $locator->findMappingFile("Foo\\stdClass2");
    }

    public function testFindMappingFileLeastSpecificNamespaceFirst()
    {
        // Low -> High
        $prefixes                             = array();
        $prefixes[__DIR__ . "/_match_ns"]     = "Foo";
        $prefixes[__DIR__ . "/_match_ns/Bar"] = "Foo\\Bar";

        $locator = new SymfonyFileLocator($prefixes, ".yml");

        self::assertEquals(
            __DIR__ . "/_match_ns/Bar/barEntity.yml",
            $locator->findMappingFile("Foo\\Bar\\barEntity")
        );
    }

    public function testFindMappingFileMostSpecificNamespaceFirst()
    {
        $prefixes                             = array();
        $prefixes[__DIR__ . "/_match_ns/Bar"] = "Foo\\Bar";
        $prefixes[__DIR__ . "/_match_ns"]     = "Foo";

        $locator = new SymfonyFileLocator($prefixes, ".yml");

        self::assertEquals(
            __DIR__ . "/_match_ns/Bar/barEntity.yml",
            $locator->findMappingFile("Foo\\Bar\\barEntity")
        );
    }
}