NerdsAndCompany\Schematic\Converters\Models\MatrixBlockTypeTest

Complexity

Total Complexity

9

Size/Duplication

Total Lines	203
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	_before()	0	4	1
A	testGetRecordDefinition()	0	11	1
A	testSetRecordAttributes()	0	15	1
B	testSaveRecord()	0	24	1
A	testDeleteRecord()	0	8	1
A	provideMatrixBlockTypes()	0	12	1
A	getMockMatrixBlockTypeDefinition()	0	14	1
B	getMockMatrixBlockType()	0	26	1
A	getMockField()	0	12	1

<?php

namespace NerdsAndCompany\Schematic\Converters\Models;

use Craft;
use craft\base\Field as FieldModel;
use craft\models\MatrixBlockType as MatrixBlockTypeModel;
use craft\models\FieldLayout;
use Codeception\Test\Unit;

/**
 * Class MatrixBlockTypeTest.
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2017, Nerds & Company
 * @license   MIT
 *
 * @see      http://www.nerds.company
 */
class MatrixBlockTypeTest extends Unit
{
    /**
     * @var MatrixBlockTypes
     */
    private $converter;

    /**
     * Set the converter.
     *
     * @SuppressWarnings(PHPMD.CamelCaseMethodName)
     */
    protected function _before()
    {
        $this->converter = new MatrixBlockType();

It seems like new \NerdsAndCompany\Schematic\Converters\Models\MatrixBlockType() of type object<NerdsAndCompany\Schematic\Converters\Models\MatrixBlockType> is incompatible with the declared type object<NerdsAndCompany\Schematic\Converters\Models\MatrixBlockTypes> of property $converter.

    }

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

    /**
     * @dataProvider provideMatrixBlockTypes
     *
     * @param MatrixBlockTypeModel $blockType
     * @param array                $definition
     */
    public function testGetRecordDefinition(MatrixBlockTypeModel $blockType, array $definition)
    {
        Craft::$app->controller->module->modelMapper->expects($this->exactly(1))
                                     ->method('export')
                                     ->with($blockType->getFieldLayout()->getFields())
                                     ->willReturn($definition['fields']);

        $result = $this->converter->getRecordDefinition($blockType);

        $this->assertSame($definition, $result);
    }

    /**
     * @dataProvider provideMatrixBlockTypes
     *
     * @param MatrixBlockTypeModel $blockType
     * @param array                $definition
     * @param array                $defaultAttributes
     */
    public function testSetRecordAttributes(MatrixBlockTypeModel $blockType, array $definition, array $defaultAttributes)
    {
        $newMatrixBlockType = $this->getMockBuilder(MatrixBlockTypeModel::class)
                                   ->setMethods(['setFieldLayout'])
                                   ->getMock();

        $newMatrixBlockType->expects($this->exactly(0))
                           ->method('setFieldLayout');

        $this->converter->setRecordAttributes($newMatrixBlockType, $definition, $defaultAttributes);

        $this->assertSame($defaultAttributes['fieldId'], $newMatrixBlockType->fieldId);

Accessing fieldId on the interface PHPUnit\Framework\MockObject\MockObject suggest that you code against a concrete implementation. How about adding an instanceof check?

        $this->assertSame($blockType->name, $newMatrixBlockType->name);

Accessing name on the interface PHPUnit\Framework\MockObject\MockObject suggest that you code against a concrete implementation. How about adding an instanceof check?

        $this->assertSame($blockType->handle, $newMatrixBlockType->handle);

Accessing handle on the interface PHPUnit\Framework\MockObject\MockObject suggest that you code against a concrete implementation. How about adding an instanceof check?

    }

    /**
     * @dataProvider provideMatrixBlockTypes
     *
     * @param MatrixBlockTypeModel $blockType
     * @param array                $definition
     */
    public function testSaveRecord(MatrixBlockTypeModel $blockType, array $definition)
    {
        Craft::$app->matrix->expects($this->exactly(1))
                           ->method('saveBlockType')
                           ->with($blockType, false)
                           ->willReturn(true);

        $context = 'matrixBlockType:'.$blockType->id;
        $existingFields = $blockType->getFieldLayout()->getFields();

        Craft::$app->fields->expects($this->exactly(1))
                           ->method('getAllFields')
                           ->with($context)
                           ->willReturn($existingFields);

        Craft::$app->controller->module->modelMapper->expects($this->exactly(1))
                                     ->method('import')
                                     ->with($definition['fields'], $existingFields, ['context' => $context], false)
                                     ->willReturn($existingFields);

        $result = $this->converter->saveRecord($blockType, $definition);

        $this->assertTrue($result);
    }

    /**
     * @dataProvider provideMatrixBlockTypes
     *
     * @param MatrixBlockTypeModel $blockType
     */
    public function testDeleteRecord(MatrixBlockTypeModel $blockType)
    {
        Craft::$app->matrix->expects($this->exactly(1))
                           ->method('deleteBlockType')
                           ->with($blockType);

        $this->converter->deleteRecord($blockType);
    }

    //==============================================================================================================
    //==============================================  PROVIDERS  ===================================================
    //==============================================================================================================

    /**
     * @return array
     */
    public function provideMatrixBlockTypes()
    {
        $mockMatrixBlockType = $this->getMockMatrixBlockType(1);

        return [
            'valid blockType' => [
                'blockType' => $mockMatrixBlockType,
                'definition' => $this->getMockMatrixBlockTypeDefinition($mockMatrixBlockType),

$mockMatrixBlockType is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<craft\models\MatrixBlockType>.

                'defaultAttributes' => ['fieldId' => 1],
            ],
        ];
    }

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

    /**
     * @param MatrixBlockTypeModel $mockMatrixBlockType
     *
     * @return array
     */
    private function getMockMatrixBlockTypeDefinition(MatrixBlockTypeModel $mockMatrixBlockType)
    {
        return [
            'class' => get_class($mockMatrixBlockType),
            'attributes' => [
                'name' => 'blockTypeName'.$mockMatrixBlockType->id,
                'handle' => 'blockTypeHandle'.$mockMatrixBlockType->id,
                'sortOrder' => null,
            ],
            'fields' => [
                'fieldDefinition',
            ],
        ];
    }

    /**
     * @param int $blockTypeId
     *
     * @return Mock|MatrixBlockTypeModel
     */
    private function getMockMatrixBlockType(int $blockTypeId)
    {
        $mockMatrixBlockType = $this->getMockBuilder(MatrixBlockTypeModel::class)
                              ->setMethods(['getFieldLayout'])
                              ->disableOriginalConstructor()
                              ->getMock();

        $mockMatrixBlockType->id = $blockTypeId;

Accessing id on the interface PHPUnit\Framework\MockObject\MockObject suggest that you code against a concrete implementation. How about adding an instanceof check?

        $mockMatrixBlockType->fieldLayoutId = $blockTypeId;

Accessing fieldLayoutId on the interface PHPUnit\Framework\MockObject\MockObject suggest that you code against a concrete implementation. How about adding an instanceof check?

        $mockMatrixBlockType->handle = 'blockTypeHandle'.$blockTypeId;

Accessing handle on the interface PHPUnit\Framework\MockObject\MockObject suggest that you code against a concrete implementation. How about adding an instanceof check?

        $mockMatrixBlockType->name = 'blockTypeName'.$blockTypeId;

Accessing name on the interface PHPUnit\Framework\MockObject\MockObject suggest that you code against a concrete implementation. How about adding an instanceof check?

        $mockField = $this->getMockField($blockTypeId);

        $mockFieldLayout = $this->getMockBuilder(FieldLayout::class)->getMock();

        $mockFieldLayout->expects($this->any())
                        ->method('getFields')
                        ->willReturn([$mockField]);

        $mockMatrixBlockType->expects($this->any())
                   ->method('getFieldLayout')
                   ->willReturn($mockFieldLayout);

        return $mockMatrixBlockType;
    }

    /**
     * Get a mock field.
     *
     * @param int $fieldId
     *
     * @return Mock|FieldModel
     */
    private function getMockField(int $fieldId)
    {
        $mockField = $this->getMockbuilder(FieldModel::class)
                         ->setMethods([])
                         ->getMock();

        $mockField->id = $fieldId;

Accessing id on the interface PHPUnit\Framework\MockObject\MockObject suggest that you code against a concrete implementation. How about adding an instanceof check?

        $mockField->handle = 'field'.$fieldId;

Accessing handle on the interface PHPUnit\Framework\MockObject\MockObject suggest that you code against a concrete implementation. How about adding an instanceof check?

        $mockField->required = true;

Accessing required on the interface PHPUnit\Framework\MockObject\MockObject suggest that you code against a concrete implementation. How about adding an instanceof check?

        return $mockField;
    }
}