diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..040685b --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,9 @@ +--- +version: 2 +updates: + - package-ecosystem: github-actions + directory: / + schedule: + interval: weekly + commit-message: + prefix: "chore(ci)" diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..1490f21 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,55 @@ +--- +name: ci + +on: + push: + branches: + - main + tags-ignore: + - "*" + pull_request: + branches: + - main + +env: + GRADLE_OPTS: '-Dorg.gradle.jvmargs="-Xmx2048m -XX:+HeapDumpOnOutOfMemoryError"' + GRADLE_SWITCHES: "-s --console=plain --info --stacktrace" + +jobs: + build: + strategy: + fail-fast: false + matrix: + os: ["ubuntu-latest"] + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: set-up-jdk + uses: actions/setup-java@v3.12.0 + with: + distribution: zulu + java-version: 17 + cache: gradle + - name: build + run: ./gradlew ${GRADLE_SWITCHES} build test + + publish-snapshots: + needs: [build] + runs-on: ubuntu-latest + if: github.event_name == 'push' + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: set-up-jdk + uses: actions/setup-java@v3.12.0 + with: + distribution: zulu + java-version: 17 + cache: gradle + - name: publish-snapshots + if: github.event_name == 'push' + timeout-minutes: 30 + run: ./gradlew ${GRADLE_SWITCHES} snapshot diff --git a/.github/workflows/gradle-wrapper-validation.yml b/.github/workflows/gradle-wrapper-validation.yml new file mode 100644 index 0000000..420d80c --- /dev/null +++ b/.github/workflows/gradle-wrapper-validation.yml @@ -0,0 +1,11 @@ +--- +name: "Validate Gradle Wrapper" +on: [push, pull_request] + +jobs: + validation: + name: "Validation" + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: gradle/wrapper-validation-action@v1 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..46d0544 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,36 @@ +--- +name: publish + +on: + push: + tags: + - v[0-9]+.[0-9]+.[0-9]+ + - v[0-9]+.[0-9]+.[0-9]+-rc.[0-9]+ + +env: + GRADLE_OPTS: '-Dorg.gradle.jvmargs="-Xmx2048m -XX:+HeapDumpOnOutOfMemoryError"' + GRADLE_SWITCHES: "-s --console=plain --info --stacktrace" + +jobs: + release: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - name: set-up-jdk + uses: actions/setup-java@v3.12.0 + with: + distribution: zulu + java-version: 17 + cache: gradle + + - name: publish-candidate + if: contains(github.ref, '-rc.') + timeout-minutes: 30 + run: ./gradlew ${GRADLE_SWITCHES} -Preleasing -Prelease.disableGitChecks=true -Prelease.useLastTag=true candidate publish + + - name: publish-release + if: (!contains(github.ref, '-rc.')) + timeout-minutes: 30 + run: ./gradlew ${GRADLE_SWITCHES} -Preleasing -Prelease.disableGitChecks=true -Prelease.useLastTag=true final publish diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..86cf277 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +build/ +.gradle/ +.idea/ +out/ diff --git a/.java-version b/.java-version new file mode 100644 index 0000000..b4de394 --- /dev/null +++ b/.java-version @@ -0,0 +1 @@ +11 diff --git a/README.md b/README.md new file mode 100644 index 0000000..8631aa6 --- /dev/null +++ b/README.md @@ -0,0 +1,104 @@ +## Rewrite recipe starter + +This repository serves as a template for building your own recipe JARs and publishing them to a repository where they can be applied on [app.moderne.io](https://app.moderne.io) against all of the public OSS code that is included there. + +We've provided a sample recipe (NoGuavaListsNewArray) and a sample test class. Both of these exist as placeholders, and they should be replaced by whatever recipe you are interested in writing. + +To begin, fork this repository and customize it by: + +1. Changing the root project name in `settings.gradle.kts`. +2. Changing the `group` in `build.gradle.kts`. +3. Changing the package structure from `com.yourorg` to whatever you want. + +## Detailed Guide + +There is a [comprehensive getting started guide](https://docs.openrewrite.org/getting-started/recipe-development-environment) +available in the OpenRewrite docs that provides more details than the below README. + +## Local Publishing for Testing + +Before you publish your recipe module to an artifact repository, you may want to try it out locally. +To do this on the command line, run `./gradlew publishToMavenLocal` (or equivalently `./gradlew pTML`). +This will publish to your local maven repository, typically under `~/.m2/repository`. + +Replace the groupId, artifactId, recipe name, and version in the below snippets with the ones that correspond to your recipe. + +In a Maven project's pom.xml, make your recipe module a plugin dependency: +```xml + + + + + org.openrewrite.maven + rewrite-maven-plugin + 5.2.4 + + + com.yourorg.NoGuavaListsNewArrayList + + + + + com.yourorg + rewrite-recipe-starter + 0.1.0-SNAPSHOT + + + + + + +``` + +Unlike Maven, Gradle must be explicitly configured to resolve dependencies from maven local. +The root project of your gradle build, make your recipe module a dependency of the `rewrite` configuration: + +```groovy +plugins { + id("java") + id("org.openrewrite.rewrite") version("6.1.8") +} + +repositories { + mavenLocal() + mavenCentral() +} + +dependencies { + rewrite("com.yourorg:rewrite-recipe-starter:0.1.0-SNAPSHOT") +} + +rewrite { + activeRecipe("com.yourorg.NoGuavaListsNewArrayList") +} +``` + +Now you can run `mvn rewrite:run` or `gradlew rewriteRun` to run your recipe. + +## Publishing to Artifact Repositories + +This project is configured to publish to Moderne's open artifact repository (via the `publishing` task at the bottom of +the `build.gradle.kts` file). If you want to publish elsewhere, you'll want to update that task. +[app.moderne.io](https://app.moderne.io) can draw recipes from the provided repository, as well as from [Maven Central](https://search.maven.org). + +Note: +Running the publish task _will not_ update [app.moderne.io](https://app.moderne.io), as only Moderne employees can +add new recipes. If you want to add your recipe to [app.moderne.io](https://app.moderne.io), please ask the +team in [Slack](https://join.slack.com/t/rewriteoss/shared_invite/zt-nj42n3ea-b~62rIHzb3Vo0E1APKCXEA) or in [Discord](https://discord.gg/xk3ZKrhWAb). + +These other docs might also be useful for you depending on where you want to publish the recipe: + +* Sonatype's instructions for [publishing to Maven Central](https://maven.apache.org/repository/guide-central-repository-upload.html) +* Gradle's instructions on the [Gradle Publishing Plugin](https://docs.gradle.org/current/userguide/publishing\_maven.html). + +### From Github Actions + +The `.github` directory contains a Github action that will push a snapshot on every successful build. + +Run the release action to publish a release version of a recipe. + +### From the command line + +To build a snapshot, run `./gradlew snapshot publish` to build a snapshot and publish it to Moderne's open artifact repository for inclusion at [app.moderne.io](https://app.moderne.io). + +To build a release, run `./gradlew final publish` to tag a release and publish it to Moderne's open artifact repository for inclusion at [app.moderne.io](https://app.moderne.io). diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..0ab182d --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,109 @@ +import nebula.plugin.contacts.Contact +import nebula.plugin.contacts.ContactsExtension + +plugins { + `java-library` + + id("nebula.release") version "16.0.0" + + id("nebula.maven-manifest") version "18.4.0" + id("nebula.maven-nebula-publish") version "18.4.0" + id("nebula.maven-resolved-dependencies") version "18.4.0" + + id("nebula.contacts") version "6.0.0" + id("nebula.info") version "11.3.3" + + id("nebula.javadoc-jar") version "18.4.0" + id("nebula.source-jar") version "18.4.0" +} + +apply(plugin = "nebula.publish-verification") + +configure { + defaultVersionStrategy = nebula.plugin.release.NetflixOssStrategies.SNAPSHOT(project) +} + +java { + toolchain { + languageVersion.set(JavaLanguageVersion.of(17)) + } +} + +// Set as appropriate for your organization +group = "com.yourorg" +description = "Rewrite recipes." + +repositories { + mavenLocal() + // Needed to pick up snapshot versions of rewrite + maven { + url = uri("https://oss.sonatype.org/content/repositories/snapshots/") + } + mavenCentral() +} + +configurations.all { + resolutionStrategy { + cacheChangingModulesFor(0, TimeUnit.SECONDS) + cacheDynamicVersionsFor(0, TimeUnit.SECONDS) + } +} + +// The bom version can also be set to a specific version or latest.release. +val rewriteBomVersion = "latest.integration" + +dependencies { + compileOnly("org.projectlombok:lombok:latest.release") + compileOnly("com.google.code.findbugs:jsr305:latest.release") + annotationProcessor("org.projectlombok:lombok:latest.release") + implementation(platform("org.openrewrite.recipe:rewrite-recipe-bom:${rewriteBomVersion}")) + + implementation("org.openrewrite:rewrite-java") + runtimeOnly("org.openrewrite:rewrite-java-17") + // Need to have a slf4j binding to see any output enabled from the parser. + runtimeOnly("ch.qos.logback:logback-classic:1.2.+") + + testImplementation("org.junit.jupiter:junit-jupiter-api:latest.release") + testImplementation("org.junit.jupiter:junit-jupiter-params:latest.release") + testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:latest.release") + testRuntimeOnly("com.google.guava:guava:latest.release") + + testImplementation("org.openrewrite:rewrite-test") + testImplementation("org.assertj:assertj-core:latest.release") +} + +tasks.named("test") { + useJUnitPlatform() + jvmArgs = listOf("-XX:+UnlockDiagnosticVMOptions", "-XX:+ShowHiddenFrames") +} + +tasks.withType().configureEach { + options.encoding = "UTF-8" + options.compilerArgs.add("-parameters") +} +tasks.named("compileJava") { + options.release.set(8) +} + +configure { + val j = Contact("team@moderne.io") + j.moniker("Team Moderne") + people["team@moderne.io"] = j +} + +configure { + publications { + named("nebula", MavenPublication::class.java) { + suppressPomMetadataWarningsFor("runtimeElements") + } + } +} + +publishing { + repositories { + maven { + name = "moderne" + url = uri("https://us-west1-maven.pkg.dev/moderne-dev/moderne-recipe") + } + } +} diff --git a/gradle/licenseHeader.txt b/gradle/licenseHeader.txt new file mode 100644 index 0000000..bcb1afc --- /dev/null +++ b/gradle/licenseHeader.txt @@ -0,0 +1,13 @@ +Copyright 2021 the original author or authors. +

+Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at +

+https://www.apache.org/licenses/LICENSE-2.0 +

+Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100755 index 0000000..249e583 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100755 index 0000000..ae04661 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..a69d9cb --- /dev/null +++ b/gradlew @@ -0,0 +1,240 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100755 index 0000000..53a6b23 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,91 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..3ea7996 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,3 @@ +rootProject.name = "rewrite-recipe-starter" + +enableFeaturePreview("VERSION_ORDERING_V2") diff --git a/src/main/java/com/yourorg/NoGuavaListsNewArrayList.java b/src/main/java/com/yourorg/NoGuavaListsNewArrayList.java new file mode 100644 index 0000000..37700ff --- /dev/null +++ b/src/main/java/com/yourorg/NoGuavaListsNewArrayList.java @@ -0,0 +1,92 @@ +/* + * Copyright 2021 the original author or authors. + *

+ * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + *

+ * https://www.apache.org/licenses/LICENSE-2.0 + *

+ * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package com.yourorg; + +import lombok.EqualsAndHashCode; +import lombok.Value; +import org.openrewrite.*; +import org.openrewrite.java.*; +import org.openrewrite.java.search.UsesMethod; +import org.openrewrite.java.tree.J; + +@Value +@EqualsAndHashCode(callSuper = true) +public class NoGuavaListsNewArrayList extends Recipe { + private static final MethodMatcher NEW_ARRAY_LIST = new MethodMatcher("com.google.common.collect.Lists newArrayList()"); + private static final MethodMatcher NEW_ARRAY_LIST_ITERABLE = new MethodMatcher("com.google.common.collect.Lists newArrayList(java.lang.Iterable)"); + private static final MethodMatcher NEW_ARRAY_LIST_CAPACITY = new MethodMatcher("com.google.common.collect.Lists newArrayListWithCapacity(int)"); + + @Override + public String getDisplayName() { + //language=markdown + return "Use `new ArrayList<>()` instead of Guava"; + } + + @Override + public String getDescription() { + //language=markdown + return "Prefer the Java standard library over third-party usage of Guava in simple cases like this."; + } + + @Override + public TreeVisitor getVisitor() { + return Preconditions.check( + // Any change to the AST made by the preconditions check will lead to the visitor returned by Recipe + // .getVisitor() being applied + // No changes made by the preconditions check will be kept + Preconditions.or(new UsesMethod<>(NEW_ARRAY_LIST), + new UsesMethod<>(NEW_ARRAY_LIST_ITERABLE), + new UsesMethod<>(NEW_ARRAY_LIST_CAPACITY)), + // To avoid stale state persisting between cycles, getVisitor() should always return a new instance of + // its visitor + new JavaVisitor() { + private final JavaTemplate newArrayList = JavaTemplate.builder("new ArrayList<>()") + .imports("java.util.ArrayList") + .build(); + + private final JavaTemplate newArrayListIterable = + JavaTemplate.builder("new ArrayList<>(#{any(java.util.Collection)})") + .imports("java.util.ArrayList") + .build(); + + private final JavaTemplate newArrayListCapacity = + JavaTemplate.builder("new ArrayList<>(#{any(int)})") + .imports("java.util.ArrayList") + .build(); + + @Override + public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext executionContext) { + if (NEW_ARRAY_LIST.matches(method)) { + maybeRemoveImport("com.google.common.collect.Lists"); + maybeAddImport("java.util.ArrayList"); + return newArrayList.apply(getCursor(), method.getCoordinates().replace()); + } else if (NEW_ARRAY_LIST_ITERABLE.matches(method)) { + maybeRemoveImport("com.google.common.collect.Lists"); + maybeAddImport("java.util.ArrayList"); + return newArrayListIterable.apply(getCursor(), method.getCoordinates().replace(), + method.getArguments().get(0)); + } else if (NEW_ARRAY_LIST_CAPACITY.matches(method)) { + maybeRemoveImport("com.google.common.collect.Lists"); + maybeAddImport("java.util.ArrayList"); + return newArrayListCapacity.apply(getCursor(), method.getCoordinates().replace(), + method.getArguments().get(0)); + } + return super.visitMethodInvocation(method, executionContext); + } + } + ); + } +} diff --git a/src/main/java/com/yourorg/package-info.java b/src/main/java/com/yourorg/package-info.java new file mode 100644 index 0000000..e4706e0 --- /dev/null +++ b/src/main/java/com/yourorg/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright 2020 the original author or authors. + *

+ * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + *

+ * https://www.apache.org/licenses/LICENSE-2.0 + *

+ * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +@NonNullApi +@NonNullFields +package com.yourorg; + +import org.openrewrite.internal.lang.NonNullApi; +import org.openrewrite.internal.lang.NonNullFields; diff --git a/src/main/resources/META-INF/rewrite.yml b/src/main/resources/META-INF/rewrite.yml new file mode 100644 index 0000000..eb787c2 --- /dev/null +++ b/src/main/resources/META-INF/rewrite.yml @@ -0,0 +1,12 @@ +# Include any Declarative YAML format recipes here, as per: +# https://docs.openrewrite.org/reference/yaml-format-reference +--- +type: specs.openrewrite.org/v1beta/recipe +name: com.yourorg.RecipeA +displayName: Recipe A +description: Applies NoGuavaListsNewArrayList. +tags: + - tag1 + - tag2 +recipeList: + - com.yourorg.NoGuavaListsNewArrayList diff --git a/src/main/resources/logback.xml b/src/main/resources/logback.xml new file mode 100644 index 0000000..338d9dc --- /dev/null +++ b/src/main/resources/logback.xml @@ -0,0 +1,13 @@ + + + + + + %d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n + + + + + + + \ No newline at end of file diff --git a/src/test/java/.editorconfig b/src/test/java/.editorconfig new file mode 100644 index 0000000..a482493 --- /dev/null +++ b/src/test/java/.editorconfig @@ -0,0 +1,5 @@ +root = true + +[*.java] +indent_size = 4 +ij_continuation_indent_size = 2 diff --git a/src/test/java/com/yourorg/NoGuavaListsNewArrayListTest.java b/src/test/java/com/yourorg/NoGuavaListsNewArrayListTest.java new file mode 100644 index 0000000..c2d9580 --- /dev/null +++ b/src/test/java/com/yourorg/NoGuavaListsNewArrayListTest.java @@ -0,0 +1,107 @@ +package com.yourorg; + +import org.junit.jupiter.api.Test; +import org.openrewrite.java.JavaParser; +import org.openrewrite.test.RecipeSpec; +import org.openrewrite.test.RewriteTest; + +import static org.openrewrite.java.Assertions.java; + +class NoGuavaListsNewArrayListTest implements RewriteTest { + + // Note, you can define defaults for the RecipeSpec and these defaults will be used for all tests. + // In this case, the recipe and the parser are common. See below, on how the defaults can be overridden + // per test. + @Override + public void defaults(RecipeSpec spec) { + spec.recipe(new NoGuavaListsNewArrayList()) + .parser(JavaParser.fromJavaVersion() + .logCompilationWarningsAndErrors(true) + .classpath("guava")); + } + + @Test + void replaceWithNewArrayList() { + rewriteRun( + // There is an overloaded version or rewriteRun that allows the RecipeSpec to be customized specifically + // for a given test. In this case, the parser for this test is configured to not log compilation warnings. + spec -> spec + .parser(JavaParser.fromJavaVersion() + .logCompilationWarningsAndErrors(false) + .classpath("guava")), + // language=java + java(""" + import com.google.common.collect.*; + + import java.util.List; + + class Test { + List cardinalsWorldSeries = Lists.newArrayList(); + } + """, + """ + import java.util.ArrayList; + import java.util.List; + + class Test { + List cardinalsWorldSeries = new ArrayList<>(); + } + """ + ) + ); + } + + @Test + void replaceWithNewArrayListIterable() { + rewriteRun( + // language=java + java(""" + import com.google.common.collect.*; + + import java.util.Collections; + import java.util.List; + + class Test { + List l = Collections.emptyList(); + List cardinalsWorldSeries = Lists.newArrayList(l); + } + """, + """ + import java.util.ArrayList; + import java.util.Collections; + import java.util.List; + + class Test { + List l = Collections.emptyList(); + List cardinalsWorldSeries = new ArrayList<>(l); + } + """ + ) + ); + } + + @Test + void replaceWithNewArrayListWithCapacity() { + rewriteRun( + // language=java + java(""" + import com.google.common.collect.*; + + import java.util.ArrayList; + import java.util.List; + + class Test { + List cardinalsWorldSeries = Lists.newArrayListWithCapacity(2); + } + """, + """ + import java.util.ArrayList; + import java.util.List; + + class Test { + List cardinalsWorldSeries = new ArrayList<>(2); + } + """) + ); + } +}