assertj / assertj/assertj-generator
switch the property/field templates over to use the 'navigation' approach by default?
- Ngôn ngữ chính
- Java
- Star
- 72
- Fork
- 47
- Merge trung bình
- 1 ngày 16 giờ
- Pull request đã merge (30 ngày)
- 2
Mô tả
Once this PR is merged and issue fixed https://github.com/joel-costigliola/assertj-assertions-generator/issues/67 along with the NavigationListAssert class in assertj-core: https://github.com/joel-costigliola/assertj-core/issues/641 it would be easy to switch the OOTB templates in the generator to use the 'navigation' model approach.
So that for every property of an object we generate exactly one navigation method that lets users chain assertions together; reusing all the methods from ListAssert and NavigationListAssert for iterable properties or the custom typed assertions for other properties.
This would result in much smaller code generated for the assertion classes and much more power. The only downside is some of the current methods would be a tad more verbose.
e.g. for a generated assertion class with a name property the current generated code would be:
``` java
// current generated code
assertThat(person).hasName("James");
// new minimal code
assertThat(person).name().isEqualTo("James");
assertThat(person).name().contains("m");
...
```
Ditto for iterable properties right now we generate a few methods which are mostly already included in ListAssert. e.g. all these assertion methods are available on any generated iterable property method:
https://github.com/jstrachan/assertj-core/blob/7b1d079edeb5ac984cebbed77a65025718ee7673/src/test/java/org/assertj/core/navigation/ListNavigation_Test.java#L56-L62
Removing the old generated methods would break folks code I guess; so maybe we should add a flag to switch to the new more concise model?
If you are interested; here are the 2 new templates (which need minor tweaks to reuse the https://github.com/joel-costigliola/assertj-core/issues/641 code):
- for general properties/fields: https://github.com/jstrachan/fabric8/blob/5f99b82696856e9c5614ff5a728adfbeaab96751/components/kubernetes-assertions/src/main/assertj-templates/navigation_template.txt
- for iterable properties/fields: https://github.com/jstrachan/fabric8/blob/6e333451afceec3308e6869f39a14c3e569d837b/components/kubernetes-assertions/src/main/assertj-templates/has_elements_assertion_template_for_iterable.txt
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu bằng việc xem xét issue 67 và assertj-core issue 641, sau đó so sánh hai template điều hướng được liên kết với các template property và iterable hiện tại của generator. Xác định cách hỗ trợ NavigationListAssert và một cờ tương thích ảnh hưởng đến các API được tạo, đồng thời xác minh rằng các assertion được tạo cung cấp các phương thức điều hướng mà không làm hỏng các phương thức hiện có.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- java
- Lĩnh vực
- tooling
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 30/100