Drupal\TqExtension\Context\Form\FormContext

Complexity

Total Complexity

53

Size/Duplication

Total Lines	467
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes	5
Bugs	1	Features	2

18 Methods

Rating	Name	Duplication	Size	Complexity
B	choseOptionFromAutocompleteVariants()	0	45	6
B	fillInWithValueOfFieldOfCurrentUser()	0	22	5
A	checkboxAction()	0	8	2
B	radioAction()	0	23	6
A	fillField()	0	4	1
A	fillFields()	0	6	2
A	attachFile()	0	16	3
C	setValueForHierarchicalSelect()	0	43	7
B	shouldSeeThumbnail()	0	26	6
B	shouldSeeNoErrors()	0	33	6
A	selectFrom()	0	4	1
A	selectFromFollowing()	0	6	2
A	assertTextualField()	0	4	1
A	assertSelectableField()	0	4	1
A	assertCheckableField()	0	4	1
A	setDate()	0	4	1
A	isDateSelected()	0	4	1
A	isDateAvailable()	0	4	1

<?php
/**
 * @author Sergey Bondarenko, <sb@firstvector.org>
 */
namespace Drupal\TqExtension\Context\Form;

// Exceptions.
use Symfony\Component\Filesystem\Exception\FileNotFoundException;
use Behat\Mink\Exception\ElementNotFoundException;
use WebDriver\Exception\NoSuchElement;

// Helpers.
use Behat\Gherkin\Node\TableNode;
use WebDriver\Service\CurlService;
use Behat\Mink\Element\NodeElement;

// Utils.
use Drupal\TqExtension\Utils\DatePicker;
use Drupal\TqExtension\Utils\FormValueAssertion;
use Drupal\TqExtension\Utils\EntityDrupalWrapper;

class FormContext extends RawFormContext
{
    /**
     * @param string $value
     *   Typed text.
     * @param string $selector
     *   Selector of the field.
     * @param int $option
     *   An option number. Will be selected from loaded variants.
     *
     * @throws \InvalidArgumentException
     *   When $option is less than zero.
     * @throws NoSuchElement
     *   When autocomplete list was not loaded.
     * @throws \RuntimeException
     *   When neither option was not loaded.
     * @throws \OverflowException
     *   When $option is more than variants are available.
     * @throws \Exception
     *   When value was not changed.
     *
     * @Then /^(?:|I )typed "([^"]*)" in the "([^"]*)" field and chose (\d+) option from autocomplete variants$/
     */
    public function choseOptionFromAutocompleteVariants($value, $selector, $option)
    {
        if (!$option) {
            throw new \InvalidArgumentException(sprintf(
                'An option that will be chosen expected as positive number, but was got the: %s',
                $option
            ));
        }

        $field = $this->element('field', $selector);
        // Syn - a Standalone Synthetic Event Library, provided by Selenium.
        $this->executeJsOnElement($field, sprintf("Syn.type({{ELEMENT}}, '%s')", token_replace($value)));
        $this->waitAjaxAndAnimations();

        $autocomplete = $field->getParent()->findById('autocomplete');
        $this->throwNoSuchElementException('#autocomplete', $autocomplete);

        $options = count($autocomplete->findAll('css', 'li'));

        if ($options < 1) {
            throw new \RuntimeException('Neither option was not loaded.');
        }

        if ($option > $options) {
            throw new \OverflowException(sprintf(
                'You can not select an option %s, as there are only %d.',
                $option,
                $options
            ));
        }

        for ($i = 0; $i < $option; $i++) {
            // 40 - down
            $field->keyDown(40);
            $field->keyUp(40);
        }

        // 13 - return
        $field->keyDown(13);
        $field->keyUp(13);

        if ($field->getValue() == $value) {
            throw new \Exception(sprintf('The value of "%s" field was not changed.', $selector));
        }
    }

    /**
     * Use the current user data for filling fields.
     *
     * @example
     * Then I fill "First name" with value of field "First name" of current user
     * And fill "field_last_name[und][0]" with value of field "field_user_last_name" of current user
     *
     * @param string $field
     *   The name of field to fill in. HTML Label, name or ID can be user as selector.
     * @param string $user_field
     *   The name of field from which the data will taken. Drupal label or machine name can be used as selector.
     *
     * @throws \InvalidArgumentException
     * @throws \UnexpectedValueException
     * @throws \Exception
     * @throws NoSuchElement
     *   When field cannot be found.
     *
     * @Then /^(?:I )fill "([^"]*)" with value of field "([^"]*)" of current user$/
     */
    public function fillInWithValueOfFieldOfCurrentUser($field, $user_field)
    {
        if (!empty($this->user) && !$this->user->uid) {
            throw new \Exception('Anonymous user have no fields');
        }

        $entity = new EntityDrupalWrapper('user');
        $wrapper = $entity->wrapper($this->user->uid);
        $user_field = $entity->getFieldNameByLocator($user_field);

        if (empty($wrapper->{$user_field})) {
            throw new \InvalidArgumentException(sprintf('User entity has no "%s" field.', $user_field));
        }

        $value = $wrapper->{$user_field}->value();

        if (empty($value)) {
            throw new \UnexpectedValueException('The value of "%s" field is empty.', $user_field);
        }

        $this->fillField($field, $value);
    }

    /**
     * @param string $action
     *   Can be "check" or "uncheck".
     * @param TableNode $checkboxes
     *   Table with one row of checkboxes selectors.
     *
     * @example
     * I uncheck the boxes:
     *   | Consumer Products  |
     *   | Financial Services |
     *
     * @example
     * I check the boxes:
     *   | Consumer Products  |
     *   | Financial Services |
     *
     * @Given /^(?:|I )(?:|un)check the boxes:/
     */
    public function checkboxAction($action, TableNode $checkboxes)
    {
        $minkContext = $this->getMinkContext();

        foreach ($checkboxes->getRows() as $checkbox) {
            $minkContext->{trim($action) . 'Option'}(reset($checkbox));
        }
    }

    /**
     * This method was defined and used instead of "assertSelectRadioById",
     * because the field label can contain too long value and better to use
     * another selector instead of label.
     *
     * @see MinkContext::assertSelectRadioById()
     *
     * @param string $customized
     *   Can be an empty string or " customized".
     * @param string $selector
     *   Field selector.
     *
     * @throws NoSuchElement
     *   When radio button was not found.
     * @throws \Exception
     *
     * @Given /^(?:|I )check the(| customized) "([^"]*)" radio button$/
     */
    public function radioAction($customized, $selector)
    {
        $field = $this->getWorkingElement()->findField($selector);
        $customized = (bool) $customized;

        if ($field !== null && !$customized) {
            $field->selectOption($field->getAttribute('value'));
            return;
        }

        // Find all labels of a radio button or only first, if it is not custom.
        foreach ($this->findLabels($selector) as $label) {
            // Check a custom label for visibility.
            if ($customized && !$label->isVisible()) {
                continue;
            }

            $label->click();
            return;
        }

        $this->throwNoSuchElementException($selector, $field);
    }

    /**
     * @param string $selector
     * @param string $value
     *
     * @throws NoSuchElement
     *
     * @When /^(?:|I )fill "([^"]*)" with "([^"]*)"$/
     */
    public function fillField($selector, $value)
    {
        $this->element('field', $selector)->setValue(token_replace($value));
    }

    /**
     * @param TableNode $fields
     *   | Field locator | Value |
     *
     * @throws NoSuchElement
     *
     * @When /^(?:|I )fill the following:$/
     */
    public function fillFields(TableNode $fields)
    {
        foreach ($fields->getRowsHash() as $field => $value) {
            $this->fillField($field, $value);
        }
    }

    /**
     * @param string $file
     *   Path to a file. Relative to the directory specified in "files_path" in behat.yml.
     * @param string $selector
     *   Field selector (label|id|name).
     *
     * @throws \Exception
     * @throws NoSuchElement
     *
     * @Given /^(?:|I )attach file "([^"]*)" to "([^"]*)"$/
     */
    public function attachFile($file, $selector)
    {
        $filesPath = $this->getMinkParameter('files_path');

        if (!$filesPath) {
            throw new \Exception('The "files_path" Mink parameter was not configured.');
        }

        $file = rtrim(realpath($filesPath), DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . $file;

        if (!is_file($file)) {
            throw new \InvalidArgumentException(sprintf('The "%s" file does not exist.', $file));
        }

        $this->element('field', $selector)->attachFile($file);
    }

    /**
     * @param string $selector
     * @param TableNode $values
     *
     * @throws ElementNotFoundException
     * @throws \Exception
     * @throws NoSuchElement
     *
     * @Given /^(?:|I )select the following in "([^"]*)" hierarchical select:$/
     */
    public function setValueForHierarchicalSelect($selector, TableNode $values)
    {
        $element = $this->getWorkingElement();
        // Try to selects by wrapper ID.
        $wrapper = $element->findById($selector);

        if (null !== $wrapper) {
            $labels = $wrapper->findAll('xpath', '//label[@for]');
        } else {
            $labels = $this->findLabels($selector);
        }

        if (empty($labels)) {
            throw new \Exception('No one hierarchical select was found.');
        }

        /** @var NodeElement $label */
        $label = reset($labels);
        $parent = $label->getParent();

        foreach (array_keys($values->getRowsHash()) as $i => $value) {
            /** @var NodeElement[] $selects */
            $selects = [];

            /** @var NodeElement $select */
            foreach ($parent->findAll('css', 'select') as $select) {
                if ($select->isVisible()) {
                    $selects[] = $select;
                }
            }

            if (!isset($selects[$i])) {
                throw new \InvalidArgumentException(sprintf(
                    'The value "%s" was specified for select "%s" but it does not exist.',
                    $value,
                    $i
                ));
            }

            $selects[$i]->selectOption($value);
            $this->waitAjaxAndAnimations();
        }
    }

    /**
     * Check that an image was uploaded and can be viewed on the page.
     *
     * @throws \Exception
     * @throws FileNotFoundException
     *
     * @Then /^(?:|I )should see the thumbnail$/
     */
    public function shouldSeeThumbnail()
    {
        $thumb = false;

        foreach (['media-thumbnail', 'image-preview'] as $classname) {
            if ($thumb) {
                break;
            }

            $thumb = $this->findByCss(".$classname img");
        }

        if (!$thumb) {
            throw new \Exception('An expected image tag was not found.');
        }

        $file = explode('?', $thumb->getAttribute('src'));
        $file = reset($file);

        $curl = new CurlService();
        list(, $info) = $curl->execute('GET', $file);

        if (empty($info) || strpos($info['content_type'], 'image/') === false) {
            throw new FileNotFoundException(sprintf('%s did not return an image', $file));
        }
    }

    /**
     * Check that the page have no error messages and fields - error classes.
     *
     * @throws \InvalidArgumentException
     * @throws \RuntimeException
     * @throws \Exception
     *
     * @Then /^(?:|I )should see no errors$/
     */
    public function shouldSeeNoErrors()
    {
        $selector = $this->getDrupalSelector('error_message_selector');

        if (empty($selector)) {
            throw new \InvalidArgumentException('The "error_message_selector" in behat.yml is not configured.');
        }

        $session = $this->getSession();
        $page = $session->getPage();
        $errors = $page->find('css', $selector);

        // Some modules are inserted an empty container for errors before
        // they are arise. The "Clientside Validation" - one of them.
        if (null !== $errors) {
            $text = $errors->getText();

            if (!empty($text)) {
                throw new \RuntimeException(sprintf(
                    'The page "%s" contains following error messages: "%s"',
                    $session->getCurrentUrl(),
                    $text
                ));
            }
        }

        /** @var NodeElement $formElement */
        foreach ($page->findAll('css', 'input, select, textarea') as $formElement) {
            if ($formElement->hasClass('error')) {
                throw new \Exception(sprintf('Element "#%s" has an error class.', $formElement->getAttribute('id')));
            }
        }
    }

    /**
     * @param string $option
     * @param string $selector
     *
     * @Then /^(?:|I )pick "([^"]*)" from "([^"]*)"$/
     */
    public function selectFrom($option, $selector)
    {
        $this->element('*', $selector)->selectOption($option);
    }

    /**
     * @example
     * And pick the following:
     *   | Entity Reference                     | Type of new field    |
     *   | Inline entity form - Multiple values | Widget for new field |
     *
     * @param TableNode $rows
     *
     * @Then /^(?:|I )pick the following:$/
     */
    public function selectFromFollowing(TableNode $rows)
    {
        foreach ($rows->getRowsHash() as $option => $selector) {
            $this->selectFrom($option, $selector);
        }
    }

    /**
     * @example
     * And check that "Users" field has "admin" value
     * And check that "Users" field has not "customer" value
     *
     * @Then /^(?:|I )check that "([^"]*)" field has(| not) "([^"]*)" value$/
     */
    public function assertTextualField($selector, $not, $expected)
    {
        (new FormValueAssertion($this, $selector, $not, $expected))->textual();
    }

    /**
     * @example
     * And check that "User" is selected in "Apply to" select
     * And check that "Product(s)" is not selected in "Apply to" select
     *
     * @Then /^(?:|I )check that "([^"]*)" is(| not) selected in "([^"]*)" select$/
     */
    public function assertSelectableField($expected, $not, $selector)
    {
        (new FormValueAssertion($this, $selector, $not, $expected))->selectable();
    }

    /**
     * @example
     * And check that "Order discount" is checked
     * And check that "Product discount" is not checked
     *
     * @Then /^(?:|I )check that "([^"]*)" is(| not) checked$/
     */
    public function assertCheckableField($selector, $not)
    {
        (new FormValueAssertion($this, $selector, $not))->checkable();
    }

    /**
     * @param string $date
     * @param string $selector
     *
     * @Then /^(?:|I )choose "([^"]*)" in "([^"]*)" datepicker$/
     * @Then /^(?:|I )set the "([^"]*)" for "([^"]*)" datepicker$/
     */
    public function setDate($date, $selector)
    {
        (new DatePicker($this, $selector, $date))->isDateAvailable()->setDate()->isDateSelected();
    }

    /**
     * @param string $selector
     * @param string $date
     *
     * @Then /^(?:|I )check that "([^"]*)" datepicker contains "([^"]*)" date$/
     */
    public function isDateSelected($selector, $date)
    {
        (new DatePicker($this, $selector, $date))->isDateSelected();
    }

    /**
     * @param string $date
     * @param string $selector
     *
     * @Then /^(?:|I )check that "([^"]*)" is available for "([^"]*)" datepicker$/
     */
    public function isDateAvailable($date, $selector)
    {
        (new DatePicker($this, $selector, $date))->isDateAvailable();
    }
}