Skip to content

Commit

Permalink
NoGuavaMapsNewLinkedHashMap
Browse files Browse the repository at this point in the history
  • Loading branch information
jkschneider committed Jul 13, 2021
1 parent 9bb17c4 commit 9d1ba4c
Show file tree
Hide file tree
Showing 2 changed files with 177 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
package org.openrewrite.java.migrate.guava;

import org.openrewrite.ExecutionContext;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.java.JavaIsoVisitor;
import org.openrewrite.java.JavaTemplate;
import org.openrewrite.java.JavaVisitor;
import org.openrewrite.java.MethodMatcher;
import org.openrewrite.java.search.UsesMethod;
import org.openrewrite.java.tree.J;

public class NoGuavaMapsNewLinkedHashMap extends Recipe {
private static final MethodMatcher NEW_LINKED_HASH_MAP = new MethodMatcher("com.google.common.collect.Maps newLinkedHashMap()");
private static final MethodMatcher NEW_LINKED_HASH_MAP_ITERABLE = new MethodMatcher("com.google.common.collect.Maps newLinkedHashMap(java.util.Map)");
private static final MethodMatcher NEW_LINKED_HASH_MAP_CAPACITY = new MethodMatcher("com.google.common.collect.Maps newLinkedHashMapWithExpectedSize(int)");

@Override
public String getDisplayName() {
return "Use `new LinkedHashMap<>()` instead of Guava";
}

@Override
public String getDescription() {
return "Prefer the Java standard library over third-party usage of Guava in simple cases like this.";
}

@Override
protected TreeVisitor<?, ExecutionContext> getApplicableTest() {
return new JavaIsoVisitor<ExecutionContext>() {
@Override
public J.CompilationUnit visitCompilationUnit(J.CompilationUnit cu, ExecutionContext executionContext) {
doAfterVisit(new UsesMethod<>(NEW_LINKED_HASH_MAP));
doAfterVisit(new UsesMethod<>(NEW_LINKED_HASH_MAP_ITERABLE));
doAfterVisit(new UsesMethod<>(NEW_LINKED_HASH_MAP_CAPACITY));
return cu;
}
};
}

@Override
protected TreeVisitor<?, ExecutionContext> getVisitor() {
return new JavaVisitor<ExecutionContext>() {
private final JavaTemplate newLinkedHashMap = JavaTemplate.builder(this::getCursor, "new LinkedHashMap<>()")
.imports("java.util.LinkedHashMap")
.build();

private final JavaTemplate newLinkedHashMapIterable = JavaTemplate.builder(this::getCursor, "new LinkedHashMap<>(#{any(java.util.Map)})")
.imports("java.util.LinkedHashMap")
.build();

private final JavaTemplate newLinkedHashMapCapacity = JavaTemplate.builder(this::getCursor, "new LinkedHashMap<>(#{any(int)})")
.imports("java.util.LinkedHashMap")
.build();

@Override
public J visitMethodInvocation(J.MethodInvocation method, ExecutionContext executionContext) {
if (NEW_LINKED_HASH_MAP.matches(method)) {
maybeRemoveImport("com.google.common.collect.Maps");
maybeAddImport("java.util.LinkedHashMap");
return method.withTemplate(newLinkedHashMap, method.getCoordinates().replace());
} else if (NEW_LINKED_HASH_MAP_ITERABLE.matches(method)) {
maybeRemoveImport("com.google.common.collect.Maps");
maybeAddImport("java.util.LinkedHashMap");
return method.withTemplate(newLinkedHashMapIterable, method.getCoordinates().replace(),
method.getArguments().get(0));
} else if (NEW_LINKED_HASH_MAP_CAPACITY.matches(method)) {
maybeRemoveImport("com.google.common.collect.Maps");
maybeAddImport("java.util.LinkedHashMap");
return method.withTemplate(newLinkedHashMapCapacity, method.getCoordinates().replace(),
method.getArguments().get(0));
}
return super.visitMethodInvocation(method, executionContext);
}
};
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
/*
* Copyright 2021 the original author or authors.
* <p>
* 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
* <p>
* https://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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 org.openrewrite.java.migrate.guava

import org.junit.jupiter.api.Test
import org.openrewrite.Recipe
import org.openrewrite.java.JavaParser
import org.openrewrite.java.JavaRecipeTest

class NoGuavaListsNewLinkedHashMapTest: JavaRecipeTest {
override val parser: JavaParser
get() = JavaParser.fromJavaVersion()
.logCompilationWarningsAndErrors(true)
.classpath("guava")
.build()

override val recipe: Recipe
get() = NoGuavaMapsNewLinkedHashMap()

@Test
fun replaceWithNewLinkedHashMap() = assertChanged(
before = """
import com.google.common.collect.*;
import java.util.Map;
class Test {
Map<Integer, Integer> cardinalsWorldSeries = Maps.newLinkedHashMap();
}
""",
after = """
import java.util.LinkedHashMap;
import java.util.Map;
class Test {
Map<Integer, Integer> cardinalsWorldSeries = new LinkedHashMap<>();
}
"""
)

@Test
fun replaceWithNewLinkedHashMapWithMap() = assertChanged(
before = """
import com.google.common.collect.*;
import java.util.Collections;
import java.util.Map;
class Test {
Map<Integer, Integer> m = Collections.emptyMap();
Map<Integer, Integer> cardinalsWorldSeries = Maps.newLinkedHashMap(m);
}
""",
after = """
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
class Test {
Map<Integer, Integer> m = Collections.emptyMap();
Map<Integer, Integer> cardinalsWorldSeries = new LinkedHashMap<>(m);
}
"""
)

@Test
fun replaceWithNewLinkedHashMapWithCapacity() = assertChanged(
before = """
import com.google.common.collect.*;
import java.util.LinkedHashMap;
import java.util.Map;
class Test {
Map<Integer, Integer> cardinalsWorldSeries = Maps.newLinkedHashMapWithExpectedSize(2);
}
""",
after = """
import java.util.LinkedHashMap;
import java.util.Map;
class Test {
Map<Integer, Integer> cardinalsWorldSeries = new LinkedHashMap<>(2);
}
"""
)
}

0 comments on commit 9d1ba4c

Please sign in to comment.