Merge branch 'main' into fix-remove-unused-imports

openrewrite · Sep 24, 2024 · 43a8266 · 43a8266
2 parents 6a11dc0 + d2c825c
commit 43a8266
Show file tree

Hide file tree

Showing 185 changed files with 4,175 additions and 2,360 deletions.
diff --git a/.github/workflows/receive-pr.yml b/.github/workflows/receive-pr.yml
@@ -72,13 +72,9 @@ jobs:
         displayName: Recipe nullability best practices
         description: Use OpenRewrite internal nullability annotations; drop JetBrains annotations; use `package-info.java` instead.
         recipeList:
-          - org.openrewrite.java.ChangeType:
-              oldFullyQualifiedTypeName: org.jetbrains.annotations.Nullable
-              newFullyQualifiedTypeName: org.openrewrite.internal.lang.Nullable
-          - org.openrewrite.java.ChangeType:
-              oldFullyQualifiedTypeName: jakarta.annotation.Nullable
-              newFullyQualifiedTypeName: org.openrewrite.internal.lang.Nullable
+          - org.openrewrite.staticanalysis.NullableOnMethodReturnType
           - org.openrewrite.java.RemoveAnnotation:
               annotationPattern: '@org.jetbrains.annotations.NotNull'
           - org.openrewrite.java.RemoveAnnotation:
               annotationPattern: '@jakarta.annotation.Nonnull'
+          - org.openrewrite.java.jspecify.MigrateToJspecify
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,8 +1,8 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.10-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionSha256Sum=5b9c5eb3f9fc2c94abaea57d90bd78747ca117ddbbf96c859d3741181a12bf2a
+distributionSha256Sum=31c55713e40233a8303827ceb42ca48a47267a0ad4bab9177123121e71524c26
diff --git a/rewrite-core/src/main/java/org/openrewrite/Cursor.java b/rewrite-core/src/main/java/org/openrewrite/Cursor.java
@@ -187,8 +187,8 @@ public String toString() {
                        .map(t -> t instanceof Tree ?
                                t.getClass().getSimpleName() :
                                t.toString())
-                       .collect(Collectors.joining("->"))
-               + "}";
+                       .collect(Collectors.joining("->")) +
+               "}";
     }
 
     public Cursor dropParentUntil(Predicate<Object> valuePredicate) {

diff --git a/rewrite-core/src/main/java/org/openrewrite/PathUtils.java b/rewrite-core/src/main/java/org/openrewrite/PathUtils.java
@@ -151,8 +151,8 @@ private static boolean matchesGlob(String pattern, String path) {
             if (!StringUtils.matchesGlob(pathTokens[pathIdxEnd], pattTokens[pattIdxEnd])) {
                 return false;
             }
-            if (pattIdxEnd == (pattTokens.length - 1)
-                && (isFileSeparator(pattern.charAt(pattern.length() - 1)) ^ isFileSeparator(path.charAt(path.length() - 1)))) {
+            if (pattIdxEnd == (pattTokens.length - 1) &&
+                (isFileSeparator(pattern.charAt(pattern.length() - 1)) ^ isFileSeparator(path.charAt(path.length() - 1)))) {
                 return false;
             }
             pattIdxEnd--;
@@ -293,8 +293,8 @@ private static boolean isFileSeparator(char ch) {
 
     @SuppressWarnings("SameParameterValue")
     private static boolean isFileSeparator(boolean strict, char ch) {
-        return strict
-                ? ch == File.separatorChar
-                : ch == UNIX_SEPARATOR || ch == WINDOWS_SEPARATOR;
+        return strict ?
+                ch == File.separatorChar :
+                ch == UNIX_SEPARATOR || ch == WINDOWS_SEPARATOR;
     }
 }
diff --git a/rewrite-core/src/main/java/org/openrewrite/config/DeclarativeRecipe.java b/rewrite-core/src/main/java/org/openrewrite/config/DeclarativeRecipe.java
@@ -270,7 +270,7 @@ public final List<Recipe> getRecipeList() {
                         getName() + " declares the ScanningRecipe " + precondition.getName() + " as a precondition." +
                         "ScanningRecipe cannot be used as Preconditions.");
             }
-            andPreconditions.add(precondition::getVisitor);
+            andPreconditions.add(() -> orVisitors(precondition));
         }
         PreconditionBellwether bellwether = new PreconditionBellwether(Preconditions.and(andPreconditions.toArray(new Supplier[]{})));
         List<Recipe> recipeListWithBellwether = new ArrayList<>(recipeList.size() + 1);
@@ -279,6 +279,19 @@ public final List<Recipe> getRecipeList() {
         return recipeListWithBellwether;
     }
 
+    private static TreeVisitor<?, ExecutionContext> orVisitors(Recipe recipe) {
+        if (recipe.getRecipeList().isEmpty()) {
+            return recipe.getVisitor();
+        }
+        List<TreeVisitor<?, ExecutionContext>> conditions = new ArrayList<>();
+        conditions.add(recipe.getVisitor());
+        for (Recipe r : recipe.getRecipeList()) {
+            conditions.add(orVisitors(r));
+        }
+        //noinspection unchecked
+        return Preconditions.or(conditions.toArray(new TreeVisitor[0]));
+    }
+
     private static boolean isScanningRecipe(Recipe recipe) {
         if (recipe instanceof ScanningRecipe) {
             return true;

diff --git a/rewrite-core/src/main/java/org/openrewrite/internal/StringUtils.java b/rewrite-core/src/main/java/org/openrewrite/internal/StringUtils.java
@@ -466,8 +466,8 @@ private static boolean matchesGlob(String pattern, String str, boolean caseSensi
             if (ch == '*') {
                 break;
             }
-            if (ch != '?'
-                && different(caseSensitive, ch, str.charAt(strIdxStart))) {
+            if (ch != '?' &&
+                different(caseSensitive, ch, str.charAt(strIdxStart))) {
                 return false; // Character mismatch
             }
             patIdxStart++;
@@ -554,9 +554,9 @@ private static boolean allStars(String chars, int start, int end) {
     }
 
     private static boolean different(boolean caseSensitive, char ch, char other) {
-        return caseSensitive
-                ? ch != other
-                : Character.toUpperCase(ch) != Character.toUpperCase(other);
+        return caseSensitive ?
+                ch != other :
+                Character.toUpperCase(ch) != Character.toUpperCase(other);
     }
 
     public static String indent(String text) {

diff --git a/rewrite-core/src/main/java/org/openrewrite/ipc/http/OkHttpSender.java b/rewrite-core/src/main/java/org/openrewrite/ipc/http/OkHttpSender.java
@@ -54,9 +54,9 @@ public Response send(Request request) {
         String methodValue = method.toString();
         if (entity.length > 0) {
             String contentType = request.getRequestHeaders().get("Content-Type");
-            MediaType mediaType = contentType != null
-                    ? MediaType.get(contentType + "; charset=utf-8")
-                    : MEDIA_TYPE_APPLICATION_JSON;
+            MediaType mediaType = contentType != null ?
+                    MediaType.get(contentType + "; charset=utf-8") :
+                    MEDIA_TYPE_APPLICATION_JSON;
             RequestBody body = RequestBody.create(entity, mediaType);
             requestBuilder.method(methodValue, body);
         } else {

diff --git a/rewrite-core/src/main/java/org/openrewrite/marker/GitProvenance.java b/rewrite-core/src/main/java/org/openrewrite/marker/GitProvenance.java
@@ -195,9 +195,9 @@ public GitProvenance(UUID id,
             if (environment instanceof JenkinsBuildEnvironment) {
                 JenkinsBuildEnvironment jenkinsBuildEnvironment = (JenkinsBuildEnvironment) environment;
                 try (Repository repository = new RepositoryBuilder().findGitDir(projectDir.toFile()).build()) {
-                    String branch = jenkinsBuildEnvironment.getLocalBranch() != null
-                            ? jenkinsBuildEnvironment.getLocalBranch()
-                            : localBranchName(repository, jenkinsBuildEnvironment.getBranch());
+                    String branch = jenkinsBuildEnvironment.getLocalBranch() != null ?
+                            jenkinsBuildEnvironment.getLocalBranch() :
+                            localBranchName(repository, jenkinsBuildEnvironment.getBranch());
                     return fromGitConfig(repository, branch, getChangeset(repository), gitRemoteParser);
                 } catch (IllegalArgumentException | GitAPIException e) {
                     // Silently ignore if the project directory is not a git repository

diff --git a/rewrite-core/src/main/java/org/openrewrite/marker/ci/BitbucketBuildEnvironment.java b/rewrite-core/src/main/java/org/openrewrite/marker/ci/BitbucketBuildEnvironment.java
@@ -47,9 +47,9 @@ public static BitbucketBuildEnvironment build(UnaryOperator<String> environment)
 
     @Override
     public GitProvenance buildGitProvenance() throws IncompleteGitConfigException {
-        if (StringUtils.isBlank(httpOrigin)
-            || StringUtils.isBlank(branch)
-            || StringUtils.isBlank(sha)) {
+        if (StringUtils.isBlank(httpOrigin) ||
+            StringUtils.isBlank(branch) ||
+            StringUtils.isBlank(sha)) {
             throw new IncompleteGitConfigException();
         } else {
             return new GitProvenance(UUID.randomUUID(), httpOrigin, branch, sha,

diff --git a/rewrite-core/src/main/java/org/openrewrite/marker/ci/BuildEnvironment.java b/rewrite-core/src/main/java/org/openrewrite/marker/ci/BuildEnvironment.java
@@ -36,8 +36,8 @@ public interface BuildEnvironment extends Marker {
         if (environment.apply("GITLAB_CI") != null) {
             return GitlabBuildEnvironment.build(environment);
         }
-        if (environment.apply("CI") != null && environment.apply("GITHUB_ACTION") != null
-                && environment.apply("GITHUB_RUN_ID") != null) {
+        if (environment.apply("CI") != null && environment.apply("GITHUB_ACTION") != null &&
+                environment.apply("GITHUB_RUN_ID") != null) {
             return GithubActionsBuildEnvironment.build(environment);
         }
         if (environment.apply("DRONE") != null) {

diff --git a/rewrite-core/src/main/java/org/openrewrite/marker/ci/CustomBuildEnvironment.java b/rewrite-core/src/main/java/org/openrewrite/marker/ci/CustomBuildEnvironment.java
@@ -47,9 +47,9 @@ public static CustomBuildEnvironment build(UnaryOperator<String> environment) {
 
     @Override
     public GitProvenance buildGitProvenance() throws IncompleteGitConfigException {
-        if (StringUtils.isBlank(cloneURL)
-            || StringUtils.isBlank(ref)
-            || StringUtils.isBlank(sha)) {
+        if (StringUtils.isBlank(cloneURL) ||
+            StringUtils.isBlank(ref) ||
+            StringUtils.isBlank(sha)) {
             throw new IncompleteGitConfigException();
         } else {
             return new GitProvenance(UUID.randomUUID(), cloneURL, ref, sha,

diff --git a/rewrite-core/src/main/java/org/openrewrite/marker/ci/DroneBuildEnvironment.java b/rewrite-core/src/main/java/org/openrewrite/marker/ci/DroneBuildEnvironment.java
@@ -62,9 +62,9 @@ public static DroneBuildEnvironment build(UnaryOperator<String> environment) {
 
     @Override
     public GitProvenance buildGitProvenance() throws IncompleteGitConfigException {
-        if (StringUtils.isBlank(remoteURL)
-            || (StringUtils.isBlank(branch) && StringUtils.isBlank(tag))
-            || StringUtils.isBlank(commitSha)) {
+        if (StringUtils.isBlank(remoteURL) ||
+            (StringUtils.isBlank(branch) && StringUtils.isBlank(tag)) ||
+            StringUtils.isBlank(commitSha)) {
             throw new IncompleteGitConfigException();
         }
         return new GitProvenance(UUID.randomUUID(), remoteURL,

diff --git a/rewrite-core/src/main/java/org/openrewrite/marker/ci/GithubActionsBuildEnvironment.java b/rewrite-core/src/main/java/org/openrewrite/marker/ci/GithubActionsBuildEnvironment.java
@@ -67,16 +67,16 @@ public GitProvenance buildGitProvenance() throws IncompleteGitConfigException {
         } else {
             gitRef = gitRef.replaceFirst("refs/heads/", "");
         }
-        if (StringUtils.isBlank(ghRef)
-            || StringUtils.isBlank(host)
-            || StringUtils.isBlank(repository)
-            || StringUtils.isBlank(sha)) {
+        if (StringUtils.isBlank(ghRef) ||
+            StringUtils.isBlank(host) ||
+            StringUtils.isBlank(repository) ||
+            StringUtils.isBlank(sha)) {
             throw new IncompleteGitConfigException(
                     String.format("Invalid GitHub environment with host: %s, branch: %s, " +
                                   "repository: %s, sha: %s", host, ghRef, repository, sha));
         }
 
-        return new GitProvenance(UUID.randomUUID(), host + "/" + getRepository()
-                                                    + ".git", gitRef, getSha(), null, null, emptyList());
+        return new GitProvenance(UUID.randomUUID(), host + "/" + getRepository() +
+                                                    ".git", gitRef, getSha(), null, null, emptyList());
     }
 }
diff --git a/rewrite-core/src/main/java/org/openrewrite/marker/ci/GitlabBuildEnvironment.java b/rewrite-core/src/main/java/org/openrewrite/marker/ci/GitlabBuildEnvironment.java
@@ -56,9 +56,9 @@ public static GitlabBuildEnvironment build(UnaryOperator<String> environment) {
 
     @Override
     public GitProvenance buildGitProvenance() throws IncompleteGitConfigException {
-        if (StringUtils.isBlank(ciRepositoryUrl)
-            || StringUtils.isBlank(ciCommitRefName)
-            || StringUtils.isBlank(ciCommitSha)) {
+        if (StringUtils.isBlank(ciRepositoryUrl) ||
+            StringUtils.isBlank(ciCommitRefName) ||
+            StringUtils.isBlank(ciCommitSha)) {
             throw new IncompleteGitConfigException();
         }
         return new GitProvenance(UUID.randomUUID(), ciRepositoryUrl, ciCommitRefName, ciCommitSha,

diff --git a/rewrite-core/src/main/java/org/openrewrite/semver/DependencyMatcher.java b/rewrite-core/src/main/java/org/openrewrite/semver/DependencyMatcher.java
@@ -75,9 +75,9 @@ public static Validated<DependencyMatcher> build(String pattern) {
     }
 
     public boolean matches(@Nullable String groupId, String artifactId, String version) {
-        return StringUtils.matchesGlob(groupId, groupPattern)
-                && StringUtils.matchesGlob(artifactId, artifactPattern)
-                && (versionComparator == null || versionComparator.isValid(null, version));
+        return StringUtils.matchesGlob(groupId, groupPattern) &&
+                StringUtils.matchesGlob(artifactId, artifactPattern) &&
+                (versionComparator == null || versionComparator.isValid(null, version));
     }
 
     public boolean matches(@Nullable String groupId, String artifactId) {

diff --git a/rewrite-core/src/main/java/org/openrewrite/semver/ExactVersion.java b/rewrite-core/src/main/java/org/openrewrite/semver/ExactVersion.java
@@ -15,13 +15,15 @@
  */
 package org.openrewrite.semver;
 
+import lombok.Getter;
 import org.jspecify.annotations.Nullable;
 import org.openrewrite.Validated;
 
 /**
  * Version selector for matching exact version: either explicitly prefixed with "=",
  * or implicit default when no other version selectors match.
  */
+@Getter
 public class ExactVersion extends LatestRelease {
     String version;
 

diff --git a/rewrite-core/src/main/java/org/openrewrite/semver/LatestRelease.java b/rewrite-core/src/main/java/org/openrewrite/semver/LatestRelease.java
@@ -100,12 +100,14 @@ static int countVersionParts(String version) {
     public int compare(@Nullable String currentVersion, String v1, String v2) {
         if (v1.equalsIgnoreCase(v2)) {
             return 0;
-        }
-        if (v1.equalsIgnoreCase("RELEASE")) {
-            return v2.equalsIgnoreCase("LATEST") ? -1 : 1;
-        }
-        if (v1.equalsIgnoreCase("LATEST")) {
+        } else if (v1.equalsIgnoreCase("LATEST")) {
+            return 1;
+        } else if (v2.equalsIgnoreCase("LATEST")) {
+            return -1;
+        } else if (v1.equalsIgnoreCase("RELEASE")) {
             return 1;
+        } else if (v2.equalsIgnoreCase("RELEASE")) {
+            return -1;
         }
 
         String nv1 = normalizeVersion(v1);

diff --git a/rewrite-core/src/main/java/org/openrewrite/semver/Semver.java b/rewrite-core/src/main/java/org/openrewrite/semver/Semver.java
@@ -26,7 +26,11 @@ public class Semver {
     private Semver() {
     }
 
-    public static boolean isVersion(String version) {
+    @SuppressWarnings("BooleanMethodIsAlwaysInverted")
+    public static boolean isVersion(@Nullable String version) {
+        if (version == null) {
+            return false;
+        }
         return LatestRelease.RELEASE_PATTERN.matcher(version).matches();
     }
 

diff --git a/rewrite-core/src/main/java/org/openrewrite/text/AppendToTextFile.java b/rewrite-core/src/main/java/org/openrewrite/text/AppendToTextFile.java
@@ -53,12 +53,12 @@ public class AppendToTextFile extends ScanningRecipe<AtomicBoolean> {
     @Nullable Boolean appendNewline;
 
     @Option(displayName = "Existing file strategy",
-            description = "Determines behavior if a file exists at this location prior to Rewrite execution.\n\n"
-                          + "- `Continue`: append new content to existing file contents. If existing file is not plaintext, recipe does nothing.\n"
-                          + "- `Replace`: remove existing content from file.\n"
-                          + "- `Leave`: *(default)* do nothing. Existing file is fully preserved.\n\n"
-                          + "Note: this only affects the first interaction with the specified file per Rewrite execution.\n"
-                          + "Subsequent instances of this recipe in the same Rewrite execution will always append.",
+            description = "Determines behavior if a file exists at this location prior to Rewrite execution.\n\n" +
+                          "- `Continue`: append new content to existing file contents. If existing file is not plaintext, recipe does nothing.\n" +
+                          "- `Replace`: remove existing content from file.\n" +
+                          "- `Leave`: *(default)* do nothing. Existing file is fully preserved.\n\n" +
+                          "Note: this only affects the first interaction with the specified file per Rewrite execution.\n" +
+                          "Subsequent instances of this recipe in the same Rewrite execution will always append.",
             valid = {"Continue", "Replace", "Leave"},
             required = false)
     @Nullable Strategy existingFileStrategy;

diff --git a/rewrite-core/src/test/java/org/openrewrite/config/DeclarativeRecipeTest.java b/rewrite-core/src/test/java/org/openrewrite/config/DeclarativeRecipeTest.java
@@ -174,6 +174,65 @@ void yamlPrecondition() {
         );
     }
 
+    @Test
+    void yamlDeclarativeRecipeAsPrecondition() {
+        rewriteRun(
+          spec -> spec.recipeFromYaml(
+            """
+            type: specs.openrewrite.org/v1beta/recipe
+            name: org.openrewrite.PreconditionTest
+            description: Test.
+            preconditions:
+              - org.openrewrite.DeclarativePrecondition
+            recipeList:
+              - org.openrewrite.text.ChangeText:
+                 toText: 3
+            ---
+            type: specs.openrewrite.org/v1beta/recipe
+            name: org.openrewrite.DeclarativePrecondition
+            recipeList:
+              - org.openrewrite.text.Find:
+                  find: 1
+            """,
+            "org.openrewrite.PreconditionTest"
+          ),
+          text("1", "3"),
+          text("2")
+        );
+    }
+
+    @Test
+    void orPreconditions() {
+        // As documented https://docs.openrewrite.org/reference/yaml-format-reference#creating-or-preconditions-instead-of-and
+        rewriteRun(
+          spec -> spec.recipeFromYaml(
+            """
+              type: specs.openrewrite.org/v1beta/recipe
+              name: org.sample.DoSomething
+              description: Test.
+              preconditions:
+                - org.sample.FindAnyJson
+              recipeList:
+                - org.openrewrite.text.ChangeText:
+                   toText: 2
+              ---
+              type: specs.openrewrite.org/v1beta/recipe
+              name: org.sample.FindAnyJson
+              recipeList:
+                - org.openrewrite.FindSourceFiles:
+                    filePattern: "**/my.json"
+                - org.openrewrite.FindSourceFiles:
+                    filePattern: "**/your.json"
+                - org.openrewrite.FindSourceFiles:
+                    filePattern: "**/our.json"
+              """,
+            "org.sample.DoSomething"
+          ),
+          text("1", "2", spec -> spec.path("a/my.json")),
+          text("a", spec -> spec.path("a/not-my.json"))
+        );
+    }
+
     @Test
     void yamlPreconditionWithScanningRecipe() {
         rewriteRun(

diff --git a/rewrite-core/src/test/java/org/openrewrite/marker/GitProvenanceTest.java b/rewrite-core/src/test/java/org/openrewrite/marker/GitProvenanceTest.java
@@ -48,7 +48,6 @@
 import java.util.concurrent.TimeUnit;
 import java.util.stream.Stream;
 
-import static com.fasterxml.jackson.core.JsonParser.Feature.IGNORE_UNDEFINED;
 import static com.fasterxml.jackson.core.JsonParser.Feature.INCLUDE_SOURCE_IN_LOCATION;
 import static java.util.Collections.emptyList;
 import static org.assertj.core.api.Assertions.assertThat;

diff --git a/rewrite-core/src/test/java/org/openrewrite/semver/LatestReleaseTest.java b/rewrite-core/src/test/java/org/openrewrite/semver/LatestReleaseTest.java
@@ -107,10 +107,12 @@ void preReleases() {
     @Test
     void releaseOrLatestKeyword_beatsEverything() {
         assertThat(latestRelease.compare(null, "RELEASE", "1.2.3")).isPositive();
+        assertThat(latestRelease.compare(null, "1.2.3", "RELEASE")).isNegative();
         assertThat(latestRelease.compare(null, "RELEASE", "999.999.999")).isPositive();
         assertThat(latestRelease.compare(null, "RELEASE", "RELEASE")).isZero();
 
         assertThat(latestRelease.compare(null, "LATEST", "1.2.3")).isPositive();
+        assertThat(latestRelease.compare(null, "1.2.3", "LATEST")).isNegative();
         assertThat(latestRelease.compare(null, "LATEST", "999.999.999")).isPositive();
         assertThat(latestRelease.compare(null, "LATEST", "LATEST")).isZero();