NerdsAndCompany\Schematic\Converters\Models\SiteTest

Complexity

Total Complexity

9

Size/Duplication

Total Lines	183
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	_before()	0	4	1
A	testGetRecordDefinition()	0	6	1
A	testSaveRecord()	0	19	2
A	testDeleteRecord()	0	8	1
A	provideSites()	0	23	1
A	getMockSiteDefinition()	0	18	1
B	getMockSite()	0	24	1
A	getMockSiteGroup()	0	11	1

<?php

namespace NerdsAndCompany\Schematic\Converters\Models;

use Craft;
use craft\models\Site as SiteModel;
use craft\models\SiteGroup;
use Codeception\Test\Unit;

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

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

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

    }

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

    /**
     * @dataProvider provideSites
     *
     * @param SiteModel $site
     * @param array     $definition
     */
    public function testGetRecordDefinition(SiteModel $site, array $definition)
    {
        $result = $this->converter->getRecordDefinition($site);

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

    /**
     * @dataProvider provideSites
     *
     * @param SiteModel $site
     * @param array     $definition
     * @param string    $groupStatus existing|new|invalid
     */
    public function testSaveRecord(SiteModel $site, array $definition, string $groupStatus)
    {
        Craft::$app->sites->expects($this->exactly(1))
                          ->method('getAllGroups')
                          ->willReturn([$this->getMockSiteGroup(1)]);

        Craft::$app->sites->expects($this->exactly($groupStatus == 'existing' ? 0 : 1))
                          ->method('saveGroup')
                          ->willReturn($groupStatus !== 'invalid');

        Craft::$app->sites->expects($this->exactly(1))
                          ->method('saveSite')
                          ->with($site)
                          ->willReturn(true);

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

        $this->assertTrue($result);
    }

    /**
     * @dataProvider provideSites
     *
     * @param SiteModel $site
     */
    public function testDeleteRecord(SiteModel $site)
    {
        Craft::$app->sites->expects($this->exactly(1))
                          ->method('deleteSiteById')
                          ->with($site->id);

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

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

    /**
     * @return array
     */
    public function provideSites()
    {
        $mockSite1 = $this->getMockSite(1, 1);
        $mockSite2 = $this->getMockSite(1, 2);

        return [
            'valid site existing group' => [
                'site' => $mockSite1,
                'definition' => $this->getMockSiteDefinition($mockSite1),

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

                'groupStatus' => 'existing',
            ],
            'valid site new group' => [
                'site' => $mockSite2,
                'definition' => $this->getMockSiteDefinition($mockSite2),

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

                'groupStatus' => 'new',
            ],
            'valid site invalid group' => [
                'site' => $mockSite2,
                'definition' => $this->getMockSiteDefinition($mockSite2),

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

                'groupStatus' => 'invalid',
            ],
        ];
    }

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

    /**
     * @param SiteModel $mockSite
     *
     * @return array
     */
    private function getMockSiteDefinition(SiteModel $mockSite)
    {
        return [
            'class' => get_class($mockSite),
            'attributes' => [
                'name' => $mockSite->name,
                'handle' => $mockSite->handle,
                'language' => 'nl',
                'primary' => true,
                'hasUrls' => true,
                'originalName' => null,
                'originalBaseUrl' => null,
                'baseUrl' => '@web/',
                'sortOrder' => 1,
            ],
            'group' => $mockSite->group->name,
        ];
    }

    /**
     * @param int $siteId
     *
     * @return Mock|SiteModel
     */
    private function getMockSite(int $siteId, int $groupId)
    {
        $mockSite = $this->getMockBuilder(SiteModel::class)
                                    ->setMethods(['getGroup'])
                                    ->disableOriginalConstructor()
                                    ->getMock();

        $mockSite->id = $siteId;

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

        $mockSite->groupId = $groupId;

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

        $mockSite->handle = 'siteHandle'.$siteId;

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

        $mockSite->language = 'nl';

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

        $mockSite->primary = true;

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

        $mockSite->hasUrls = true;

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

        $mockSite->originalName = null;

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

        $mockSite->originalBaseUrl = null;

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

        $mockSite->baseUrl = '@web/';

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

        $mockSite->sortOrder = 1;

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

        $mockSite->expects($this->any())
                 ->method('getGroup')
                 ->willReturn($this->getMockSiteGroup($groupId));

        return $mockSite;
    }

    /**
     * Get a mock site group.
     *
     * @param int $groupId
     *
     * @return Mock|SiteGroup
     */
    private function getMockSiteGroup(int $groupId)
    {
        $mockGroup = $this->getMockBuilder(SiteGroup::class)
                        ->disableOriginalConstructor()
                        ->getmock();

        $mockGroup->id = $groupId;

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

        $mockGroup->name = 'siteGroup'.$groupId;

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

        return $mockGroup;
    }
}