NerdsAndCompany\Schematic\Converters\Models\EntryTypeTest

Complexity

Total Complexity

8

Size/Duplication

Total Lines	151
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	7

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	_before()	0	4	1
A	testGetRecordDefinition()	0	6	1
A	testSaveRecord()	0	11	1
A	testDeleteRecord()	0	8	1
A	provideEntryTypes()	0	11	1
A	getMockEntryTypeDefinition()	0	21	2
B	getMockEntryType()	0	29	1

<?php

namespace NerdsAndCompany\Schematic\Converters\Models;

use Craft;
use craft\base\Field as FieldModel;
use craft\models\EntryType as EntryTypeModel;
use craft\models\FieldLayout;
use craft\entryTypes\Local;
use Codeception\Test\Unit;

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

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

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

    }

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

    /**
     * @dataProvider provideEntryTypes
     *
     * @param EntryTypeModel $entryType
     * @param array          $definition
     */
    public function testGetRecordDefinition(EntryTypeModel $entryType, array $definition)
    {
        $result = $this->converter->getRecordDefinition($entryType);

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

    /**
     * @dataProvider provideEntryTypes
     *
     * @param EntryTypeModel $entryType
     * @param array          $definition
     */
    public function testSaveRecord(EntryTypeModel $entryType, array $definition)
    {
        Craft::$app->sections->expects($this->exactly(1))
                             ->method('saveEntryType')
                             ->with($entryType)
                             ->willReturn(true);

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

        $this->assertTrue($result);
    }

    /**
     * @dataProvider provideEntryTypes
     *
     * @param EntryTypeModel $entryType
     */
    public function testDeleteRecord(EntryTypeModel $entryType)
    {
        Craft::$app->sections->expects($this->exactly(1))
                             ->method('deleteEntryType')
                             ->with($entryType);

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

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

    /**
     * @return array
     */
    public function provideEntryTypes()
    {
        $mockEntryType = $this->getMockEntryType(1);

        return [
            'local entryType' => [
                'entryType' => $mockEntryType,
                'definition' => $this->getMockEntryTypeDefinition($mockEntryType),

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

            ],
        ];
    }

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

    /**
     * @param EntryTypeModel $mockEntryType
     *
     * @return array
     */
    private function getMockEntryTypeDefinition(EntryTypeModel $mockEntryType)
    {
        $fieldDefs = [];
        foreach ($mockEntryType->getFieldLayout()->getFields() as $field) {
            $fieldDefs[$field->handle] = $field->required;
        }

        return [
            'class' => get_class($mockEntryType),
            'attributes' => [
                'name' => 'entryTypeName'.$mockEntryType->id,
                'handle' => 'entryTypeHandle'.$mockEntryType->id,
                'hasTitleField' => true,
                'titleLabel' => 'Title',
                'titleFormat' => null,
            ],
            'fieldLayout' => [
                'fields' => $fieldDefs,
            ],
        ];
    }

    /**
     * @param int $entryTypeId
     *
     * @return Mock|EntryTypeModel
     */
    private function getMockEntryType(int $entryTypeId)
    {
        $mockEntryType = $this->getMockBuilder(EntryTypeModel::class)
                           ->setMethods(['getFieldLayout'])
                           ->disableOriginalConstructor()
                           ->getMock();

        $mockEntryType->id = $entryTypeId;

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

        $mockEntryType->fieldLayoutId = $entryTypeId;

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

        $mockEntryType->handle = 'entryTypeHandle'.$entryTypeId;

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

        $mockEntryType->name = 'entryTypeName'.$entryTypeId;

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->getMockbuilder(FieldModel::class)->getMock();
        $mockField->id = $entryTypeId;

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'.$entryTypeId;

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?

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

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

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

        return $mockEntryType;
    }
}