General Coding rule to detect usages of old time and date classes (#1384 / #1385) by Bukama · Pull Request #1385 · TNG/ArchUnit

Bukama · 2024-11-27T19:40:44Z

Update:

Provided commit message

General coding rule to detect usages of old time and date classes (#1384 / #1385)

With this commit new general rules are added which detect the usages of old
time and date classes, e.g. java.util.Date.

closes #1384

I would like to provide rules for #1384, but I'm failing with the OLD_DATE_AND_TIME_CLASSES_SHOULD_NOT_BE_USED_should_fail_when_class_uses_java_util_date test as my violation is not captured, but this

[violation details (should have some detail containing 'since Java 8 (and JavaEE 7 if JPA is needed) java.time-API should be used.')]
Expecting any elements of:
["Method <com.tngtech.archunit.library.testclasses.timeapi.incorrect.UsesJavaUtilDate.usesJavaUtilDate()> calls method <java.util.Date.from(java.time.Instant)> in (UsesJavaUtilDate.java:9)"]
to match given predicate but none did.
java.lang.AssertionError: [violation details (should have some detail containing 'since Java 8 (and JavaEE 7 if JPA is needed) java.time-API should be used.')]
Expecting any elements of:
["Method <com.tngtech.archunit.library.testclasses.timeapi.incorrect.UsesJavaUtilDate.usesJavaUtilDate()> calls method <java.util.Date.from(java.time.Instant)> in (UsesJavaUtilDate.java:9)"]
to match given predicate but none did.

Can anyone give me a hint how to fix that?

P.S. I know that my formatting (e.g. star import) are not yet correct. Will fix this when my tests are working and before changing this draft into a real PR, including providing a real commit message.

hankem · 2024-11-27T19:54:29Z

Thanks for your contribution! I think that your confusion is that

since Java 8 (and JavaEE 7 if JPA is needed) java.time-API should be used.

is part of the rule description, but you're testing the violation description, which is

Method <com.tngtech.archunit.library.testclasses.timeapi.incorrect.UsesJavaUtilDate.usesJavaUtilDate()> calls method <java.util.Date.from(java.time.Instant)> in (UsesJavaUtilDate.java:9)

Bukama · 2024-11-28T16:06:48Z

Thanks for your contribution! I think that your confusion is that

since Java 8 (and JavaEE 7 if JPA is needed) java.time-API should be used.

is part of the rule description, but you're testing the violation description, which is

Method <com.tngtech.archunit.library.testclasses.timeapi.incorrect.UsesJavaUtilDate.usesJavaUtilDate()> calls method <java.util.Date.from(java.time.Instant)> in (UsesJavaUtilDate.java:9)

Thanks that helped!

codecholeric · 2025-01-19T14:05:02Z

Hey @Bukama, thanks a lot for your support, we really appreciate it 😃 Could you do me a favor and sign off your commits according to the DCO? (-> https://github.com/TNG/ArchUnit/blob/main/DCO) It's basically some legal thing where you confirm that you contribute the code under the project license and are allowed to contribute it.

I think the easiest would be to squash your commits(I think this change in the end is small enough for a single commit, right?) and then run git commit -s --amend --no-edit from the command line. The -s option adds the standardized sign-off part to the commit message 🙂

…G#1384 / TNG#1385) With this commit new general rules are added which detect the usages of old time and date classes, e.g. java.util.Date. closes TNG#1384 > Developer's Certificate of Origin 1.1 > > By making a contribution to this project, I certify that: > > (a) The contribution was created in whole or in part by me and I > have the right to submit it under the open source license > indicated in the file; or > > (b) The contribution is based upon previous work that, to the best > of my knowledge, is covered under an appropriate open source > license and I have the right under that license to submit that > work with modifications, whether created in whole or in part > by me, under the same open source license (unless I am > permitted to submit under a different license), as indicated > in the file; or > > (c) The contribution was provided directly to me by some other > person who certified (a), (b) or (c) and I have not modified > it. > > (d) I understand and agree that this project and the contribution > are public and that a record of the contribution (including all > personal information I submit with it, including my sign-off) is > maintained indefinitely and may be redistributed consistent with > this project or the open source license(s) involved. Signed-off-by: Matthias Bünger <[email protected]>

Bukama · 2025-01-19T17:32:46Z

Hey @Bukama, thanks a lot for your support, we really appreciate it 😃 Could you do me a favor and sign off your commits according to the DCO? (-> https://github.com/TNG/ArchUnit/blob/main/DCO) It's basically some legal thing where you confirm that you contribute the code under the project license and are allowed to contribute it.

I think the easiest would be to squash your commits(I think this change in the end is small enough for a single commit, right?) and then run git commit -s --amend --no-edit from the command line. The -s option adds the standardized sign-off part to the commit message 🙂

Hey, thanks for the response.
Didn't notice that part, so I only prepared a commit message for you to use when squash-merging the PR (which I'm used from other projects, but ofc this is no valid excuse, because every project defines how it deals with PR). Hope I've done it right now.

…G#1384 / TNG#1385) With this commit new general rules are added which detect the usages of old time and date classes, e.g. java.util.Date. closes TNG#1384 > Developer's Certificate of Origin 1.1 > > By making a contribution to this project, I certify that: > > (a) The contribution was created in whole or in part by me and I > have the right to submit it under the open source license > indicated in the file; or > > (b) The contribution is based upon previous work that, to the best > of my knowledge, is covered under an appropriate open source > license and I have the right under that license to submit that > work with modifications, whether created in whole or in part > by me, under the same open source license (unless I am > permitted to submit under a different license), as indicated > in the file; or > > (c) The contribution was provided directly to me by some other > person who certified (a), (b) or (c) and I have not modified > it. > > (d) I understand and agree that this project and the contribution > are public and that a record of the contribution (including all > personal information I submit with it, including my sign-off) is > maintained indefinitely and may be redistributed consistent with > this project or the open source license(s) involved. Signed-off-by: Matthias Bünger <[email protected]>

/ #1385) With this commit new general rules are added which detect the usages of old time and date classes, e.g. java.util.Date. closes #1384 > Developer's Certificate of Origin 1.1 > > By making a contribution to this project, I certify that: > > (a) The contribution was created in whole or in part by me and I > have the right to submit it under the open source license > indicated in the file; or > > (b) The contribution is based upon previous work that, to the best > of my knowledge, is covered under an appropriate open source > license and I have the right under that license to submit that > work with modifications, whether created in whole or in part > by me, under the same open source license (unless I am > permitted to submit under a different license), as indicated > in the file; or > > (c) The contribution was provided directly to me by some other > person who certified (a), (b) or (c) and I have not modified > it. > > (d) I understand and agree that this project and the contribution > are public and that a record of the contribution (including all > personal information I submit with it, including my sign-off) is > maintained indefinitely and may be redistributed consistent with > this project or the open source license(s) involved. Signed-off-by: Matthias Bünger <[email protected]>

hankem

I've reformatted your commit according to the code style of the project (cf. CONTRIBUTING.md).

hankem · 2025-01-25T11:31:52Z

+                    .as("since Java 8 (and JavaEE 7 if JPA is needed) java.time-API should be used.")
+                    .because("since Java 8 (and JavaEE 7 if JPA is needed) java.time-API should be used.");


If you use the same text in as and because, you essentially duplicate it in the final rule description:

Rule 'since Java 8 (and JavaEE 7 if JPA is needed) java.time-API should be used., because since Java 8 (and JavaEE 7 if JPA is needed) java.time-API should be used.' was violated [...]

How about

Suggested change

.as("since Java 8 (and JavaEE 7 if JPA is needed) java.time-API should be used.")

.because("since Java 8 (and JavaEE 7 if JPA is needed) java.time-API should be used.");

.as("java.time API should be used")

.because("legacy date/time APIs have been replaced since Java 8 (JSR 310)");

which gives the final rule description

Rule 'java.time API should be used, because legacy date/time APIs have been replaced since Java 8' was violated [...]

without full stop before , because,

without the reference to Java EE 7 & JPA, because it might be confusing if the general coding rule is used in an context unrelated to Java EE/JPA, but

with a reference to JSR 310, which might help unexperienced developers to find more information.

For your convenience, I've prepared this suggestion on the dateutil-review branch.

Thank you for your suggestion. I'm fine with that. In my initial version I added the JPA information, because we have that at work, that Java 8 is available, but not JavaEE 7.
Also run spotless tasks, so that should fit too now.

edit: and rebased as obvious after months that there are commits on mains.

/ #1385) With this commit new general rules are added which detect the usages of old time and date classes, e.g. java.util.Date. closes #1384 > Developer's Certificate of Origin 1.1 > > By making a contribution to this project, I certify that: > > (a) The contribution was created in whole or in part by me and I > have the right to submit it under the open source license > indicated in the file; or > > (b) The contribution is based upon previous work that, to the best > of my knowledge, is covered under an appropriate open source > license and I have the right under that license to submit that > work with modifications, whether created in whole or in part > by me, under the same open source license (unless I am > permitted to submit under a different license), as indicated > in the file; or > > (c) The contribution was provided directly to me by some other > person who certified (a), (b) or (c) and I have not modified > it. > > (d) I understand and agree that this project and the contribution > are public and that a record of the contribution (including all > personal information I submit with it, including my sign-off) is > maintained indefinitely and may be redistributed consistent with > this project or the open source license(s) involved. Signed-off-by: Matthias Bünger <[email protected]>

…G#1384 / TNG#1385) With this commit new general rules are added which detect the usages of old time and date classes, e.g. java.util.Date. closes TNG#1384 > Developer's Certificate of Origin 1.1 > > By making a contribution to this project, I certify that: > > (a) The contribution was created in whole or in part by me and I > have the right to submit it under the open source license > indicated in the file; or > > (b) The contribution is based upon previous work that, to the best > of my knowledge, is covered under an appropriate open source > license and I have the right under that license to submit that > work with modifications, whether created in whole or in part > by me, under the same open source license (unless I am > permitted to submit under a different license), as indicated > in the file; or > > (c) The contribution was provided directly to me by some other > person who certified (a), (b) or (c) and I have not modified > it. > > (d) I understand and agree that this project and the contribution > are public and that a record of the contribution (including all > personal information I submit with it, including my sign-off) is > maintained indefinitely and may be redistributed consistent with > this project or the open source license(s) involved. Signed-off-by: Matthias Bünger <[email protected]>

rweisleder · 2025-02-11T08:50:58Z

@hankem It looks like this nice enhancement is missing in the 1.4.0 release notes. 😢

hankem · 2025-02-11T09:58:50Z

Oooh, I'm sorry for overlooking that one! The release notes have been fixed.

Bukama marked this pull request as ready for review November 28, 2024 16:07

Bukama changed the title ~~General Coding rule to detect usages of old time and date classes (DRAFT for #1384)~~ General Coding rule to detect usages of old time and date classes (#1384 / #1385) Nov 28, 2024

Bukama force-pushed the dateutil branch from dc4f115 to 57891fd Compare January 19, 2025 17:30

hankem force-pushed the dateutil branch from 57891fd to bfd231e Compare January 25, 2025 10:20

hankem force-pushed the dateutil branch from bfd231e to 1e7bcde Compare January 25, 2025 11:27

hankem reviewed Jan 25, 2025

View reviewed changes

Bukama force-pushed the dateutil branch from 1e7bcde to 82aba71 Compare January 25, 2025 19:13

Bukama force-pushed the dateutil branch from 82aba71 to d48b634 Compare January 25, 2025 19:17

hankem force-pushed the dateutil branch from d48b634 to c4372b2 Compare January 26, 2025 11:09

hankem enabled auto-merge January 26, 2025 11:10

hankem merged commit 54fae8d into TNG:main Jan 26, 2025

Bukama deleted the dateutil branch February 11, 2025 15:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

General Coding rule to detect usages of old time and date classes (#1384 / #1385)#1385

General Coding rule to detect usages of old time and date classes (#1384 / #1385)#1385
hankem merged 1 commit into
TNG:mainfrom
Bukama:dateutil

Bukama commented Nov 27, 2024 •

edited

Loading

Uh oh!

hankem commented Nov 27, 2024

Uh oh!

Bukama commented Nov 28, 2024

Uh oh!

codecholeric commented Jan 19, 2025

Uh oh!

Bukama commented Jan 19, 2025

Uh oh!

hankem left a comment

Uh oh!

hankem Jan 25, 2025

Uh oh!

hankem Jan 25, 2025

Uh oh!

Bukama Jan 25, 2025 •

edited

Loading

Uh oh!

rweisleder commented Feb 11, 2025

Uh oh!

hankem commented Feb 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		.as("since Java 8 (and JavaEE 7 if JPA is needed) java.time-API should be used.")
		.because("since Java 8 (and JavaEE 7 if JPA is needed) java.time-API should be used.");

Conversation

Bukama commented Nov 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hankem commented Nov 27, 2024

Uh oh!

Bukama commented Nov 28, 2024

Uh oh!

codecholeric commented Jan 19, 2025

Uh oh!

Bukama commented Jan 19, 2025

Uh oh!

hankem left a comment

Choose a reason for hiding this comment

Uh oh!

hankem Jan 25, 2025

Choose a reason for hiding this comment

Uh oh!

hankem Jan 25, 2025

Choose a reason for hiding this comment

Uh oh!

Bukama Jan 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rweisleder commented Feb 11, 2025

Uh oh!

hankem commented Feb 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Bukama commented Nov 27, 2024 •

edited

Loading

Bukama Jan 25, 2025 •

edited

Loading