-
Notifications
You must be signed in to change notification settings - Fork 92
Prefer System getProperty() over getenv()
#679
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Prefer System getProperty() over getenv()
#679
Conversation
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
src/main/java/org/openrewrite/staticanalysis/PreferSystemGetPropertyOverGetenv.java
Outdated
Show resolved
Hide resolved
src/test/java/org/openrewrite/staticanalysis/PreferSystemGetPropertyOverGetenvTest.java
Outdated
Show resolved
Hide resolved
src/test/java/org/openrewrite/staticanalysis/PreferSystemGetPropertyOverGetenvTest.java
Show resolved
Hide resolved
src/main/java/org/openrewrite/staticanalysis/PreferSystemGetPropertyOverGetenv.java
Outdated
Show resolved
Hide resolved
src/test/java/org/openrewrite/staticanalysis/PreferSystemGetPropertyOverGetenvTest.java
Outdated
Show resolved
Hide resolved
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
|
I've made the requested changes! |
src/test/java/org/openrewrite/staticanalysis/PreferSystemGetPropertyOverGetenvTest.java
Outdated
Show resolved
Hide resolved
| @Override | ||
| public String getDisplayName() { | ||
| return "Prefer System.getProperty(\"user.home\") over System.getenv(\"HOME\")"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can extend it now for other cases.
ChatGPT suggests:
(left hand side is getenv, right hand side is getProperty)
- USERNAME/USER =>
user.name - HOME/USERPROFILE =>
user.home - TMPDIR/TEMP/TMP =>
java.io.tmpdir
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it, sure
System getProperty() over getenv()
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some suggestions could not be made:
- src/test/java/org/openrewrite/staticanalysis/BooleanChecksNotInvertedTest.java
- lines 27-27
- lines 64-64
- src/test/java/org/openrewrite/staticanalysis/SimplifyTernaryTest.java
- lines 25-25
- lines 91-91
timtebeek
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for the help & rework here @Akanksha928 ! Seems like a perfect addition to the catalog.
I've applied some minor polish to your PR on the following points:
- No need to check the number of arguments: that's implied by MethodMatcher
- No need to check the type of the value returned by the Literal; again implied
- No need to add imports for
java.langentries; those are always present - Then no need to use JavaTemplate builder, as there's a shorthand to directly apply
Note that we don't expect you to know all this when starting out; just sharing here as it might help you learn, as we'd love to see what else you will build. :)
… 2.15.0 to 2.16.0 [skip ci] Bumps [org.openrewrite.recipe:rewrite-static-analysis](https://github.com/openrewrite/rewrite-static-analysis) from 2.15.0 to 2.16.0. Release notes *Sourced from [org.openrewrite.recipe:rewrite-static-analysis's releases](https://github.com/openrewrite/rewrite-static-analysis/releases).* > 2.16.0 > ------ > > What's Changed > -------------- > > * fix: Enhanced UseCollectionInterfaces to prevent conversions when non interface methods are used by [`@e5LA`](https://github.com/e5LA) in [openrewrite/rewrite-static-analysis#709](https://redirect.github.com/openrewrite/rewrite-static-analysis/pull/709) > * Improve support method invocations for `RemoveRedundantTypeCast` by [`@jevanlingen`](https://github.com/jevanlingen) in [openrewrite/rewrite-static-analysis#711](https://redirect.github.com/openrewrite/rewrite-static-analysis/pull/711) > * Do not move field annotations around arrays by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-static-analysis#712](https://redirect.github.com/openrewrite/rewrite-static-analysis/pull/712) > * Use classpath from resource for Refaster by [`@jevanlingen`](https://github.com/jevanlingen) in [openrewrite/rewrite-static-analysis#714](https://redirect.github.com/openrewrite/rewrite-static-analysis/pull/714) > * Fix NPE in UseCollectionInterfaces with annotated raw collection types by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-static-analysis#717](https://redirect.github.com/openrewrite/rewrite-static-analysis/pull/717) > * Prefer `System getProperty()` over `getenv()` by [`@Akanksha928`](https://github.com/Akanksha928) in [openrewrite/rewrite-static-analysis#679](https://redirect.github.com/openrewrite/rewrite-static-analysis/pull/679) > * Expand coverage of UseCollectionInterfaces to LinkedList, Stack, TreeMap, TreeSet and PriorityQueue by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-static-analysis#718](https://redirect.github.com/openrewrite/rewrite-static-analysis/pull/718) > * Fix ReplaceLambdaWithMethodReference to not replace lambdas inside anonymous inner classes by [`@timtebeek`](https://github.com/timtebeek) in [openrewrite/rewrite-static-analysis#723](https://redirect.github.com/openrewrite/rewrite-static-analysis/pull/723) > > New Contributors > ---------------- > > * [`@Akanksha928`](https://github.com/Akanksha928) made their first contribution in [openrewrite/rewrite-static-analysis#679](https://redirect.github.com/openrewrite/rewrite-static-analysis/pull/679) > > **Full Changelog**: <openrewrite/rewrite-static-analysis@v2.15.0...v2.16.0> Commits * [`53c6b3e`](openrewrite/rewrite-static-analysis@53c6b3e) Update documentation examples * [`0437c5c`](openrewrite/rewrite-static-analysis@0437c5c) Fix ReplaceLambdaWithMethodReference to not replace lambdas inside anonymous ... * [`da75646`](openrewrite/rewrite-static-analysis@da75646) Expand coverage of UseCollectionInterfaces to LinkedList, Stack, TreeMap, Tre... * [`d01363c`](openrewrite/rewrite-static-analysis@d01363c) Prefer `System getProperty()` over `getenv()` ([#679](https://redirect.github.com/openrewrite/rewrite-static-analysis/issues/679)) * [`6f8b0df`](openrewrite/rewrite-static-analysis@6f8b0df) AssertJ best practices * [`5f64939`](openrewrite/rewrite-static-analysis@5f64939) Fix NPE in UseCollectionInterfaces with annotated raw collection types ([#717](https://redirect.github.com/openrewrite/rewrite-static-analysis/issues/717)) * [`feee568`](openrewrite/rewrite-static-analysis@feee568) Fix annotation order and import * [`a51a3ba`](openrewrite/rewrite-static-analysis@a51a3ba) Use classpath from resource for Refaster ([#714](https://redirect.github.com/openrewrite/rewrite-static-analysis/issues/714)) * [`fa1d3c3`](openrewrite/rewrite-static-analysis@fa1d3c3) Fix OnlyCatchDeclaredExceptions to skip generic type variables * [`21ad269`](openrewrite/rewrite-static-analysis@21ad269) Do not move field annotations around arrays ([#712](https://redirect.github.com/openrewrite/rewrite-static-analysis/issues/712)) * Additional commits viewable in [compare view](openrewrite/rewrite-static-analysis@v2.15.0...v2.16.0) [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- Dependabot commands and options You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
What's changed?
Added a new recipe that replaces 'System.getenv("HOME")' with 'System.getProperty("user.home")'.
What's your motivation?
getProperty()overgetenv()#624Anything in particular you'd like reviewers to focus on?
Nothing in specific
Have you considered any alternatives or workarounds?
Not yet, but open to discussion
Checklist