TextEditorPage::closeTheTextEditor() - Code Metrics - Inspection of "Check CI" - owncloud/files_texteditor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#237)

by Phil

created 2018-07-24 10:18 UTC

TextEditorPage::closeTheTextEditor() A

↳ Parent: Project

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
dl	0
loc	11
rs	9.4285
c	2
b	0
f	0
cc	2
eloc	7
nc	2
nop	1

<?php
/**
 * ownCloud
 *
 * @author Phillip Davis <[email protected]>
 * @copyright 2017 Phillip Davis [email protected]
 *
 * 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 (is_null($element)) {
			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(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->typeInField(
					$session,
					$this->newTextFileNameInputXpath,
					$name,
					true
				);
			} else {
				try {
					$this->fillField($this->newTextFileNameInputLabel, $name . "\n");
				} catch (NoSuchElement $e) {
					// 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) {
					// 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);
	}

}

1			<?php
2			/**
3			* ownCloud
4			*
5			* @author Phillip Davis <[email protected]>
6			* @copyright 2017 Phillip Davis [email protected]
7			*
8			* This library is free software; you can redistribute it and/or
9			* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
10			* License as published by the Free Software Foundation; either
11			* version 3 of the License, or any later version.
12			*
13			* This library is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
17			*
18			* You should have received a copy of the GNU Affero General Public
19			* License along with this library. If not, see <http://www.gnu.org/licenses/>.
20			*
21			*/
22
23			namespace Page;
24
25			use Behat\Mink\Session;
26			use SensioLabs\Behat\PageObjectExtension\PageObject\Exception\ElementNotFoundException;
27			use WebDriver\Exception\NoSuchElement;
28			use WebDriver\Exception\StaleElementReference;
29			use WebDriver\Key;
30
31			/**
32			* Text Editor page.
33			*/
34			class TextEditorPage extends FilesPage {
35			protected $newTextFileButtonXpath
36			= './/div[contains(@class, "newFileMenu")]' .
37			'//a[@data-templatename="New text file.txt"]';
38			protected $newTextFileNameInputLabel = 'New text file.txt';
39			protected $newTextFileNameInputXpath
40			= './/div[contains(@class, "newFileMenu")]' .
41			'//a[@data-templatename="New text file.txt"]//input';
42			protected $newTextFileTooltipXpath = ".//*[@class='tooltip-inner']";
43			protected $textFileEditXpath = "//textarea[contains(@class,'ace_text-input')]";
44			protected $textFileTextLayerXpath = "//div[contains(@class,'ace_text-layer')]";
45			protected $textFileLineXpath = ".//div[@class='ace_line']";
46			protected $textEditorCloseButtonId = "editor_close";
47
48			/**
49			* type in the field that matches the given xpath and optionally press enter.
50			* Note: this depends on methods that might only be in the Selenium
51			* implementation
52			*
53			* @param Session $session
54			* @param string $xpath
55			* @param string $text
56			* @param bool $pressEnter
57			*
58			* @throws ElementNotFoundException
59			* @return void
60			*/
61			public function typeInField(
62			Session $session,
63			$xpath,
64			$text,
65			$pressEnter = false
66			) {
67			$element = $session->getDriver()->getWebDriverSession()->element(
68			"xpath", $xpath
69			);
70
71			if (is_null($element)) {
72			throw new ElementNotFoundException(
73			"could not find element with xpath '" . $xpath . "'"
74			);
75			}
76
77			$keys = preg_split('//u', $text, null, PREG_SPLIT_NO_EMPTY);
78			if ($pressEnter) {
79			$keys[] = Key::ENTER;
80			}
81			$element->postValue(array('value' => $keys));
82			}
83
84			/**
85			* create a text file with the given name.
86			* If name is not given the default is used.
87			* If $useDefaultFileExtension is true, then only the name is entered and the
88			* file extension is the default given by the application.
89			*
90			* @param Session $session
91			* @param string $name
92			* @param boolean $useDefaultFileExtension
93			*
94			* @return void
95			*/
96			public function createTextFile(
97			Session $session,
98			$name = null,
99			$useDefaultFileExtension = false
100			) {
101			$newFileFolderButton
102			= $this->find("xpath", $this->newFileFolderButtonXpath);
103
104			if ($newFileFolderButton === null) {
105			throw new ElementNotFoundException(
106			"could not find new file/folder button"
107			);
108			}
109
110			$newFileFolderButton->click();
111
112			$newTextFileButton = $this->find("xpath", $this->newTextFileButtonXpath);
113
114			if ($newTextFileButton === null) {
115			throw new ElementNotFoundException(
116			"could not find new text file button"
117			);
118			}
119
120			$newTextFileButton->click();
121
122			if (strlen($name)) {
123			if ($useDefaultFileExtension) {
124			$this->typeInField(
125			$session,
126			$this->newTextFileNameInputXpath,
127			$name,
128			true
129			);
130			} else {
131			try {
132			$this->fillField($this->newTextFileNameInputLabel, $name . "\n");
133			} catch (NoSuchElement $e) {
134			// this seems to be a bug in MinkSelenium2Driver.
135			// used to work fine in 1.3.1 but now throws this exception
136			// actually all that we need does happen,
137			// so we just don't do anything
138			} catch (StaleElementReference $e) {
139			// At the end of processing setValue, MinkSelenium2Driver tries to blur
140			// away from the element. But we pressed enter which has already
141			// made the element go away. So we do not care about this exception.
142			// This issue started happening due to:
143			// https://github.com/minkphp/MinkSelenium2Driver/pull/286
144			}
145			}
146			}
147			} else {
			0 ignored issues – show Bug introduced 2018-07-24 10:21 UTC by Report Bug Copy Issue Report This code did not parse for me. Apparently, there is an error somewhere around this line: Syntax error, unexpected T_ELSE, expecting T_FUNCTION or T_CONST Loading history...
148			$this->typeInField(
149			$session,
150			$this->newTextFileNameInputXpath,
151			'',
152			true
153			);
154			}
155
156			$this->waitForAjaxCallsToStartAndFinish($session);
157			}
158
159			/**
160			* returns the tooltip that is displayed next to the new text file name box
161			*
162			* @return string
163			*/
164			public function getTooltipOfNewTextFileBox() {
165			$newTextFileTooltip = $this->find("xpath", $this->newTextFileTooltipXpath);
166
167			if ($newTextFileTooltip === null) {
168			throw new ElementNotFoundException(
169			"could not find new text file box tooltip"
170			);
171			}
172
173			return $newTextFileTooltip->getText();
174			}
175
176			/**
177			* type text into the text area
178			*
179			* @param Session $session
180			* @param string $text
181			*
182			* @return void
183			*/
184			public function typeIntoTextFile(
185			Session $session,
186			$text
187			) {
188			$this->typeInField(
189			$session,
190			$this->textFileEditXpath,
191			$text
192			);
193			}
194
195			/**
196			* get the content of the open text file
197			*
198			* @return array of lines of text
199			*/
200			public function textFileContent() {
201			$textLayer = $this->find("xpath", $this->textFileTextLayerXpath);
202			if ($textLayer === null) {
203			throw new ElementNotFoundException("could not find text layer");
204			}
205			$textLineElements = $textLayer->findAll(
206			"xpath", $this->textFileLineXpath
207			);
208			if ($textLineElements === null) {
209			throw new ElementNotFoundException("could not find text lines");
210			}
211			$textLines = [];
212			foreach ($textLineElements as $textLineElement) {
213			$textLines[] = $textLineElement->getText();
214			}
215			return $textLines;
216			}
217
218			/**
219			*
220			* @param Session $session
221			*
222			* @throws ElementNotFoundException
223			* @return void
224			*/
225			public function closeTheTextEditor(Session $session) {
226			$this->waitForAjaxCallsToStartAndFinish($session);
227
228			$closeButton = $this->findById($this->textEditorCloseButtonId);
229			if ($closeButton === null) {
230			throw new ElementNotFoundException(
231			"could not find text editor close button"
232			);
233			}
234			$closeButton->click();
235			}
236
237			/**
238			* @param int $timeout_msec
239			*
240			* @return void
241			*/
242			public function waitTillEditorIsLoaded(
243			$timeout_msec = STANDARDUIWAITTIMEOUTMILLISEC
244			) {
245			$this->waitTillElementIsNotNull($this->textFileEditXpath, $timeout_msec);
246			}
247
248			}

owncloud / files_texteditor

Pull Request — master (#237)

TextEditorPage::closeTheTextEditor() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like