SelectTrait.php

<?php

declare(strict_types=1);

namespace DrevOps\BehatSteps;

/**
 * Trait SelectTrait.
 *
 * Steps to work with HTML select element.
 *
 * @package DrevOps\BehatSteps
 */
trait SelectTrait {

  /**
   * Assert that a select has an option.
   *
   * @Then select :select should have an option :option
   */
  public function selectShouldHaveOption(string $select, string $option): void {
    $selectElement = $this->getSession()->getPage()->findField($select);
    if (is_null($selectElement)) {
      throw new \InvalidArgumentException(sprintf('Element "%s" is not found.', $select));
    }

    $optionElement = $selectElement->find('named', ['option', $option]);
    if (is_null($optionElement)) {
      throw new \InvalidArgumentException(sprintf('Option "%s" is not found in select "%s".', $option, $select));
    }
  }

  /**
   * Assert that a select does not have an option.
   *
   * @Then select :select should not have an option :option
   */
  public function selectShouldNotHaveOption(string $select, string $option): void {
    $selectElement = $this->getSession()->getPage()->findField($select);
    if (is_null($selectElement)) {
      throw new \InvalidArgumentException(sprintf('Element "%s" is not found.', $select));
    }

    $optionElement = $selectElement->find('named', ['option', $option]);
    if (!is_null($optionElement)) {
      throw new \InvalidArgumentException(sprintf('Option "%s" is found in select "%s", but should not.', $option, $select));
    }
  }

  /**
   * Assert that a select option is selected.
   *
   * @Then /^the option "([^"]*)" from select "([^"]*)" is selected$/
   */
  public function selectOptionSelected(string $value, string $select): void {
    $selectField = $this->getSession()->getPage()->findField($select);
    $currentUrl = $this->getSession()->getCurrentUrl();

    if (!$selectField) {
      throw new \Exception(sprintf('The select "%s" was not found on the page %s', $select, $currentUrl));
    }

    $optionField = $selectField->find('named', [
      'option',
      $value,
    ]);

    if (!$optionField) {
      throw new \Exception(sprintf('No option is selected in the %s select on the page %s', $select, $currentUrl));
    }

    if (!$optionField->isSelected()) {
      throw new \Exception(sprintf('The option "%s" was not selected on the page %s', $value, $currentUrl));
    }
  }

}