CommonListBuilderUnitTest::customActionsDataProvider() - Code Metrics - Inspection of "feature/ListBuilder class was split into 2 classes..." - alexdodonov/mezon-gui - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c477ed...0b5fa5 )

by Alex

created 2020-12-20 08:12 UTC

customActionsDataProvider() A

↳ Parent: CommonListBuilderUnitTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	79
Code Lines	40

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	40
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	79
rs	9.28

How to fix Long Method

<?php
namespace Mezon\Gui\Tests;

use PHPUnit\Framework\TestCase;
use Mezon\Gui\ListBuilder\Common as CommonListBuilder;

class CommonListBuilderUnitTest extends TestCase
{

    /**
     * Method returns list of fields
     *
     * @return array Fields algorithms object
     */
    protected function getFields(): array
    {
        return [
            'id',
            'domain_id',
            'title'
        ];
    }

    /**
     * Method runs string assertions
     *
     * @param array $asserts
     *            asserts
     * @param string $content
     *            content to assert
     */
    protected function runAssertions(array $asserts, string $content): void
    {
        foreach ($asserts as $assert) {
            $this->assertStringContainsString($assert, $content);
        }
    }

    /**
     * Testing constructor
     */
    public function testConstructorValid(): void
    {
        // setup and test body
        $listBuilder = new CommonListBuilder($this->getFields(), new FakeAdapter());

        // assertions
        $this->assertIsArray($listBuilder->getFields(), 'Invalid fields list type');
    }

    /**
     * Method returns testing records
     *
     * @return array testing records
     */
    private function getRecords(): array
    {
        return [
            [
                'id' => 1,
            ],
            [
                'id' => 2,
            ]
        ];
    }

    /**
     * Data provider for the testListingForm
     *
     * @return array test data
     */
    public function listingFormDataProvider(): array
    {
        return [
            [
                0,
                $this->getRecords(),
                [
                    '>id<',
                    '>1<',
                    '>2<'
                ]
            ],
            [
                1,
                $this->getRecords(),
                [
                    '>id<',
                    '>1<',
                    '>2<',
                    '/create-endpoint/'
                ]
            ],
            [
                0,
                [],
                [
                    'class="no-items-title"',
                    '../create/'
                ]
            ]
        ];
    }

    /**
     * Testing listing form
     *
     * @param int $createButton
     *            do we need to show create button
     * @param array $records
     *            list of records to be displayed
     * @param array $asserts
     *            asserts
     * @dataProvider listingFormDataProvider
     */
    public function testListingForm(int $createButton, array $records, array $asserts): void
    {
        // setup
        $_GET['create-page-endpoint'] = $createButton ? '/create-endpoint/' : null;
        $_GET['create-button'] = $createButton;
        $listBuilder = new CommonListBuilder($this->getFields(), new FakeAdapter($records));

        // test body
        $content = $listBuilder->listingForm();

        // assertions
        $this->runAssertions($asserts, $content);
    }

    /**
     * Testing data provider
     *
     * @return array testing data
     */
    public function customActionsDataProvider(): array
    {
        $setup = function (): object {
            // setup method
            $listBuilder = new CommonListBuilder($this->getFields(), new FakeAdapter($this->getRecords()));

            $listBuilder->setCustomActions('!{id}!');

            return $listBuilder;
        };

        $assert = function ($result): void {
            // asserting method
            $this->assertStringNotContainsString('!1!', $result);
            $this->assertStringNotContainsString('!2!', $result);
        };

        return [
            // #0, listingForm
            [
                $setup,
                function ($result): void {
                    // asserting method
                    $this->assertStringContainsString('!1!', $result);
                    $this->assertStringContainsString('!2!', $result);
                }
            ],
            // #1, listingForm, no custom buttons
            [
                function (): object {
                    // setup method
                    return new CommonListBuilder($this->getFields(), new FakeAdapter($this->getRecords()));
                },
                $assert
            ],
            // #2, listingForm, no custom buttons
            [
                function (): object {
                    // setup method
                    return new CommonListBuilder([
                        'id' => [
                            'title' => 'Some id field'
                        ]
                    ], new FakeAdapter($this->getRecords()));
                },
                $assert
            ],
            // #3, listingForm, no custom buttons
            [
                function (): object {
                    // setup method
                    return new CommonListBuilder([
                        'id' => [
                            'title' => 'Some id field'
                        ]
                    ], new FakeAdapter($this->getRecords()));
                },
                function (string $result) use ($assert) {
                    $assert($result);

                    $this->assertStringContainsString('Some id field', $result);
                    $this->assertStringContainsString('>1<', $result);
                    $this->assertStringContainsString('>2<', $result);
                }
            ],
            // #4, listingForm, default buttons
            [
                function (): object {
                    // setup method
                    $_GET['update-button'] = 1;
                    $_GET['create-button'] = 1;
                    return new CommonListBuilder($this->getFields(), new FakeAdapter($this->getRecords()));
                },
                function (string $result) use ($assert) {
                    $assert($result);

                    $this->assertStringContainsString('>id<', $result);
                    $this->assertStringContainsString('>1<', $result);
                    $this->assertStringContainsString('>2<', $result);
                }
            ]
        ];
    }

    /**
     * Testing method
     *
     * @param callable $setup
     *            setup method
     * @param callable $assertions
     *            assertions method
     * @dataProvider customActionsDataProvider
     */
    public function testCustomActions(callable $setup, callable $assertions): void
    {
        // setup
        $obj = $setup();

        // test body
        $result = $obj->listingForm();

        // assertions
        $assertions($result);
    }
}


1			<?php
2			namespace Mezon\Gui\Tests;
3
4			use PHPUnit\Framework\TestCase;
5			use Mezon\Gui\ListBuilder\Common as CommonListBuilder;
6
7			class CommonListBuilderUnitTest extends TestCase
8			{
9
10			/**
11			* Method returns list of fields
12			*
13			* @return array Fields algorithms object
14			*/
15			protected function getFields(): array
16			{
17			return [
18			'id',
19			'domain_id',
20			'title'
21			];
22			}
23
24			/**
25			* Method runs string assertions
26			*
27			* @param array $asserts
28			* asserts
29			* @param string $content
30			* content to assert
31			*/
32			protected function runAssertions(array $asserts, string $content): void
33			{
34			foreach ($asserts as $assert) {
35			$this->assertStringContainsString($assert, $content);
36			}
37			}
38
39			/**
40			* Testing constructor
41			*/
42			public function testConstructorValid(): void
43			{
44			// setup and test body
45			$listBuilder = new CommonListBuilder($this->getFields(), new FakeAdapter());
46
47			// assertions
48			$this->assertIsArray($listBuilder->getFields(), 'Invalid fields list type');
49			}
50
51			/**
52			* Method returns testing records
53			*
54			* @return array testing records
55			*/
56			private function getRecords(): array
57			{
58			return [
59			[
60			'id' => 1,
61			],
62			[
63			'id' => 2,
64			]
65			];
66			}
67
68			/**
69			* Data provider for the testListingForm
70			*
71			* @return array test data
72			*/
73			public function listingFormDataProvider(): array
74			{
75			return [
76			[
77			0,
78			$this->getRecords(),
79			[
80			'>id<',
81			'>1<',
82			'>2<'
83			]
84			],
85			[
86			1,
87			$this->getRecords(),
88			[
89			'>id<',
90			'>1<',
91			'>2<',
92			'/create-endpoint/'
93			]
94			],
95			[
96			0,
97			[],
98			[
99			'class="no-items-title"',
100			'../create/'
101			]
102			]
103			];
104			}
105
106			/**
107			* Testing listing form
108			*
109			* @param int $createButton
110			* do we need to show create button
111			* @param array $records
112			* list of records to be displayed
113			* @param array $asserts
114			* asserts
115			* @dataProvider listingFormDataProvider
116			*/
117			public function testListingForm(int $createButton, array $records, array $asserts): void
118			{
119			// setup
120			$_GET['create-page-endpoint'] = $createButton ? '/create-endpoint/' : null;
121			$_GET['create-button'] = $createButton;
122			$listBuilder = new CommonListBuilder($this->getFields(), new FakeAdapter($records));
123
124			// test body
125			$content = $listBuilder->listingForm();
126
127			// assertions
128			$this->runAssertions($asserts, $content);
129			}
130
131			/**
132			* Testing data provider
133			*
134			* @return array testing data
135			*/
136			public function customActionsDataProvider(): array
137			{
138			$setup = function (): object {
139			// setup method
140			$listBuilder = new CommonListBuilder($this->getFields(), new FakeAdapter($this->getRecords()));
141
142			$listBuilder->setCustomActions('!{id}!');
143
144			return $listBuilder;
145			};
146
147			$assert = function ($result): void {
148			// asserting method
149			$this->assertStringNotContainsString('!1!', $result);
150			$this->assertStringNotContainsString('!2!', $result);
151			};
152
153			return [
154			// #0, listingForm
155			[
156			$setup,
157			function ($result): void {
158			// asserting method
159			$this->assertStringContainsString('!1!', $result);
160			$this->assertStringContainsString('!2!', $result);
161			}
162			],
163			// #1, listingForm, no custom buttons
164			[
165			function (): object {
166			// setup method
167			return new CommonListBuilder($this->getFields(), new FakeAdapter($this->getRecords()));
168			},
169			$assert
170			],
171			// #2, listingForm, no custom buttons
172			[
173			function (): object {
174			// setup method
175			return new CommonListBuilder([
176			'id' => [
177			'title' => 'Some id field'
178			]
179			], new FakeAdapter($this->getRecords()));
180			},
181			$assert
182			],
183			// #3, listingForm, no custom buttons
184			[
185			function (): object {
186			// setup method
187			return new CommonListBuilder([
188			'id' => [
189			'title' => 'Some id field'
190			]
191			], new FakeAdapter($this->getRecords()));
192			},
193			function (string $result) use ($assert) {
194			$assert($result);
195
196			$this->assertStringContainsString('Some id field', $result);
197			$this->assertStringContainsString('>1<', $result);
198			$this->assertStringContainsString('>2<', $result);
199			}
200			],
201			// #4, listingForm, default buttons
202			[
203			function (): object {
204			// setup method
205			$_GET['update-button'] = 1;
206			$_GET['create-button'] = 1;
207			return new CommonListBuilder($this->getFields(), new FakeAdapter($this->getRecords()));
208			},
209			function (string $result) use ($assert) {
210			$assert($result);
211
212			$this->assertStringContainsString('>id<', $result);
213			$this->assertStringContainsString('>1<', $result);
214			$this->assertStringContainsString('>2<', $result);
215			}
216			]
217			];
218			}
219
220			/**
221			* Testing method
222			*
223			* @param callable $setup
224			* setup method
225			* @param callable $assertions
226			* assertions method
227			* @dataProvider customActionsDataProvider
228			*/
229			public function testCustomActions(callable $setup, callable $assertions): void
230			{
231			// setup
232			$obj = $setup();
233
234			// test body
235			$result = $obj->listingForm();
236
237			// assertions
238			$assertions($result);
239			}
240			}
241

alexdodonov / mezon-gui

Push — master ( c477ed...0b5fa5 )

customActionsDataProvider() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like