Merge branch 'develop' into update-from-template-merged

Author: xdev-gh-bot

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -15,9 +15,9 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/template-placeholder/releases/latest)"
+        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/selenium-elements/releases/latest)"
           required: true
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/selenium-elements/issues) or [closed](https://github.com/xdev-software/selenium-elements/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -13,7 +13,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/selenium-elements/issues) or [closed](https://github.com/xdev-software/selenium-elements/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the feature request will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -12,7 +12,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/selenium-elements/issues) or [closed](https://github.com/xdev-software/selenium-elements/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the question will be dismissed otherwise."
           required: true

.github/workflows/check-build.yml

@@ -19,9 +19,6 @@ on:
       - '.idea/**'
       - 'assets/**'
 
-env:
-  DEMO_MAVEN_MODULE: ${{ github.event.repository.name }}-demo
-
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -68,13 +65,6 @@ jobs:
           exit 1
         fi
 
-    - name: Upload demo files
-      uses: actions/upload-artifact@v7
-      with:
-        name: demo-files-java-${{ matrix.java }}
-        path: ${{ env.DEMO_MAVEN_MODULE }}/target/${{ env.DEMO_MAVEN_MODULE }}.jar
-        if-no-files-found: error
-
   checkstyle:
     runs-on: ubuntu-latest
     if: ${{ github.event_name != 'pull_request' || !startsWith(github.head_ref, 'renovate/') }}

.run/Run Demo.run.xml

@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run Demo" type="Application" factoryName="Application">
     <option name="MAIN_CLASS_NAME" value="software.xdev.Application" />
-    <module name="template-placeholder-demo" />
+    <module name="selenium-elements-demo" />
     <option name="WORKING_DIRECTORY" value="$MODULE_DIR$" />
     <extension name="coverage">
       <pattern>

CHANGELOG.md

@@ -0,0 +1,40 @@
+# 1.1.1
+* Updated dependencies
+
+# 1.1.0
+* Internal restructuring - new interfaces to deduplicate code
+* Added `SimpleImprovedWebElement` which can be for direct instantiation 
+
+# 1.0.8
+* Fix `ImprovedRemoteWebElement` not using correct search context
+
+# 1.0.7
+* Added `nativeClick` method which executes the original/upstream click
+* Updated dependencies
+
+# 1.0.6
+* Updated dependencies
+
+# 1.0.5
+* Add new shortcut method ``CanFindElements#waitForFirstByClassName``
+* Updated dependencies
+
+# 1.0.4
+* ``ImprovedWebElement#hasAttribute`` now waits for loading operations to complete (now calls ``prepareForOperation`` - like ``getProperty`` already does)
+
+# 1.0.3
+* Removed reflection calls in ``CustomizableJsonToWebElementConverter`` as https://github.com/SeleniumHQ/selenium/issues/15884 was fixed #11
+  * Selenium version 4.34+ is required
+* Updated dependencies
+
+# 1.0.2
+* ``ImprovedRemoteWebElement``
+  * Make it possible to disable auto scroll
+  * Don't throw an exception when scrolling into view is somehow not working
+  * Improve logger initialization
+
+# 1.0.1
+* Correctly declare ``software.xdev:testcontainers-selenium`` as scope ``test``
+
+# 1.0.0
+_Initial release_

CONTRIBUTING.md

@@ -34,10 +34,10 @@ You should have the following things installed:
   * Ensure that the JDK/Java-Version is correct
 
 
-## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/release.yml?branch=master)](https://github.com/xdev-software/template-placeholder/actions/workflows/release.yml)
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/selenium-elements/release.yml?branch=master)](https://github.com/xdev-software/selenium-elements/actions/workflows/release.yml)
 
 Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/template-placeholder/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+* Consider doing a [test-deployment](https://github.com/xdev-software/selenium-elements/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
 * Check the [changelog](CHANGELOG.md)
 
 If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes

README.md

@@ -1,11 +1,76 @@
-[![Latest version](https://img.shields.io/maven-central/v/software.xdev/template-placeholder?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/template-placeholder)
-[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/check-build.yml?branch=develop)](https://github.com/xdev-software/template-placeholder/actions/workflows/check-build.yml?query=branch%3Adevelop)
+[![Latest version](https://img.shields.io/maven-central/v/software.xdev/selenium-elements?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/selenium-elements)
+[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/selenium-elements/check-build.yml?branch=develop)](https://github.com/xdev-software/selenium-elements/actions/workflows/check-build.yml?query=branch%3Adevelop)
 
-# template-placeholder
+# <img src="https://raw.githubusercontent.com/SeleniumHQ/seleniumhq.github.io/690acbad7b4bf4656f116274809765db64e6ccf7/website_and_docs/static/images/logos/webdriver.svg" width=24 /> Elements for Selenium
 
+Define Selenium HTML elements as Java classes, similar to Selenium's [``@FindBy`` annotation](https://www.selenium.dev/selenium/docs/api/java/org/openqa/selenium/support/FindBy.html).
+
+Also contains a ton of other predefined utility, for example:
+* Automatically scrolls elements that perform operations into the view
+* Safe click: When an element is detected as stale a JavaScript click is executed instead
+* Option to globally wait until the page finished loading
+* Waiting for some time until the element is present (``waitUntil``)
+
+Overall this should result in:
+* Less [flaky](https://www.browserstack.com/test-reporting-and-analytics/features/test-reporting/what-is-flaky-test) tests
+* Abstraction of elements in an object oriented way
+
+## Usage
+
+1. Define the elements you want to access
+    ```java
+    @FindBySelector(tagName = "body")
+    abstract class BodyElement implements ImprovedWebElement {
+        public MyElement myElement() {
+            return waitForFirst(MyElement.class);
+        }
+    }
+
+    @FindBySelector(id = "abc")
+    abstract class MyElement implements ImprovedWebElement {
+    }
+    ```
+2. Utilize the predefined methods and classes to get/access the elements in a test
+    ```java
+    class MyWebDriverTest implements CanFindElements {
+        WebDriver webDriver;
+
+        @BeforeEach
+        void beforeEach() {
+            webDriver = createWebDriver();
+            CustomizableRemoteWebElementInstaller.install(
+                webDriver,
+                () -> new ImprovedRemoteWebElement(
+                    "return document.readyState == 'complete';")
+            );
+        }
+
+        @Test
+        void test() {
+            MyElement myElement = waitForFirst(BodyElement.class).myElement();
+            assertEquals("Hello world", myElement.getText());
+
+            // Or alternatively
+            ElementInstantiatorInstance.instance().find(webDriver, BodyElement.class);
+        }
+
+        @AfterEach
+        void afterEach() {
+            // Stop webDriver here...
+            webDriver = null;
+        }
+
+        @Override
+        public WebDriver getWebDriver() {
+            return webDriver;
+        }
+    }
+    ```
+
+You can also checkout the [integrated tests](./selenium-elements/src/test/java/) to see this in action.
 
 ## Installation
-[Installation guide for the latest release](https://github.com/xdev-software/template-placeholder/releases/latest#Installation)
+[Installation guide for the latest release](https://github.com/xdev-software/selenium-elements/releases/latest#Installation)
 
 ## Support
 If you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).
@@ -14,4 +79,6 @@ If you need support as soon as possible and you can't wait for any pull request,
 See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.
 
 ## Dependencies and Licenses
-View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/template-placeholder/dependencies)
+View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/selenium-elements/dependencies)
+
+<sub>Disclaimer: This is not an official Testcontainers/Selenium product and not associated</sub>

SECURITY.md

@@ -2,4 +2,4 @@
 
 ## Reporting a Vulnerability
 
-Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/template-placeholder/security/advisories/new).
+Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/selenium-elements/security/advisories/new).

pom.xml

@@ -5,8 +5,8 @@
 	<modelVersion>4.0.0</modelVersion>
 
 	<groupId>software.xdev</groupId>
-	<artifactId>template-placeholder-root</artifactId>
-	<version>1.0.0-SNAPSHOT</version>
+	<artifactId>selenium-elements-root</artifactId>
+	<version>1.1.2-SNAPSHOT</version>
 	<packaging>pom</packaging>
 
 	<organization>
@@ -15,8 +15,7 @@
 	</organization>
 
 	<modules>
-		<module>template-placeholder</module>
-		<module>template-placeholder-demo</module>
+		<module>selenium-elements</module>
 	</modules>
 
 	<properties>