Simplyfy creation of PageObject instances and fix bug with changePageObjectType

Author: tobiasstamann

pogen4selenium-api/src/main/java/io/toolisticon/pogen4selenium/api/CommonParentInterface.java

@@ -4,6 +4,8 @@
 
 import org.openqa.selenium.WebDriver;
 
+import io.toolisticon.pogen4selenium.runtime.PageObjectUtilities;
+
 public interface CommonParentInterface {
 
 	/**
@@ -13,36 +15,18 @@ public interface CommonParentInterface {
 	WebDriver getDriver();
 
 	/**
-	 * Allows the creation of page object instances while using the fluent interface
-	 * @param <T>
-	 * @param pageObjectInterfaceType
-	 * @return
+	 * This method can be used to change the page object type.
+	 * This will be helpful if you encounter expected situations that differ from "happy path" like i.e. having a failing form validation.
+	 * @param <APO> the alternative page object type
 	 */
-	default <T extends PageObjectParent<T>> T getPageObjectInstance(Class<T> pageObjectInterfaceType) {
+	default <APO extends PageObjectParent<APO>> APO changePageObjectType(Class<APO> targetPageObjectType) {
 
-		return getPageObjectInstance(pageObjectInterfaceType, getDriver());
+		return PageObjectUtilities.getPageObjectInstance(targetPageObjectType, getDriver());
 
 	}
 
-	/**
-	 * Allows the creation of page object instances while using the fluent interface
-	 * @param <T>
-	 * @param pageObjectInterfaceType
-	 * @return
-	 */
-	@SuppressWarnings("unchecked")
-	public static <T extends PageObjectParent<T>> T getPageObjectInstance(Class<T> pageObjectInterfaceType, WebDriver driver) {
-		
-		try {
-			
-			Class<?> clazz = Class.forName(pageObjectInterfaceType.getPackageName() + "." + pageObjectInterfaceType.getSimpleName() + "Impl");
-			return (T) clazz.getConstructor(WebDriver.class).newInstance(driver);
-			
-		} catch (ClassCastException |ClassNotFoundException | NoSuchMethodException | SecurityException | InstantiationException | IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
-			throw new IllegalArgumentException("Couldn't create instance for PageObject '" + pageObjectInterfaceType.getCanonicalName() + "'", e);
-		}
-		
-	}
+	
+	
 
 
 

pogen4selenium-api/src/main/java/io/toolisticon/pogen4selenium/api/PageObjectParent.java

@@ -48,10 +48,5 @@ public interface PageObjectParent<PAGEOBJECT extends PageObjectParent<PAGEOBJECT
 	 */
 	<OPO extends PageObjectParent<OPO>> OPO execute(ExecuteBlock<PAGEOBJECT, OPO> function);
 
-	/**
-	 * This method can be used to change the page object type.
-	 * This will be helpful if you encounter expected situations that differ from "happy path" like i.e. having a failing form validation.
-	 * @param <APO> the alternative page object type
-	 */
-	<APO extends PageObjectParent<APO>> APO changePageObjectType(Class<APO> targetPageObjectType);
+	
 }

pogen4selenium-api/src/main/java/io/toolisticon/pogen4selenium/runtime/PageObjectParentImpl.java

@@ -1,6 +1,5 @@
 package io.toolisticon.pogen4selenium.runtime;
 
-import java.lang.reflect.InvocationTargetException;
 import java.time.Duration;
 
 import org.openqa.selenium.By;
@@ -63,19 +62,7 @@ public <OPO extends PageObjectParent<OPO>> OPO execute(ExecuteBlock<PAGEOBJECT,O
 
 		return (OPO) function.execute((PAGEOBJECT)this);
 	}
-		
-	@Override
-	public <APO extends PageObjectParent<APO>> APO changePageObjectType(Class<APO> targetPageObjectType) {
-		try {
-			return targetPageObjectType.getConstructor(WebDriver.class).newInstance(this.getDriver());
-		} catch (InstantiationException | IllegalAccessException | IllegalArgumentException | InvocationTargetException
-				| NoSuchMethodException | SecurityException e) {
-			throw new RuntimeException("Unable to instantate the passed page object class : " + targetPageObjectType.getCanonicalName(), e);
-		}
-		
-	}
-
-	
+			
 	protected void waitUntilUrl(String urlRegex) {
     	PageObjectUtilities.waitForiPageToHaveMatchingUrl(driver, urlRegex);
 	}

pogen4selenium-api/src/main/java/io/toolisticon/pogen4selenium/runtime/PageObjectUtilities.java

@@ -1,5 +1,6 @@
 package io.toolisticon.pogen4selenium.runtime;
 
+import java.lang.reflect.InvocationTargetException;
 import java.time.Duration;
 
 import org.openqa.selenium.By;
@@ -11,6 +12,8 @@
 import org.openqa.selenium.support.ui.FluentWait;
 import org.openqa.selenium.support.ui.Wait;
 
+import io.toolisticon.pogen4selenium.api.PageObjectParent;
+
 public class PageObjectUtilities {
 
 	/**
@@ -126,4 +129,25 @@ public static void doPageRefresh(WebDriver driver) {
 	}
 
 
+	/**
+	 * Allows the creation of page object instances while using the fluent interface
+	 * @param <T>
+	 * @param pageObjectInterfaceType
+	 * @return
+	 */
+	@SuppressWarnings("unchecked")
+	public static <T extends PageObjectParent<T>> T getPageObjectInstance(Class<T> pageObjectInterfaceType, WebDriver driver) {
+		
+		try {
+			
+			Class<?> clazz = Class.forName(pageObjectInterfaceType.getPackageName() + "." + pageObjectInterfaceType.getSimpleName() + "Impl");
+			return (T) clazz.getConstructor(WebDriver.class).newInstance(driver);
+			
+		} catch (ClassCastException |ClassNotFoundException | NoSuchMethodException | SecurityException | InstantiationException | IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
+			throw new IllegalArgumentException("Couldn't create instance for PageObject '" + pageObjectInterfaceType.getCanonicalName() + "'", e);
+		}
+		
+	}
+	
+	
 }

pogen4selenium-processor/src/main/resources/DataToExtract.tpl

@@ -46,7 +46,7 @@ public class ${ toImplementHelper.implementationClassName }  extends DataObjectP
 		${action.generateCode}
 !{/for}
 !{if method.returnsPageObject}	
-		return getPageObjectInstance(${method.getNextImplClassName}.class).pause(Duration.ofMillis(${method.afterPause}L));
+		return changePageObjectType(${method.getNextImplClassName}.class).pause(Duration.ofMillis(${method.afterPause}L));
 !{else}
 		return this;	
 !{/if}

pogen4selenium-processor/src/main/resources/PageObject.tpl

@@ -65,7 +65,7 @@ public class ${ toImplementHelper.implementationClassName } ${toImplementHelper.
 !{elseif method.getExtractData.isPresent}
 		return ${method.getExtractData.get.getFinalMethodCall}
 !{else}
-		return getPageObjectInstance(${method.getNextImplClassName}.class).pause(Duration.ofMillis(${method.afterPause}L));
+		return changePageObjectType(${method.getNextImplClassName}.class).pause(Duration.ofMillis(${method.afterPause}L));
 !{/if}
 	}
 !{/for}