feat(functions): add .refresh() function

acdcjunior · acdcjunior · commit 673a17c96f67 · 2017-12-06T22:30:51.000-02:00
closes #185
diff --git a/src/main/java/io/github/seleniumquery/SeleniumQueryObject.java b/src/main/java/io/github/seleniumquery/SeleniumQueryObject.java
@@ -619,4 +619,13 @@ default <T> List<T> map(Function<? super WebElement, ? extends T> mapper) {
 	    return this.stream().map(mapper).collect(Collectors.toList());
     }
 
+	/**
+	 * Queries -- in-place -- the current seleniumQuery object again. Useful for dealing with fast-changing contexts or
+     * <b>removing stale element exceptions</b>.
+	 *
+	 * @return The same seleniumQuery object, now updated (with more or less elements).
+	 * @since 0.18.0
+     */
+	SeleniumQueryObject refresh();
+
 }
diff --git a/src/main/java/io/github/seleniumquery/internal/SqObject.java b/src/main/java/io/github/seleniumquery/internal/SqObject.java
@@ -75,7 +75,13 @@ class SqObject implements SeleniumQueryObject {
 		this.previous = previous;
 	}
 
-	@Override
+    @Override
+    public SeleniumQueryObject refresh() {
+        this.elements = ListUtils.toImmutableRandomAccessList(driver.findElements(by));
+        return this;
+    }
+
+    @Override
     public final SeleniumQueryFluentFunction waitUntil() {
 		return new SqFluentFunction(this, new FluentWaitUntil());
 	}
diff --git a/src/test/java/endtoend/functions/seleniumquery/RefreshFunctionTest.html b/src/test/java/endtoend/functions/seleniumquery/RefreshFunctionTest.html
@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<!--
+  ~ Copyright (c) 2017 seleniumQuery authors
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~    http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+
+<!--suppress HtmlFormInputWithoutLabel -->
+<html>
+<body>
+    <div id="d1">aaa</div>
+    <div id="d2">bbb</div>
+</body>
+</html>
diff --git a/src/test/java/endtoend/functions/seleniumquery/RefreshFunctionTest.java b/src/test/java/endtoend/functions/seleniumquery/RefreshFunctionTest.java
@@ -0,0 +1,28 @@
+package endtoend.functions.seleniumquery;
+
+import static io.github.seleniumquery.SeleniumQuery.$;
+
+import org.junit.ClassRule;
+import org.junit.Rule;
+import org.junit.Test;
+import org.openqa.selenium.JavascriptExecutor;
+
+import io.github.seleniumquery.SeleniumQueryObject;
+import testinfrastructure.junitrule.SetUpAndTearDownDriver;
+
+public class RefreshFunctionTest {
+
+    @ClassRule @Rule public static SetUpAndTearDownDriver setUpAndTearDownDriverRule = new SetUpAndTearDownDriver();
+
+    @Test
+    public void refresh__updates__size() {
+        SeleniumQueryObject sqo = $("div");
+        sqo.assertThat().size().isEqualTo(2);
+        ((JavascriptExecutor) $.driver().get()).executeScript("document.body.removeChild(document.getElementById('d2'))");
+        sqo.assertThat().size().isEqualTo(2);
+        $("div").assertThat().size().isEqualTo(1);
+        sqo.refresh().assertThat().size().isEqualTo(1);
+        sqo.assertThat().size().isEqualTo(1);
+    }
+
+}
diff --git a/src/test/java/testinfrastructure/testdouble/io/github/seleniumquery/SeleniumQueryObjectDummy.java b/src/test/java/testinfrastructure/testdouble/io/github/seleniumquery/SeleniumQueryObjectDummy.java
@@ -94,5 +94,6 @@ private SeleniumQueryObjectDummy() { }
     @Override public SeleniumQueryObject filter(String selector) { throw new PseudoTestDoubleException(); }
     @Override public SeleniumQueryObject each(EachFunction function) { throw new PseudoTestDoubleException(); }
     @Override public Stream<WebElement> stream() { throw new PseudoTestDoubleException(); }
+    @Override public SeleniumQueryObject refresh() { throw new PseudoTestDoubleException(); }
 
 }

Original file line number	Diff line number	Diff line change
`@@ -619,4 +619,13 @@ default <T> List<T> map(Function<? super WebElement, ? extends T> mapper) {`
`619`	`619`	`return this.stream().map(mapper).collect(Collectors.toList());`
`620`	`620`	`}`
`621`	`621`
	`622`	`+ /**`
	`623`	`+ * Queries -- in-place -- the current seleniumQuery object again. Useful for dealing with fast-changing contexts or`
	`624`	`+ * <b>removing stale element exceptions</b>.`
	`625`	`+ *`
	`626`	`+ * @return The same seleniumQuery object, now updated (with more or less elements).`
	`627`	`+ * @since 0.18.0`
	`628`	`+ */`
	`629`	`+ SeleniumQueryObject refresh();`
	`630`	`+`
`622`	`631`	`}`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,13 @@ class SqObject implements SeleniumQueryObject {`
`75`	`75`	`this.previous = previous;`
`76`	`76`	`}`
`77`	`77`
`78`		`- @Override`
	`78`	`+ @Override`
	`79`	`+ public SeleniumQueryObject refresh() {`
	`80`	`+ this.elements = ListUtils.toImmutableRandomAccessList(driver.findElements(by));`
	`81`	`+ return this;`
	`82`	`+ }`
	`83`	`+`
	`84`	`+ @Override`
`79`	`85`	`public final SeleniumQueryFluentFunction waitUntil() {`
`80`	`86`	`return new SqFluentFunction(this, new FluentWaitUntil());`
`81`	`87`	`}`
Original file line number	Diff line number	Diff line change
`@@ -94,5 +94,6 @@ private SeleniumQueryObjectDummy() { }`
`94`	`94`	`@Override public SeleniumQueryObject filter(String selector) { throw new PseudoTestDoubleException(); }`
`95`	`95`	`@Override public SeleniumQueryObject each(EachFunction function) { throw new PseudoTestDoubleException(); }`
`96`	`96`	`@Override public Stream<WebElement> stream() { throw new PseudoTestDoubleException(); }`
	`97`	`+ @Override public SeleniumQueryObject refresh() { throw new PseudoTestDoubleException(); }`
`97`	`98`
`98`	`99`	`}`