Changed @wait to @Waituntil and replaced enumeration with class reference in order to be more extendable

Author: slu-it

documentation/README.md

@@ -17,7 +17,7 @@
   - [@Must](chapters/annotation-must.md)
   - [@Named](chapters/annotation-named.md)
   - [@PostConstruct](chapters/annotation-post-construct.md)
-  - [@Wait](chapters/annotation-wait.md)
+  - [@Wait](chapters/annotation-wait-until.md)
 - Utility Classes
   - [Conditions](chapters/conditions.md)
   - [ByProducers](chapters/by-producers.md)

documentation/chapters/annotation-must.md

@@ -48,19 +48,19 @@ public interface FooWidget extends PageFragment {
 }
 ```
 
-## Combination with @Wait
+## Combination with @WaitUntil
 
-The `@Must` annotation can be used in combination with `@Wait`. This is especially useful in AJAX heavy applications where
-a fragment might be created with a short delay.
+The `@Must` annotation can be used in combination with `WaitUntil`. This is especially useful in AJAX heavy applications
+where a fragment might be created with a short delay.
 
 **Example:**
-In this example the `widget` is checked as soon as `BarPage` is initialized. But `@Wait` will be triggered when invoking 
+In this example the `widget` is checked as soon as `BarPage` is initialized. But `WaitUntil` will be triggered when invoking 
 the method assuring that the widget is present before checking if it is visible.
 ```java
 public interface BarPage extends Page {
 
     @Must(Be.VISIBLE)
-    @Wait(Until.PRESENT)
+    WaitUntil(Present.class)
     @IdentifyUsing("#bar")
     BarWidget widget();
 
@@ -74,4 +74,4 @@ public interface BarPage extends Page {
 - [Pages](page.md)
 - [Page Fragments](page-fragment.md)
 - [@PostConstruct](annotation-post-construct.md)
-- [@Wait](annotation-wait.md)
+- [@WaitUntil](annotation-wait-until.md)

documentation/chapters/annotation-wait.md renamed to documentation/chapters/annotation-wait-until.md

@@ -1,25 +1,22 @@
 [Home](../README.md)
 
-# @Wait
+# @WaitUntil
 This annotation can be added to `@IdentifyUsing` annotated methods of `Page` or `PageFragment` subclasses.
 When the annotated method is invoked a 'wait until' operation is executed using the annotations condition.
+The condition is provided via a class reference in order to support custom conditions. See [Conditions](conditions.md) for
+a set of provided page fragment related predicates.
 
-> Collection and Streams are currently NOT supported!
-
-**The following conditions are available:**
+It is important to note that not all Predicate classes will work with this annotation.
+The mechanism with which the predicate is evaluated will initialize the given class via reflection
+and needs a default constructor to work!
 
-- `VISIBLE`: The fragment is displayed on the current page.
-- `PRESENT`: The fragment is present in the current page's DOM.
-- `PRESENT_AND_VISIBLE`: The fragment is present in the current page's DOM and is displayed.
-- `ENABLED`: The fragment is enabled / not disabled.
-- `EDITABLE`: The fragment is enabled and not 'read-only'
-- `INTERACTABLE`: The fragment is visible and editable.
+> Collection and Streams are currently NOT supported!
 
 **Example for page:**
 ```java
 public interface FooPage extends Page {
 
-    @Wait(Until.VISIBLE)
+    @WaitUntil(Visible.class)
     @IdentifyUsing("#foo")
     FooWidget widget();
 
@@ -32,11 +29,11 @@ public interface FooPage extends Page {
 ```java
 public interface FooWidget extends PageFragment {
 
-    @Wait(Until.VISIBLE)
+    @WaitUntil(Visible.class)
     @IdentifyUsing("#one")
     TextField fieldOne();
 
-    @Wait(Until.VISIBLE)
+    @WaitUntil(Visible.class)
     @IdentifyUsing("#two")
     TextField fieldTwo();
 
@@ -49,3 +46,4 @@ public interface FooWidget extends PageFragment {
 
 - [Pages](page.md)
 - [Page Fragments](page-fragment.md)
+- [Conditions](conditions.md)

documentation/chapters/page-fragment.md

@@ -96,7 +96,7 @@ These annotations can be used within a `PageFragment`.
 - [@Must](annotation-must.md)
 - [@Named](annotation-named.md)
 - [@PostConstruct](annotation-post-construct.md)
-- [@Wait](annotation-wait.md)
+- [@WaitUntil](annotation-wait-until.md)
 
 # Linked Documentation
 

documentation/chapters/page.md

@@ -98,7 +98,7 @@ These annotations can be used within a `Page`.
 - [@Must](annotation-must.md)
 - [@Named](annotation-named.md)
 - [@PostConstruct](annotation-post-construct.md)
-- [@Wait](annotation-wait.md)
+- [@WaitUntil](annotation-wait-until.md)
 
 # Anatomy of a Page 
 Pages generally provide four kinds of methods:

webtester-core/src/main/java/info/novatec/testit/webtester/internal/proxies/impls/IdentifyUsingImpl.java

@@ -11,19 +11,24 @@
 import info.novatec.testit.webtester.browser.Browser;
 import info.novatec.testit.webtester.config.Configuration;
 import info.novatec.testit.webtester.internal.PageFragmentFactory;
+import info.novatec.testit.webtester.internal.exceptions.IllegalSignatureException;
 import info.novatec.testit.webtester.internal.proxies.PageFragmentModel;
 import info.novatec.testit.webtester.internal.proxies.PageFragmentModel.PageFragmentModelBuilder;
 import info.novatec.testit.webtester.pagefragments.PageFragment;
 import info.novatec.testit.webtester.pagefragments.annotations.Cached;
 import info.novatec.testit.webtester.pagefragments.annotations.IdentifyUsing;
 import info.novatec.testit.webtester.pagefragments.annotations.Named;
+import info.novatec.testit.webtester.pagefragments.annotations.WaitUntil;
 import info.novatec.testit.webtester.pagefragments.identification.ByProducers;
-import info.novatec.testit.webtester.pagefragments.annotations.Wait;
+import info.novatec.testit.webtester.waiting.Wait;
 
 
 @Slf4j
 public class IdentifyUsingImpl implements Implementation {
 
+    public static final String COULD_NOT_CREATE_PREDICATE_INSTANCE_MSG =
+        "Could not create Predicate instance! Default constructor might be missing";
+
     private static final String IDENTIFIED_BY_NAME = "%s identified by %s: %s";
 
     private final Browser browser;
@@ -70,13 +75,26 @@ public PageFragment invoke(Object proxy, Method method, Object[] args) throws Th
         }
 
         PageFragment pageFragment = factory.pageFragment(modelBuilder.build());
-        if (method.isAnnotationPresent(Wait.class)) {
-            method.getAnnotation(Wait.class).value().waitWith(pageFragment);
-        }
+        waitIfAnnotationPresent(method, pageFragment);
         return pageFragment;
 
     }
 
+    private void waitIfAnnotationPresent(Method method, PageFragment fragment) {
+        WaitUntil waitAnnotation = method.getAnnotation(WaitUntil.class);
+        if (method.isAnnotationPresent(WaitUntil.class)) {
+            doWaitUntil(waitAnnotation, fragment);
+        }
+    }
+
+    private void doWaitUntil(WaitUntil waitAnnotation, PageFragment fragment) {
+        try {
+            Wait.until(fragment).is(waitAnnotation.value().newInstance());
+        } catch (InstantiationException | IllegalAccessException e) {
+            throw new IllegalSignatureException(COULD_NOT_CREATE_PREDICATE_INSTANCE_MSG, e);
+        }
+    }
+
     @SuppressWarnings("unchecked")
     private Class<? extends PageFragment> getReturnType(Method method) {
         return ( Class<? extends PageFragment> ) method.getReturnType();

webtester-core/src/main/java/info/novatec/testit/webtester/pagefragments/annotations/Until.java

@@ -0,0 +1,68 @@
+package info.novatec.testit.webtester.pagefragments.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import java.util.function.Predicate;
+
+import info.novatec.testit.webtester.conditions.Conditions;
+import info.novatec.testit.webtester.conditions.pagefragments.Disabled;
+import info.novatec.testit.webtester.conditions.pagefragments.Editable;
+import info.novatec.testit.webtester.conditions.pagefragments.Enabled;
+import info.novatec.testit.webtester.conditions.pagefragments.Interactable;
+import info.novatec.testit.webtester.conditions.pagefragments.Invisible;
+import info.novatec.testit.webtester.conditions.pagefragments.Present;
+import info.novatec.testit.webtester.conditions.pagefragments.PresentAndVisible;
+import info.novatec.testit.webtester.conditions.pagefragments.ReadOnly;
+import info.novatec.testit.webtester.conditions.pagefragments.Selected;
+import info.novatec.testit.webtester.conditions.pagefragments.Visible;
+import info.novatec.testit.webtester.pagefragments.PageFragment;
+import info.novatec.testit.webtester.pages.Page;
+
+
+/**
+ * Identification methods of {@link Page pages} and {@link PageFragment page fragments} can be annotation with this
+ * annotation. With it the framework will wait until the specified {@link #value() predicate} returns true or the timeout is
+ * reached.
+ * <p>
+ * <b>Important:</b> The used predicate class must provide a default constructor! Hence not all of our provided {@link
+ * Conditions} will work. The following conditions can be used:
+ * <ul>
+ * <li>{@link Disabled}</li>
+ * <li>{@link Editable}</li>
+ * <li>{@link Enabled}</li>
+ * <li>{@link Interactable}</li>
+ * <li>{@link Invisible}</li>
+ * <li>{@link Present}</li>
+ * <li>{@link PresentAndVisible}</li>
+ * <li>{@link ReadOnly}</li>
+ * <li>{@link Selected}</li>
+ * <li>{@link Visible}</li>
+ * </ul>
+ * <p>
+ * <b>Example:</b>
+ * <pre>
+ * &#64;WaitUntil(Visible.class)
+ * &#64;IdentifyUsing("#username")
+ * TextField username();
+ * </pre>
+ *
+ * @see WaitUntil
+ * @since 2.0
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface WaitUntil {
+
+    /**
+     * The until predicate to use for the wait operation.
+     *
+     * @return the until predicate to use
+     * @since 2.0
+     */
+    Class<? extends Predicate<PageFragment>> value();
+
+    // TODO: timeout
+
+}

webtester-core/src/main/java/info/novatec/testit/webtester/pagefragments/annotations/Wait.java

@@ -5,17 +5,17 @@
 
 import integration.BaseIntegrationTest;
 
+import info.novatec.testit.webtester.conditions.pagefragments.PresentAndVisible;
 import info.novatec.testit.webtester.internal.must.MustConditionException;
 import info.novatec.testit.webtester.pagefragments.Button;
 import info.novatec.testit.webtester.pagefragments.annotations.Be;
 import info.novatec.testit.webtester.pagefragments.annotations.IdentifyUsing;
 import info.novatec.testit.webtester.pagefragments.annotations.Must;
-import info.novatec.testit.webtester.pagefragments.annotations.Until;
-import info.novatec.testit.webtester.pagefragments.annotations.Wait;
+import info.novatec.testit.webtester.pagefragments.annotations.WaitUntil;
 import info.novatec.testit.webtester.pages.Page;
 
 
-public class MustWithWaitFeatureTest extends BaseIntegrationTest {
+public class MustWithWaitUntilFeatureTest extends BaseIntegrationTest {
 
     @Before
     public void openPage() {
@@ -42,7 +42,7 @@ public void demonstrateFailingMustBeBehaviour() {
     public interface PassingFeaturePage extends Page {
 
         @Must(Be.VISIBLE)
-        @Wait(Until.PRESENT_AND_VISIBLE)
+        @WaitUntil(PresentAndVisible.class)
         @IdentifyUsing("#button")
         Button button();