EntryTypeTest::getMockEntryType() - Code Metrics - Inspection of "Don’t scrutinize test files, phpmd and phpcs will..." - nerds-and-company/schematic - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — do-not-scrutinize-tests ( fcf005 )

by Bart

created 2018-04-27 19:44 UTC

EntryTypeTest::getMockEntryType() B

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	32
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	32
rs	8.8571
c	0
b	0
f	0
cc	1
eloc	23
nc	1
nop	1

<?php

namespace NerdsAndCompany\Schematic\Converters\Models;

use Craft;
use craft\base\Field as FieldModel;
use craft\models\EntryType as EntryTypeModel;
use craft\models\FieldLayout;
use craft\models\FieldLayoutTab;
use Codeception\Test\Unit;

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

    /**
     * Set the converter.
     *
     * @SuppressWarnings(PHPMD.CamelCaseMethodName)
     * phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
     */
    protected function _before()
    {
        $this->converter = new EntryType();
    }

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

    /**
     * @dataProvider provideEntryTypes
     *
     * @param EntryTypeModel $entryType
     * @param array          $definition
     */
    public function testGetRecordDefinition(EntryTypeModel $entryType, array $definition)
    {
        $result = $this->converter->getRecordDefinition($entryType);

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

    /**
     * @dataProvider provideEntryTypes
     *
     * @param EntryTypeModel $entryType
     * @param array          $definition
     * @param array          $defaultAttributes
     */
    public function testSetRecordAttributes(EntryTypeModel $entryType, array $definition, array $defaultAttributes)
    {
        $newEntryType = $this->getMockBuilder(EntryTypeModel::class)
                             ->setMethods(['setFieldLayout'])
                             ->getMock();

        $newEntryType->expects($this->exactly(1))
                     ->method('setFieldLayout');

        Craft::$app->fields->expects($this->any())
                           ->method('getFieldByHandle')
                           ->willReturn($this->getMockField($entryType->id));

        $this->converter->setRecordAttributes($newEntryType, $definition, $defaultAttributes);

        $this->assertSame($defaultAttributes['sectionId'], $newEntryType->sectionId);
        $this->assertSame($entryType->name, $newEntryType->name);
        $this->assertSame($entryType->handle, $newEntryType->handle);
    }

    /**
     * @dataProvider provideEntryTypes
     *
     * @param EntryTypeModel $entryType
     * @param array          $definition
     */
    public function testSaveRecord(EntryTypeModel $entryType, array $definition)
    {
        Craft::$app->sections->expects($this->exactly(1))
                             ->method('saveEntryType')
                             ->with($entryType)
                             ->willReturn(true);

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

        $this->assertTrue($result);
    }

    /**
     * @dataProvider provideEntryTypes
     *
     * @param EntryTypeModel $entryType
     */
    public function testDeleteRecord(EntryTypeModel $entryType)
    {
        Craft::$app->sections->expects($this->exactly(1))
                             ->method('deleteEntryType')
                             ->with($entryType);

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

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

    /**
     * @return array
     */
    public function provideEntryTypes()
    {
        $mockEntryType = $this->getMockEntryType(1);

        return [
            'valid entryType' => [
                'entryType' => $mockEntryType,
                'definition' => $this->getMockEntryTypeDefinition($mockEntryType),
                'defaultAttributes' => ['sectionId' => 1],
            ],
        ];
    }

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

    /**
     * @param EntryTypeModel $mockEntryType
     *
     * @return array
     */
    private function getMockEntryTypeDefinition(EntryTypeModel $mockEntryType)
    {
        return [
            'class' => get_class($mockEntryType),
            'attributes' => [
                'name' => 'entryTypeName'.$mockEntryType->id,
                'handle' => 'entryTypeHandle'.$mockEntryType->id,
                'hasTitleField' => true,
                'titleLabel' => 'Title',
                'titleFormat' => null,
            ],
            'fieldLayout' => $this->getMockFieldLayoutDefinition($mockEntryType->getFieldLayout()),
        ];
    }

    /**
     * Get mock field layout definition.
     *
     * @param FieldLayout $fieldLayout
     *
     * @return array
     */
    private function getMockFieldLayoutDefinition(FieldLayout $fieldLayout)
    {
        $tabsDef = [];
        foreach ($fieldLayout->getTabs() as $tab) {
            $tabsDef[$tab->name] = [];
            foreach ($tab->getFields() as $field) {
                $tabsDef[$tab->name][$field->handle] = $field->required;
            }
        }

        return [
            'tabs' => $tabsDef,
        ];
    }

    /**
     * @param int $entryTypeId
     *
     * @return Mock|EntryTypeModel
     */
    private function getMockEntryType(int $entryTypeId)
    {
        $mockEntryType = $this->getMockBuilder(EntryTypeModel::class)
                              ->setMethods(['getFieldLayout'])
                              ->disableOriginalConstructor()
                              ->getMock();

        $mockEntryType->id = $entryTypeId;
        $mockEntryType->fieldLayoutId = $entryTypeId;
        $mockEntryType->handle = 'entryTypeHandle'.$entryTypeId;
        $mockEntryType->name = 'entryTypeName'.$entryTypeId;

        $mockField = $this->getMockField($entryTypeId);

        $mockFieldLayout = $this->getMockBuilder(FieldLayout::class)->getMock();
        $mockFieldLayoutTab = $this->getMockBuilder(FieldLayoutTab::class)->getMock();
        $mockFieldLayoutTab->name = 'Content';

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

        $mockFieldLayoutTab->expects($this->any())
                           ->method('getFields')
                           ->willReturn([$mockField]);

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

        return $mockEntryType;
    }

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

        $mockField->id = $fieldId;
        $mockField->handle = 'field'.$fieldId;
        $mockField->required = true;

        return $mockField;
    }
}


1			<?php
2
3			namespace NerdsAndCompany\Schematic\Converters\Models;
4
5			use Craft;
6			use craft\base\Field as FieldModel;
7			use craft\models\EntryType as EntryTypeModel;
8			use craft\models\FieldLayout;
9			use craft\models\FieldLayoutTab;
10			use Codeception\Test\Unit;
11
12			/**
13			* Class EntryTypeTest.
14			*
15			* @author Nerds & Company
16			* @copyright Copyright (c) 2015-2017, Nerds & Company
17			* @license MIT
18			*
19			* @see http://www.nerds.company
20			*/
21			class EntryTypeTest extends Unit
22			{
23			/**
24			* @var EntryType
25			*/
26			private $converter;
27
28			/**
29			* Set the converter.
30			*
31			* @SuppressWarnings(PHPMD.CamelCaseMethodName)
32			* phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
33			*/
34			protected function _before()
35			{
36			$this->converter = new EntryType();
37			}
38
39			//==============================================================================================================
40			//================================================= TESTS ====================================================
41			//==============================================================================================================
42
43			/**
44			* @dataProvider provideEntryTypes
45			*
46			* @param EntryTypeModel $entryType
47			* @param array $definition
48			*/
49			public function testGetRecordDefinition(EntryTypeModel $entryType, array $definition)
50			{
51			$result = $this->converter->getRecordDefinition($entryType);
52
53			$this->assertSame($definition, $result);
54			}
55
56			/**
57			* @dataProvider provideEntryTypes
58			*
59			* @param EntryTypeModel $entryType
60			* @param array $definition
61			* @param array $defaultAttributes
62			*/
63			public function testSetRecordAttributes(EntryTypeModel $entryType, array $definition, array $defaultAttributes)
64			{
65			$newEntryType = $this->getMockBuilder(EntryTypeModel::class)
66			->setMethods(['setFieldLayout'])
67			->getMock();
68
69			$newEntryType->expects($this->exactly(1))
70			->method('setFieldLayout');
71
72			Craft::$app->fields->expects($this->any())
73			->method('getFieldByHandle')
74			->willReturn($this->getMockField($entryType->id));
75
76			$this->converter->setRecordAttributes($newEntryType, $definition, $defaultAttributes);
77
78			$this->assertSame($defaultAttributes['sectionId'], $newEntryType->sectionId);
79			$this->assertSame($entryType->name, $newEntryType->name);
80			$this->assertSame($entryType->handle, $newEntryType->handle);
81			}
82
83			/**
84			* @dataProvider provideEntryTypes
85			*
86			* @param EntryTypeModel $entryType
87			* @param array $definition
88			*/
89			public function testSaveRecord(EntryTypeModel $entryType, array $definition)
90			{
91			Craft::$app->sections->expects($this->exactly(1))
92			->method('saveEntryType')
93			->with($entryType)
94			->willReturn(true);
95
96			$result = $this->converter->saveRecord($entryType, $definition);
97
98			$this->assertTrue($result);
99			}
100
101			/**
102			* @dataProvider provideEntryTypes
103			*
104			* @param EntryTypeModel $entryType
105			*/
106			public function testDeleteRecord(EntryTypeModel $entryType)
107			{
108			Craft::$app->sections->expects($this->exactly(1))
109			->method('deleteEntryType')
110			->with($entryType);
111
112			$this->converter->deleteRecord($entryType);
113			}
114
115			//==============================================================================================================
116			//============================================== PROVIDERS ===================================================
117			//==============================================================================================================
118
119			/**
120			* @return array
121			*/
122			public function provideEntryTypes()
123			{
124			$mockEntryType = $this->getMockEntryType(1);
125
126			return [
127			'valid entryType' => [
128			'entryType' => $mockEntryType,
129			'definition' => $this->getMockEntryTypeDefinition($mockEntryType),
130			'defaultAttributes' => ['sectionId' => 1],
131			],
132			];
133			}
134
135			//==============================================================================================================
136			//================================================ HELPERS ===================================================
137			//==============================================================================================================
138
139			/**
140			* @param EntryTypeModel $mockEntryType
141			*
142			* @return array
143			*/
144			private function getMockEntryTypeDefinition(EntryTypeModel $mockEntryType)
145			{
146			return [
147			'class' => get_class($mockEntryType),
148			'attributes' => [
149			'name' => 'entryTypeName'.$mockEntryType->id,
150			'handle' => 'entryTypeHandle'.$mockEntryType->id,
151			'hasTitleField' => true,
152			'titleLabel' => 'Title',
153			'titleFormat' => null,
154			],
155			'fieldLayout' => $this->getMockFieldLayoutDefinition($mockEntryType->getFieldLayout()),
156			];
157			}
158
159			/**
160			* Get mock field layout definition.
161			*
162			* @param FieldLayout $fieldLayout
163			*
164			* @return array
165			*/
166			private function getMockFieldLayoutDefinition(FieldLayout $fieldLayout)
167			{
168			$tabsDef = [];
169			foreach ($fieldLayout->getTabs() as $tab) {
170			$tabsDef[$tab->name] = [];
171			foreach ($tab->getFields() as $field) {
172			$tabsDef[$tab->name][$field->handle] = $field->required;
173			}
174			}
175
176			return [
177			'tabs' => $tabsDef,
178			];
179			}
180
181			/**
182			* @param int $entryTypeId
183			*
184			* @return Mock\|EntryTypeModel
185			*/
186			private function getMockEntryType(int $entryTypeId)
187			{
188			$mockEntryType = $this->getMockBuilder(EntryTypeModel::class)
189			->setMethods(['getFieldLayout'])
190			->disableOriginalConstructor()
191			->getMock();
192
193			$mockEntryType->id = $entryTypeId;
194			$mockEntryType->fieldLayoutId = $entryTypeId;
195			$mockEntryType->handle = 'entryTypeHandle'.$entryTypeId;
196			$mockEntryType->name = 'entryTypeName'.$entryTypeId;
197
198			$mockField = $this->getMockField($entryTypeId);
199
200			$mockFieldLayout = $this->getMockBuilder(FieldLayout::class)->getMock();
201			$mockFieldLayoutTab = $this->getMockBuilder(FieldLayoutTab::class)->getMock();
202			$mockFieldLayoutTab->name = 'Content';
203
204			$mockFieldLayout->expects($this->any())
205			->method('getTabs')
206			->willReturn([$mockFieldLayoutTab]);
207
208			$mockFieldLayoutTab->expects($this->any())
209			->method('getFields')
210			->willReturn([$mockField]);
211
212			$mockEntryType->expects($this->any())
213			->method('getFieldLayout')
214			->willReturn($mockFieldLayout);
215
216			return $mockEntryType;
217			}
218
219			/**
220			* Get a mock field.
221			*
222			* @param int $fieldId
223			*
224			* @return Mock\|FieldModel
225			*/
226			private function getMockField(int $fieldId)
227			{
228			$mockField = $this->getMockbuilder(FieldModel::class)
229			->setMethods([])
230			->getMock();
231
232			$mockField->id = $fieldId;
233			$mockField->handle = 'field'.$fieldId;
234			$mockField->required = true;
235
236			return $mockField;
237			}
238			}
239

nerds-and-company / schematic

Push — do-not-scrutinize-tests ( fcf005 )

EntryTypeTest::getMockEntryType() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like