Add role query to container queries

Author: DanielleHuisman

packages/dom/src/get_queries_for_element.rs

@@ -4,6 +4,7 @@ use crate::{
     error::QueryError,
     queries::*,
     types::{Matcher, MatcherOptions, SelectorMatcherOptions, WaitForOptions},
+    ByRoleMatcher, ByRoleOptions,
 };
 
 pub fn get_queries_for_element(element: HtmlElement) -> BoundFunctions {
@@ -15,10 +16,10 @@ pub struct BoundFunctions {
 }
 
 macro_rules! queries_for_element {
-    ($(($name:ident, $options_type:ty)),*,) => {
+    ($(($name:ident, $matcher_type:ty, $options_type:ty)),*,) => {
         paste::paste! {
             impl BoundFunctions {
-                $(pub fn [< find_by_ $name >]<M: Into<Matcher>>(
+                $(pub fn [< find_by_ $name >]<M: Into<$matcher_type>>(
                     &self,
                     matcher: M,
                     options: $options_type,
@@ -27,7 +28,7 @@ macro_rules! queries_for_element {
                     [< find_by_ $name >](&self.element, matcher, options, wait_for_options)
                 })*
 
-                $(pub fn [< find_all_by_ $name >]<M: Into<Matcher>>(
+                $(pub fn [< find_all_by_ $name >]<M: Into<$matcher_type>>(
                     &self,
                     matcher: M,
                     options: $options_type,
@@ -36,31 +37,31 @@ macro_rules! queries_for_element {
                     [< find_all_by_ $name >](&self.element, matcher, options, wait_for_options)
                 })*
 
-                $(pub fn [< get_by_ $name >]<M: Into<Matcher>>(
+                $(pub fn [< get_by_ $name >]<M: Into<$matcher_type>>(
                     &self,
                     matcher: M,
                     options: $options_type,
                 ) -> Result<Option<HtmlElement>, QueryError> {
                     [< get_by_ $name >](&self.element, matcher, options)
                 })*
 
-                $(pub fn [< get_all_by_ $name >]<M: Into<Matcher>>(
+                $(pub fn [< get_all_by_ $name >]<M: Into<$matcher_type>>(
                     &self,
                     matcher: M,
                     options: $options_type,
                 ) -> Result<Vec<HtmlElement>, QueryError> {
                     [< get_all_by_ $name >](&self.element, matcher, options)
                 })*
 
-                $(pub fn [< query_by_ $name >]<M: Into<Matcher>>(
+                $(pub fn [< query_by_ $name >]<M: Into<$matcher_type>>(
                     &self,
                     matcher: M,
                     options: $options_type,
                 ) -> Result<Option<HtmlElement>, QueryError> {
                     [< query_by_ $name >](&self.element, matcher, options)
                 })*
 
-                $(pub fn [< query_all_by_ $name >]<M: Into<Matcher>>(
+                $(pub fn [< query_all_by_ $name >]<M: Into<$matcher_type>>(
                     &self,
                     matcher: M,
                     options: $options_type,
@@ -73,11 +74,12 @@ macro_rules! queries_for_element {
 }
 
 queries_for_element!(
-    (alt_text, MatcherOptions),
-    (display_value, MatcherOptions),
-    (label_text, SelectorMatcherOptions),
-    (placeholder_text, MatcherOptions),
-    (test_id, MatcherOptions),
-    (text, SelectorMatcherOptions),
-    (title, MatcherOptions),
+    (alt_text, Matcher, MatcherOptions),
+    (display_value, Matcher, MatcherOptions),
+    (label_text, Matcher, SelectorMatcherOptions),
+    (placeholder_text, Matcher, MatcherOptions),
+    (role, ByRoleMatcher, ByRoleOptions),
+    (test_id, Matcher, MatcherOptions),
+    (text, Matcher, SelectorMatcherOptions),
+    (title, Matcher, MatcherOptions),
 );

packages/dom/tests/element_queries.rs

@@ -193,6 +193,22 @@ fn get_throws_a_useful_error_message() -> Result<(), QueryError> {
         )),
         container_queries.get_by_display_value("LucyRicardo", MatcherOptions::default())
     );
+    // TODO
+    // assert_eq!(
+    //     Err(QueryError::Element(
+    //         indoc! {"
+    //         Unable to find an accessible element with the role: \"LucyRicardo\"
+
+    //         There are no accessible roles. But there might be some inaccessible roles. If you wish to access them, then set the `hidden` option to `true`. Learn more about this here: https://testing-library.com/docs/dom-testing-library/api-queries#byrole
+
+    //         Ignored nodes: comments, script, style
+    //         <div>
+    //           <div />
+    //         </div>"}
+    //         .into()
+    //     )),
+    //     container_queries.get_by_role("LucyRicardo", ByRoleOptions::default())
+    // );
 
     after_each();