pyseext 2.0.1__tar.gz → 2.0.3__tar.gz

pyseext-2.0.1/README.md → pyseext-2.0.3/PKG-INFO

@@ -1,4 +1,14 @@
-# PySeExt Module Repository
+Metadata-Version: 2.4
+Name: pyseext
+Version: 2.0.3
+Summary: Aids the testing of ExtJS applications from Python using Selenium.
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: selenium
+Dynamic: license-file
+
+# PySeExt
 
 This project contains a package to aid the testing of ExtJS applications from Python using Selenium.
 
@@ -21,7 +31,3 @@ Instance Variables | `lower_with_under` | `_lower_with_under`
 Method Names | `lower_with_under()` | `_lower_with_under()`
 Function/Method Parameters | `lower_with_under` |
 Local Variables | `lower_with_under` |
-
-### Additional Notes
-I have also settled on a standard of having a single class per source file (that I now understand are called modules), although inner classes are allowed.
-This is pretty much standard practice in other languages, and makes source control and managing conflicts far easier.

pyseext-2.0.3/README.md

@@ -0,0 +1,23 @@
+# PySeExt
+
+This project contains a package to aid the testing of ExtJS applications from Python using Selenium.
+
+---
+## Naming Standards
+
+Full details [here](https://namingconvention.org/python/).
+
+### TL;DR
+**Type** | **Public** | **Internal**
+--- | --- | ---
+Packages | `lower_with_under` |
+Modules | `lower_with_under` | `_lower_with_under`
+Classes | `CapWords` | `_CapWords`
+Exceptions | `CapWords` |
+Functions | `lower_with_under()` | `_lower_with_under()`
+Global/Class Constants | `CAPS_WITH_UNDER` | `_CAPS_WITH_UNDER`
+Global/Class Variables | `lower_with_under` | `_lower_with_under`
+Instance Variables | `lower_with_under` | `_lower_with_under`
+Method Names | `lower_with_under()` | `_lower_with_under()`
+Function/Method Parameters | `lower_with_under` |
+Local Variables | `lower_with_under` |

{pyseext-2.0.1 → pyseext-2.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyseext"
-version = "2.0.1"
+version = "2.0.3"
 description = "Aids the testing of ExtJS applications from Python using Selenium."
 readme = "README.md"
 requires-python = ">=3.8"

{pyseext-2.0.1/src/pseext → pyseext-2.0.3/src/pyseext}/grid_helper.py

@@ -335,6 +335,37 @@ class GridHelper(HasReferencedJavaScript):
         self._input_helper.type_escape()
         self._input_helper.type_escape()
 
+    def filter_bool_column(
+        self,
+        grid_cq: str,
+        column_text_or_data_index: str,
+        bool_value: str,
+        wait_for_store_loaded: bool = True,
+    ):
+        """Toggles the values on a boolean filtered column on a grid.
+
+        Args:
+            grid_cq (str): The component query for the owning grid.
+            column_text_or_data_index (str): The header text or dataIndex of the grid column.
+            bool_value (str): The value to set e.g. Yes/No.
+            wait_for_store_loaded (bool, optional): Indicates whether to wait for the store to load. Defaults to True.
+        """
+        self.click_column_header_trigger(grid_cq, column_text_or_data_index)
+        self._menu_helper.move_to_menu_item_by_text("Filters")
+
+        if wait_for_store_loaded:
+            self._store_helper.reset_store_load_count(grid_cq)
+
+        self._menu_helper.click_menu_item_by_text(bool_value)
+
+        if wait_for_store_loaded:
+            self._store_helper.wait_for_store_loaded(grid_cq)
+
+        # Close filter and then column menu
+        self._input_helper.type_escape()
+        self._input_helper.type_escape()
+
+
     def filter_number_column(
         self,
         grid_cq: str,

{pyseext-2.0.1/src/pseext → pyseext-2.0.3/src/pyseext}/has_referenced_javascript.py

@@ -2,8 +2,7 @@
 Module that contains our HasReferencedJavaScript class.
 """
 from logging import Logger
-from os import path
-import pkg_resources
+from importlib.resources import files
 
 from selenium.webdriver.remote.webdriver import WebDriver
 from selenium.webdriver.support.wait import WebDriverWait
@@ -48,7 +47,7 @@ class HasReferencedJavaScript:
         # If our JavaScript has not been loaded then load it now
         if not self._driver.execute_script(self._SCRIPT_LOADED_TEST_TEMPLATE.format(class_name=class_name)):
             # Read JavaScript from package resources
-            stream = pkg_resources.resource_stream(__package__, path.join('js', f'PySeExt.{class_name}.js'))
+            stream = files(__package__).joinpath('js', f'PySeExt.{class_name}.js').open('rb')
 
             self._logger.debug("Loading JavaScript from '%s'", stream.name)
             self._driver.execute_script(str(stream.read(), encoding = "utf-8"))

pyseext-2.0.3/src/pyseext/js/PySeExt.ComponentQuery.js

@@ -0,0 +1,123 @@
+globalThis.None = null;
+
+globalThis.PySeExt = globalThis.PySeExt || {};
+globalThis.PySeExt.ComponentQuery = {
+    /**
+     * Returns an array of matched element dom objects from within the dom.
+     *
+     * This wraps Ext.ComponentQuery.query, so see there for more detail.
+     * Each component has it's dom object returned however.
+     * You should never need this from Ext code. This will likely be useful for automated testing.
+     *
+     * Only supports the passing in of a single root (so no filtering), and an optional CSS selector,
+     * to return a sub-element in the found component.
+     *
+     * @param {String} selector      The selector string to filter returned elements.
+     * @param {String} [rootId]      The id of the dom element indicating the container within which to perform the query.
+     *                               If omitted, all components within the document are included in the search.
+     * @param {String} [cssSelector] An optional CSS selector that can be used to get child elements of a found component, e.g. a trigger on a field.
+     * @return {Object[]}            The matched dom objects or an empty array if none found.
+     */
+    query: function(selector, rootId, cssSelector) {
+        var components,
+            results = [],
+            root,
+            len,
+            i,
+            component,
+            el,
+            j;
+
+        // Get component for our root if specified
+        if (rootId) {
+            root = globalThis.Ext.getCmp(rootId);
+
+            if (!root) {
+                globalThis.Ext.Error.raise("Failed to find root component with id '" + rootId + "'! Are you passing in WebElement.get_attribute('id'), because that's what you need?");
+            }
+        }
+
+        components = globalThis.Ext.ComponentQuery.query(selector, root);
+        len = components && components.length;
+
+        if (len) {
+            for (i = 0; i < len; i += 1) {
+                component = components[i];
+
+                if (component && component.getEl) {
+                    el = component.getEl();
+
+                    if (el) {
+                        if (cssSelector) {
+                            el = el.query(cssSelector);
+
+                            if (el && el.length) {
+                                for (j = 0; j < el.length; j += 1) {
+                                    if (el[j]) {
+                                        // This will already be a DOM element,
+                                        // since Element.query defaults to that.
+                                        results.push(el[j]);
+                                    }
+                                }
+                            }
+                        } else {
+                            results.push(el.dom);
+                        }
+                    }
+                }
+            }
+        }
+
+        return results;
+    },
+
+    /**
+     * Determines whether all components for the specified CQ are an instance of the specified class name.
+     *
+     * Note, will return True if the components are a subclass of the type too.
+     * @param {String} className The name of the class that we want to test for.
+     * @param {String} selector The selector string to query for.
+     * @param {String} rootId The id of the dom element indicating the container within which to perform the query.
+     *                        If omitted, all components within the document are included in the search.
+     * @return {Boolean} True if all components are an instance of the specified class, False if they are not, and
+     *                   undefined if no components are found.
+     */
+    isComponentInstanceOf: function(className, selector, rootId) {
+        var cls = Ext.ClassManager.get(className),
+            components,
+            root,
+            len,
+            i,
+            component,
+            el,
+            isInstance;
+
+        if (!cls) {
+            globalThis.Ext.Error.raise("A class with the name '" + className + "' is not defined!");
+        }
+
+        // Get component for our root if specified
+        if (rootId) {
+            root = globalThis.Ext.getCmp(rootId);
+        }
+
+        components = globalThis.Ext.ComponentQuery.query(selector, root);
+        len = components && components.length;
+
+        if (len) {
+            for (i = 0; i < len; i += 1) {
+                component = components[i];
+
+                if (component) {
+                    isInstance = component instanceof cls;
+
+                    if (!isInstance) {
+                        break;
+                    }
+                }
+            }
+        }
+
+        return isInstance;
+    }
+};

pyseext-2.0.3/src/pyseext/js/PySeExt.Core.js

@@ -0,0 +1,34 @@
+globalThis.None = null;
+
+globalThis.PySeExt = globalThis.PySeExt || {};
+globalThis.PySeExt.Core = {
+    /**
+     * Retrieves the value of a member from an object.
+     *
+     * The member can contain periods, to access child objects.
+     *
+     * @param  {Object} object The object from which to retrieve the value.
+     * @param  {String} member A string identifying the member value to retrieve. Can contain periods to access child objects.
+     * @return {Object} The value of the object member, or undefined if it or any part of the path was not found.
+     */
+    getObjectMember: function(object, member) {
+        var me = this,
+            members = member.split('.'),
+            value = object[members[0]];
+
+        if (value && (members.length > 1)) {
+            members.shift();
+            value = me.getObjectMember(value, members.join('.'));
+        }
+
+        return value;
+    },
+
+    /**
+     * Indicates whether there is currently an Ajax request in progress.
+     * @return {Boolean} True if there is a request in progress, false otherwise.
+     */
+    isAjaxRequestInProgress: function() {
+        return globalThis.Ext.Ajax.isLoading();
+    }
+};

pyseext-2.0.3/src/pyseext/js/PySeExt.FieldHelper.js

@@ -0,0 +1,249 @@
+globalThis.None = null;
+
+globalThis.PySeExt = globalThis.PySeExt || {};
+globalThis.PySeExt.FieldHelper = {
+    /**
+     * Finds the specified field input element on the specified form.
+     * @param {String} formCQ The CQ to get to the form panel.
+     * @param {String} name The name of the field.
+     * @returns The DOM for the field's input element
+     */
+    findFieldInputElement: function(formCQ, name) {
+        var field = this.__getField(formCQ, name);
+
+        return field && field.inputEl.dom;
+    },
+
+    /**
+     * Finds the specified field on the specified form and returns it's xtype.
+     * @param {String} formCQ The CQ to get to the form panel.
+     * @param {String} name The name of the field.
+     * @returns {String} The xtype of the field, if found.
+     */
+    getFieldXType: function(formCQ, name) {
+        var field = this.__getField(formCQ, name);
+
+        return field && field.xtype;
+    },
+
+    /**
+     * Finds the specified field on the specified form and returns it's value.
+     * @param {String} formCQ The CQ to get to the form panel.
+     * @param {String} name The name of the field.
+     * @returns {Mixed} The value of the field, if found.
+     */
+    getFieldValue: function(formCQ, name) {
+        var field = this.__getField(formCQ, name),
+            value;
+
+        if (field) {
+            value = field.getValue();
+            // Python cannot convert a JS datetime to a Python one, so convert before sending.
+            if (Ext.isDate(value)) {
+                value = value.toLocaleDateString('en-gb')
+            }
+        }
+
+        return value;
+    },
+
+    /**
+     * Finds the specified field on the specified form and returns it's display value, if it has one.
+     * @param {String} formCQ The CQ to get to the form panel.
+     * @param {String} name The name of the field.
+     * @returns {Mixed} The display value of the field, if found and has a display value.
+     */
+    getFieldDisplayValue: function(formCQ, name) {
+        var field = this.__getField(formCQ, name);
+
+        return field && field.getDisplayValue && field.getDisplayValue();
+    },
+
+    /**
+     * Finds the specified field on the specified form and returns it's raw value, if it has one.
+     * @param {String} formCQ The CQ to get to the form panel.
+     * @param {String} name The name of the field.
+     * @returns {String} The raw value of the field, if found and has a raw value.
+     */
+    getFieldRawValue: function(formCQ, name) {
+        var field = this.__getField(formCQ, name);
+
+        return field && field.getRawValue && field.getRawValue();
+    },
+
+    /**
+     * Finds the specified field and sets its value directly.
+     *
+     * Raises an error if the field was not found.
+     * @param {String} formCQ The CQ to get to the form panel.
+     * @param {String} name The name of the field.
+     * @param {Number} value The value of the field.
+     */
+    setFieldValue: function(formCQ, name, value) {
+        this.__getField(formCQ, name, true).setValue(value);
+    },
+
+    /**
+     * Determines whether the specified field is a remotely filtered combobox.
+     * @param {String} formCQ The CQ to get to the form panel.
+     * @param {String} name The name of the field.
+     * @returns {Boolean} True if the field was found, and is a remotely filtered combobox.
+     *                    False otherwise.
+     */
+    isRemotelyFilteredComboBox: function(formCQ, name) {
+        var field = this.__getField(formCQ, name),
+            isRemotelyFilteredComboBox;
+
+        isRemotelyFilteredComboBox = field instanceof globalThis.Ext.form.field.ComboBox &&
+                                     field.queryMode === 'remote';
+
+        return isRemotelyFilteredComboBox;
+    },
+
+    /**
+     * Method to focus on a field on a form by (zero-based) index or name.
+     *
+     * Raises an error if the field was not found.
+     * @param {String} formCQ The CQ to get to the form panel.
+     * @param {String|Integer} indexOrName The zero-based index or name of the field to focus.
+     */
+    focusField: function(formCQ, indexOrName) {
+        var me = this;
+
+        if (globalThis.Ext.isString(indexOrName)) {
+            me.__getField(formCQ, indexOrName, true).focus();
+        } else {
+            me.__getFieldAtIndex(formCQ, indexOrName).focus();
+        }
+    },
+
+    /**
+     * Determines whether the specified field has focus or not.
+     *
+     * @param {String} formCQ The CQ to get to the form panel.
+     * @param {String|Integer} indexOrName The zero-based index or name of the field to focus.
+     * @returns {Boolean} True if the field has focus, false otherwise.
+     */
+    doesFieldHaveFocus: function(formCQ, indexOrName) {
+        var me = this,
+            field;
+
+        if (globalThis.Ext.isString(indexOrName)) {
+            field = me.__getField(formCQ, indexOrName, true);
+        } else {
+            field = me.__getFieldAtIndex(formCQ, indexOrName);
+        }
+
+        return field.hasFocus;
+    },
+
+    /**
+     * Selects a value on a combobox field by finding a record with the specified data.
+     *
+     * Ensures that the select event is fired if the record is found and selected.
+     * @param {String} formCQ The CQ to get to the form panel.
+     * @param {String} name The name of the field.
+     * @param {Object} data The data to find in the combobox store and select.
+     * @returns {Boolean} Indicates whether a record was found and selected.
+     */
+    selectComboBoxValue: function(formCQ, name, data) {
+        var me = this,
+            field = me.__getField(formCQ, name, true),
+            store,
+            index,
+            record;
+
+        if (field instanceof globalThis.Ext.form.field.ComboBox) {
+            store = field.getStore();
+
+            if (store.isLoaded()) {
+                index = store.getData().findIndexBy(function(record) {
+                    var prop,
+                        doAllMembersMatch = true;
+
+                    for (prop in data) {
+                        if (data.hasOwnProperty(prop)) {
+                            if (data[prop] !== record.get(prop)) {
+                                doAllMembersMatch = false;
+                                break;
+                            }
+                        }
+                    }
+
+                    return doAllMembersMatch;
+                });
+
+                if (index === -1) {
+                    // Record was not found
+                    return false;
+                } else {
+                    record = store.getAt(index);
+
+                    field.select(record);
+                    field.fireEvent('select', field, record);
+
+                    return true;
+                }
+            } else {
+                globalThis.Ext.Error.raise("The combobox store is not loaded!");
+            }
+        } else {
+            globalThis.Ext.Error.raise("Field is not a combobox!");
+        }
+    },
+
+    /**
+     * Finds a field in a form panel.
+     * Optionally raises an error if not found.
+     * @param {String} formCQ The CQ to get to the form panel.
+     * @param {String} name The name of the field.
+     * @param {Boolean} throwIfNotFound Indicates whether to raise an error if not found.
+     *                                  If omitted then value is taken to be false.
+     * @returns {Ext.form.field.Base} The field instance.
+     */
+    __getField: function(formCQ, name, throwIfNotFound) {
+        var formPanel = Ext.ComponentQuery.query(formCQ),
+            field;
+
+        if (formPanel && formPanel.length) {
+            formPanel = formPanel[0];
+            field = formPanel.getForm().findField(name);
+        } else if (throwIfNotFound) {
+            globalThis.Ext.Error.raise("Form panel could not be found!");
+        }
+
+        if (!field && throwIfNotFound) {
+            globalThis.Ext.Error.raise("Field could not be found!");
+        }
+
+        return field;
+    },
+
+    /**
+     * Gets a field in a form panel by index.
+     *
+     * Raises an error if the index is outside of the bounds of the fields,
+     * or is otherwise invalid.
+     * @param {String} formCQ The CQ to get to the form panel.
+     * @param {Number} index The index of the field.
+     * @returns {Ext.form.field.Base} The field instance.
+     */
+     __getFieldAtIndex: function(formCQ, index) {
+        var formPanel = Ext.ComponentQuery.query(formCQ),
+            field;
+
+        if (formPanel && formPanel.length) {
+            formPanel = formPanel[0];
+            field = formPanel.getForm().getFields().getAt(index);
+        } else {
+            globalThis.Ext.Error.raise("Form panel could not be found!");
+        }
+
+        if (!field) {
+            globalThis.Ext.Error.raise("Field could not be found!");
+        }
+
+        return field;
+    }
+
+};