Page\TextEditorPage

Complexity

Total Complexity

14

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	0

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	typeInFieldAndPressEnter()	0	15	2
B	createTextFile()	0	51	6
A	findTextFileEditField()	0	9	2
A	typeIntoTextFile()	0	4	1
A	closeTheTextEditor()	0	9	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\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 $textFileEditXpath = "//textarea[contains(@class,'ace_text-input')]";
	protected $textEditorCloseButtonId = "editor_close";

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

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

		$keys = preg_split('//u', $text, null, PREG_SPLIT_NO_EMPTY);
		$keys[] = Key::ENTER;
		$element->postValue(array('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->typeInFieldAndPressEnter(
					$this->newTextFileNameInputXpath,
					$name,
					$session
				);
			} else {
				try {
					$this->fillField($this->newTextFileNameInputLabel, $name . "\n");
				} catch (\WebDriver\Exception\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
				}
			}
		} else {
			$this->typeInFieldAndPressEnter(
				$this->newTextFileNameInputXpath,
				'',
				$session
			);
		}
	}

	/**
	 * finds the textarea field to use for editing a text file
	 *
	 * @throws ElementNotFoundException
	 * @return \Behat\Mink\Element\NodeElement
	 */
	public function findTextFileEditField() {
		$textField = $this->find(
			"xpath", $this->textFileEditXpath
		);
		if ($textField === null) {
			throw new ElementNotFoundException("could not find textarea field");
		}
		return $textField;
	}

	/**
	 * type text into the text area
	 *
	 * @param string $text
	 * @return void
	 */
	public function typeIntoTextFile($text) {
		$textField = $this->findTextFileEditField();
		$textField->setValue($text);
	}

	/**
	 *
	 * @throws ElementNotFoundException
	 * @return void
	 */
	public function closeTheTextEditor() {
		$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);
	}

}