Merge pull request #222 from aik099/do-not-inject-se-selector

Change Selenium Selector resolution principle
qa-tools · Mar 22, 2024 · bd6e6e4 · bd6e6e4
2 parents 488aa8c + 0bfaa2f
commit bd6e6e4
Show file tree

Hide file tree

Showing 33 changed files with 389 additions and 243 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,10 +6,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 - Added the public `Page::getBrowserUrl` method, that returns URL of the Web Browser (overriding allows operating within a frameset).
 - Added the protected `Page::setBrowserUrl` method, that sets URL of the Web Browser (overriding allows operating within a frameset).
+- Added the public `PageFactory::translateToXPath` method for converting Selenium-style selector (how + using) into XPath.
 
 ### Changed
 - The `WebElement::waitFor` method now provide `WebElement` class (or used subclass, like `AbstractElementContainer`, etc.) instance to the callback instead of a Mink's `NodeElement` class instance.
 - The `Page::waitFor` method now provide `Page` class (or used subclass, like `TypifiedPage`, `BEMPage`, etc.) instance to the callback instead of a Mink's `DocumentElement` class instance.
+- The `se` selector handler is no longer registered in the Mink Session (use the `PageFactory::translateToXPath` instead).
 
 ### Fixed
 ...

diff --git a/library/QATools/QATools/BEM/BEMPageFactory.php b/library/QATools/QATools/BEM/BEMPageFactory.php
@@ -60,7 +60,11 @@ public function __construct(Session $session, $container_or_config = null, Locat
 	 */
 	public function createDecorator(ISearchContext $search_context)
 	{
-		$locator_factory = new BEMElementLocatorFactory($search_context, $this->_locatorHelper);
+		$locator_factory = new BEMElementLocatorFactory(
+			$search_context,
+			$this->seleniumSelector,
+			$this->_locatorHelper
+		);
 
 		return new BEMPropertyDecorator($locator_factory, $this);
 	}

diff --git a/library/QATools/QATools/BEM/Element/Block.php b/library/QATools/QATools/BEM/Element/Block.php
@@ -37,6 +37,13 @@ class Block extends AbstractPart implements IBlock
 	 */
 	private $_locator;
 
+	/**
+	 * Page factory.
+	 *
+	 * @var IPageFactory
+	 */
+	private $_pageFactory;
+
 	/**
 	 * Create instance of BEM block.
 	 *
@@ -51,6 +58,7 @@ public final function __construct($name, array $nodes, IPageFactory $page_factor
 
 		$this->_nodes = $nodes;
 		$this->_locator = $locator;
+		$this->_pageFactory = $page_factory;
 
 		$page_factory->initElements($this, $page_factory->createDecorator($this));
 	}
@@ -99,7 +107,11 @@ public function getElements($element_name, $modificator_name = null, $modificato
 			$modificator_value
 		);
 
-		return $this->findAll('se', $locator);
+		$how = key($locator);
+		$using = $locator[$how];
+		$xpath = $this->_pageFactory->translateToXPath($how, $using);
+
+		return $this->findAll('xpath', $xpath);
 	}
 
 	/**

diff --git a/library/QATools/QATools/BEM/ElementLocator/BEMElementLocator.php b/library/QATools/QATools/BEM/ElementLocator/BEMElementLocator.php
@@ -17,6 +17,7 @@
 use QATools\QATools\PageObject\Exception\AnnotationException;
 use QATools\QATools\PageObject\ISearchContext;
 use QATools\QATools\PageObject\Property;
+use QATools\QATools\PageObject\SeleniumSelector;
 
 /**
  * Locates BEM blocks/elements.
@@ -36,16 +37,18 @@ class BEMElementLocator extends DefaultElementLocator
 	/**
 	 * Creates a new element locator.
 	 *
-	 * @param Property       $property       Property.
-	 * @param ISearchContext $search_context The context to use when finding the element.
-	 * @param LocatorHelper  $locator_helper Locator helper.
+	 * @param Property         $property          Property.
+	 * @param ISearchContext   $search_context    The context to use when finding the element.
+	 * @param SeleniumSelector $selenium_selector Selenium selector.
+	 * @param LocatorHelper    $locator_helper    Locator helper.
 	 */
 	public function __construct(
 		Property $property,
 		ISearchContext $search_context,
+		SeleniumSelector $selenium_selector,
 		LocatorHelper $locator_helper
 	) {
-		parent::__construct($property, $search_context);
+		parent::__construct($property, $search_context, $selenium_selector);
 
 		$this->_helper = $locator_helper;
 	}

diff --git a/library/QATools/QATools/BEM/ElementLocator/BEMElementLocatorFactory.php b/library/QATools/QATools/BEM/ElementLocator/BEMElementLocatorFactory.php
@@ -15,6 +15,7 @@
 use QATools\QATools\PageObject\ElementLocator\IElementLocator;
 use QATools\QATools\PageObject\ISearchContext;
 use QATools\QATools\PageObject\Property;
+use QATools\QATools\PageObject\SeleniumSelector;
 
 /**
  * Factory to create BEM block/element locators.
@@ -34,14 +35,16 @@ class BEMElementLocatorFactory extends DefaultElementLocatorFactory
 	/**
 	 * Create locator factory instance.
 	 *
-	 * @param ISearchContext $search_context Search context.
-	 * @param LocatorHelper  $locator_helper Locator helper.
+	 * @param ISearchContext   $search_context    Search context.
+	 * @param SeleniumSelector $selenium_selector Selenium selector.
+	 * @param LocatorHelper    $locator_helper    Locator helper.
 	 */
 	public function __construct(
 		ISearchContext $search_context,
+		SeleniumSelector $selenium_selector,
 		LocatorHelper $locator_helper
 	) {
-		parent::__construct($search_context);
+		parent::__construct($search_context, $selenium_selector);
 		$this->_locatorHelper = $locator_helper;
 	}
 
@@ -54,7 +57,7 @@ public function __construct(
 	 */
 	public function createLocator(Property $property)
 	{
-		return new BEMElementLocator($property, $this->searchContext, $this->_locatorHelper);
+		return new BEMElementLocator($property, $this->searchContext, $this->seleniumSelector, $this->_locatorHelper);
 	}
 
 }
diff --git a/library/QATools/QATools/HtmlElements/Element/Select.php b/library/QATools/QATools/HtmlElements/Element/Select.php
@@ -47,7 +47,12 @@ public function isMultiple()
 	 */
 	public function getOptions()
 	{
-		return $this->wrapOptions($this->getWrappedElement()->findAll('se', array(How::TAG_NAME => 'option')));
+		return $this->wrapOptions(
+			$this->getWrappedElement()->findAll(
+				'xpath',
+				$this->getPageFactory()->translateToXPath(How::TAG_NAME, 'option')
+			)
+		);
 	}
 
 	/**

diff --git a/library/QATools/QATools/HtmlElements/TypifiedPageFactory.php b/library/QATools/QATools/HtmlElements/TypifiedPageFactory.php
@@ -49,7 +49,7 @@ public function __construct(Session $session, $container_or_config = null)
 	 */
 	public function createDecorator(ISearchContext $search_context)
 	{
-		$locator_factory = new DefaultElementLocatorFactory($search_context);
+		$locator_factory = new DefaultElementLocatorFactory($search_context, $this->seleniumSelector);
 
 		return new TypifiedPropertyDecorator($locator_factory, $this);
 	}

diff --git a/library/QATools/QATools/PageObject/Container.php b/library/QATools/QATools/PageObject/Container.php
@@ -77,6 +77,10 @@ public function __construct(array $values = array())
 
 			return $page_url_matcher_registry;
 		};
+
+		$this['selenium_selector'] = function () {
+			return new SeleniumSelector();
+		};
 	}
 
 }
diff --git a/library/QATools/QATools/PageObject/ElementLocator/DefaultElementLocator.php b/library/QATools/QATools/PageObject/ElementLocator/DefaultElementLocator.php
@@ -17,6 +17,7 @@
 use QATools\QATools\PageObject\Exception\ElementException;
 use QATools\QATools\PageObject\ISearchContext;
 use QATools\QATools\PageObject\Property;
+use QATools\QATools\PageObject\SeleniumSelector;
 
 /**
  * Class, that locates WebElements.
@@ -40,16 +41,28 @@ class DefaultElementLocator implements IElementLocator
 	 */
 	protected $property;
 
+	/**
+	 * Selenium selector.
+	 *
+	 * @var SeleniumSelector
+	 */
+	protected $seleniumSelector;
+
 	/**
 	 * Creates a new element locator.
 	 *
-	 * @param Property       $property       Property.
-	 * @param ISearchContext $search_context The context to use when finding the element.
+	 * @param Property         $property          Property.
+	 * @param ISearchContext   $search_context    The context to use when finding the element.
+	 * @param SeleniumSelector $selenium_selector Selenium selector.
 	 */
-	public function __construct(Property $property, ISearchContext $search_context)
-	{
+	public function __construct(
+		Property $property,
+		ISearchContext $search_context,
+		SeleniumSelector $selenium_selector
+	) {
 		$this->property = $property;
 		$this->searchContext = $search_context;
+		$this->seleniumSelector = $selenium_selector;
 	}
 
 	/**
@@ -85,7 +98,11 @@ public function findAll()
 		$elements = array();
 
 		foreach ( $this->getSelectors() as $selector ) {
-			$elements = array_merge($elements, $this->searchContext->findAll('se', $selector));
+			$how = key($selector);
+			$using = $selector[$how];
+			$xpath = $this->seleniumSelector->translateToXPath($how, $using);
+
+			$elements = array_merge($elements, $this->searchContext->findAll('xpath', $xpath));
 		}
 
 		$element_count = count($elements);
@@ -164,7 +181,7 @@ public function __toString()
 		$selectors = $this->getSelectors();
 
 		foreach ( $selectors as $selector ) {
-			$exported_selectors[] = array('se' => $selector);
+			$exported_selectors[] = $selector;
 		}
 
 		return var_export($exported_selectors, true);

diff --git a/library/QATools/QATools/PageObject/ElementLocator/DefaultElementLocatorFactory.php b/library/QATools/QATools/PageObject/ElementLocator/DefaultElementLocatorFactory.php
@@ -13,6 +13,7 @@
 
 use QATools\QATools\PageObject\ISearchContext;
 use QATools\QATools\PageObject\Property;
+use QATools\QATools\PageObject\SeleniumSelector;
 
 /**
  * Factory, that creates locators for finding WebElements.
@@ -29,14 +30,23 @@ class DefaultElementLocatorFactory implements IElementLocatorFactory
 	 */
 	protected $searchContext;
 
+	/**
+	 * Selenium selector.
+	 *
+	 * @var SeleniumSelector
+	 */
+	protected $seleniumSelector;
+
 	/**
 	 * Create locator factory instance.
 	 *
-	 * @param ISearchContext $search_context Search context.
+	 * @param ISearchContext   $search_context    Search context.
+	 * @param SeleniumSelector $selenium_selector Selenium selector.
 	 */
-	public function __construct(ISearchContext $search_context)
+	public function __construct(ISearchContext $search_context, SeleniumSelector $selenium_selector)
 	{
 		$this->searchContext = $search_context;
+		$this->seleniumSelector = $selenium_selector;
 	}
 
 	/**
@@ -48,7 +58,7 @@ public function __construct(ISearchContext $search_context)
 	 */
 	public function createLocator(Property $property)
 	{
-		return new WaitingElementLocator($property, $this->searchContext);
+		return new WaitingElementLocator($property, $this->searchContext, $this->seleniumSelector);
 	}
 
 }
diff --git a/library/QATools/QATools/PageObject/ElementLocator/WaitingElementLocator.php b/library/QATools/QATools/PageObject/ElementLocator/WaitingElementLocator.php
@@ -15,6 +15,7 @@
 use QATools\QATools\PageObject\Annotation\TimeoutAnnotation;
 use QATools\QATools\PageObject\ISearchContext;
 use QATools\QATools\PageObject\Property;
+use QATools\QATools\PageObject\SeleniumSelector;
 
 /**
  * Class, that locates WebElements that might not be present at the moment.
@@ -34,12 +35,16 @@ class WaitingElementLocator extends DefaultElementLocator
 	/**
 	 * Creates a new element locator.
 	 *
-	 * @param Property       $property       Property.
-	 * @param ISearchContext $search_context The context to use when finding the element.
+	 * @param Property         $property          Property.
+	 * @param ISearchContext   $search_context    The context to use when finding the element.
+	 * @param SeleniumSelector $selenium_selector Selenium selector.
 	 */
-	public function __construct(Property $property, ISearchContext $search_context)
-	{
-		parent::__construct($property, $search_context);
+	public function __construct(
+		Property $property,
+		ISearchContext $search_context,
+		SeleniumSelector $selenium_selector
+	) {
+		parent::__construct($property, $search_context, $selenium_selector);
 
 		/** @var TimeoutAnnotation[] $annotations */
 		$annotations = $property->getAnnotationsFromPropertyOrClass('@timeout');

diff --git a/library/QATools/QATools/PageObject/IPageFactory.php b/library/QATools/QATools/PageObject/IPageFactory.php
@@ -85,4 +85,14 @@ public function getPage($class_name);
 	 */
 	public function opened(Page $page);
 
+	/**
+	 * Translates provided how/using combo into XPath.
+	 *
+	 * @param string $how   How class constant.
+	 * @param string $using Using value.
+	 *
+	 * @return string
+	 */
+	public function translateToXPath($how, $using);
+
 }
diff --git a/library/QATools/QATools/PageObject/PageFactory.php b/library/QATools/QATools/PageObject/PageFactory.php
@@ -87,6 +87,13 @@ class PageFactory implements IPageFactory
 	 */
 	protected $pageUrlMatcherRegistry;
 
+	/**
+	 * Selenium selector.
+	 *
+	 * @var SeleniumSelector
+	 */
+	protected $seleniumSelector;
+
 	/**
 	 * The current config.
 	 *
@@ -118,14 +125,15 @@ public function __construct(Session $session, $container_or_config = null)
 			$container_or_config = $this->_createContainer();
 		}
 
-		$this->_setSession($session);
+		$this->_session = $session;
 		$this->config = $container_or_config['config'];
 
 		$this->_setAnnotationManager($container_or_config['annotation_manager']);
 		$this->urlFactory = $container_or_config['url_factory'];
 		$this->urlNormalizer = $container_or_config['url_normalizer'];
 		$this->pageLocator = $container_or_config['page_locator'];
 		$this->pageUrlMatcherRegistry = $container_or_config['page_url_matcher_registry'];
+		$this->seleniumSelector = $container_or_config['selenium_selector'];
 	}
 
 	/**
@@ -173,31 +181,11 @@ private function _setAnnotationManager(AnnotationManager $manager)
 	 */
 	public function createDecorator(ISearchContext $search_context)
 	{
-		$locator_factory = new DefaultElementLocatorFactory($search_context);
+		$locator_factory = new DefaultElementLocatorFactory($search_context, $this->seleniumSelector);
 
 		return new DefaultPropertyDecorator($locator_factory, $this);
 	}
 
-	/**
-	 * Sets session.
-	 *
-	 * @param Session $session Session.
-	 *
-	 * @return self
-	 */
-	private function _setSession(Session $session)
-	{
-		$selectors_handler = $session->getSelectorsHandler();
-
-		if ( !$selectors_handler->isSelectorRegistered('se') ) {
-			$selectors_handler->registerSelector('se', new SeleniumSelector());
-		}
-
-		$this->_session = $session;
-
-		return $this;
-	}
-
 	/**
 	 * Returns session.
 	 *
@@ -326,4 +314,17 @@ public function getPage($class_name)
 		return new $resolved_page_class($this);
 	}
 
+	/**
+	 * Translates provided how/using combo into XPath.
+	 *
+	 * @param string $how   How class constant.
+	 * @param string $using Using value.
+	 *
+	 * @return string
+	 */
+	public function translateToXPath($how, $using)
+	{
+		return $this->seleniumSelector->translateToXPath($how, $using);
+	}
+
 }