ModelMapperTest::getMockSiteSettings() - 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-11 21:46 UTC

ModelMapperTest::getMockSiteSettings() A

↳ Parent: ModelMapperTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	8
nc	1
nop	0

<?php

namespace NerdsAndCompany\Schematic\Mappers;

use Craft;
use craft\models\CategoryGroup;
use craft\models\CategoryGroup_SiteSettings;
use craft\models\FieldLayout;
use craft\models\Site;
use craft\services\Fields;
use Codeception\Test\Unit;
use NerdsAndCompany\Schematic\Schematic;

/**
 * Class ModelMapperTest.
 *
 * @TODO: Isolate from category groups
 *
 * @author    Nerds & Company
 * @copyright Copyright (c) 2015-2017, Nerds & Company
 * @license   MIT
 *
 * @see      http://www.nerds.company
 */
class ModelMapperTest extends Unit
{
    /**
     * @var CategoryGroups
     */
    private $service;

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

        $this->service = new ModelMapper();

    }

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

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

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

    /**
     * @dataProvider provideValidCategoryGroupDefinitions
     *
     * @param array $groupDefinitions
     */
    public function testSuccessfulImport(array $groupDefinitions, array $existingGroups, int $saveCount)
    {
        $this->expectSaves($saveCount);
        $this->expectDeletes(0);

        $this->service->import($groupDefinitions, $existingGroups);
    }

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

        $this->service->import($groupDefinitions, $existingGroups);
    }

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

    /**
     * @return array
     */
    public function provideValidCategoryGroups()
    {
        $mockCategoryGroup1 = $this->getMockCategoryGroup(1);
        $mockCategoryGroup2 = $this->getMockCategoryGroup(2);

        return [
            'emptyArray' => [
                'categoryGroups' => [],
                'expectedResult' => [],
            ],
            'single group' => [
                'categoryGroups' => [
                    'group1' => $mockCategoryGroup1,
                ],
                'expectedResult' => [
                    'groupHandle1' => $this->getMockCategoryGroupDefinition($mockCategoryGroup1),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                ],
            ],
            'multiple groups' => [
                'categoryGroups' => [
                    'group1' => $mockCategoryGroup1,
                    'group2' => $mockCategoryGroup2,
                ],
                'expectedResult' => [
                    'groupHandle1' => $this->getMockCategoryGroupDefinition($mockCategoryGroup1),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    'groupHandle2' => $this->getMockCategoryGroupDefinition($mockCategoryGroup2),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

    /**
     * @return array
     */
    public function provideValidCategoryGroupDefinitions()
    {
        $mockCategoryGroup1 = $this->getMockCategoryGroup(1);
        $mockCategoryGroup2 = $this->getMockCategoryGroup(2);

        return [
            'emptyArray' => [
                'groupDefinitions' => [],
                'existingGroups' => [
                    $mockCategoryGroup1,
                ],
                'saveCount' => 0,
                'deleteCount' => 1,
            ],
            'single new group' => [
                'groupDefinitions' => [
                    'groupHandle1' => $this->getMockCategoryGroupDefinition($mockCategoryGroup1),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                    'groupHandle2' => $this->getMockCategoryGroupDefinition($mockCategoryGroup2),
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

    /**
     * @param CategoryGroup $mockCategoryGroup
     *
     * @return array
     */
    private function getMockCategoryGroupDefinition(CategoryGroup $mockCategoryGroup)
    {
        return [
            'class' => get_class($mockCategoryGroup),
            'attributes' => [
                'name' => $mockCategoryGroup->name,
                'handle' => $mockCategoryGroup->handle,
                'maxLevels' => 3,
            ],
            'fieldLayout' => [
                'fields' => [],
            ],
            'siteSettings' => [
                '' => [
                    'class' => get_class($mockCategoryGroup->getSiteSettings()[0]),
                    'attributes' => [
                        'hasUrls' => null,
                        'uriFormat' => null,
                        'template' => null,
                    ],
                ],
            ],
        ];
    }

    /**
     * @param int $groupId
     *
     * @return Mock|CategoryGroup
     */
    private function getMockCategoryGroup(int $groupId)
    {
        $mockGroup = $this->getMockBuilder(CategoryGroup::class)
                                    ->setMethods(['getFieldLayout', 'getSiteSettings'])
                                    ->getMock();
        $mockGroup->setAttributes([
            'id' => $groupId,
            'fieldLayoutId' => $groupId,
            'handle' => 'groupHandle'.$groupId,
            'name' => 'groupName'.$groupId,
            'maxLevels' => 3,
        ]);

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

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

        $mockSiteSettings = $this->getMockSiteSettings();

        $mockGroup->expects($this->any())
                  ->method('getSiteSettings')
                  ->willReturn([$mockSiteSettings]);

        return $mockGroup;
    }

    /**
     * Get mock siteSettings.
     *
     * @param string $class
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return Mock|CategoryGroup_SiteSettings
     */
    private function getMockSiteSettings()
    {
        $mockSiteSettings = $this->getMockBuilder(CategoryGroup_SiteSettings::class)
                                 ->setMethods(['getSite'])
                                 ->getMock();

        $mockSiteSettings->expects($this->any())
          ->method('getSite')
          ->willReturn($this->getMockSite());

        return $mockSiteSettings;
    }

    /**
     * Get a mock site.
     *
     * @return Mock|Site
     */
    private function getMockSite()
    {
        return $this->getMockBuilder(Site::class)->getMock();
    }

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

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


1			<?php
2
3			namespace NerdsAndCompany\Schematic\Mappers;
4
5			use Craft;
6			use craft\models\CategoryGroup;
7			use craft\models\CategoryGroup_SiteSettings;
8			use craft\models\FieldLayout;
9			use craft\models\Site;
10			use craft\services\Fields;
11			use Codeception\Test\Unit;
12			use NerdsAndCompany\Schematic\Schematic;
13
14			/**
15			* Class ModelMapperTest.
16			*
17			* @TODO: Isolate from category groups
18			*
19			* @author Nerds & Company
20			* @copyright Copyright (c) 2015-2017, Nerds & Company
21			* @license MIT
22			*
23			* @see http://www.nerds.company
24			*/
25			class ModelMapperTest extends Unit
26			{
27			/**
28			* @var CategoryGroups
29			*/
30			private $service;
31
32			/**
33			* Set the service.
34			*
35			* @SuppressWarnings(PHPMD.CamelCaseMethodName)
36			*/
37			protected function _before()
38			{
39			Craft::$app->sites->expects($this->any())
40			->method('getSiteByHandle')
41			->willReturn($this->getMockSite());
42
43			$this->service = new ModelMapper();
			0 ignored issues – show Documentation Bug introduced 2018-04-11 21:50 UTC by Report Bug Copy Issue Report It seems like `new \NerdsAndCompany\Sch...c\Mappers\ModelMapper()` of type `object<NerdsAndCompany\S...ic\Mappers\ModelMapper>` is incompatible with the declared type `object<NerdsAndCompany\S...Mappers\CategoryGroups>` of property `$service`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
44			}
45
46			//==============================================================================================================
47			//================================================= TESTS ====================================================
48			//==============================================================================================================
49
50			/**
51			* @dataProvider provideValidCategoryGroups
52			*
53			* @param CategoryGroupModel[] $groups
54			* @param array $expectedResult
55			*/
56			public function testSuccessfulExport(array $groups, array $expectedResult = [])
57			{
58			$actualResult = $this->service->export($groups);
59
60			$this->assertSame($expectedResult, $actualResult);
61			}
62
63			/**
64			* @dataProvider provideValidCategoryGroupDefinitions
65			*
66			* @param array $groupDefinitions
67			*/
68			public function testSuccessfulImport(array $groupDefinitions, array $existingGroups, int $saveCount)
69			{
70			$this->expectSaves($saveCount);
71			$this->expectDeletes(0);
72
73			$this->service->import($groupDefinitions, $existingGroups);
74			}
75
76			/**
77			* @dataProvider provideValidCategoryGroupDefinitions
78			*
79			* @param array $groupDefinitions
80			*/
81			public function testImportWithForceOption(array $groupDefinitions, array $existingGroups, int $saveCount, int $deleteCount)
82			{
83			Schematic::$force = true;
84			$this->expectSaves($saveCount);
85			$this->expectDeletes($deleteCount);
86
87			$this->service->import($groupDefinitions, $existingGroups);
88			}
89
90			//==============================================================================================================
91			//============================================== PROVIDERS ===================================================
92			//==============================================================================================================
93
94			/**
95			* @return array
96			*/
97			public function provideValidCategoryGroups()
98			{
99			$mockCategoryGroup1 = $this->getMockCategoryGroup(1);
100			$mockCategoryGroup2 = $this->getMockCategoryGroup(2);
101
102			return [
103			'emptyArray' => [
104			'categoryGroups' => [],
105			'expectedResult' => [],
106			],
107			'single group' => [
108			'categoryGroups' => [
109			'group1' => $mockCategoryGroup1,
110			],
111			'expectedResult' => [
112			'groupHandle1' => $this->getMockCategoryGroupDefinition($mockCategoryGroup1),
			0 ignored issues – show Documentation introduced 2018-04-09 13:37 UTC by Report Bug Copy Issue Report `$mockCategoryGroup1` is of type `object<PHPUnit\Framework\MockObject\MockObject>`, but the function expects a `object<craft\models\CategoryGroup>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
113			],
114			],
115			'multiple groups' => [
116			'categoryGroups' => [
117			'group1' => $mockCategoryGroup1,
118			'group2' => $mockCategoryGroup2,
119			],
120			'expectedResult' => [
121			'groupHandle1' => $this->getMockCategoryGroupDefinition($mockCategoryGroup1),
			0 ignored issues – show Documentation introduced 2018-04-09 13:37 UTC by Report Bug Copy Issue Report `$mockCategoryGroup1` is of type `object<PHPUnit\Framework\MockObject\MockObject>`, but the function expects a `object<craft\models\CategoryGroup>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
122			'groupHandle2' => $this->getMockCategoryGroupDefinition($mockCategoryGroup2),
			0 ignored issues – show Documentation introduced 2018-04-09 13:37 UTC by Report Bug Copy Issue Report `$mockCategoryGroup2` is of type `object<PHPUnit\Framework\MockObject\MockObject>`, but the function expects a `object<craft\models\CategoryGroup>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
123			],
124			],
125			];
126			}
127
128			/**
129			* @return array
130			*/
131			public function provideValidCategoryGroupDefinitions()
132			{
133			$mockCategoryGroup1 = $this->getMockCategoryGroup(1);
134			$mockCategoryGroup2 = $this->getMockCategoryGroup(2);
135
136			return [
137			'emptyArray' => [
138			'groupDefinitions' => [],
139			'existingGroups' => [
140			$mockCategoryGroup1,
141			],
142			'saveCount' => 0,
143			'deleteCount' => 1,
144			],
145			'single new group' => [
146			'groupDefinitions' => [
147			'groupHandle1' => $this->getMockCategoryGroupDefinition($mockCategoryGroup1),
			0 ignored issues – show Documentation introduced 2018-04-09 13:37 UTC by Report Bug Copy Issue Report `$mockCategoryGroup1` is of type `object<PHPUnit\Framework\MockObject\MockObject>`, but the function expects a `object<craft\models\CategoryGroup>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
148			'groupHandle2' => $this->getMockCategoryGroupDefinition($mockCategoryGroup2),
			0 ignored issues – show Documentation introduced 2018-04-09 13:37 UTC by Report Bug Copy Issue Report `$mockCategoryGroup2` is of type `object<PHPUnit\Framework\MockObject\MockObject>`, but the function expects a `object<craft\models\CategoryGroup>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
149			],
150			'existingGroups' => [
151			$mockCategoryGroup1,
152			],
153			'saveCount' => 1,
154			'deleteCount' => 0,
155			],
156			];
157			}
158
159			//==============================================================================================================
160			//================================================ HELPERS ===================================================
161			//==============================================================================================================
162
163			/**
164			* @param CategoryGroup $mockCategoryGroup
165			*
166			* @return array
167			*/
168			private function getMockCategoryGroupDefinition(CategoryGroup $mockCategoryGroup)
169			{
170			return [
171			'class' => get_class($mockCategoryGroup),
172			'attributes' => [
173			'name' => $mockCategoryGroup->name,
174			'handle' => $mockCategoryGroup->handle,
175			'maxLevels' => 3,
176			],
177			'fieldLayout' => [
178			'fields' => [],
179			],
180			'siteSettings' => [
181			'' => [
182			'class' => get_class($mockCategoryGroup->getSiteSettings()[0]),
183			'attributes' => [
184			'hasUrls' => null,
185			'uriFormat' => null,
186			'template' => null,
187			],
188			],
189			],
190			];
191			}
192
193			/**
194			* @param int $groupId
195			*
196			* @return Mock\|CategoryGroup
197			*/
198			private function getMockCategoryGroup(int $groupId)
199			{
200			$mockGroup = $this->getMockBuilder(CategoryGroup::class)
201			->setMethods(['getFieldLayout', 'getSiteSettings'])
202			->getMock();
203			$mockGroup->setAttributes([
204			'id' => $groupId,
205			'fieldLayoutId' => $groupId,
206			'handle' => 'groupHandle'.$groupId,
207			'name' => 'groupName'.$groupId,
208			'maxLevels' => 3,
209			]);
210
211			$mockFieldLayout = $this->getMockBuilder(FieldLayout::class)->getMock();
212
213			$mockGroup->expects($this->any())
214			->method('getFieldLayout')
215			->willReturn($mockFieldLayout);
216
217			$mockSiteSettings = $this->getMockSiteSettings();
218
219			$mockGroup->expects($this->any())
220			->method('getSiteSettings')
221			->willReturn([$mockSiteSettings]);
222
223			return $mockGroup;
224			}
225
226			/**
227			* Get mock siteSettings.
228			*
229			* @param string $class
			0 ignored issues – show Bug introduced 2018-04-11 11:36 UTC by Report Bug Copy Issue Report There is no parameter named `$class`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
230			*
231			* @return Mock\|CategoryGroup_SiteSettings
232			*/
233			private function getMockSiteSettings()
234			{
235			$mockSiteSettings = $this->getMockBuilder(CategoryGroup_SiteSettings::class)
236			->setMethods(['getSite'])
237			->getMock();
238
239			$mockSiteSettings->expects($this->any())
240			->method('getSite')
241			->willReturn($this->getMockSite());
242
243			return $mockSiteSettings;
244			}
245
246			/**
247			* Get a mock site.
248			*
249			* @return Mock\|Site
250			*/
251			private function getMockSite()
252			{
253			return $this->getMockBuilder(Site::class)->getMock();
254			}
255
256			/**
257			* Expect a number of group saves.
258			*
259			* @param int $saveCount
260			*/
261			private function expectSaves(int $saveCount)
262			{
263			Craft::$app->categories
264			->expects($this->exactly($saveCount))
265			->method('saveGroup')
266			->willReturn(true);
267			}
268
269			/**
270			* Expect a number of group deletes.
271			*
272			* @param int $deleteCount
273			*/
274			private function expectDeletes(int $deleteCount)
275			{
276			Craft::$app->categories
277			->expects($this->exactly($deleteCount))
278			->method('deleteGroupById');
279			}
280			}
281

nerds-and-company / schematic

Pull Request — master (#114)

ModelMapperTest::getMockSiteSettings() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like