FiltersContext::iPressButtonInColumnHeader() - 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 12:02 UTC

FiltersContext::iPressButtonInColumnHeader() A

↳ Parent: FiltersContext

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?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 FSi\Bundle\AdminBundle\Admin\CRUD\ListElement as AdminListElement;
use FSi\Bundle\AdminBundle\Behat\Element\Filters;
use FSi\Bundle\AdminBundle\Behat\Element\ListElement;
use FSi\Bundle\AdminBundle\Behat\Element\ListResultsElement;
use FSi\Bundle\AdminBundle\Behat\Page\DefaultPage;
use FSi\Component\DataSource\DataSourceInterface;

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

    /**
     * @var DataSourceInterface[]
     */
    private $datasources = [];

    public function __construct(DefaultPage $defaultPage)
    {
        $this->defaultPage = $defaultPage;
    }

    /**
     * @Given /^("[^"]*" element) datasource max results is set (\d+)$/
     */
    public function elementDatasourceMaxResultsIsSet(AdminListElement $adminElement, $maxResults)
    {
        expect($this->getDataSource($adminElement)->getMaxResults())->toBe($maxResults);
        $this->clearDataSource($adminElement);
    }

    /**
     * @Given /^("[^"]*" element) has datasource with fields$/
     */
    public function elementHaveDatasourceWithFields(AdminListElement $adminElement)
    {
        $dataSource = $this->getDataSource($adminElement);

        expect(count($dataSource->getFields()) > 0)->toBe(true);
        $this->clearDataSource($adminElement);
    }

    /**
     * @Given /^("[^"]*" element) has datasource without filters$/
     */
    public function elementHaveDatasourceWithoutFilters(AdminListElement $adminElement)
    {
        $dataSource = $this->getDataSource($adminElement);

        $filters = false;
        foreach ($dataSource->getFields() as $field) {
            if ($field->getOption('form_filter')) {
                $filters = true;
                break;
            }
        }
        expect($filters)->toBe(false);

        $this->clearDataSource($adminElement);
    }

    /**
     * @Then /^both sorting buttons in column header "([^"]*)" should be active$/
     */
    public function bothSortingButtonsInColumnHeaderShouldBeActive($column)
    {
        expect($this->getListElement()->isColumnAscSortActive($column))->toBe(true);
    }

    /**
     * @When /^I press "([^"]*)" button in "([^"]*)" column header$/
     */
    public function iPressButtonInColumnHeader($sort, $column)
    {
        $this->getListElement()->pressSortButton($column, $sort);
    }

    /**
     * @Then /^"([^"]*)" button in "([^"]*)" column header should be disabled$/
     */
    public function buttonInColumnHeaderShouldBeDisabled($sort, $column)
    {
        $list = $this->getListElement();

        switch (strtolower($sort)) {
            case 'sort asc':
                expect($list->isColumnAscSortActive($column))->toBe(false);
                break;
            case 'sort desc':
                expect($list->isColumnDescSortActive($column))->toBe(false);
                break;
            default :
                throw new \LogicException(sprintf('Unknown sorting type %s', $sort));
        }
    }

    /**
     * @Given /^"([^"]*)" button in "([^"]*)" column header should be active$/
     */
    public function buttonInColumnHeaderShouldBeActive($sort, $column)
    {
        $list = $this->getListElement();

        switch (strtolower($sort)) {
            case 'sort asc':
                expect($list->isColumnAscSortActive($column))->toBe(true);
                break;
            case 'sort desc':
                expect($list->isColumnDescSortActive($column))->toBe(true);
                break;
            default :
                throw new \LogicException(sprintf('Unknown sorting type %s', $sort));
        }
    }

    /**
     * @When /^I change elements per page to (\d+)$/
     */
    public function iChangeElementsPerPageTo($elementsCount)
    {
        $this->getListResultsElement()->setElementsPerPage((int) $elementsCount);
    }

    /**
     * @Then /^I should not see any filters$/
     */
    public function iShouldNotSeeAnyFilters()
    {
        expect($this->defaultPage->find('css', 'form.filters') === null)->toBe(true);
    }

    /**
     * @Then /^I should see simple text filter "([^"]*)"$/
     */
    public function iShouldSeeSimpleTextFilter($filterName)
    {
        expect($this->getFiltersElement()->hasField($filterName))->toBe(true);
    }

    /**
     * @Given /^I should see between filter "([^"]*)" with "([^"]*)" and "([^"]*)" simple text fields$/
     */
    public function iShouldSeeBetweenFilterWithAndSimpleTextFields($filterName, $fromName, $toName)
    {
        expect($this->getFiltersElement()->hasBetweenFilter($filterName, $fromName, $toName))->toBe(true);
    }

    /**
     * @Given /^I should see choice filter "([^"]*)"$/
     */
    public function iShouldSeeChoiceFilter($filterName)
    {
        expect($this->getFiltersElement()->hasChoiceFilter($filterName))->toBe(true);
    }

    /**
     * @Given /^I fill simple text filter "([^"]*)" with value "([^"]*)"$/
     */
    public function iFillSimpleTextFilterWithValue($filterName, $filterValue)
    {
        $this->getFiltersElement()->fillField($filterName, $filterValue);
    }

    /**
     * @When /^I select "([^"]*)" in choice filter "([^"]*)"$/
     */
    public function iSelectInChoiceFilter($filterValue, $filterName)
    {
        $this->getFiltersElement()->findField($filterName)->selectOption($filterValue);
    }

    /**
     * @Given /^I press "Search" button$/
     */
    public function iPressSearchButton()
    {
        $this->getFiltersElement()->pressButton('Search');
    }

    /**
     * @Given /^simple text filter "([^"]*)" should be filled with value "([^"]*)"$/
     */
    public function simpleTextFilterShouldBeFilledWithValue($filterName, $filterValue)
    {
        expect($this->getFiltersElement()->findField($filterName)->getValue())->toBe($filterValue);
    }

    /**
     * @Given /^choice filter "([^"]*)" should have value "([^"]*)" selected$/
     */
    public function choiceFilterShouldHaveValueSelected($filterName, $choice)
    {
        $field = $this->getFiltersElement()->findField($filterName);
        expect($field->find('css', sprintf('option:contains("%s")', $choice))
            ->getAttribute('selected'))->toBe('selected');
    }

    /**
     * @Then /^I should see actions dropdown with following options$/
     */
    public function iShouldSeeActionsDropdownWithFollowingOptions(TableNode $actions)
    {
        expect($this->defaultPage->hasBatchActionsDropdown())->toBe(true);

        foreach ($actions->getHash() as $actionRow) {
            expect($this->defaultPage->hasBatchAction($actionRow['Option']))->toBe(true);
        }
    }

    /**
     * @Given /^I should see confirmation button "([^"]*)"$/
     */
    public function iShouldSeeConfirmationButton($button)
    {
        $this->defaultPage->hasButton($button);
    }

    /**
     * @param AdminListElement $adminElement
     * @return DataSourceInterface
     */
    private function getDataSource(AdminListElement $adminElement)
    {
        if (!isset($this->datasources[$adminElement->getId()])) {
            $this->datasources[$adminElement->getId()] = $adminElement->createDataSource();
        }

        return $this->datasources[$adminElement->getId()];
    }

    private function clearDataSource(AdminListElement $element): void
    {
        $this->getContainer()->get('test.datasource.factory')->clearDataSource($element->getId());
    }

    private function getFiltersElement(): Filters
    {
        return $this->defaultPage->getElement('Filters');
    }

    private function getListElement(): ListElement
    {
        return $this->defaultPage->getElement('ListElement');
    }

    private function getListResultsElement(): ListResultsElement
    {
        return $this->defaultPage->getElement('ListResultsElement');
    }
}


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 FSi\Bundle\AdminBundle\Admin\CRUD\ListElement as AdminListElement;
16			use FSi\Bundle\AdminBundle\Behat\Element\Filters;
17			use FSi\Bundle\AdminBundle\Behat\Element\ListElement;
18			use FSi\Bundle\AdminBundle\Behat\Element\ListResultsElement;
19			use FSi\Bundle\AdminBundle\Behat\Page\DefaultPage;
20			use FSi\Component\DataSource\DataSourceInterface;
21
22			class FiltersContext extends AbstractContext
23			{
24			/**
25			* @var DefaultPage
26			*/
27			private $defaultPage;
28
29			/**
30			* @var DataSourceInterface[]
31			*/
32			private $datasources = [];
33
34			public function __construct(DefaultPage $defaultPage)
35			{
36			$this->defaultPage = $defaultPage;
37			}
38
39			/**
40			* @Given /^("[^"]*" element) datasource max results is set (\d+)$/
41			*/
42			public function elementDatasourceMaxResultsIsSet(AdminListElement $adminElement, $maxResults)
43			{
44			expect($this->getDataSource($adminElement)->getMaxResults())->toBe($maxResults);
45			$this->clearDataSource($adminElement);
46			}
47
48			/**
49			* @Given /^("[^"]*" element) has datasource with fields$/
50			*/
51			public function elementHaveDatasourceWithFields(AdminListElement $adminElement)
52			{
53			$dataSource = $this->getDataSource($adminElement);
54
55			expect(count($dataSource->getFields()) > 0)->toBe(true);
56			$this->clearDataSource($adminElement);
57			}
58
59			/**
60			* @Given /^("[^"]*" element) has datasource without filters$/
61			*/
62			public function elementHaveDatasourceWithoutFilters(AdminListElement $adminElement)
63			{
64			$dataSource = $this->getDataSource($adminElement);
65
66			$filters = false;
67			foreach ($dataSource->getFields() as $field) {
68			if ($field->getOption('form_filter')) {
69			$filters = true;
70			break;
71			}
72			}
73			expect($filters)->toBe(false);
74
75			$this->clearDataSource($adminElement);
76			}
77
78			/**
79			* @Then /^both sorting buttons in column header "([^"]*)" should be active$/
80			*/
81			public function bothSortingButtonsInColumnHeaderShouldBeActive($column)
82			{
83			expect($this->getListElement()->isColumnAscSortActive($column))->toBe(true);
84			}
85
86			/**
87			* @When /^I press "([^"])" button in "([^"])" column header$/
88			*/
89			public function iPressButtonInColumnHeader($sort, $column)
90			{
91			$this->getListElement()->pressSortButton($column, $sort);
92			}
93
94			/**
95			* @Then /^"([^"])" button in "([^"])" column header should be disabled$/
96			*/
97			public function buttonInColumnHeaderShouldBeDisabled($sort, $column)
98			{
99			$list = $this->getListElement();
100
101			switch (strtolower($sort)) {
102			case 'sort asc':
103			expect($list->isColumnAscSortActive($column))->toBe(false);
104			break;
105			case 'sort desc':
106			expect($list->isColumnDescSortActive($column))->toBe(false);
107			break;
108			default :
109			throw new \LogicException(sprintf('Unknown sorting type %s', $sort));
110			}
111			}
112
113			/**
114			* @Given /^"([^"])" button in "([^"])" column header should be active$/
115			*/
116			public function buttonInColumnHeaderShouldBeActive($sort, $column)
117			{
118			$list = $this->getListElement();
119
120			switch (strtolower($sort)) {
121			case 'sort asc':
122			expect($list->isColumnAscSortActive($column))->toBe(true);
123			break;
124			case 'sort desc':
125			expect($list->isColumnDescSortActive($column))->toBe(true);
126			break;
127			default :
128			throw new \LogicException(sprintf('Unknown sorting type %s', $sort));
129			}
130			}
131
132			/**
133			* @When /^I change elements per page to (\d+)$/
134			*/
135			public function iChangeElementsPerPageTo($elementsCount)
136			{
137			$this->getListResultsElement()->setElementsPerPage((int) $elementsCount);
138			}
139
140			/**
141			* @Then /^I should not see any filters$/
142			*/
143			public function iShouldNotSeeAnyFilters()
144			{
145			expect($this->defaultPage->find('css', 'form.filters') === null)->toBe(true);
146			}
147
148			/**
149			* @Then /^I should see simple text filter "([^"]*)"$/
150			*/
151			public function iShouldSeeSimpleTextFilter($filterName)
152			{
153			expect($this->getFiltersElement()->hasField($filterName))->toBe(true);
154			}
155
156			/**
157			* @Given /^I should see between filter "([^"])" with "([^"])" and "([^"]*)" simple text fields$/
158			*/
159			public function iShouldSeeBetweenFilterWithAndSimpleTextFields($filterName, $fromName, $toName)
160			{
161			expect($this->getFiltersElement()->hasBetweenFilter($filterName, $fromName, $toName))->toBe(true);
162			}
163
164			/**
165			* @Given /^I should see choice filter "([^"]*)"$/
166			*/
167			public function iShouldSeeChoiceFilter($filterName)
168			{
169			expect($this->getFiltersElement()->hasChoiceFilter($filterName))->toBe(true);
170			}
171
172			/**
173			* @Given /^I fill simple text filter "([^"])" with value "([^"])"$/
174			*/
175			public function iFillSimpleTextFilterWithValue($filterName, $filterValue)
176			{
177			$this->getFiltersElement()->fillField($filterName, $filterValue);
178			}
179
180			/**
181			* @When /^I select "([^"])" in choice filter "([^"])"$/
182			*/
183			public function iSelectInChoiceFilter($filterValue, $filterName)
184			{
185			$this->getFiltersElement()->findField($filterName)->selectOption($filterValue);
186			}
187
188			/**
189			* @Given /^I press "Search" button$/
190			*/
191			public function iPressSearchButton()
192			{
193			$this->getFiltersElement()->pressButton('Search');
194			}
195
196			/**
197			* @Given /^simple text filter "([^"])" should be filled with value "([^"])"$/
198			*/
199			public function simpleTextFilterShouldBeFilledWithValue($filterName, $filterValue)
200			{
201			expect($this->getFiltersElement()->findField($filterName)->getValue())->toBe($filterValue);
202			}
203
204			/**
205			* @Given /^choice filter "([^"])" should have value "([^"])" selected$/
206			*/
207			public function choiceFilterShouldHaveValueSelected($filterName, $choice)
208			{
209			$field = $this->getFiltersElement()->findField($filterName);
210			expect($field->find('css', sprintf('option:contains("%s")', $choice))
211			->getAttribute('selected'))->toBe('selected');
212			}
213
214			/**
215			* @Then /^I should see actions dropdown with following options$/
216			*/
217			public function iShouldSeeActionsDropdownWithFollowingOptions(TableNode $actions)
218			{
219			expect($this->defaultPage->hasBatchActionsDropdown())->toBe(true);
220
221			foreach ($actions->getHash() as $actionRow) {
222			expect($this->defaultPage->hasBatchAction($actionRow['Option']))->toBe(true);
223			}
224			}
225
226			/**
227			* @Given /^I should see confirmation button "([^"]*)"$/
228			*/
229			public function iShouldSeeConfirmationButton($button)
230			{
231			$this->defaultPage->hasButton($button);
232			}
233
234			/**
235			* @param AdminListElement $adminElement
236			* @return DataSourceInterface
237			*/
238			private function getDataSource(AdminListElement $adminElement)
239			{
240			if (!isset($this->datasources[$adminElement->getId()])) {
241			$this->datasources[$adminElement->getId()] = $adminElement->createDataSource();
242			}
243
244			return $this->datasources[$adminElement->getId()];
245			}
246
247			private function clearDataSource(AdminListElement $element): void
248			{
249			$this->getContainer()->get('test.datasource.factory')->clearDataSource($element->getId());
250			}
251
252			private function getFiltersElement(): Filters
253			{
254			return $this->defaultPage->getElement('Filters');
255			}
256
257			private function getListElement(): ListElement
258			{
259			return $this->defaultPage->getElement('ListElement');
260			}
261
262			private function getListResultsElement(): ListResultsElement
263			{
264			return $this->defaultPage->getElement('ListResultsElement');
265			}
266			}
267

fsi-open / admin-bundle

Pull Request — 3.1 (#348)

FiltersContext::iPressButtonInColumnHeader() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like