Page\TextEditorPage

Complexity

Total Complexity

20

Size/Duplication

Total Lines	214
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	0

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	typeInField()	0	22	3
B	createTextFile()	0	62	7
A	getTooltipOfNewTextFileBox()	0	11	2
A	typeIntoTextFile()	0	10	1
A	textFileContent()	0	17	4
A	closeTheTextEditor()	0	11	2
A	waitTillEditorIsLoaded()	0	5	1

<?php
/**
 * ownCloud
 *
 * @author Phillip Davis <phil@jankaritech.com>
 * @copyright 2017 Phillip Davis phil@jankaritech.com
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace Page;

use Behat\Mink\Session;
use SensioLabs\Behat\PageObjectExtension\PageObject\Exception\ElementNotFoundException;
use WebDriver\Exception\NoSuchElement;
use WebDriver\Exception\StaleElementReference;
use WebDriver\Key;

/**
 * Text Editor page.
 */
class TextEditorPage extends FilesPage {
	protected $newTextFileButtonXpath
		= './/div[contains(@class, "newFileMenu")]' .
			'//a[@data-templatename="New text file.txt"]';
	protected $newTextFileNameInputLabel = 'New text file.txt';
	protected $newTextFileNameInputXpath
		= './/div[contains(@class, "newFileMenu")]' .
			'//a[@data-templatename="New text file.txt"]//input';
	protected $newTextFileTooltipXpath = ".//*[@class='tooltip-inner']";
	protected $textFileEditXpath = "//textarea[contains(@class,'ace_text-input')]";
	protected $textFileTextLayerXpath = "//div[contains(@class,'ace_text-layer')]";
	protected $textFileLineXpath = ".//div[@class='ace_line']";
	protected $textEditorCloseButtonId = "editor_close";

	/**
	 * type in the field that matches the given xpath and optionally press enter.
	 * Note: this depends on methods that might only be in the Selenium
	 * implementation
	 *
	 * @param Session $session
	 * @param string $xpath
	 * @param string $text
	 * @param bool $pressEnter
	 *
	 * @throws ElementNotFoundException
	 * @return void
	 */
	public function typeInField(
		Session $session,
		$xpath,
		$text,
		$pressEnter = false
	) {
		$element = $session->getDriver()->getWebDriverSession()->element(
			"xpath", $xpath
		);

		if ($element === null) {
			throw new ElementNotFoundException(
				"could not find element with xpath '" . $xpath . "'"
			);
		}

		$keys = \preg_split('//u', $text, null, PREG_SPLIT_NO_EMPTY);
		if ($pressEnter) {
			$keys[] = Key::ENTER;
		}
		$element->postValue(['value' => $keys]);
	}

	/**
	 * create a text file with the given name.
	 * If name is not given the default is used.
	 * If $useDefaultFileExtension is true, then only the name is entered and the
	 * file extension is the default given by the application.
	 *
	 * @param Session $session
	 * @param string $name
	 * @param boolean $useDefaultFileExtension
	 *
	 * @return void
	 */
	public function createTextFile(
		Session $session,
		$name = null,
		$useDefaultFileExtension = false
	) {
		$newFileFolderButton
			= $this->find("xpath", $this->newFileFolderButtonXpath);

		if ($newFileFolderButton === null) {
			throw new ElementNotFoundException(
				"could not find new file/folder button"
			);
		}

		$newFileFolderButton->click();

		$newTextFileButton = $this->find("xpath", $this->newTextFileButtonXpath);

		if ($newTextFileButton === null) {
			throw new ElementNotFoundException(
				"could not find new text file button"
			);
		}

		$newTextFileButton->click();

		if (\strlen($name)) {
			if ($useDefaultFileExtension) {
				$this->typeInField(
					$session,
					$this->newTextFileNameInputXpath,
					$name,
					true
				);
			} else {
				try {
					$this->fillField($this->newTextFileNameInputLabel, $name . "\n");
				} catch (NoSuchElement $e) {

The class WebDriver\Exception\NoSuchElement does not exist. Did you forget a USE statement, or did you not list all dependencies?

					// this seems to be a bug in MinkSelenium2Driver.
					// used to work fine in 1.3.1 but now throws this exception
					// actually all that we need does happen,
					// so we just don't do anything
				} catch (StaleElementReference $e) {

The class WebDriver\Exception\StaleElementReference does not exist. Did you forget a USE statement, or did you not list all dependencies?

					// At the end of processing setValue, MinkSelenium2Driver
					// tries to blur away from the element. But we pressed
					// enter which has already made the element go away.
					// So we do not care about this exception.
					// This issue started happening due to:
					// https://github.com/minkphp/MinkSelenium2Driver/pull/286
				}
			}
		} else {
			$this->typeInField(
				$session,
				$this->newTextFileNameInputXpath,
				'',
				true
			);
		}

		$this->waitForAjaxCallsToStartAndFinish($session);
	}

	/**
	 * returns the tooltip that is displayed next to the new text file name box
	 *
	 * @return string
	 */
	public function getTooltipOfNewTextFileBox() {
		$newTextFileTooltip = $this->find("xpath", $this->newTextFileTooltipXpath);

		if ($newTextFileTooltip === null) {
			throw new ElementNotFoundException(
				"could not find new text file box tooltip"
			);
		}

		return $newTextFileTooltip->getText();
	}

	/**
	 * type text into the text area
	 *
	 * @param Session $session
	 * @param string $text
	 *
	 * @return void
	 */
	public function typeIntoTextFile(
		Session $session,
		$text
	) {
		$this->typeInField(
			$session,
			$this->textFileEditXpath,
			$text
		);
	}

	/**
	 * get the content of the open text file
	 *
	 * @return array of lines of text
	 */
	public function textFileContent() {
		$textLayer = $this->find("xpath", $this->textFileTextLayerXpath);
		if ($textLayer === null) {
			throw new ElementNotFoundException("could not find text layer");
		}
		$textLineElements = $textLayer->findAll(
			"xpath", $this->textFileLineXpath
		);
		if ($textLineElements === null) {
			throw new ElementNotFoundException("could not find text lines");
		}
		$textLines = [];
		foreach ($textLineElements as $textLineElement) {
			$textLines[] = $textLineElement->getText();
		}
		return $textLines;
	}

	/**
	 *
	 * @param Session $session
	 *
	 * @throws ElementNotFoundException
	 * @return void
	 */
	public function closeTheTextEditor(Session $session) {
		$this->waitForAjaxCallsToStartAndFinish($session);

		$closeButton = $this->findById($this->textEditorCloseButtonId);
		if ($closeButton === null) {
			throw new ElementNotFoundException(
				"could not find text editor close button"
			);
		}
		$closeButton->click();
	}

	/**
	 * @param int $timeout_msec
	 *
	 * @return void
	 */
	public function waitTillEditorIsLoaded(
		$timeout_msec = STANDARDUIWAITTIMEOUTMILLISEC
	) {
		$this->waitTillElementIsNotNull($this->textFileEditXpath, $timeout_msec);
	}
}