Skip to content

Commit 77ab3da

Browse files
authored
Merge pull request #55 from mathisloge/refactor/rename_make_query
rename make_query to query; remove all prefixes of `with_`
2 parents 1a43648 + 6385c13 commit 77ab3da

File tree

10 files changed

+78
-84
lines changed

10 files changed

+78
-84
lines changed

example/qt/cpp_test/test_manage_todo.cpp

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,17 @@ static suite<"integration manage todo"> _ = [] { // NOLINT
2222
probe.wait_for_connected(std::chrono::seconds{5});
2323
steps.scenario("*") = [&] {};
2424
steps.when("I have entered '{todoText}' into the todo input field") = [&](std::string todoText) {
25-
auto input_obj =
26-
probe.find_object(quite::make_query().with_property("objectName", std::string{"inputField"}));
25+
auto input_obj = probe.find_object(quite::query().property("objectName", std::string{"inputField"}));
2726
input_obj.property("text").write(std::move(todoText));
2827
};
2928
steps.when("I click the 'Add' button") = [&]() {
30-
auto btn_query = quite::make_query().with_property("objectName", std::string{"addButton"});
29+
auto btn_query = quite::query().property("objectName", std::string{"addButton"});
3130
auto btn_obj = probe.find_object(btn_query);
3231
btn_obj.mouse_action();
3332
};
3433

3534
steps.then("the todo list should display '{expectedTodoText}' as a new item") = [&](std::string todoText) {
36-
auto delegate_query = quite::make_query().with_property("text", todoText).with_type("SwipeDelegate");
35+
auto delegate_query = quite::query().property("text", todoText).type("SwipeDelegate");
3736
auto delegate_text = probe.try_find_object(delegate_query, std::chrono::seconds{2}).property("text");
3837
expect(std::holds_alternative<std::string>(delegate_text.value()));
3938
expect(that % todoText == std::get<std::string>(delegate_text.value()));

example/qt/python_test/test_manage_todo.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
import test_paths
1111
from pytest_bdd import parsers, scenario, then, when
1212

13-
from quite import Probe, ProbeManager, make_query
13+
from quite import Probe, ProbeManager, query
1414

1515

1616
@pytest.fixture
@@ -29,15 +29,15 @@ def test_add_todo():
2929
@when(parsers.parse("I have entered '{todo_text}' into the todo input field"))
3030
def enter_todo_text(application: Probe, todo_text: str):
3131
input_field = application.find_object(
32-
object_query=make_query().with_property("objectName", "inputField")
32+
object_query=query().property("objectName", "inputField")
3333
)
3434
input_field.property("text").write(todo_text)
3535

3636

3737
@when("I click the 'Add' button")
3838
def click_add_button(application: Probe):
3939
button = application.find_object(
40-
object_query=make_query().with_property("objectName", "addButton")
40+
object_query=query().property("objectName", "addButton")
4141
)
4242
button.mouse_action()
4343

@@ -47,13 +47,11 @@ def click_add_button(application: Probe):
4747
)
4848
def verify_new_todo_exists(application: Probe, expected_todo_text: str):
4949
list_item = application.find_object(
50-
object_query=make_query().with_property("objectName", "listView")
50+
object_query=query().property("objectName", "listView")
5151
)
5252
new_item_index = list_item.property("count").value() - 1
5353
todo_list_item = application.try_find_object(
54-
object_query=make_query()
55-
.with_property("index", new_item_index)
56-
.with_type("SwipeDelegate"),
54+
object_query=query().property("index", new_item_index).type("SwipeDelegate"),
5755
timeout=timedelta(seconds=1),
5856
)
5957
assert todo_list_item.property("text").value() == expected_todo_text

libs/core/include/quite/value/object_query.hpp

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,21 @@ class QUITE_CORE_EXPORT ObjectQueryBuilder
3434
public:
3535
ObjectQueryBuilder();
3636

37-
ObjectQueryBuilder &with_property(std::initializer_list<std::pair<std::string, entt::meta_any>> props);
37+
ObjectQueryBuilder &property(std::initializer_list<std::pair<std::string, entt::meta_any>> props);
3838

39-
ObjectQueryBuilder &with_property(std::string key, std::int64_t value);
39+
ObjectQueryBuilder &property(std::string key, std::int64_t value);
4040

41-
ObjectQueryBuilder &with_property(std::string key, std::uint64_t value);
41+
ObjectQueryBuilder &property(std::string key, std::uint64_t value);
4242

43-
ObjectQueryBuilder &with_property(std::string key, double value);
43+
ObjectQueryBuilder &property(std::string key, double value);
4444

45-
ObjectQueryBuilder &with_property(std::string key, bool value);
45+
ObjectQueryBuilder &property(std::string key, bool value);
4646

47-
ObjectQueryBuilder &with_property(std::string key, std::string value);
47+
ObjectQueryBuilder &property(std::string key, std::string value);
4848

49-
ObjectQueryBuilder &with_parent(ObjectQueryBuilder parent);
49+
ObjectQueryBuilder &parent(ObjectQueryBuilder parent);
5050

51-
ObjectQueryBuilder &with_type(std::string type_name);
51+
ObjectQueryBuilder &type(std::string type_name);
5252

5353
operator std::shared_ptr<ObjectQuery>() const;
5454

@@ -57,7 +57,7 @@ class QUITE_CORE_EXPORT ObjectQueryBuilder
5757
};
5858

5959
// Factory function
60-
QUITE_CORE_EXPORT ObjectQueryBuilder make_query();
60+
QUITE_CORE_EXPORT ObjectQueryBuilder query();
6161

6262
} // namespace quite
6363
template <>

libs/core/src/value/object_query.cpp

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ ObjectQueryBuilder::ObjectQueryBuilder()
1212
: query_(std::make_shared<ObjectQuery>())
1313
{}
1414

15-
ObjectQueryBuilder &ObjectQueryBuilder::with_property(
16-
std::initializer_list<std::pair<std::string, entt::meta_any>> props)
15+
ObjectQueryBuilder &ObjectQueryBuilder::property(std::initializer_list<std::pair<std::string, entt::meta_any>> props)
1716
{
1817
for (const auto &[key, val] : props)
1918
{
@@ -22,43 +21,43 @@ ObjectQueryBuilder &ObjectQueryBuilder::with_property(
2221
return *this;
2322
}
2423

25-
ObjectQueryBuilder &ObjectQueryBuilder::with_property(std::string key, std::int64_t value)
24+
ObjectQueryBuilder &ObjectQueryBuilder::property(std::string key, std::int64_t value)
2625
{
2726
query_->properties.insert_or_assign(std::move(key), std::move(value));
2827
return *this;
2928
}
3029

31-
ObjectQueryBuilder &ObjectQueryBuilder::with_property(std::string key, std::uint64_t value)
30+
ObjectQueryBuilder &ObjectQueryBuilder::property(std::string key, std::uint64_t value)
3231
{
3332
query_->properties.insert_or_assign(std::move(key), std::move(value));
3433
return *this;
3534
}
3635

37-
ObjectQueryBuilder &ObjectQueryBuilder::with_property(std::string key, double value)
36+
ObjectQueryBuilder &ObjectQueryBuilder::property(std::string key, double value)
3837
{
3938
query_->properties.insert_or_assign(std::move(key), std::move(value));
4039
return *this;
4140
}
4241

43-
ObjectQueryBuilder &ObjectQueryBuilder::with_property(std::string key, bool value)
42+
ObjectQueryBuilder &ObjectQueryBuilder::property(std::string key, bool value)
4443
{
4544
query_->properties.insert_or_assign(std::move(key), std::move(value));
4645
return *this;
4746
}
4847

49-
ObjectQueryBuilder &ObjectQueryBuilder::with_property(std::string key, std::string value)
48+
ObjectQueryBuilder &ObjectQueryBuilder::property(std::string key, std::string value)
5049
{
5150
query_->properties.insert_or_assign(std::move(key), std::move(value));
5251
return *this;
5352
}
5453

55-
ObjectQueryBuilder &ObjectQueryBuilder::with_parent(ObjectQueryBuilder parent)
54+
ObjectQueryBuilder &ObjectQueryBuilder::parent(ObjectQueryBuilder parent)
5655
{
5756
query_->container = parent;
5857
return *this;
5958
}
6059

61-
ObjectQueryBuilder &ObjectQueryBuilder::with_type(std::string type_name)
60+
ObjectQueryBuilder &ObjectQueryBuilder::type(std::string type_name)
6261
{
6362
query_->type_name = std::move(type_name);
6463
return *this;
@@ -69,7 +68,7 @@ ObjectQueryBuilder::operator std::shared_ptr<ObjectQuery>() const
6968
return query_;
7069
}
7170

72-
ObjectQueryBuilder make_query()
71+
ObjectQueryBuilder query()
7372
{
7473
return ObjectQueryBuilder{};
7574
}

libs/probeqt/tests/test_object_tracker.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -146,8 +146,8 @@ static suite<"qtprobe"> _ = [] { // NOLINT
146146
tracker.add_object(&a2);
147147
expect(loop.processEvents());
148148

149-
auto &&query = make_query().with_type("MyCustomClass");
150-
auto found = tracker.find_object_by_query(query);
149+
auto &&type_query = query().type("MyCustomClass");
150+
auto found = tracker.find_object_by_query(type_query);
151151
expect(found.has_value());
152152
expect(found->object_id == to_object_id(&my_class));
153153
};

python/binding.cpp

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -96,28 +96,28 @@ PYBIND11_MODULE(_quite, m)
9696
py::class_<quite::ObjectQuery>(m, "ObjectQuery").def(py::init<quite::ObjectQueryBuilder>());
9797
py::class_<quite::ObjectQueryBuilder>(m, "ObjectQueryBuilder")
9898
.def(py::init<>())
99-
.def("with_property",
100-
py::overload_cast<std::string, std::int64_t>(&quite::ObjectQueryBuilder::with_property),
99+
.def("property",
100+
py::overload_cast<std::string, std::int64_t>(&quite::ObjectQueryBuilder::property),
101101
py::arg{"key"},
102102
py::arg{"value"},
103103
"Adds the property to the search requirements")
104-
.def("with_property",
105-
py::overload_cast<std::string, double>(&quite::ObjectQueryBuilder::with_property),
104+
.def("property",
105+
py::overload_cast<std::string, double>(&quite::ObjectQueryBuilder::property),
106106
py::arg{"key"},
107107
py::arg{"value"})
108-
.def("with_property",
109-
py::overload_cast<std::string, bool>(&quite::ObjectQueryBuilder::with_property),
108+
.def("property",
109+
py::overload_cast<std::string, bool>(&quite::ObjectQueryBuilder::property),
110110
py::arg{"key"},
111111
py::arg{"value"})
112-
.def("with_property",
113-
py::overload_cast<std::string, std::string>(&quite::ObjectQueryBuilder::with_property),
112+
.def("property",
113+
py::overload_cast<std::string, std::string>(&quite::ObjectQueryBuilder::property),
114114
py::arg{"key"},
115115
py::arg{"value"})
116-
.def("with_parent", &quite::ObjectQueryBuilder::with_parent, py::arg("parent"))
117-
.def("with_type", &quite::ObjectQueryBuilder::with_type, py::arg("type_name"));
116+
.def("parent", &quite::ObjectQueryBuilder::parent, py::arg("parent"))
117+
.def("type", &quite::ObjectQueryBuilder::type, py::arg("type_name"));
118118
py::implicitly_convertible<quite::ObjectQueryBuilder, quite::ObjectQuery>();
119119

120-
m.def("make_query", &quite::make_query, "Create a new ObjectQuery");
120+
m.def("query", &quite::query, "Create a new ObjectQuery");
121121

122122
m.def("expect", &expect, py::arg{"object"});
123123
py_expect.def("screenshot", &IExpectBuilder::to_have_screenshot, py::arg{"name"});

python/quite/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
__version__,
1919
__version_git_ref__,
2020
expect,
21-
make_query,
21+
query,
2222
)
2323

2424
__all__ = [
@@ -35,5 +35,5 @@
3535
"__version__",
3636
"__version_git_ref__",
3737
"expect",
38-
"make_query",
38+
"query",
3939
]

python/quite/__init__.pyi

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ from ._quite import (
4242
expect as expect,
4343
)
4444
from ._quite import (
45-
make_query as make_query,
45+
query as query,
4646
)
4747

4848
__all__ = [
@@ -59,5 +59,5 @@ __all__ = [
5959
"__version__",
6060
"__version_git_ref__",
6161
"expect",
62-
"make_query",
62+
"query",
6363
]

python/quite/_quite.pyi

Lines changed: 30 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -76,77 +76,75 @@ class ObjectQueryBuilder:
7676
def __init__(self) -> None:
7777
"""__init__(self: quite._quite.ObjectQueryBuilder) -> None"""
7878

79-
def with_parent(self, parent: ObjectQuery) -> ObjectQueryBuilder:
80-
"""with_parent(self: quite._quite.ObjectQueryBuilder, parent: quite._quite.ObjectQuery) -> quite._quite.ObjectQueryBuilder"""
79+
def parent(self, parent: ObjectQueryBuilder) -> ObjectQueryBuilder:
80+
"""parent(self: quite._quite.ObjectQueryBuilder, parent: quite._quite.ObjectQueryBuilder) -> quite._quite.ObjectQueryBuilder"""
8181

8282
@overload
83-
def with_property(self, key: str, value: typing.SupportsInt) -> ObjectQueryBuilder:
84-
"""with_property(*args, **kwargs)
83+
def property(self, key: str, value: typing.SupportsInt) -> ObjectQueryBuilder:
84+
"""property(*args, **kwargs)
8585
Overloaded function.
8686
87-
1. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsInt) -> quite._quite.ObjectQueryBuilder
87+
1. property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsInt) -> quite._quite.ObjectQueryBuilder
8888
8989
Adds the property to the search requirements
9090
91-
2. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsFloat) -> quite._quite.ObjectQueryBuilder
91+
2. property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsFloat) -> quite._quite.ObjectQueryBuilder
9292
93-
3. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: bool) -> quite._quite.ObjectQueryBuilder
93+
3. property(self: quite._quite.ObjectQueryBuilder, key: str, value: bool) -> quite._quite.ObjectQueryBuilder
9494
95-
4. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: str) -> quite._quite.ObjectQueryBuilder
95+
4. property(self: quite._quite.ObjectQueryBuilder, key: str, value: str) -> quite._quite.ObjectQueryBuilder
9696
"""
9797

9898
@overload
99-
def with_property(
100-
self, key: str, value: typing.SupportsFloat
101-
) -> ObjectQueryBuilder:
102-
"""with_property(*args, **kwargs)
99+
def property(self, key: str, value: typing.SupportsFloat) -> ObjectQueryBuilder:
100+
"""property(*args, **kwargs)
103101
Overloaded function.
104102
105-
1. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsInt) -> quite._quite.ObjectQueryBuilder
103+
1. property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsInt) -> quite._quite.ObjectQueryBuilder
106104
107105
Adds the property to the search requirements
108106
109-
2. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsFloat) -> quite._quite.ObjectQueryBuilder
107+
2. property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsFloat) -> quite._quite.ObjectQueryBuilder
110108
111-
3. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: bool) -> quite._quite.ObjectQueryBuilder
109+
3. property(self: quite._quite.ObjectQueryBuilder, key: str, value: bool) -> quite._quite.ObjectQueryBuilder
112110
113-
4. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: str) -> quite._quite.ObjectQueryBuilder
111+
4. property(self: quite._quite.ObjectQueryBuilder, key: str, value: str) -> quite._quite.ObjectQueryBuilder
114112
"""
115113

116114
@overload
117-
def with_property(self, key: str, value: bool) -> ObjectQueryBuilder:
118-
"""with_property(*args, **kwargs)
115+
def property(self, key: str, value: bool) -> ObjectQueryBuilder:
116+
"""property(*args, **kwargs)
119117
Overloaded function.
120118
121-
1. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsInt) -> quite._quite.ObjectQueryBuilder
119+
1. property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsInt) -> quite._quite.ObjectQueryBuilder
122120
123121
Adds the property to the search requirements
124122
125-
2. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsFloat) -> quite._quite.ObjectQueryBuilder
123+
2. property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsFloat) -> quite._quite.ObjectQueryBuilder
126124
127-
3. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: bool) -> quite._quite.ObjectQueryBuilder
125+
3. property(self: quite._quite.ObjectQueryBuilder, key: str, value: bool) -> quite._quite.ObjectQueryBuilder
128126
129-
4. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: str) -> quite._quite.ObjectQueryBuilder
127+
4. property(self: quite._quite.ObjectQueryBuilder, key: str, value: str) -> quite._quite.ObjectQueryBuilder
130128
"""
131129

132130
@overload
133-
def with_property(self, key: str, value: str) -> ObjectQueryBuilder:
134-
"""with_property(*args, **kwargs)
131+
def property(self, key: str, value: str) -> ObjectQueryBuilder:
132+
"""property(*args, **kwargs)
135133
Overloaded function.
136134
137-
1. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsInt) -> quite._quite.ObjectQueryBuilder
135+
1. property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsInt) -> quite._quite.ObjectQueryBuilder
138136
139137
Adds the property to the search requirements
140138
141-
2. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsFloat) -> quite._quite.ObjectQueryBuilder
139+
2. property(self: quite._quite.ObjectQueryBuilder, key: str, value: typing.SupportsFloat) -> quite._quite.ObjectQueryBuilder
142140
143-
3. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: bool) -> quite._quite.ObjectQueryBuilder
141+
3. property(self: quite._quite.ObjectQueryBuilder, key: str, value: bool) -> quite._quite.ObjectQueryBuilder
144142
145-
4. with_property(self: quite._quite.ObjectQueryBuilder, key: str, value: str) -> quite._quite.ObjectQueryBuilder
143+
4. property(self: quite._quite.ObjectQueryBuilder, key: str, value: str) -> quite._quite.ObjectQueryBuilder
146144
"""
147145

148-
def with_type(self, type_name: str) -> ObjectQueryBuilder:
149-
"""with_type(self: quite._quite.ObjectQueryBuilder, type_name: str) -> quite._quite.ObjectQueryBuilder"""
146+
def type(self, type_name: str) -> ObjectQueryBuilder:
147+
"""type(self: quite._quite.ObjectQueryBuilder, type_name: str) -> quite._quite.ObjectQueryBuilder"""
150148

151149
class Probe:
152150
def __init__(self, *args, **kwargs) -> None:
@@ -270,8 +268,8 @@ class RemoteObject:
270268
def expect(object: RemoteObject) -> IExpectBuilder:
271269
"""expect(object: quite._quite.RemoteObject) -> quite._quite.IExpectBuilder"""
272270

273-
def make_query() -> ObjectQueryBuilder:
274-
"""make_query() -> quite._quite.ObjectQueryBuilder
271+
def query() -> ObjectQueryBuilder:
272+
"""query() -> quite._quite.ObjectQueryBuilder
275273
276274
Create a new ObjectQuery
277275
"""

0 commit comments

Comments
 (0)