Select2Context::iFillInSelect2FieldWaitUntilResultsAreLoaded() - Code Metrics - Inspection of "Add step to fill Select2 field and wait for respon..." - novaway/BehatCommonContext - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#19)

by Jérémy

created 2016-10-06 19:38 UTC

iFillInSelect2FieldWaitUntilResultsAreLoaded() A

↳ Parent: Select2Context

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	7
rs	9.4285
cc	1
eloc	4
nc	1
nop	3

<?php

namespace Novaway\CommonContexts\Context;

use Behat\Mink\Element\DocumentElement;

class Select2Context extends BaseContext
{
    const DEFAULT_TIMEOUT = 60;

    /** @var int */
    private $timeout;

    /**
     * Constructor
     *
     * @param int $timeout Timeout for waiting results (in seconds)
     */
    public function __construct($timeout = self::DEFAULT_TIMEOUT)
    {
        $this->timeout = $timeout;
    }

    /**
     * Fills in Select2 field with specified
     *
     * @When /^(?:|I )fill in select2 "(?P<field>(?:[^"]|\\")*)" with "(?P<value>(?:[^"]|\\")*)"$/
     * @When /^(?:|I )fill in select2 "(?P<value>(?:[^"]|\\")*)" for "(?P<field>(?:[^"]|\\")*)"$/
     */
    public function iFillInSelect2Field($field, $value)
    {
        $page = $this->getSession()->getPage();

        $this->openField($page, $field);
        $this->selectValue($page, $field, $value, $this->timeout);
    }

    /**
     * Fills in Select2 field with specified and wait for results
     *
     * @When /^(?:|I )fill in select2 "(?P<field>(?:[^"]|\\")*)" with "(?P<value>(?:[^"]|\\")*)" and wait (?P<time>(?:[^"]|\\")*) seconds until results are loaded$/
     * @When /^(?:|I )fill in select2 "(?P<value>(?:[^"]|\\")*)" for "(?P<field>(?:[^"]|\\")*)" and wait (?P<time>(?:[^"]|\\")*) seconds until results are loaded$/
     */
    public function iFillInSelect2FieldWaitUntilResultsAreLoaded($field, $value, $time)
    {
        $page = $this->getSession()->getPage();

        $this->openField($page, $field);
        $this->selectValue($page, $field, $value, $time);
    }

    /**
     * Fill Select2 input field
     *
     * @When /^(?:|I )fill in select2 input "(?P<field>(?:[^"]|\\")*)" with "(?P<value>(?:[^"]|\\")*)"$/
     */
    public function iFillInSelect2InputWith($field, $value)
    {
        $page = $this->getSession()->getPage();

        $this->openField($page, $field);
        $this->fillSearchField($page, $field, $value);
    }

    /**
     * Fill Select2 input field and select a value
     *
     * @When /^(?:|I )fill in select2 input "(?P<field>(?:[^"]|\\")*)" with "(?P<value>(?:[^"]|\\")*)" and select "(?P<entry>(?:[^"]|\\")*)"$/
     */
    public function iFillInSelect2InputWithAndSelect($field, $value, $entry)
    {
        $page = $this->getSession()->getPage();

        $this->openField($page, $field);
        $this->fillSearchField($page, $field, $value);
        $this->selectValue($page, $field, $entry, $this->timeout);
    }

    /**
     * Fill Select2 input field
     *
     * @Then /^(?:|I )should see (?P<num>\d+) choice(?:|s) in select2 "(?P<field>(?:[^"]|\\")*)"$/
     */
    public function iShouldSeeSelectChoices($field, $num)
    {
        $selector = sprintf('#select2-%s-results li', $field);

        $this->assertSession()->elementsCount('css', $selector, intval($num));
    }

    /**
     * Open Select2 choice list
     *
     * @param DocumentElement $page
     * @param string          $field
     * @throws \Exception
     */
    private function openField(DocumentElement $page, $field)

    {
        $fieldName = sprintf('select[name="%s"] + .select2-container', $field);

        $inputField = $page->find('css', $fieldName);
        if (!$inputField) {
            throw new \Exception(sprintf('No field "%s" found', $field));
        }

        $choice = $inputField->find('css', '.select2-selection');
        if (!$choice) {
            throw new \Exception(sprintf('No select2 choice found for "%s"', $field));
        }
        $choice->press();
    }

    /**
     * Fill Select2 search field
     *
     * @param DocumentElement $page
     * @param string          $field
     * @param string          $value
     * @throws \Exception
     */
    private function fillSearchField(DocumentElement $page, $field, $value)
    {
        $driver = $this->getSession()->getDriver();
        if ('Behat\Mink\Driver\Selenium2Driver' === get_class($driver)) {
            // Can't use `$this->getSession()->getPage()->find()` because of https://github.com/minkphp/MinkSelenium2Driver/issues/188
            $select2Input = $this->getSession()->getDriver()->getWebDriverSession()->element('xpath', "//html/descendant-or-self::*[@class and contains(concat(' ', normalize-space(@class), ' '), ' select2-search__field ')]");
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            if (!$select2Input) {
                throw new \Exception(sprintf('No field "%s" found', $field));
            }
            $select2Input->postValue(['value' => [$value]]);
        } else {
            $select2Input = $page->find('css', '.select2-search__field');
            if (!$select2Input) {
                throw new \Exception(sprintf('No input found for "%s"', $field));
            }
            $select2Input->setValue($value);
        }

        $this->waitForLoadingResults($this->timeout);
    }

    /**
     * Select value in choice list
     *
     * @param DocumentElement $page
     * @param string          $field
     * @param string          $value
     * @param int             $time
     * @throws \Exception
     */
    private function selectValue(DocumentElement $page, $field, $value, $time)
    {
        $this->waitForLoadingResults($time);

        $chosenResults = $page->findAll('css', '.select2-results li');
        foreach ($chosenResults as $result) {
            if ($result->getText() == $value) {
                $result->click();
                return;
            }
        }

        throw new \Exception(sprintf('Value "%s" not found for "%s"', $value, $field));
    }

    /**
     * Wait the end of fetching Select2 results
     *
     * @param int $time Time to wait in seconds
     */
    private function waitForLoadingResults($time)
    {
        for ($i = 0; $i < $time; $i++) {
            if (!$this->getSession()->getPage()->find('css', '.select2-results__option.loading-results')) {
                return;
            }

            sleep(1);
        }
    }
}


1		<?php
2
3		namespace Novaway\CommonContexts\Context;
4
5		use Behat\Mink\Element\DocumentElement;
6
7		class Select2Context extends BaseContext
8		{
9		const DEFAULT_TIMEOUT = 60;
10
11		/** @var int */
12		private $timeout;
13
14		/**
15		* Constructor
16		*
17		* @param int $timeout Timeout for waiting results (in seconds)
18		*/
19		public function __construct($timeout = self::DEFAULT_TIMEOUT)
20		{
21		$this->timeout = $timeout;
22		}
23
24		/**
25		* Fills in Select2 field with specified
26		*
27		* @When /^(?:\|I )fill in select2 "(?P<field>(?:[^"]\|\\"))" with "(?P<value>(?:[^"]\|\\"))"$/
28		* @When /^(?:\|I )fill in select2 "(?P<value>(?:[^"]\|\\"))" for "(?P<field>(?:[^"]\|\\"))"$/
29		*/
30		public function iFillInSelect2Field($field, $value)
31		{
32		$page = $this->getSession()->getPage();
33
34		$this->openField($page, $field);
35		$this->selectValue($page, $field, $value, $this->timeout);
36		}
37
38		/**
39		* Fills in Select2 field with specified and wait for results
40		*
41		* @When /^(?:\|I )fill in select2 "(?P<field>(?:[^"]\|\\"))" with "(?P<value>(?:[^"]\|\\"))" and wait (?P<time>(?:[^"]\|\\")*) seconds until results are loaded$/
42		* @When /^(?:\|I )fill in select2 "(?P<value>(?:[^"]\|\\"))" for "(?P<field>(?:[^"]\|\\"))" and wait (?P<time>(?:[^"]\|\\")*) seconds until results are loaded$/
43		*/
44		public function iFillInSelect2FieldWaitUntilResultsAreLoaded($field, $value, $time)
45		{
46		$page = $this->getSession()->getPage();
47
48		$this->openField($page, $field);
49		$this->selectValue($page, $field, $value, $time);
50		}
51
52		/**
53		* Fill Select2 input field
54		*
55		* @When /^(?:\|I )fill in select2 input "(?P<field>(?:[^"]\|\\"))" with "(?P<value>(?:[^"]\|\\"))"$/
56		*/
57		public function iFillInSelect2InputWith($field, $value)
58		{
59		$page = $this->getSession()->getPage();
60
61		$this->openField($page, $field);
62		$this->fillSearchField($page, $field, $value);
63		}
64
65		/**
66		* Fill Select2 input field and select a value
67		*
68		* @When /^(?:\|I )fill in select2 input "(?P<field>(?:[^"]\|\\"))" with "(?P<value>(?:[^"]\|\\"))" and select "(?P<entry>(?:[^"]\|\\")*)"$/
69		*/
70		public function iFillInSelect2InputWithAndSelect($field, $value, $entry)
71		{
72		$page = $this->getSession()->getPage();
73
74		$this->openField($page, $field);
75		$this->fillSearchField($page, $field, $value);
76		$this->selectValue($page, $field, $entry, $this->timeout);
77		}
78
79		/**
80		* Fill Select2 input field
81		*
82		* @Then /^(?:\|I )should see (?P<num>\d+) choice(?:\|s) in select2 "(?P<field>(?:[^"]\|\\")*)"$/
83		*/
84		public function iShouldSeeSelectChoices($field, $num)
85		{
86		$selector = sprintf('#select2-%s-results li', $field);
87
88		$this->assertSession()->elementsCount('css', $selector, intval($num));
89		}
90
91		/**
92		* Open Select2 choice list
93		*
94		* @param DocumentElement $page
95		* @param string $field
96		* @throws \Exception
97		*/
98	View Code Duplication	private function openField(DocumentElement $page, $field)
		0 ignored issues – show Duplication introduced 2015-12-12 20:41 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
99		{
100		$fieldName = sprintf('select[name="%s"] + .select2-container', $field);
101
102		$inputField = $page->find('css', $fieldName);
103		if (!$inputField) {
104		throw new \Exception(sprintf('No field "%s" found', $field));
105		}
106
107		$choice = $inputField->find('css', '.select2-selection');
108		if (!$choice) {
109		throw new \Exception(sprintf('No select2 choice found for "%s"', $field));
110		}
111		$choice->press();
112		}
113
114		/**
115		* Fill Select2 search field
116		*
117		* @param DocumentElement $page
118		* @param string $field
119		* @param string $value
120		* @throws \Exception
121		*/
122		private function fillSearchField(DocumentElement $page, $field, $value)
123		{
124		$driver = $this->getSession()->getDriver();
125		if ('Behat\Mink\Driver\Selenium2Driver' === get_class($driver)) {
126		// Can't use `$this->getSession()->getPage()->find()` because of https://github.com/minkphp/MinkSelenium2Driver/issues/188
127		$select2Input = $this->getSession()->getDriver()->getWebDriverSession()->element('xpath', "//html/descendant-or-self::*[@class and contains(concat(' ', normalize-space(@class), ' '), ' select2-search__field ')]");
		0 ignored issues – show Bug introduced 2015-12-12 20:41 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Mink\Driver\DriverInterface` as the method `getWebDriverSession()` does only exist in the following implementations of said interface: `Behat\Mink\Driver\Selenium2Driver`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
128		if (!$select2Input) {
129		throw new \Exception(sprintf('No field "%s" found', $field));
130		}
131		$select2Input->postValue(['value' => [$value]]);
132		} else {
133		$select2Input = $page->find('css', '.select2-search__field');
134		if (!$select2Input) {
135		throw new \Exception(sprintf('No input found for "%s"', $field));
136		}
137		$select2Input->setValue($value);
138		}
139
140		$this->waitForLoadingResults($this->timeout);
141		}
142
143		/**
144		* Select value in choice list
145		*
146		* @param DocumentElement $page
147		* @param string $field
148		* @param string $value
149		* @param int $time
150		* @throws \Exception
151		*/
152		private function selectValue(DocumentElement $page, $field, $value, $time)
153		{
154		$this->waitForLoadingResults($time);
155
156		$chosenResults = $page->findAll('css', '.select2-results li');
157		foreach ($chosenResults as $result) {
158		if ($result->getText() == $value) {
159		$result->click();
160		return;
161		}
162		}
163
164		throw new \Exception(sprintf('Value "%s" not found for "%s"', $value, $field));
165		}
166
167		/**
168		* Wait the end of fetching Select2 results
169		*
170		* @param int $time Time to wait in seconds
171		*/
172		private function waitForLoadingResults($time)
173		{
174		for ($i = 0; $i < $time; $i++) {
175		if (!$this->getSession()->getPage()->find('css', '.select2-results__option.loading-results')) {
176		return;
177		}
178
179		sleep(1);
180		}
181		}
182		}
183

novaway / BehatCommonContext

Pull Request — master (#19)

iFillInSelect2FieldWaitUntilResultsAreLoaded() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like