remove deprecated keywords and methods (enhancement #11)

sampeson · sampeson · commit 09054a91a2d4 · 2020-09-15T14:16:43.000+03:00
diff --git a/src/main/java/javafxlibrary/keywords/AdditionalKeywords/ApplicationLauncher.java b/src/main/java/javafxlibrary/keywords/AdditionalKeywords/ApplicationLauncher.java
@@ -263,17 +263,6 @@ public String getCurrentApplication() {
         }
     }
 
-    @Deprecated
-    @RobotKeyword("*DEPRECATED in version 0.6.0!* Use `Get Current Application` keyword instead.\n\n"
-            + "Returns the class name of currently active JavaFX Application\n")
-    public String currentApplication() {
-        try {
-            return getCurrentSessionApplicationName();
-        } catch (Exception e) {
-            throw new JavaFXLibraryNonFatalException("Problem getting current application name.", e);
-        }
-    }
-
     @RobotKeyword("Returns if JavaFXLibrary is started as java agent.")
     public boolean isJavaAgent() {
         return TestFxAdapter.isAgent;
diff --git a/src/main/java/javafxlibrary/keywords/AdditionalKeywords/ConvenienceKeywords.java b/src/main/java/javafxlibrary/keywords/AdditionalKeywords/ConvenienceKeywords.java
@@ -54,30 +54,6 @@
 @RobotKeywords
 public class ConvenienceKeywords extends TestFxAdapter {
 
-    @Deprecated
-    @RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Find` instead.\n\n" +
-            "finder that mimics _xpath_ style search.\n\n"
-            + "``query`` is a query locator, see `3.1 Locator syntax`.\n\n"
-            + "``failIfNotFound`` specifies if keyword should fail if nothing is found. By default it's false and "
-            + "keyword returns null in case lookup returns nothing.\n\n"
-            + "\nExample:\n"
-            + " | ${node}= | Find With Path | .main-view[0] .split-pane[0] \\#node-id class=GridPane .toggle-button[3] sometext | ")
-    @ArgumentNames({"query", "failIfNotFound=False"})
-    public Object findWithPath(String query, boolean failIfNotFound){
-
-        try {
-            return mapObject(findNode(query));
-
-        } catch (JavaFXLibraryNonFatalException e){
-            if(failIfNotFound)
-                throw new JavaFXLibraryNonFatalException("Unable to find anything with query: \"" + query + "\"");
-            return "";
-
-        } catch (Exception e) {
-            throw new JavaFXLibraryNonFatalException("Find operation failed for query: \"" + query + "\"", e);
-        }
-    }
-
     @RobotKeyword("Brings the given stage to front\n\n"
             + "``stage`` is an Object:Stage to be set in front of others, see `3.2 Using locators as keyword arguments`. \n\n")
     @ArgumentNames({ "stage" })
@@ -130,116 +106,6 @@ public void callObjectMethodInFxApplicationThread(Object object, String method,
         callMethod(object, method, finalArgs, true);
     }
 
-    @Deprecated
-    @RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Find` instead.\n\n"
-            + "Returns the *first* node matching the query. \n\n"
-            + "``query`` is the Class name String to use in lookup.\n"
-            + "\nExample:\n"
-            + "| ${my node}= | Find | javafx.scene.control.Button | # button class |")
-    @ArgumentNames({ "query" })
-    public Object findClass(final String query) {
-        try {
-            Class<?> clazz = Class.forName(query);
-            InstanceOfMatcher matcher = new InstanceOfMatcher(clazz);
-            return mapObject(robot.lookup(matcher).query());
-        } catch (Exception e) {
-            RobotLog.trace("Problem has occurred during node lookup: " + e);
-            return "";
-        }
-    }
-
-    @Deprecated
-    @RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Find All` instead.\n\n"
-            + "Returns *all* descendant nodes of given node matching the query. \n\n"
-            + "``node`` is the starting point Object:Node from where to start looking, see `3.2 Using locators as keyword arguments`. \n\n"
-            + "``query`` is a query locator, see `3.1 Locator syntax`.\n\n"
-            + "``failIfNotFound`` specifies if keyword should fail if nothing is found. By default it's false and "
-            + "keyword returns null in case lookup returns nothing.\n\n"
-            + "\nExample:\n"
-            + "| ${my nodes}= | Find All From Node | ${some node} | .css | \n"
-            + "See keyword `Find` for further examples of query usage.\n")
-    @ArgumentNames({ "node", "query", "failIfNotFound=False" })
-    public List<Object> findAllFromNode(Object node, String query, boolean failIfNotFound) {
-        try {
-            if ( node instanceof Node ) {
-                RobotLog.info("Trying to find all nodes with query: \"" + query + "\" that are under starting " +
-                        "point node: \"" + node + "\", failIfNotFound= \"" + failIfNotFound + "\"");
-                return mapObjects(((Node) node).lookupAll(query));
-            }
-            // fail in case no valid node argument.
-            failIfNotFound = true;
-            throw new JavaFXLibraryNonFatalException("Illegal argument type for node.");
-        } catch (JavaFXLibraryNonFatalException e){
-            if(failIfNotFound)
-                throw e;
-            return Collections.emptyList();
-
-        } catch (Exception e) {
-            throw new JavaFXLibraryNonFatalException("Find all from node operation failed for node: \"" + node.toString() +
-                    "\" and query: " + query, e);
-        }
-    }
-
-    @Deprecated
-    @RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Find All` instead.\n\n"
-            + "Returns *all* nodes matching query AND given pseudo-class state. \r\n"
-            + "``query`` is a query locator, see `3.1 Locator syntax`.\n\n"
-            + "``pseudo`` is a String value specifying pseudo class value.\n\n"
-            + "``failIfNotFound`` specifies if keyword should fail if nothing is found. By default it's false and "
-            + "keyword returns null in case lookup returns nothing.\n\n"
-            + "\nExample:\n"
-            + "| ${my node}= | Find All With Pseudo Class | .check-box-tree-cell .check-box | selected | \n")
-    @ArgumentNames({ "query", "pseudo", "failIfNotFound=False" })
-    public List<Object> findAllWithPseudoClass(String query, String pseudo, boolean failIfNotFound) {
-        RobotLog.info("Trying to find all nodes with query: \"" + query + "\" that has pseudoclass state as: \"" +
-                pseudo + "\", failIfNotFound= \"" + failIfNotFound + "\"");
-        try {
-            Set<Node> nodes = robot.lookup(query).queryAll();
-            Set<Node> matches = nodes.stream()
-                    .filter(n -> n.getPseudoClassStates().stream().
-                            map(PseudoClass::getPseudoClassName).anyMatch(pseudo::contains))
-                    .collect(Collectors.toSet());
-            return mapObjects(matches);
-
-        } catch (JavaFXLibraryNonFatalException e){
-            if(failIfNotFound)
-                throw e;
-            return Collections.emptyList();
-
-        } catch (Exception e) {
-            throw new JavaFXLibraryNonFatalException("Find all with pseudo class operation failed for query: \"" +
-                    query + "\" and pseudo: \"" + pseudo + "\"", e);
-        }
-    }
-
-    @Deprecated
-    @RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Find` instead.\n\n"
-            + "Returns the *first* descendant node of given node matching the query. \n\n"
-            + "``node`` is the starting point Object:Node from where to start looking, see `3.2 Using locators as keyword arguments`. \n\n"
-            + "``query`` is a query locator, see `3.1 Locator syntax`.\n\n"
-            + "``failIfNotFound`` specifies if keyword should fail if nothing is found. By default it's false and "
-            + "keyword returns null in case lookup returns nothing.\n\n"
-            + "\nExample:\n"
-            + "| ${my node}= | Find From Node | ${some node} | .css |\n"
-            + "See keyword `Find` for further examples of query usage.\n")
-    @ArgumentNames({ "node", "query", "failIfNotFound=False" })
-    public Object findFromNode(Node node, String query, boolean failIfNotFound) {
-        RobotLog.info("Trying to find: \"" + query + "\" from node: \"" + node + "\", failIfNotFound= \"" + failIfNotFound + "\"");
-        try {
-            Node childNode = node.lookup(query);
-            return mapObject(childNode);
-
-        } catch (JavaFXLibraryNonFatalException e){
-            if(failIfNotFound)
-                throw e;
-            return "";
-
-        } catch (Exception e) {
-            throw new JavaFXLibraryNonFatalException("Find from node operation failed for node: \"" + node +
-                    "\" and query: " + query, e);
-        }
-    }
-
     @RobotKeyword("Lists methods available for given node.\n"
             + "``node`` is the Object:Node which methods to list, see `3.2 Using locators as keyword arguments`. \n\n"
             + "When working with custom components you may use this keyword to discover methods you can call "
@@ -390,40 +256,6 @@ public Set<PseudoClass> getPseudoClassStates(Object locator) {
         }
     }
 
-    // TODO: Should this be deleted? Find All From Node has the same functionality
-    @Deprecated
-    @RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Find` instead.\n\n"
-            + "Returns *all* descendant nodes of given node matching the given Java class name. \n\n"
-            + "``locator`` is either a _query_ or _Object_ for node whose children will be queried, see "
-            + "`3.2 Using locators as keyword arguments`. \n\n"
-            + "``className`` is the Java class name to look for.\n"
-            + "\nExample:\n"
-            + "| ${panes}= | Get Node Children By Class Name | ${some node} | BorderPane | \n"
-            + "Returns an empty list if none is found. \n")
-    @ArgumentNames({ "node", "className" })
-    public Set<Object> getNodeChildrenByClassName(Object locator, String className) {
-        Node node = objectToNode(locator);
-        RobotLog.info("Getting node: \"" + node + "\" children by class name: \"" + className + "\"");
-        try {
-            Set<Object> keys = new HashSet<>();
-            Set childNodes = node.lookupAll("*");
-
-            for (Object o : childNodes) {
-                Node childNode = (Node) o;
-                if (childNode.getClass().getSimpleName().equals(className)) {
-                    RobotLog.trace("Classname: \"" + className + "\" found: \"" + childNode + "\"");
-                    keys.add(mapObject(childNode));
-                }
-            }
-            return keys;
-        } catch (Exception e) {
-            if(e instanceof JavaFXLibraryNonFatalException)
-                throw e;
-            throw new JavaFXLibraryNonFatalException("Unable to get node children for node: \"" + node.toString() +
-                    "\" with class name: " + className, e);
-        }
-    }
-
     @RobotKeyword("Returns text value of the Node. \n\n"
             + "``locator`` is either a _query_ or _Object_ for a node whose getText method will be called, see "
             + "`3. Locating JavaFX Nodes`. \n\n")
@@ -441,35 +273,6 @@ public String getNodeText(Object locator) {
         }
     }
 
-    @Deprecated
-    @RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Find` instead.\n\n"
-            + "Returns height value of the node. \n\n"
-            + "``locator`` is either a _query_ or _Object_ for a node whose getHeight method will be called, see "
-            + "`3. Locating JavaFX Nodes`. \n\n")
-    @ArgumentNames({ "locator" })
-    public String getNodeHeight(Object locator) {
-        Node node = objectToNode(locator);
-        try {
-            Method[] methods = node.getClass().getMethods();
-            for (Method m : methods) {
-                if (m.getName().equals("getHeight")) {
-                    try {
-                        Object result = m.invoke(node, (Object) null);
-                        return result.toString();
-                    } catch (Exception e) {
-                        throw new JavaFXLibraryNonFatalException("Problem calling method: .getHeight(): " + e.getMessage(), e);
-                    }
-                }
-            }
-            throw new JavaFXLibraryNonFatalException(
-                    "Get node height failed for node: \"" + node.toString() + "\". Element has no method getHeight()");
-        } catch (Exception e) {
-            if (e instanceof JavaFXLibraryNonFatalException)
-                throw e;
-            throw new JavaFXLibraryNonFatalException("Unable to get node height for node: " + node.toString(), e);
-        }
-    }
-
     @RobotKeyword("Returns image name and path of the node. \n\n"
             + "``locator`` is either a _query_ or _Object_ for a node whose getHeight method will be called, see "
             + "`3. Locating JavaFX Nodes`. \n\n"
@@ -535,31 +338,6 @@ public String getObjectClassName(Object locator) {
         }
     }
 
-    @Deprecated
-    @RobotKeyword("*DEPRECATED in version 0.6.0!* Use keyword `Get Scene` instead.\n\n"
-            +"Returns given locators Scene object. \n\n"
-            + "``locator`` is either a _query_ or a _Node_, see `3.2 Using locators as keyword arguments`\n\n")
-    @ArgumentNames({ "locator" })
-    public Object getNodesScene(Object locator) {
-        try {
-            if (locator instanceof Node){
-                RobotLog.info("Getting a Scene object for a Node: \"" + locator + "\"");
-                return mapObject(((Node) locator).getScene());
-            } else if (locator instanceof String) {
-                RobotLog.info("Getting a Scene object for a query: \"" + locator + "\"");
-                Node node = objectToNode(locator);
-                return mapObject(node.getScene());
-            }
-
-            throw new JavaFXLibraryNonFatalException("Locator type is not a Node or a query string!");
-
-        } catch (Exception e) {
-            if (e instanceof JavaFXLibraryNonFatalException)
-                throw e;
-            throw new JavaFXLibraryNonFatalException("Unable to get Scene object for locator: \"" + locator + "\"", e);
-        }
-    }
-
     @RobotKeyword("Returns Scene of the given object. \n\n"
             + "``locator`` is either a _query_, a _Node_ or a _Window_, see `3.2 Using locators as keyword arguments`\n\n")
     @ArgumentNames({ "locator" })
diff --git a/src/main/java/javafxlibrary/keywords/AdditionalKeywords/Verifiers.java b/src/main/java/javafxlibrary/keywords/AdditionalKeywords/Verifiers.java
@@ -158,16 +158,6 @@ public static void nodeShouldNotBeVisible(Object locator) {
         verifyThat(objectToNode(locator), isInvisible() );
     }
 
-    @Deprecated
-    @RobotKeyword("*DEPRECATED in version 0.6.0!* Use `Node Should Not Be Visible` instead.\n\n"
-            + "Verifies that node is invisible. \n\n"
-            + "``locator`` is either a _query_ or _Object:Node_ for identifying the Node, see "
-            + "`3. Locating JavaFX Nodes`. \n\n")
-    @ArgumentNames({ "locator" })
-    public static void nodeShouldBeInvisible(Object locator) {
-        verifyThat(objectToNode(locator), isInvisible() );
-    }
-
     @RobotKeyword("Verifies that node is focused. \n\n"
             + "``locator`` is either a _query_ or _Object:Node_ for identifying the Node, see "
             + "`3. Locating JavaFX Nodes`. \n\n")
@@ -204,16 +194,6 @@ public static void nodeShouldNotBeEnabled(Object locator) {
         verifyThat(objectToNode(locator), NodeMatchers.isDisabled() );
     }
 
-    @Deprecated
-    @RobotKeyword("*DEPRECATED in version 0.6.0!* Use `Node Should Not Be Enabled` instead."
-            + "Verifies that node is disabled. \n\n"
-            + "``locator`` is either a _query_ or _Object:Node_ for identifying the Node, see "
-            + "`3. Locating JavaFX Nodes`. \n\n")
-    @ArgumentNames({ "locator" })
-    public static void nodeShouldBeDisabled(Object locator) {
-        verifyThat(objectToNode(locator), NodeMatchers.isDisabled() );
-    }
-
     @RobotKeyword("Verifies that node is hoverable with mouse. \n\n"
             + "``locator`` is either a _query_ or _Object:Node_ for identifying the Node, see "
             + "`3. Locating JavaFX Nodes`. \n\n")
@@ -290,14 +270,6 @@ public static void windowShouldBeVisible(Object window) {
         verifyThat((Window) window, WindowMatchers.isShowing());
     }
 
-    @Deprecated
-    @RobotKeyword("*DEPRECATED in version 0.6.0!* Please use `Window Should Be Visible` instead.\n\n" +"Verifies that given window is showing. \n\n"
-            + "``window`` is the _Object:Window_ that specifies which window should be showing, see `3.2 Using locators as keyword arguments`.")
-    @ArgumentNames({ "window" })
-    public static void windowShouldBeShowing(Object window) {
-        verifyThat((Window) window, WindowMatchers.isShowing());
-    }
-
     @RobotKeyword("Verifies that given window is not visible.\n\n"
             + "``window`` is the _Object:Window_ that specifies which window should be not visible, see `3.2 Using locators as keyword arguments`.")
     @ArgumentNames({ "window" })
diff --git a/src/main/java/javafxlibrary/utils/HelperFunctions.java b/src/main/java/javafxlibrary/utils/HelperFunctions.java
@@ -648,73 +648,6 @@ private static String remainingQueries(String query) {
             return queries[1];
     }
 
-
-    // Deprecated: Use javafxlibrary.utils.finder.finder instead
-    @Deprecated
-    public static Node findNode(Node node, String query) {
-
-        RobotLog.info("Finding from node: " + node.toString() + " with query: " + query);
-
-        if (query != null) {
-            List<Node> nodelist = new ArrayList<>();
-
-            String currentQuery = query.split(" ", 2)[0];
-            String nextQuery = remainingQueries(query);
-            RobotLog.info("CurrentQuery: " + currentQuery + ", nextQuery: " + nextQuery);
-
-            if (currentQuery.startsWith("class=")) {
-                nodelist.addAll(node.lookupAll((getQueryString(currentQuery)).replaceFirst("^class=", "")));
-            } else {
-                nodelist.addAll(robot.from(node).lookup(getQueryString(currentQuery)).queryAll());
-            }
-
-            if (nodelist.isEmpty()) {
-                return null;
-            } else {
-                if (getQueryIndex(currentQuery) != -1) {
-                    // if index [..] was given, continue search with only one match
-                    return findNode(nodelist.get(getQueryIndex(currentQuery)), nextQuery);
-                } else {
-                    // no index given, continue search with all matches
-                    Node newNode;
-
-                    for (Node n : nodelist) {
-                        newNode = findNode(n, nextQuery);
-                        if (newNode != null)
-                            return newNode;
-                    }
-                    return null;
-                }
-            }
-        } else {
-            return node;
-        }
-    }
-
-    // Deprecated: Use javafxlibrary.utils.finder.finder instead
-    @Deprecated
-    public static Node findNode(String query) {
-        return findNode(robot.listTargetWindows().get(0).getScene().getRoot(), query);
-    }
-
-    // Deprecated: Used only in deprecated method findNode
-    @Deprecated
-    public static String getQueryString(String query) {
-        return query.replaceAll("\\[\\d]$", "");
-    }
-
-    // Deprecated: Used only in deprecated method findNode
-    @Deprecated
-    public static int getQueryIndex(String query) {
-        Pattern pattern = Pattern.compile(".*\\[\\d]$");
-        Matcher matcher = pattern.matcher(query);
-        if (matcher.matches()) {
-            String index = StringUtils.substringBetween(query, "[", "]");
-            return Integer.parseInt(index);
-        }
-        return -1;
-    }
-
     public static Node getHoveredNode() {
         return getHoveredNode(robot.listTargetWindows().get(0).getScene().getRoot());
     }
diff --git a/src/test/java/javafxlibrary/keywords/AdditionalKeywordsTests/ConvenienceKeywords/DeprecatedFindKeywordsTest.java b/src/test/java/javafxlibrary/keywords/AdditionalKeywordsTests/ConvenienceKeywords/DeprecatedFindKeywordsTest.java
