NavigationContext::transformToPageObject() - Code Metrics - Inspection of "Do not use Faker populator directly in Behat conte..." - fsi-open/admin-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 3.1 (#348)

by Piotr

created 2021-02-12 11:35 UTC

NavigationContext::transformToPageObject() D

↳ Parent: NavigationContext

Complexity

Conditions	21
Paths	21

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	49
rs	4.1666
c	0
b	0
f	0
cc	21
nc	21
nop	1

How to fix Complexity

<?php

/**
 * (c) FSi sp. z o.o. <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace FSi\Bundle\AdminBundle\Behat\Context;

use Behat\Gherkin\Node\TableNode;
use Exception;
use FSi\Bundle\AdminBundle\Behat\Page\AdminPanel;
use FSi\Bundle\AdminBundle\Behat\Page\CategoryList;
use FSi\Bundle\AdminBundle\Behat\Page\CategoryNewsCreate;
use FSi\Bundle\AdminBundle\Behat\Page\CategoryNewsEdit;
use FSi\Bundle\AdminBundle\Behat\Page\CategoryNewsList;
use FSi\Bundle\AdminBundle\Behat\Page\CustomNewsEdit;
use FSi\Bundle\AdminBundle\Behat\Page\CustomNewsList;
use FSi\Bundle\AdminBundle\Behat\Page\CustomSubscribersList;
use FSi\Bundle\AdminBundle\Behat\Page\DefaultPage;
use FSi\Bundle\AdminBundle\Behat\Page\DTOForm;
use FSi\Bundle\AdminBundle\Behat\Page\NewsDisplay;
use FSi\Bundle\AdminBundle\Behat\Page\HomePageEdit;
use FSi\Bundle\AdminBundle\Behat\Page\NewsCreate;
use FSi\Bundle\AdminBundle\Behat\Page\NewsEdit;
use FSi\Bundle\AdminBundle\Behat\Page\NewsList;
use FSi\Bundle\AdminBundle\Behat\Page\Page;
use FSi\Bundle\AdminBundle\Behat\Page\PersonAddForm;
use FSi\Bundle\AdminBundle\Behat\Page\PersonEditForm;
use FSi\Bundle\AdminBundle\Behat\Page\PersonList;
use FSi\Bundle\AdminBundle\Behat\Page\SubscriberEdit;
use FSi\Bundle\AdminBundle\Behat\Page\SubscriberForm;
use FSi\Bundle\AdminBundle\Behat\Page\SubscribersList;
use InvalidArgumentException;

class NavigationContext extends AbstractContext
{
    /**
     * @var DefaultPage
     */
    private $defaultPage;

    /**
     * @var AdminPanel
     */
    private $adminPanelPage;

    /**
     * @var CustomNewsEdit
     */
    private $customNewsEditPage;

    /**
     * @var CustomNewsList
     */
    private $customNewsListPage;

    /**
     * @var CustomSubscribersList
     */
    private $customSubscribersListPage;

    /**
     * @var DTOForm
     */
    private $dtoFormPage;

    /**
     * @var HomePageEdit
     */
    private $homePageEditPage;

    /**
     * @var NewsCreate
     */
    private $newsCreatePage;

    /**
     * @var NewsDisplay
     */
    private $newsDisplayPage;

    /**
     * @var NewsEdit
     */
    private $newsEditPage;

    /**
     * @var CategoryList
     */
    private $categoryListPage;

    /**
     * @var CategoryNewsList
     */
    private $categoryNewsListPage;

    /**
     * @var CategoryNewsCreate
     */
    private $categoryNewsCreatePage;

    /**
     * @var CategoryNewsEdit
     */
    private $categoryNewsEditPage;

    /**
     * @va NewsList
     */
    private $newsListPage;

    /**
     * @var PersonAddForm
     */
    private $personAddFormPage;

    /**
     * @var PersonEditForm
     */
    private $personEditFormPage;

    /**
     * @var PersonList
     */
    private $personListPage;

    /**
     * @var SubscriberEdit
     */
    private $subscriberEditPage;

    /**
     * @var SubscriberForm
     */
    private $subscriberFormPage;

    /**
     * @var SubscribersList
     */
    private $subscribersListPage;

    public function __construct(
        DefaultPage $defaultPage,
        AdminPanel $adminPanelPage,
        CustomNewsEdit $customNewsEditPage,
        CustomNewsList $customNewsListPage,
        CustomSubscribersList $customSubscribersListPage,
        DTOForm $dtoFormPage,
        HomePageEdit $homePageEditPage,
        NewsCreate $newsCreatePage,
        NewsDisplay $newsDisplayPage,
        NewsEdit $newsEditPage,
        NewsList $newsListPage,
        CategoryList $categoryListPage,
        CategoryNewsList $categoryNewsListPage,
        CategoryNewsCreate $categoryNewsCreatePage,
        CategoryNewsEdit $categoryNewsEditPage,
        PersonAddForm $personAddFormPage,
        PersonEditForm $personEditFormPage,
        PersonList $personListPage,
        SubscriberEdit $subscriberEditPage,
        SubscriberForm $subscriberFormPage,
        SubscribersList $subscribersListPage
    ) {
        $this->defaultPage = $defaultPage;
        $this->adminPanelPage = $adminPanelPage;
        $this->customNewsEditPage = $customNewsEditPage;
        $this->customNewsListPage = $customNewsListPage;
        $this->customSubscribersListPage = $customSubscribersListPage;
        $this->dtoFormPage = $dtoFormPage;
        $this->homePageEditPage = $homePageEditPage;
        $this->newsCreatePage = $newsCreatePage;
        $this->newsDisplayPage = $newsDisplayPage;
        $this->newsEditPage = $newsEditPage;
        $this->newsListPage = $newsListPage;
        $this->categoryListPage = $categoryListPage;
        $this->categoryNewsListPage = $categoryNewsListPage;
        $this->categoryNewsCreatePage = $categoryNewsCreatePage;
        $this->categoryNewsEditPage = $categoryNewsEditPage;
        $this->personAddFormPage = $personAddFormPage;
        $this->personEditFormPage = $personEditFormPage;
        $this->personListPage = $personListPage;
        $this->subscriberEditPage = $subscriberEditPage;
        $this->subscriberFormPage = $subscriberFormPage;
        $this->subscribersListPage = $subscribersListPage;
    }

    /**
     * @transform :page
     */
    public function transformToPageObject($pageName)
    {
        switch ($pageName) {
            case 'News list':
                return $this->newsListPage;
            case 'Admin panel':
                return $this->adminPanelPage;
            case 'Custom news edit':
                return $this->customNewsEditPage;
            case 'Custom news list':
                return $this->customNewsListPage;
            case 'Custom subscribers list':
                return $this->customSubscribersListPage;
            case 'DTO Form':
                return $this->dtoFormPage;
            case 'Home page edit':
                return $this->homePageEditPage;
            case 'News create':
                return $this->newsCreatePage;
            case 'News display':
                return $this->newsDisplayPage;
            case 'News edit':
                return $this->newsEditPage;
            case 'Category list':
                return $this->categoryListPage;
            case 'Category news list':
                return $this->categoryNewsListPage;
            case 'Category news edit':
                return $this->categoryNewsEditPage;
            case 'Category news create':
                return $this->categoryNewsCreatePage;
            case 'Person add form':
                return $this->personAddFormPage;
            case 'Person edit form':
                return $this->personEditFormPage;
            case 'Person list':
                return $this->personListPage;
            case 'Subscriber edit':
                return $this->subscriberEditPage;
            case 'Subscriber form':
                return $this->subscriberFormPage;
            case 'Subscribers list':
                return $this->subscribersListPage;
            default:
                throw new InvalidArgumentException(
                    sprintf('Could not transform "%s" to any page object', $pageName)
                );
        }
    }

    /**
     * @When /^I follow "([^"]*)" url from top bar$/
     * @Given /^I follow "([^"]*)" menu element$/
     */
    public function iFollowUrlFromTopBar($menuElement)
    {
        $this->adminPanelPage->getMenu()->clickLink($menuElement);
    }

    /**
     * @Then /^menu with following elements should be visible at the top of the page$/
     */
    public function menuWithFollowingElementsShouldBeVisibleAtTheTopOfThePage(TableNode $table)
    {
        expect($this->adminPanelPage->getMenuElementsCount())->toBe(count($table->getHash()));

        foreach ($table->getHash() as $elementRow) {
            expect($this->adminPanelPage->hasMenuElement(
                $elementRow['Element name'],
                empty($elementRow['Element group']) ? null : $elementRow['Element group'])
            )->toBe(true);
        }
    }

    /**
     * @Then :link link in the top bar should be highlighted
     */
    public function linkInTheTopBarShouldBeHighlighted($link)
    {
        $linkNode = $this->adminPanelPage->getMenu()->findLink($link);

        expect($linkNode->getParent()->hasClass('active'))->toBe(true);
    }

    /**
     * @Given I am on the :page page
     */
    public function iAmOnThePage(Page $page)
    {
        $page->open();
    }

    /**
     * @Given I am on the :page page with id :id
     */
    public function iAmOnThePageWithId(Page $page, $id)
    {
        $page->open(['id' => $id]);
    }

    /**
     * @Given I should be on the :page page
     * @Given I should be redirected to :page page
     */
    public function iShouldBeOnThePage(Page $page)
    {
        expect($page->isOpen())->toBe(true);
    }

    /**
     * @Given I try to open the :page page
     */
    public function iTryToOpenPage(Page $page)
    {
        $page->openWithoutVerifying();
    }

    /**
     * @Given /^I press "New element" link$/
     */
    public function iPressNewElementLink()
    {
        $this->defaultPage->getElement('New Element Link')->click();
    }

    /**
     * @When /^I press "([^"]*)" button at pagination$/
     */
    public function iPressButtonAtPagination($button)
    {
        $this->defaultPage->getElement('Pagination')->clickLink($button);
    }

    /**
     * @Then /^I should see pagination with following buttons$/
     */
    public function iShouldSeePaginationWithFollowingButtons(TableNode $table)
    {
        $pagination = $this->defaultPage->getElement('Pagination');

        foreach ($table->getHash() as $buttonRow) {
            expect($pagination->hasLink($buttonRow['Button']))->toBe(true);

            if ($buttonRow['Active'] === 'true') {
                expect($pagination->isDisabled($buttonRow['Button']))->toBe(false);
            } else {
                expect($pagination->isDisabled($buttonRow['Button']))->toBe(true);
            }

            if ($buttonRow['Current'] === 'true') {
                expect($pagination->isCurrentPage($buttonRow['Button']))->toBe(true);
            } else {
                expect($pagination->isCurrentPage($buttonRow['Button']))->toBe(false);
            }
        }
    }

    /**
     * @Then page :page should display OK status
     */
    public function pageShouldDisplayOKStatus(Page $page)
    {
        $this->expectPageStatus($page, 200);
    }

    /**
     * @Then page :page should display not found exception
     */
    public function pageShouldDisplayNotFoundException(Page $page)
    {
        $this->expectPageStatus($page, 404);
    }

    /**
     * @Then page :page should throw an error exception
     */
    public function pageShouldThrowAnErrorExceptionException(Page $page)
    {
        $this->expectPageStatus($page, 500);
    }

    private function expectPageStatus(Page $page, int $expectedStatus): void
    {
        $status = $page->getStatusCode();
        if ($status !== $expectedStatus) {
            throw new Exception(sprintf(
                'Invalid status code "%s", expected "%s".',
                $status,
                $expectedStatus
            ));
        }
    }
}


1			<?php
2
3			/**
4			* (c) FSi sp. z o.o. <[email protected]>
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*/
9
10			declare(strict_types=1);
11
12			namespace FSi\Bundle\AdminBundle\Behat\Context;
13
14			use Behat\Gherkin\Node\TableNode;
15			use Exception;
16			use FSi\Bundle\AdminBundle\Behat\Page\AdminPanel;
17			use FSi\Bundle\AdminBundle\Behat\Page\CategoryList;
18			use FSi\Bundle\AdminBundle\Behat\Page\CategoryNewsCreate;
19			use FSi\Bundle\AdminBundle\Behat\Page\CategoryNewsEdit;
20			use FSi\Bundle\AdminBundle\Behat\Page\CategoryNewsList;
21			use FSi\Bundle\AdminBundle\Behat\Page\CustomNewsEdit;
22			use FSi\Bundle\AdminBundle\Behat\Page\CustomNewsList;
23			use FSi\Bundle\AdminBundle\Behat\Page\CustomSubscribersList;
24			use FSi\Bundle\AdminBundle\Behat\Page\DefaultPage;
25			use FSi\Bundle\AdminBundle\Behat\Page\DTOForm;
26			use FSi\Bundle\AdminBundle\Behat\Page\NewsDisplay;
27			use FSi\Bundle\AdminBundle\Behat\Page\HomePageEdit;
28			use FSi\Bundle\AdminBundle\Behat\Page\NewsCreate;
29			use FSi\Bundle\AdminBundle\Behat\Page\NewsEdit;
30			use FSi\Bundle\AdminBundle\Behat\Page\NewsList;
31			use FSi\Bundle\AdminBundle\Behat\Page\Page;
32			use FSi\Bundle\AdminBundle\Behat\Page\PersonAddForm;
33			use FSi\Bundle\AdminBundle\Behat\Page\PersonEditForm;
34			use FSi\Bundle\AdminBundle\Behat\Page\PersonList;
35			use FSi\Bundle\AdminBundle\Behat\Page\SubscriberEdit;
36			use FSi\Bundle\AdminBundle\Behat\Page\SubscriberForm;
37			use FSi\Bundle\AdminBundle\Behat\Page\SubscribersList;
38			use InvalidArgumentException;
39
40			class NavigationContext extends AbstractContext
41			{
42			/**
43			* @var DefaultPage
44			*/
45			private $defaultPage;
46
47			/**
48			* @var AdminPanel
49			*/
50			private $adminPanelPage;
51
52			/**
53			* @var CustomNewsEdit
54			*/
55			private $customNewsEditPage;
56
57			/**
58			* @var CustomNewsList
59			*/
60			private $customNewsListPage;
61
62			/**
63			* @var CustomSubscribersList
64			*/
65			private $customSubscribersListPage;
66
67			/**
68			* @var DTOForm
69			*/
70			private $dtoFormPage;
71
72			/**
73			* @var HomePageEdit
74			*/
75			private $homePageEditPage;
76
77			/**
78			* @var NewsCreate
79			*/
80			private $newsCreatePage;
81
82			/**
83			* @var NewsDisplay
84			*/
85			private $newsDisplayPage;
86
87			/**
88			* @var NewsEdit
89			*/
90			private $newsEditPage;
91
92			/**
93			* @var CategoryList
94			*/
95			private $categoryListPage;
96
97			/**
98			* @var CategoryNewsList
99			*/
100			private $categoryNewsListPage;
101
102			/**
103			* @var CategoryNewsCreate
104			*/
105			private $categoryNewsCreatePage;
106
107			/**
108			* @var CategoryNewsEdit
109			*/
110			private $categoryNewsEditPage;
111
112			/**
113			* @va NewsList
114			*/
115			private $newsListPage;
116
117			/**
118			* @var PersonAddForm
119			*/
120			private $personAddFormPage;
121
122			/**
123			* @var PersonEditForm
124			*/
125			private $personEditFormPage;
126
127			/**
128			* @var PersonList
129			*/
130			private $personListPage;
131
132			/**
133			* @var SubscriberEdit
134			*/
135			private $subscriberEditPage;
136
137			/**
138			* @var SubscriberForm
139			*/
140			private $subscriberFormPage;
141
142			/**
143			* @var SubscribersList
144			*/
145			private $subscribersListPage;
146
147			public function __construct(
148			DefaultPage $defaultPage,
149			AdminPanel $adminPanelPage,
150			CustomNewsEdit $customNewsEditPage,
151			CustomNewsList $customNewsListPage,
152			CustomSubscribersList $customSubscribersListPage,
153			DTOForm $dtoFormPage,
154			HomePageEdit $homePageEditPage,
155			NewsCreate $newsCreatePage,
156			NewsDisplay $newsDisplayPage,
157			NewsEdit $newsEditPage,
158			NewsList $newsListPage,
159			CategoryList $categoryListPage,
160			CategoryNewsList $categoryNewsListPage,
161			CategoryNewsCreate $categoryNewsCreatePage,
162			CategoryNewsEdit $categoryNewsEditPage,
163			PersonAddForm $personAddFormPage,
164			PersonEditForm $personEditFormPage,
165			PersonList $personListPage,
166			SubscriberEdit $subscriberEditPage,
167			SubscriberForm $subscriberFormPage,
168			SubscribersList $subscribersListPage
169			) {
170			$this->defaultPage = $defaultPage;
171			$this->adminPanelPage = $adminPanelPage;
172			$this->customNewsEditPage = $customNewsEditPage;
173			$this->customNewsListPage = $customNewsListPage;
174			$this->customSubscribersListPage = $customSubscribersListPage;
175			$this->dtoFormPage = $dtoFormPage;
176			$this->homePageEditPage = $homePageEditPage;
177			$this->newsCreatePage = $newsCreatePage;
178			$this->newsDisplayPage = $newsDisplayPage;
179			$this->newsEditPage = $newsEditPage;
180			$this->newsListPage = $newsListPage;
181			$this->categoryListPage = $categoryListPage;
182			$this->categoryNewsListPage = $categoryNewsListPage;
183			$this->categoryNewsCreatePage = $categoryNewsCreatePage;
184			$this->categoryNewsEditPage = $categoryNewsEditPage;
185			$this->personAddFormPage = $personAddFormPage;
186			$this->personEditFormPage = $personEditFormPage;
187			$this->personListPage = $personListPage;
188			$this->subscriberEditPage = $subscriberEditPage;
189			$this->subscriberFormPage = $subscriberFormPage;
190			$this->subscribersListPage = $subscribersListPage;
191			}
192
193			/**
194			* @transform :page
195			*/
196			public function transformToPageObject($pageName)
197			{
198			switch ($pageName) {
199			case 'News list':
200			return $this->newsListPage;
201			case 'Admin panel':
202			return $this->adminPanelPage;
203			case 'Custom news edit':
204			return $this->customNewsEditPage;
205			case 'Custom news list':
206			return $this->customNewsListPage;
207			case 'Custom subscribers list':
208			return $this->customSubscribersListPage;
209			case 'DTO Form':
210			return $this->dtoFormPage;
211			case 'Home page edit':
212			return $this->homePageEditPage;
213			case 'News create':
214			return $this->newsCreatePage;
215			case 'News display':
216			return $this->newsDisplayPage;
217			case 'News edit':
218			return $this->newsEditPage;
219			case 'Category list':
220			return $this->categoryListPage;
221			case 'Category news list':
222			return $this->categoryNewsListPage;
223			case 'Category news edit':
224			return $this->categoryNewsEditPage;
225			case 'Category news create':
226			return $this->categoryNewsCreatePage;
227			case 'Person add form':
228			return $this->personAddFormPage;
229			case 'Person edit form':
230			return $this->personEditFormPage;
231			case 'Person list':
232			return $this->personListPage;
233			case 'Subscriber edit':
234			return $this->subscriberEditPage;
235			case 'Subscriber form':
236			return $this->subscriberFormPage;
237			case 'Subscribers list':
238			return $this->subscribersListPage;
239			default:
240			throw new InvalidArgumentException(
241			sprintf('Could not transform "%s" to any page object', $pageName)
242			);
243			}
244			}
245
246			/**
247			* @When /^I follow "([^"]*)" url from top bar$/
248			* @Given /^I follow "([^"]*)" menu element$/
249			*/
250			public function iFollowUrlFromTopBar($menuElement)
251			{
252			$this->adminPanelPage->getMenu()->clickLink($menuElement);
253			}
254
255			/**
256			* @Then /^menu with following elements should be visible at the top of the page$/
257			*/
258			public function menuWithFollowingElementsShouldBeVisibleAtTheTopOfThePage(TableNode $table)
259			{
260			expect($this->adminPanelPage->getMenuElementsCount())->toBe(count($table->getHash()));
261
262			foreach ($table->getHash() as $elementRow) {
263			expect($this->adminPanelPage->hasMenuElement(
264			$elementRow['Element name'],
265			empty($elementRow['Element group']) ? null : $elementRow['Element group'])
266			)->toBe(true);
267			}
268			}
269
270			/**
271			* @Then :link link in the top bar should be highlighted
272			*/
273			public function linkInTheTopBarShouldBeHighlighted($link)
274			{
275			$linkNode = $this->adminPanelPage->getMenu()->findLink($link);
276
277			expect($linkNode->getParent()->hasClass('active'))->toBe(true);
278			}
279
280			/**
281			* @Given I am on the :page page
282			*/
283			public function iAmOnThePage(Page $page)
284			{
285			$page->open();
286			}
287
288			/**
289			* @Given I am on the :page page with id :id
290			*/
291			public function iAmOnThePageWithId(Page $page, $id)
292			{
293			$page->open(['id' => $id]);
294			}
295
296			/**
297			* @Given I should be on the :page page
298			* @Given I should be redirected to :page page
299			*/
300			public function iShouldBeOnThePage(Page $page)
301			{
302			expect($page->isOpen())->toBe(true);
303			}
304
305			/**
306			* @Given I try to open the :page page
307			*/
308			public function iTryToOpenPage(Page $page)
309			{
310			$page->openWithoutVerifying();
311			}
312
313			/**
314			* @Given /^I press "New element" link$/
315			*/
316			public function iPressNewElementLink()
317			{
318			$this->defaultPage->getElement('New Element Link')->click();
319			}
320
321			/**
322			* @When /^I press "([^"]*)" button at pagination$/
323			*/
324			public function iPressButtonAtPagination($button)
325			{
326			$this->defaultPage->getElement('Pagination')->clickLink($button);
327			}
328
329			/**
330			* @Then /^I should see pagination with following buttons$/
331			*/
332			public function iShouldSeePaginationWithFollowingButtons(TableNode $table)
333			{
334			$pagination = $this->defaultPage->getElement('Pagination');
335
336			foreach ($table->getHash() as $buttonRow) {
337			expect($pagination->hasLink($buttonRow['Button']))->toBe(true);
338
339			if ($buttonRow['Active'] === 'true') {
340			expect($pagination->isDisabled($buttonRow['Button']))->toBe(false);
341			} else {
342			expect($pagination->isDisabled($buttonRow['Button']))->toBe(true);
343			}
344
345			if ($buttonRow['Current'] === 'true') {
346			expect($pagination->isCurrentPage($buttonRow['Button']))->toBe(true);
347			} else {
348			expect($pagination->isCurrentPage($buttonRow['Button']))->toBe(false);
349			}
350			}
351			}
352
353			/**
354			* @Then page :page should display OK status
355			*/
356			public function pageShouldDisplayOKStatus(Page $page)
357			{
358			$this->expectPageStatus($page, 200);
359			}
360
361			/**
362			* @Then page :page should display not found exception
363			*/
364			public function pageShouldDisplayNotFoundException(Page $page)
365			{
366			$this->expectPageStatus($page, 404);
367			}
368
369			/**
370			* @Then page :page should throw an error exception
371			*/
372			public function pageShouldThrowAnErrorExceptionException(Page $page)
373			{
374			$this->expectPageStatus($page, 500);
375			}
376
377			private function expectPageStatus(Page $page, int $expectedStatus): void
378			{
379			$status = $page->getStatusCode();
380			if ($status !== $expectedStatus) {
381			throw new Exception(sprintf(
382			'Invalid status code "%s", expected "%s".',
383			$status,
384			$expectedStatus
385			));
386			}
387			}
388			}
389

fsi-open / admin-bundle

Pull Request — 3.1 (#348)

NavigationContext::transformToPageObject() D

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like