SitesTest::provideValidSiteDefinitions() - Code Metrics - Inspection of "Refactor for Craft3" - nerds-and-company/schematic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#114)

by Bart

created 2018-04-10 16:24 UTC

SitesTest::provideValidSiteDefinitions() B

↳ Parent: SitesTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	27
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	27
rs	8.8571
c	0
b	0
f	0
cc	1
eloc	18
nc	1
nop	0

<?php

namespace NerdsAndCompany\Schematic\Services;

use Craft;
use craft\models\Site;
use craft\models\SiteGroup;
use Codeception\Test\Unit;
use NerdsAndCompany\Schematic\Schematic;

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

    /**
     * Set the service.
     *
     * @SuppressWarnings(PHPMD.CamelCaseMethodName)
     */
    protected function _before()
    {
        Craft::$app->sites->expects($this->any())
                          ->method('getAllGroups')
                          ->willReturn([$this->getMockSiteGroup(1)]);

        Craft::$app->sites->expects($this->any())
                          ->method('saveGroup')
                          ->willReturn(true);

        $this->service = new ModelProcessor();

    }

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

    /**
     * @dataProvider provideValidSites
     *
     * @param SiteModel[] $sites
     * @param array       $expectedResult
     */
    public function testSuccessfulExport(array $sites, array $expectedResult = [])
    {
        $actualResult = $this->service->export($sites);

        $this->assertSame($expectedResult, $actualResult);
    }

    /**
     * @dataProvider provideValidSiteDefinitions
     *
     * @param array $siteDefinitions
     */
    public function testSuccessfulImport(array $siteDefinitions, array $existingsites, int $saveCount)
    {
        $this->expectSaves($saveCount);
        $this->expectDeletes(0);

        $this->service->import($siteDefinitions, $existingsites);
    }

    /**
     * @dataProvider provideValidSiteDefinitions
     *
     * @param array $siteDefinitions
     */
    public function testImportWithForceOption(array $siteDefinitions, array $existingsites, int $saveCount, int $deleteCount)
    {
        Schematic::$force = true;
        $this->expectSaves($saveCount);
        $this->expectDeletes($deleteCount);

        $this->service->import($siteDefinitions, $existingsites);
    }

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

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

        return [
            'emptyArray' => [
                'sites' => [],
                'expectedResult' => [],
            ],
            'single site' => [
                'sites' => [
                    'site1' => $mockSite1,
                ],
                'expectedResult' => [
                    'siteHandle1' => $this->getMockSiteDefinition($mockSite1),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                ],
            ],
            'multiple sites' => [
                'sites' => [
                    'site1' => $mockSite1,
                    'site2' => $mockSite2,
                ],
                'expectedResult' => [
                    'siteHandle1' => $this->getMockSiteDefinition($mockSite1),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    'siteHandle2' => $this->getMockSiteDefinition($mockSite2),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                ],
            ],
        ];
    }

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

        return [
            'emptyArray' => [
                'siteDefinitions' => [],
                'existingsites' => [
                    $mockSite1,
                ],
                'saveCount' => 0,
                'deleteCount' => 1,
            ],
            'single new site' => [
                'siteDefinitions' => [
                    'siteHandle1' => $this->getMockSiteDefinition($mockSite1),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    'siteHandle2' => $this->getMockSiteDefinition($mockSite2),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                ],
                'existingsites' => [
                    $mockSite1,
                ],
                'saveCount' => 1,
                'deleteCount' => 0,
            ],
        ];
    }

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

    /**
     * @param Site $mockSite
     *
     * @return array
     */
    private function getMockSiteDefinition(Site $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|Site
     */
    private function getMockSite(int $siteId, int $groupId)
    {
        $mockSite = $this->getMockBuilder(Site::class)
                                    ->setMethods(['getGroup'])
                                    ->disableOriginalConstructor()
                                    ->getMock();

        $mockSite->id = $siteId;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $mockSite->groupId = 1;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $mockSite->handle = 'siteHandle'.$siteId;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $mockSite->language = 'nl';
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $mockSite->primary = true;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $mockSite->hasUrls = true;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $mockSite->originalName = null;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $mockSite->originalBaseUrl = null;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $mockSite->baseUrl = '@web/';
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $mockSite->sortOrder = 1;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        $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;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        $mockGroup->name = 'siteGroup'.$groupId;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        return $mockGroup;
    }

    /**
     * Expect a number of site saves.
     *
     * @param int $saveCount
     */
    private function expectSaves(int $saveCount)
    {
        Craft::$app->sites
                   ->expects($this->exactly($saveCount))
                   ->method('saveSite')
                   ->willReturn(true);
    }

    /**
     * Expect a number of site deletes.
     *
     * @param int $deleteCount
     */
    private function expectDeletes(int $deleteCount)
    {
        Craft::$app->sites
                    ->expects($this->exactly($deleteCount))
                    ->method('deleteSiteById');
    }
}


Pull Request — master (#114)

SitesTest::provideValidSiteDefinitions() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			namespace NerdsAndCompany\Schematic\Services;
4
5			use Craft;
6			use craft\models\Site;
7			use craft\models\SiteGroup;
8			use Codeception\Test\Unit;
9			use NerdsAndCompany\Schematic\Schematic;
10
11			/**
12			* Class SitesTest.
13			*
14			* @author Nerds & Company
15			* @copyright Copyright (c) 2015-2017, Nerds & Company
16			* @license MIT
17			*
18			* @see http://www.nerds.company
19			*/
20			class SitesTest extends Unit
21			{
22			/**
23			* @var Sites
24			*/
25			private $service;
26
27			/**
28			* Set the service.
29			*
30			* @SuppressWarnings(PHPMD.CamelCaseMethodName)
31			*/
32			protected function _before()
33			{
34			Craft::$app->sites->expects($this->any())
35			->method('getAllGroups')
36			->willReturn([$this->getMockSiteGroup(1)]);
37
38			Craft::$app->sites->expects($this->any())
39			->method('saveGroup')
40			->willReturn(true);

nerds-and-company / schematic

Pull Request — master (#114)

SitesTest::provideValidSiteDefinitions() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like