UserSettingsMapperTest::getMockFieldLayout() - 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-13 12:44 UTC

UserSettingsMapperTest::getMockFieldLayout() A

↳ Parent: UserSettingsMapperTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	19
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	13
nc	1
nop	0

<?php

namespace NerdsAndCompany\Schematic\Mappers;

use Craft;
use craft\base\Field;
use craft\base\Volume;
use craft\elements\User;
use craft\models\FieldLayout;
use craft\models\FieldLayoutTab;
use Codeception\Test\Unit;

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

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

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

    /**
     * Test UserSettings service export.
     */
    public function testUserSettingsServiceExport()
    {
        $this->setMockServicesForExport();

        $definition = $this->getUserSettingsDefinition();
        $result = $this->mapper->export();

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

    /**
     * Test UserSettings service import.
     */
    public function testUserSettingsServiceImportWithoutFieldLayout()
    {
        $this->setMockServicesForImport(false, false);

        $definition = $this->getUserSettingsDefinition();
        unset($definition['fieldLayout']);
        $import = $this->mapper->import($definition);

        $this->assertSame([], $import);
    }

    /**
     * Test UserSettings service import.
     */
    public function testUserSettingsServiceImportWithImportError()
    {
        $this->setMockServicesForImport(true, true, true);

        $definition = $this->getUserSettingsDefinition();
        $import = $this->mapper->import($definition);

        $this->assertSame([], $import);
    }

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

    /**
     * [getUserSettingsDefinition description].
     *
     * @return [type] [description]

     */
    private function getUserSettingsDefinition()
    {
        return [
            'settings' => [
                'requireEmailVerification' => true,
                'allowPublicRegistration' => false,
                'defaultGroup' => null,
                'photoSubpath' => 'profile',
                'photoVolume' => 'volumeHandle',
            ],
            'fieldLayout' => [
                'tabs' => [
                    'Content' => [
                        'fieldHandle1' => true,
                        'fieldHandle2' => false,
                    ],
                ],
            ],
        ];
    }

    /**
     * Set mock services for export.
     */
    private function setMockServicesForExport()
    {
        $mockFieldLayout = $this->getMockFieldLayout();
        Craft::$app->fields->expects($this->exactly(1))
                           ->method('getLayoutByType')
                           ->with(User::class)
                           ->willReturn($mockFieldLayout);

        $settings = [
            'requireEmailVerification' => true,
            'allowPublicRegistration' => false,
            'defaultGroup' => null,
            'photoSubpath' => 'profile',
            'photoVolumeId' => 1,
        ];

        Craft::$app->systemSettings->expects($this->exactly(1))
                                   ->method('getSettings')
                                   ->with('users')
                                   ->willReturn($settings);

        Craft::$app->volumes->expects($this->exactly(1))
                            ->method('getVolumeById')
                            ->with(1)
                            ->willReturn($this->getMockVolume());
    }

    /**
     * @param bool $saveLayout
     * @param bool $deleteLayoutsByType
     */
    private function setMockServicesForImport($saveLayout = true, $deleteLayoutsByType = true, $errors = false)
    {
        Craft::$app->fields->expects($this->exactly($saveLayout ? 1 : 0))->method('saveLayout')->willReturn(!$errors);
        Craft::$app->fields->expects($this->exactly($deleteLayoutsByType ? 1 : 0))->method('deleteLayoutsByType')->willReturn(true);
        $mockFieldLayout = $this->getMockFieldLayout();
        if ($errors) {
            $mockFieldLayout->expects($this->exactly(1))->method('getErrors')->willReturn([
                'errors' => ['error 1', 'error 2', 'error 3'],
            ]);
        }

        Craft::$app->fields->expects($this->exactly($saveLayout ? 1 : 0))->method('assembleLayout')->willReturn($mockFieldLayout);
    }

    /**
     * @return Mock|FieldLayout
     */
    private function getMockFieldLayout()
    {
        $mockFieldLayout = $this->getMockBuilder(FieldLayout::class)->getMock();
        $mockFieldLayoutTab = $this->getMockBuilder(FieldLayoutTab::class)->getMock();
        $mockFieldLayoutTab->name = 'Content';
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

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

        $mockFieldLayout->expects($this->any())
                        ->method('getTabs')
                        ->willReturn([$mockFieldLayoutTab]);

        $mockFieldLayoutTab->expects($this->any())
                           ->method('getFields')
                           ->willReturn([
                               $this->getMockField(1, true),
                               $this->getMockField(2, false),
                           ]);

        return $mockFieldLayout;
    }

    /**
     * Get a mock field.
     *
     * @param int  $fieldId
     * @param bool $required
     *
     * @return Mock|Field
     */
    private function getMockField(int $fieldId, bool $required)
    {
        $mockField = $this->getMockbuilder(Field::class)
                         ->setMethods([])
                         ->getMock();

        $mockField->id = $fieldId;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

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

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

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

        return $mockField;
    }

    /**
     * Get mock volume.
     *
     * @return Mock|Volume
     */
    private function getMockVolume()
    {
        $mockVolume = $this->getMockBuilder(Volume::class)->getMock();
        $mockVolume->handle = 'volumeHandle';
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

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

        return $mockVolume;
    }
}


Pull Request — master (#114)

UserSettingsMapperTest::getMockFieldLayout() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1			<?php
2
3			namespace NerdsAndCompany\Schematic\Mappers;
4
5			use Craft;
6			use craft\base\Field;
7			use craft\base\Volume;
8			use craft\elements\User;
9			use craft\models\FieldLayout;
10			use craft\models\FieldLayoutTab;
11			use Codeception\Test\Unit;
12
13			/**
14			* Class UserSettingsMapperTest.
15			*
16			* @author Nerds & Company
17			* @copyright Copyright (c) 2015-2018, Nerds & Company
18			* @license MIT
19			*
20			* @see http://www.nerds.company
21			*/
22			class UserSettingsMapperTest extends Unit
23			{
24			/**
25			* @var UserSettingsMapper
26			*/
27			private $mapper;
28
29			/**
30			* Set the mapper.
31			*
32			* @SuppressWarnings(PHPMD.CamelCaseMethodName)
33			*/
34			protected function _before()
35			{
36			$this->mapper = new UserSettingsMapper();
37			}
38
39			//==============================================================================================================
40			//================================================= TESTS ====================================================
41			//==============================================================================================================
42
43			/**
44			* Test UserSettings service export.
45			*/
46			public function testUserSettingsServiceExport()
47			{
48			$this->setMockServicesForExport();
49
50			$definition = $this->getUserSettingsDefinition();
51			$result = $this->mapper->export();
52
53			$this->assertSame($definition, $result);
54			}
55
56			/**
57			* Test UserSettings service import.
58			*/
59			public function testUserSettingsServiceImportWithoutFieldLayout()
60			{
61			$this->setMockServicesForImport(false, false);
62
63			$definition = $this->getUserSettingsDefinition();
64			unset($definition['fieldLayout']);
65			$import = $this->mapper->import($definition);
66
67			$this->assertSame([], $import);
68			}
69
70			/**
71			* Test UserSettings service import.
72			*/
73			public function testUserSettingsServiceImportWithImportError()
74			{
75			$this->setMockServicesForImport(true, true, true);
76
77			$definition = $this->getUserSettingsDefinition();
78			$import = $this->mapper->import($definition);
79
80			$this->assertSame([], $import);
81			}
82
83			//==============================================================================================================
84			//================================================ HELPERS ===================================================
85			//==============================================================================================================
86
87			/**
88			* [getUserSettingsDefinition description].
89			*
90			* @return [type] [description]
			0 ignored issues – show Documentation introduced 2018-04-12 14:26 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
91			*/
92			private function getUserSettingsDefinition()
93			{
94			return [
95			'settings' => [
96			'requireEmailVerification' => true,
97			'allowPublicRegistration' => false,
98			'defaultGroup' => null,
99			'photoSubpath' => 'profile',
100			'photoVolume' => 'volumeHandle',
101			],
102			'fieldLayout' => [
103			'tabs' => [
104			'Content' => [
105			'fieldHandle1' => true,
106			'fieldHandle2' => false,
107			],
108			],
109			],
110			];
111			}
112
113			/**
114			* Set mock services for export.
115			*/
116			private function setMockServicesForExport()
117			{
118			$mockFieldLayout = $this->getMockFieldLayout();
119			Craft::$app->fields->expects($this->exactly(1))
120			->method('getLayoutByType')
121			->with(User::class)
122			->willReturn($mockFieldLayout);
123
124			$settings = [
125			'requireEmailVerification' => true,
126			'allowPublicRegistration' => false,
127			'defaultGroup' => null,
128			'photoSubpath' => 'profile',
129			'photoVolumeId' => 1,
130			];
131
132			Craft::$app->systemSettings->expects($this->exactly(1))
133			->method('getSettings')
134			->with('users')
135			->willReturn($settings);
136
137			Craft::$app->volumes->expects($this->exactly(1))
138			->method('getVolumeById')
139			->with(1)
140			->willReturn($this->getMockVolume());
141			}
142
143			/**
144			* @param bool $saveLayout
145			* @param bool $deleteLayoutsByType
146			*/
147			private function setMockServicesForImport($saveLayout = true, $deleteLayoutsByType = true, $errors = false)
148			{
149			Craft::$app->fields->expects($this->exactly($saveLayout ? 1 : 0))->method('saveLayout')->willReturn(!$errors);
150			Craft::$app->fields->expects($this->exactly($deleteLayoutsByType ? 1 : 0))->method('deleteLayoutsByType')->willReturn(true);
151			$mockFieldLayout = $this->getMockFieldLayout();
152			if ($errors) {
153			$mockFieldLayout->expects($this->exactly(1))->method('getErrors')->willReturn([
154			'errors' => ['error 1', 'error 2', 'error 3'],
155			]);
156			}
157
158			Craft::$app->fields->expects($this->exactly($saveLayout ? 1 : 0))->method('assembleLayout')->willReturn($mockFieldLayout);
159			}
160
161			/**
162			* @return Mock\|FieldLayout
163			*/
164			private function getMockFieldLayout()
165			{
166			$mockFieldLayout = $this->getMockBuilder(FieldLayout::class)->getMock();
167			$mockFieldLayoutTab = $this->getMockBuilder(FieldLayoutTab::class)->getMock();
168			$mockFieldLayoutTab->name = 'Content';
			0 ignored issues – show Bug introduced 2018-04-12 14:26 UTC by Report Bug Copy Issue Report Accessing `name` on the interface `PHPUnit\Framework\MockObject\MockObject` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
169
170			$mockFieldLayout->expects($this->any())
171			->method('getTabs')
172			->willReturn([$mockFieldLayoutTab]);
173
174			$mockFieldLayoutTab->expects($this->any())
175			->method('getFields')
176			->willReturn([
177			$this->getMockField(1, true),
178			$this->getMockField(2, false),
179			]);
180
181			return $mockFieldLayout;
182			}
183
184			/**
185			* Get a mock field.
186			*
187			* @param int $fieldId
188			* @param bool $required
189			*
190			* @return Mock\|Field
191			*/
192			private function getMockField(int $fieldId, bool $required)
193			{
194			$mockField = $this->getMockbuilder(Field::class)
195			->setMethods([])
196			->getMock();
197
198			$mockField->id = $fieldId;
			0 ignored issues – show Bug introduced 2018-04-12 14:26 UTC by Report Bug Copy Issue Report Accessing `id` on the interface `PHPUnit\Framework\MockObject\MockObject` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
199			$mockField->handle = 'fieldHandle'.$fieldId;
			0 ignored issues – show Bug introduced 2018-04-12 14:26 UTC by Report Bug Copy Issue Report Accessing `handle` on the interface `PHPUnit\Framework\MockObject\MockObject` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
200			$mockField->required = $required;
			0 ignored issues – show Bug introduced 2018-04-12 14:26 UTC by Report Bug Copy Issue Report Accessing `required` on the interface `PHPUnit\Framework\MockObject\MockObject` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
201
202			return $mockField;
203			}
204
205			/**
206			* Get mock volume.
207			*
208			* @return Mock\|Volume
209			*/
210			private function getMockVolume()
211			{
212			$mockVolume = $this->getMockBuilder(Volume::class)->getMock();
213			$mockVolume->handle = 'volumeHandle';
			0 ignored issues – show Bug introduced 2018-04-12 14:26 UTC by Report Bug Copy Issue Report Accessing `handle` on the interface `PHPUnit\Framework\MockObject\MockObject` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
214
215			return $mockVolume;
216			}
217			}
218

nerds-and-company / schematic

Pull Request — master (#114)

UserSettingsMapperTest::getMockFieldLayout() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like