Select2Context::__construct() - Code Metrics - Inspection of "Add timeout configuration for Select2 ajax query" - novaway/BehatCommonContext - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#18)

by Jérémy

created 2016-10-04 06:26 UTC

Select2Context::__construct() A

↳ Parent: Select2Context

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?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);
    }

    /**
     * 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);
    }

    /**
     * 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
     * @throws \Exception
     */
    private function selectValue(DocumentElement $page, $field, $value)
    {
        $this->waitForLoadingResults($this->timeout);

        $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 true;
            }

            sleep(1);
        }

        throw new \Exception(sprintf('Results are not load after "%d" seconds.', $time));
    }
}


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);
36		}
37
38		/**
39		* Fill Select2 input field
40		*
41		* @When /^(?:\|I )fill in select2 input "(?P<field>(?:[^"]\|\\"))" with "(?P<value>(?:[^"]\|\\"))"$/
42		*/
43		public function iFillInSelect2InputWith($field, $value)
44		{
45		$page = $this->getSession()->getPage();
46
47		$this->openField($page, $field);
48		$this->fillSearchField($page, $field, $value);
49		}
50
51		/**
52		* Fill Select2 input field and select a value
53		*
54		* @When /^(?:\|I )fill in select2 input "(?P<field>(?:[^"]\|\\"))" with "(?P<value>(?:[^"]\|\\"))" and select "(?P<entry>(?:[^"]\|\\")*)"$/
55		*/
56		public function iFillInSelect2InputWithAndSelect($field, $value, $entry)
57		{
58		$page = $this->getSession()->getPage();
59
60		$this->openField($page, $field);
61		$this->fillSearchField($page, $field, $value);
62		$this->selectValue($page, $field, $entry);
63		}
64
65		/**
66		* Fill Select2 input field
67		*
68		* @Then /^(?:\|I )should see (?P<num>\d+) choice(?:\|s) in select2 "(?P<field>(?:[^"]\|\\")*)"$/
69		*/
70		public function iShouldSeeSelectChoices($field, $num)
71		{
72		$selector = sprintf('#select2-%s-results li', $field);
73
74		$this->assertSession()->elementsCount('css', $selector, intval($num));
75		}
76
77		/**
78		* Open Select2 choice list
79		*
80		* @param DocumentElement $page
81		* @param string $field
82		* @throws \Exception
83		*/
84	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...
85		{
86		$fieldName = sprintf('select[name="%s"] + .select2-container', $field);
87
88		$inputField = $page->find('css', $fieldName);
89		if (!$inputField) {
90		throw new \Exception(sprintf('No field "%s" found', $field));
91		}
92
93		$choice = $inputField->find('css', '.select2-selection');
94		if (!$choice) {
95		throw new \Exception(sprintf('No select2 choice found for "%s"', $field));
96		}
97		$choice->press();
98		}
99
100		/**
101		* Fill Select2 search field
102		*
103		* @param DocumentElement $page
104		* @param string $field
105		* @param string $value
106		* @throws \Exception
107		*/
108		private function fillSearchField(DocumentElement $page, $field, $value)
109		{
110		$driver = $this->getSession()->getDriver();
111		if ('Behat\Mink\Driver\Selenium2Driver' === get_class($driver)) {
112		// Can't use `$this->getSession()->getPage()->find()` because of https://github.com/minkphp/MinkSelenium2Driver/issues/188
113		$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...
114		if (!$select2Input) {
115		throw new \Exception(sprintf('No field "%s" found', $field));
116		}
117		$select2Input->postValue(['value' => [$value]]);
118		} else {
119		$select2Input = $page->find('css', '.select2-search__field');
120		if (!$select2Input) {
121		throw new \Exception(sprintf('No input found for "%s"', $field));
122		}
123		$select2Input->setValue($value);
124		}
125
126		$this->waitForLoadingResults($this->timeout);
127		}
128
129		/**
130		* Select value in choice list
131		*
132		* @param DocumentElement $page
133		* @param string $field
134		* @param string $value
135		* @throws \Exception
136		*/
137		private function selectValue(DocumentElement $page, $field, $value)
138		{
139		$this->waitForLoadingResults($this->timeout);
140
141		$chosenResults = $page->findAll('css', '.select2-results li');
142		foreach ($chosenResults as $result) {
143		if ($result->getText() == $value) {
144		$result->click();
145		return;
146		}
147		}
148
149		throw new \Exception(sprintf('Value "%s" not found for "%s"', $value, $field));
150		}
151
152		/**
153		* Wait the end of fetching Select2 results
154		*
155		* @param int $time Time to wait in seconds
156		*/
157		private function waitForLoadingResults($time)
158		{
159		for ($i = 0; $i < $time; $i++) {
160		if (!$this->getSession()->getPage()->find('css', '.select2-results__option.loading-results')) {
161		return true;
162		}
163
164		sleep(1);
165		}
166
167		throw new \Exception(sprintf('Results are not load after "%d" seconds.', $time));
168		}
169		}
170

novaway / BehatCommonContext

Pull Request — master (#18)

Select2Context::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like