robotframework-browserpom 0.1.1__tar.gz → 0.1.3__tar.gz

{robotframework_browserpom-0.1.1 → robotframework_browserpom-0.1.3}/BrowserPOM/pageobject.py

@@ -28,6 +28,7 @@ class PageObject(metaclass=ABCMeta):
         self.logger = robot.api.logger
         self.locator = LocatorMap(getattr(self, "_locators", {}))
         self.builtin = BuiltIn()
+        self.builtin.set_local_variable(f"${self.__class__.__name__}", self.locator)
 
     @property
     def browser(self) -> Browser:

robotframework_browserpom-0.1.3/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.1
+Name: robotframework-browserpom
+Version: 0.1.3
+Summary: robotframework-browser library extension to create Page Objects
+Home-page: https://github.com/hasanalpzengin/robotframework-browserpom
+Author: Hasan Alp Zengin
+Author-email: hasanalpzengin@gmail.com
+Requires-Python: >=3.12,<4.0
+Classifier: Framework :: Robot Framework
+Classifier: Framework :: Robot Framework :: Library
+Classifier: Framework :: Robot Framework :: Tool
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Dist: robotframework (>=7.1.0,<8.0.0)
+Requires-Dist: robotframework-browser (>=18.0.0,<19.0.0)
+Project-URL: Repository, https://github.com/hasanalpzengin/robotframework-browserpom
+Description-Content-Type: text/markdown
+
+# robotframework-browserpom
+
+`robotframework-browserpom` is a [robotframework-browser](https://robotframework-browser.org/) library extension designed to simplify the creation of Page Objects. It provides an easy-to-use interface to define Page Object Models (POM) for browser automation with the Robot Framework, allowing for cleaner, maintainable, and reusable test automation code.
+
+Heavily inspired by [robotframework-pageobjectlibrary](https://github.com/boakley/robotframework-pageobjectlibrary) repository which is built for usage with Selenium Library and not compatible with robotframework-browser.
+
+## Features
+
+- **Integration with Robot Framework Browser**: Seamlessly integrates with the `robotframework-browser` library.
+- **Page Object Model Support**: Simplifies the creation and management of Page Objects in browser-based test automation.
+- **Enhanced Readability**: Improves the maintainability of test automation by promoting a clean separation between test actions and page element interactions.
+
+## Installation
+
+To install `robotframework-browserpom`, you can use `poetry`:
+
+```bash
+poetry add robotframework-browserpom
+```
+
+Alternatively, to install in development mode (if you are contributing to the library):
+
+poetry install
+
+Dependencies
+
+This project depends on the following libraries:
+
+    Python 3.12 or above
+    robotframework (>=7.1.0)
+    robotframework-browser (>=18.0.0)
+
+Development dependencies include:
+
+    pytest for testing
+    black for code formatting
+    isort for sorting imports
+    flake8 for linting
+    mypy for static type checking
+    pylint for additional linting checks
+    coverage for test coverage reporting
+
+Usage
+
+To use robotframework-browserpom, create Page Objects by defining Python classes that represent the pages in your web application. These classes should contain methods that interact with the elements on the page.
+
+Example:
+
+```python
+from robot.api.deco import keyword
+
+from BrowserPOM.pageobject import PageObject
+
+
+class MainPage(PageObject):
+    """
+    main page
+    """
+    PAGE_TITLE = "MainPage"
+    PAGE_URL = "/index.html"
+
+    _locators = {
+        "tile": {
+            "skeleton": "//li",
+            "price_label": "//li//p[2]",
+            "title": "//li//h2",
+            "author": "//li//p[1]"
+        },
+        "search_bar": "input[@id='searchBar']"
+    }
+
+    @keyword
+    def enter_search(self, search):
+        """Enter to search bar"""
+        self.browser.type_text(self.locator.search_bar, search)
+
+    def get_tile_count(self):
+        return self.browser.get_element_count(self.locator.get("tile").get("skeleton"))
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+Contributing
+
+Contributions are welcome! Please fork this repository and submit a pull request with your changes.
+
+Before submitting your pull request, make sure to:
+
+    Follow the coding style conventions (Black for formatting, Flake8 for linting).
+    Write tests for any new features or bug fixes.
+    Update the documentation as needed.
+
+Contact
+
+For any questions or feedback, you can reach the project maintainer:
+
+    Hasan Alp Zengin (hasanalpzengin@gmail.com)

{robotframework_browserpom-0.1.1 → robotframework_browserpom-0.1.3}/pyproject.toml

@@ -1,9 +1,22 @@
 [tool.poetry]
 name = "robotframework-browserpom"
-version = "0.1.1"
+version = "0.1.3"
 description = "robotframework-browser library extension to create Page Objects"
 authors = ["Hasan Alp Zengin <hasanalpzengin@gmail.com>"]
 packages = [{ include = "BrowserPOM" }]
+readme = "readme.md"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Framework :: Robot Framework",
+    "Framework :: Robot Framework :: Library",
+    "Framework :: Robot Framework :: Tool",
+    "Topic :: Software Development :: Testing",
+    "Topic :: Software Development :: Quality Assurance",
+]
+repository = "https://github.com/hasanalpzengin/robotframework-browserpom"
+
 
 [tool.poetry.dependencies]
 python = "^3.12"
@@ -24,24 +37,6 @@ flake8-pyproject = "1.2.3"
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
-[project]
-name = "robotframework-browserpom"
-version = "0.1.1"
-authors = [
-  { name="Hasan Alp Zengin", email="hasalp38@gmail.com" },
-]
-description = "robotframework-browser library extension to create Page Object Model"
-readme = "README.md"
-requires-python = ">=3.12"
-classifiers = [
-    "Programming Language :: Python :: 3",
-    "License :: OSI Approved :: MIT License",
-    "Operating System :: OS Independent",
-]
-
-[project.urls]
-Homepage = "https://github.com/hasanalpzengin/robotframework-browserpom"
-
 [tool.black]
 line-length = 88
 target-version = ['py312']

robotframework_browserpom-0.1.3/readme.md

@@ -0,0 +1,98 @@
+# robotframework-browserpom
+
+`robotframework-browserpom` is a [robotframework-browser](https://robotframework-browser.org/) library extension designed to simplify the creation of Page Objects. It provides an easy-to-use interface to define Page Object Models (POM) for browser automation with the Robot Framework, allowing for cleaner, maintainable, and reusable test automation code.
+
+Heavily inspired by [robotframework-pageobjectlibrary](https://github.com/boakley/robotframework-pageobjectlibrary) repository which is built for usage with Selenium Library and not compatible with robotframework-browser.
+
+## Features
+
+- **Integration with Robot Framework Browser**: Seamlessly integrates with the `robotframework-browser` library.
+- **Page Object Model Support**: Simplifies the creation and management of Page Objects in browser-based test automation.
+- **Enhanced Readability**: Improves the maintainability of test automation by promoting a clean separation between test actions and page element interactions.
+
+## Installation
+
+To install `robotframework-browserpom`, you can use `poetry`:
+
+```bash
+poetry add robotframework-browserpom
+```
+
+Alternatively, to install in development mode (if you are contributing to the library):
+
+poetry install
+
+Dependencies
+
+This project depends on the following libraries:
+
+    Python 3.12 or above
+    robotframework (>=7.1.0)
+    robotframework-browser (>=18.0.0)
+
+Development dependencies include:
+
+    pytest for testing
+    black for code formatting
+    isort for sorting imports
+    flake8 for linting
+    mypy for static type checking
+    pylint for additional linting checks
+    coverage for test coverage reporting
+
+Usage
+
+To use robotframework-browserpom, create Page Objects by defining Python classes that represent the pages in your web application. These classes should contain methods that interact with the elements on the page.
+
+Example:
+
+```python
+from robot.api.deco import keyword
+
+from BrowserPOM.pageobject import PageObject
+
+
+class MainPage(PageObject):
+    """
+    main page
+    """
+    PAGE_TITLE = "MainPage"
+    PAGE_URL = "/index.html"
+
+    _locators = {
+        "tile": {
+            "skeleton": "//li",
+            "price_label": "//li//p[2]",
+            "title": "//li//h2",
+            "author": "//li//p[1]"
+        },
+        "search_bar": "input[@id='searchBar']"
+    }
+
+    @keyword
+    def enter_search(self, search):
+        """Enter to search bar"""
+        self.browser.type_text(self.locator.search_bar, search)
+
+    def get_tile_count(self):
+        return self.browser.get_element_count(self.locator.get("tile").get("skeleton"))
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+Contributing
+
+Contributions are welcome! Please fork this repository and submit a pull request with your changes.
+
+Before submitting your pull request, make sure to:
+
+    Follow the coding style conventions (Black for formatting, Flake8 for linting).
+    Write tests for any new features or bug fixes.
+    Update the documentation as needed.
+
+Contact
+
+For any questions or feedback, you can reach the project maintainer:
+
+    Hasan Alp Zengin (hasanalpzengin@gmail.com)

robotframework_browserpom-0.1.1/PKG-INFO

@@ -1,12 +0,0 @@
-Metadata-Version: 2.1
-Name: robotframework-browserpom
-Version: 0.1.1
-Summary: robotframework-browser library extension to create Page Objects
-Author: Hasan Alp Zengin
-Author-email: hasanalpzengin@gmail.com
-Requires-Python: >=3.12,<4.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: robotframework (>=7.1.0,<8.0.0)
-Requires-Dist: robotframework-browser (>=18.0.0,<19.0.0)