NerdsAndCompany\Schematic\Converters\Base\VolumeTest

Complexity

Total Complexity

8

Size/Duplication

Total Lines	152
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	6

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	provideVolumes()	0	11	1
B	getMockVolume()	0	29	1
A	getMockVolumeDefinition()	0	22	2

<?php

namespace NerdsAndCompany\Schematic\Converters\Base;

use Craft;
use craft\base\Field as FieldModel;
use craft\base\Volume as VolumeModel;
use craft\models\FieldLayout;
use craft\volumes\Local;
use Codeception\Test\Unit;

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

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

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

    }

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

    /**
     * @dataProvider provideVolumes
     *
     * @param VolumeModel $volume
     * @param array       $definition
     */
    public function testGetRecordDefinition(VolumeModel $volume, array $definition)
    {
        $result = $this->converter->getRecordDefinition($volume);

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

    /**
     * @dataProvider provideVolumes
     *
     * @param VolumeModel $volume
     * @param array       $definition
     */
    public function testSaveRecord(VolumeModel $volume, array $definition)
    {
        Craft::$app->volumes->expects($this->exactly(1))
                            ->method('saveVolume')
                            ->with($volume)
                            ->willReturn(true);

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

        $this->assertTrue($result);
    }

    /**
     * @dataProvider provideVolumes
     *
     * @param VolumeModel $volume
     */
    public function testDeleteRecord(VolumeModel $volume)
    {
        Craft::$app->volumes->expects($this->exactly(1))
                            ->method('deleteVolume')
                            ->with($volume);

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

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

    /**
     * @return array
     */
    public function provideVolumes()
    {
        $mockVolume = $this->getMockVolume(1);

        return [
            'local volume' => [
                'volume' => $mockVolume,
                'definition' => $this->getMockVolumeDefinition($mockVolume),

$mockVolume is of type object<PHPUnit\Framework\MockObject\MockObject>, but the function expects a object<craft\base\Volume>.

            ],
        ];
    }

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

    /**
     * @param int $volumeId
     *
     * @return Mock|VolumeModel
     */
    private function getMockVolume(int $volumeId)
    {
        $mockVolume = $this->getMockBuilder(Local::class)
                           ->setMethods(['getFieldLayout'])
                           ->disableOriginalConstructor()
                           ->getMock();

        $mockVolume->id = $volumeId;

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

        $mockVolume->fieldLayoutId = $volumeId;

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

        $mockVolume->handle = 'volumeHandle'.$volumeId;

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

        $mockVolume->name = 'volumeName'.$volumeId;

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 = $volumeId;

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

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]);

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

        return $mockVolume;
    }

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

        return [
            'class' => get_class($mockVolume),
            'attributes' => [
                'path' => null,
                'name' => 'volumeName'.$mockVolume->id,
                'handle' => 'volumeHandle'.$mockVolume->id,
                'hasUrls' => null,
                'url' => null,
                'sortOrder' => null,
            ],
            'fieldLayout' => [
                'fields' => $fieldDefs,
            ],
        ];
    }
}