EasyDictionary\ManagerTest

Complexity

Total Complexity

12

Size/Duplication

Total Lines	258
Duplicated Lines	27.13 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	testClassExistence()	0	4	1
A	testSetConfigFromConstructor()	0	7	1
A	testGetDictionaryWithoutConfig()	0	5	1
A	testGetANonExistentDictionary()	0	6	1
A	testAddNewDictionary()	11	11	1
A	testAddDuplicatedDictionary()	12	12	1
A	testCreateSimpleDictionary()	0	38	1
A	testCreateRealDictionary()	0	19	1
A	testGetExceptionOfUndefinedDataProviderClass()	0	15	1
A	testGetExceptionOfBadDataProviderClass()	15	15	1
A	testGetExceptionOfUndefinedDictionaryClass()	16	16	1
A	testGetExceptionOfBadDictionaryClass()	16	16	1

<?php

Missing file doc comment

declare(strict_types=1);

namespace EasyDictionary;

use EasyDictionary\DataProvider\Simple;
use EasyDictionary\Dictionary\Simple as SimpleDictionary;
use EasyDictionary\Interfaces\ConfigInterface;
use EasyDictionary\Interfaces\DataProviderInterface;
use EasyDictionary\Interfaces\DictionaryInterface;
use PHPUnit\Framework\TestCase;
use Psr\SimpleCache\CacheInterface;

/**

Missing short description in doc comment

 * @coversDefaultClass \EasyDictionary\Manager
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class ManagerTest extends TestCase
{
    /**

Missing short description in doc comment

     * @covers \EasyDictionary\Manager
     */

Missing @return tag in function comment

    public function testClassExistence()
    {
        self::assertTrue(class_exists('\EasyDictionary\Manager'));
    }

    /**

Missing short description in doc comment

     * @covers ::__construct
     * @covers ::setConfig
     * @covers ::getConfig
     */

Missing @return tag in function comment

    public function testSetConfigFromConstructor()
    {
        $config = $this->createMock(ConfigInterface::class);
        $manager = new Manager($config);

$config is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a null|object<EasyDictionary\Interfaces\ConfigInterface>.

        self::assertEquals($config, $manager->getConfig());
    }

    /**

Missing short description in doc comment

     * @covers ::__construct
     * @covers ::getConfig
     * @covers ::get
     *
     * @expectedException \EasyDictionary\Exception\RuntimeException

Tag value indented incorrectly; expected 8 spaces but found 1

     * @expectedExceptionMessage Config not found
     */

Missing @return tag in function comment

    public function testGetDictionaryWithoutConfig()
    {
        $manager = new Manager();
        $manager->get('test');
    }

    /**

Missing short description in doc comment

     * @covers ::__construct
     * @covers ::setConfig
     * @covers ::getConfig
     * @covers ::get
     *
     * @expectedException \EasyDictionary\Exception\RuntimeException

Tag value indented incorrectly; expected 8 spaces but found 1

     * @expectedExceptionMessage  Dictionary with key "test" not found

Tag value indented incorrectly; expected 1 spaces but found 2

     */

Missing @return tag in function comment

    public function testGetANonExistentDictionary()
    {
        $config = $this->createMock(ConfigInterface::class);
        $manager = new Manager($config);

$config is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a null|object<EasyDictionary\Interfaces\ConfigInterface>.

        $manager->get('test');
    }

    /**

Missing short description in doc comment

     * @covers ::__construct
     * @covers ::add
     * @covers ::get
     */

Missing @return tag in function comment

    public function testAddNewDictionary()

This method seems to be duplicated in your project.

    {
        $dictionaryName = 'test';
        $dictionary = $this->createMock(DictionaryInterface::class);
        $dictionary->method('getName')->willReturn($dictionaryName);

        $manager = new Manager();
        $manager->add($dictionary);

$dictionary is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<EasyDictionary\Interfaces\DictionaryInterface>.

        self::assertEquals($dictionary, $manager->get($dictionaryName));
    }

    /**

Missing short description in doc comment

     * @covers ::__construct
     * @covers ::add
     * @covers ::get
     *
     * @expectedException \EasyDictionary\Exception\RuntimeException

Tag value indented incorrectly; expected 8 spaces but found 1

     * @expectedExceptionMessage The dictionary with key "test" already exists
     */

Missing @return tag in function comment

    public function testAddDuplicatedDictionary()

This method seems to be duplicated in your project.

    {
        $dictionaryName = 'test';
        $dictionary = $this->createMock(DictionaryInterface::class);
        $dictionary->method('getName')->willReturn($dictionaryName);

        $manager = new Manager();
        $manager->add($dictionary);

$dictionary is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<EasyDictionary\Interfaces\DictionaryInterface>.

        $manager->add($dictionary);

$dictionary is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<EasyDictionary\Interfaces\DictionaryInterface>.

        self::assertEquals($dictionary, $manager->get($dictionaryName));
    }

    /**

Missing short description in doc comment

     * @covers ::get
     * @covers ::add
     * @covers ::create
     */

Missing @return tag in function comment

    public function testCreateSimpleDictionary()
    {
        $cacheMock = $this->createMock(CacheInterface::class);
        $dataProviderMock = $this->createMock(DataProviderInterface::class);

        $dictionaryMock = $this->createMock(DictionaryInterface::class);
        $dictionaryMock->method('getName')->willReturn('test');
        $dictionaryMock->expects(self::once())->method('getName');
        $dictionaryMock->expects(self::once())->method('setDataProvider')->with($dataProviderMock);
        $dictionaryMock->expects(self::once())->method('setName');
        $dictionaryMock->expects(self::once())->method('setDefaultView')->with(null);
        $dictionaryMock->expects(self::once())->method('setSearchFields')->with([]);
        $dictionaryMock->expects(self::once())->method('setCache')->with($cacheMock, 1);

        $config = $this->createMock(ConfigInterface::class);
        $config->method('getCache')->with('testCache')->willReturn($cacheMock);
        $config->expects(self::once())->method('getDefaultDataProviderClass');
        $config->expects(self::once())->method('getDefaultDictionaryClass');
        $config->method('getDictionaryConfig')->willReturn([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'test' => [
                'cache' => 'testCache',
                'cacheTTL' => 1,
                'data' => []
            ]
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $manager = $this->createPartialMock(Manager::class, [

The opening parenthesis of a multi-line function call should be the last content on the line.

            'createDictionary',
            'createDataProvider',
            'getConfig',
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $manager->method('createDictionary')->willReturn($dictionaryMock);
        $manager->method('createDataProvider')->willReturn($dataProviderMock);
        $manager->method('getConfig')->willReturn($config);

        self::assertEquals($manager->get('test'), $manager->get('test'));
    }

    /**

Missing short description in doc comment

     * @covers \EasyDictionary\AbstractDictionary
     * @covers \EasyDictionary\DataProvider\Simple
     * @covers ::<public>
     * @covers ::create
     * @covers ::createDataProvider
     */

Missing @return tag in function comment

    public function testCreateRealDictionary()
    {
        $config = $this->createMock(ConfigInterface::class);
        $config->expects(self::once())->method('getDefaultDataProviderClass')
            ->willReturn(Simple::class);
        $config->expects(self::once())->method('getDefaultDictionaryClass')
            ->willReturn(SimpleDictionary::class);

        $config->method('getDictionaryConfig')->willReturn([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'test' => [
                'data' => []
            ]
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $manager = new Manager();
        $manager->setConfig($config);

$config is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<EasyDictionary\Interfaces\ConfigInterface>.

        self::assertEquals($manager->get('test'), $manager->get('test'));
    }

    /**

Missing short description in doc comment

     * @covers ::<public>

Tag value indented incorrectly; expected 19 spaces but found 1

     * @covers ::create

Tag value indented incorrectly; expected 19 spaces but found 1

     * @covers ::createDataProvider

Tag value indented incorrectly; expected 19 spaces but found 1

     * @expectedException \EasyDictionary\Exception\InvalidConfigurationException

Tag value indented incorrectly; expected 8 spaces but found 1

     * @expectedExceptionMessage Class "/bad/dataprovider/class" not found
     */

Missing @return tag in function comment

    public function testGetExceptionOfUndefinedDataProviderClass()
    {
        $config = $this->createMock(ConfigInterface::class);
        $config->method('getDictionaryConfig')->willReturn([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'test' => [
                'data' => [
                    'class' => '/bad/dataprovider/class',
                ]
            ]
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $manager = new Manager();
        $manager->setConfig($config);

$config is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<EasyDictionary\Interfaces\ConfigInterface>.

        $manager->get('test');
    }

    /**

Missing short description in doc comment

     * @covers ::<public>

Tag value indented incorrectly; expected 19 spaces but found 1

     * @covers ::create

Tag value indented incorrectly; expected 19 spaces but found 1

     * @covers ::createDataProvider

Tag value indented incorrectly; expected 19 spaces but found 1

     * @expectedException \EasyDictionary\Exception\InvalidConfigurationException

Tag value indented incorrectly; expected 8 spaces but found 1

     * @expectedExceptionMessage Class "stdClass" is not implement required interface
     */

Missing @return tag in function comment

    public function testGetExceptionOfBadDataProviderClass()

This method seems to be duplicated in your project.

    {
        $config = $this->createMock(ConfigInterface::class);
        $config->method('getDictionaryConfig')->willReturn([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'test' => [
                'data' => [
                    'class' => \stdClass::class,
                ]
            ]
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $manager = new Manager();
        $manager->setConfig($config);

$config is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<EasyDictionary\Interfaces\ConfigInterface>.

        $manager->get('test');
    }

    /**

Missing short description in doc comment

     * @covers \EasyDictionary\DataProvider\Simple

Tag value indented incorrectly; expected 19 spaces but found 1

     * @covers ::<public>

Tag value indented incorrectly; expected 19 spaces but found 1

     * @covers ::create

Tag value indented incorrectly; expected 19 spaces but found 1

     * @covers ::createDataProvider

Tag value indented incorrectly; expected 19 spaces but found 1

     * @expectedException \EasyDictionary\Exception\InvalidConfigurationException

Tag value indented incorrectly; expected 8 spaces but found 1

     * @expectedExceptionMessage Class "/bad/dictionary/class" not found
     */

Missing @return tag in function comment

    public function testGetExceptionOfUndefinedDictionaryClass()

This method seems to be duplicated in your project.

    {
        $config = $this->createMock(ConfigInterface::class);
        $config->method('getDictionaryConfig')->willReturn([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'test' => [
                'class' => '/bad/dictionary/class',
                'data' => [
                    'class' => Simple::class,
                ]
            ]
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $manager = new Manager();
        $manager->setConfig($config);

$config is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<EasyDictionary\Interfaces\ConfigInterface>.

        $manager->get('test');
    }

    /**

Missing short description in doc comment

     * @covers \EasyDictionary\DataProvider\Simple

Tag value indented incorrectly; expected 19 spaces but found 1

     * @covers ::<public>

Tag value indented incorrectly; expected 19 spaces but found 1

     * @covers ::create

Tag value indented incorrectly; expected 19 spaces but found 1

     * @covers ::createDataProvider

Tag value indented incorrectly; expected 19 spaces but found 1

     * @expectedException \EasyDictionary\Exception\InvalidConfigurationException

Tag value indented incorrectly; expected 8 spaces but found 1

     * @expectedExceptionMessage Class "stdClass" not found
     */

Missing @return tag in function comment

    public function testGetExceptionOfBadDictionaryClass()

This method seems to be duplicated in your project.

    {
        $config = $this->createMock(ConfigInterface::class);
        $config->method('getDictionaryConfig')->willReturn([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'test' => [
                'class' => \stdClass::class,
                'data' => [
                    'class' => Simple::class,
                ]
            ]
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        $manager = new Manager();
        $manager->setConfig($config);

$config is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<EasyDictionary\Interfaces\ConfigInterface>.

        $manager->get('test');
    }
}