NerdsAndCompany\Schematic\Mappers\ElementIndexMapperTest

Complexity

Total Complexity

10

Size/Duplication

Total Lines	216
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	1
Bugs	0	Features	0

<?php
class ElementIndexMapperTest extends Unit
{
    /**
     * @var ElementIndexMapper
     */
    private $mapper;

    /**
     * Set the mapper.
     *
     * @SuppressWarnings(PHPMD.CamelCaseMethodName)
     * phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
     */
    protected function _before()
    {
        $this->setMockSectionsService();
        $this->setMockFieldsService();
        $this->setMockElementIndexesService();

        $this->mapper = new ElementIndexMapper();
    }

    //==============================================================================================================
    //=================================================  TESTS  ====================================================
    //==============================================================================================================

    /**
     * Test default import functionality.
     */
    public function testImport()
    {
        $data = $this->getElementIndexSettingsExportedData();

        $result = $this->mapper->import($data, $this->getElementsData());

        $this->assertSame([], $result);
    }

    /**
     * Test export functionality.
     */
    public function testExport()
    {
        $data = $this->getElementsData();
        $expected = $this->getElementIndexSettingsExportedData();

        $result = $this->mapper->export($data);
        $this->assertEquals($expected, $result);
    }

    //==============================================================================================================
    //================================================  HELPERS  ===================================================
    //==============================================================================================================

    /**
     * @param array $getAllElementTypesResponse
     */
    protected function setMockElementsService($getAllElementTypesResponse = [])
    {
        Craft::$app->elementTypes->expects($this->any())
                                 ->method('getAllElementTypes')
                                 ->willReturn($getAllElementTypesResponse);
    }

    /**
     * St mock element index service.
     */
    protected function setMockElementIndexesService()
    {
        $getSettingsResponse = $this->getElementIndexSettingsSavedData();
        Craft::$app->elementIndexes
                   ->expects($this->any())
                   ->method('getSettings')
                   ->willReturnMap([
                      [Entry::class, $getSettingsResponse['Entry']],
                      [Category::class, $getSettingsResponse['Category']],
                   ]);

        Craft::$app->elementIndexes->expects($this->any())
                                   ->method('saveSettings')
                                   ->willReturn(false);
    }

    /**
     * Returns elements data.
     *
     * @return array
     */
    public function getElementsData()
    {
        return [
            Category::class,
            Entry::class,
        ];
    }

    /**
     * Returns element index settings saved data.
     *
     * @return array
     */
    private function getElementIndexSettingsSavedData()
    {
        return [
            'Category' => [
                'sourceOrder' => [
                    ['heading', 'Channels'],
                    ['key', 'section:1'],
                ],
                'sources' => [
                    '*' => [
                        'tableAttributes' => [
                            '0' => 'section',
                            '1' => 'postDate',
                            '2' => 'expiryDate',
                            '3' => 'author',
                            '4' => 'link',
                            '5' => 'field:1',
                        ],
                    ],
                ],
            ],
            'Entry' => [
                'sourceOrder' => [
                    ['heading', 'Channels'],
                    ['key', 'section:1'],
                ],
                'sources' => [
                    '*' => [
                        'tableAttributes' => [
                            '0' => 'section',
                            '1' => 'postDate',
                            '2' => 'expiryDate',
                            '3' => 'author',
                            '4' => 'link',
                        ],
                    ],
                ],
            ],
        ];
    }

    /**
     * Returns element index settings exported data.
     *
     * @return array
     */
    private function getElementIndexSettingsExportedData()
    {
        return [
            'Category' => [
                'sourceOrder' => [
                    ['heading', 'Channels'],
                    ['key', 'section:handle'],
                ],
                'sources' => [
                    '*' => [
                        'tableAttributes' => [
                            '0' => 'section',
                            '1' => 'postDate',
                            '2' => 'expiryDate',
                            '3' => 'author',
                            '4' => 'link',
                            '5' => 'field:handle',
                        ],
                    ],
                ],
            ],
            'Entry' => [
                'sourceOrder' => [
                    ['heading', 'Channels'],
                    ['key', 'section:handle'],
                ],
                'sources' => [
                    '*' => [
                        'tableAttributes' => [
                            '0' => 'section',
                            '1' => 'postDate',
                            '2' => 'expiryDate',
                            '3' => 'author',
                            '4' => 'link',
                        ],
                    ],
                ],
            ],
        ];
    }

    /**
     * @return Mock|Sources
     */
    private function setMockSectionsService()
    {
        $mockSection = $this->getMockBuilder(Section::class)->getMock();
        $mockSection->handle = 'handle';

        Craft::$app->sections->expects($this->any())
                             ->method('getSectionById')
                             ->with('1')
                             ->willReturn($mockSection);
    }

    /**
     * Set mock fields service.
     */
    private function setMockFieldsService()
    {
        $mockField = $this->getMockBuilder(Field::class)->getMock();
        $mockField->handle = 'handle';

        Craft::$app->fields->expects($this->any())
                            ->method('getFieldById')
                            ->with('1')
                            ->willReturn($mockField);
    }
}