Skip to content

Commit

Permalink
Apache Commons File Utils Migrations (#274)
Browse files Browse the repository at this point in the history 
* added first two refaster templates, and created ubertest

* updated license headers

* Move classes; disable Write; make test compile, sorted & pass

* updated tests and sorted new entries

* Also update expected test outcome

---------

Co-authored-by: Tim te Beek <[email protected]>
  • Loading branch information
@AlekSimpson @timtebeek
AlekSimpson and timtebeek authored Aug 22, 2023
1 parent eddbad3 commit 29a24e1
Show file tree
Hide file tree
Showing 2 changed files with 203 additions and 0 deletions.
51 changes: 51 additions & 0 deletions src/main/java/org/openrewrite/java/migrate/apache/commons/io/ApacheCommonsFileUtils.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/*
* Copyright 2023 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.apache.commons.io;

import com.google.errorprone.refaster.annotation.AfterTemplate;
import com.google.errorprone.refaster.annotation.BeforeTemplate;
import org.apache.commons.io.FileUtils;

import java.io.File;

public class ApacheCommonsFileUtils {
private static class GetFile {
@BeforeTemplate
File before(String name) {
return FileUtils.getFile(name);
}

@AfterTemplate
File after(String name) {
return new File(name);
}
}

// NOTE: java: reference to compile is ambiguous; methods P3 & F3 match
// private static class Write {
// @BeforeTemplate
// void before(File file, CharSequence data, Charset cs) throws Exception {
// FileUtils.write(file, data, cs);
// }
//
// @AfterTemplate
// void after(File file, CharSequence data, Charset cs) throws Exception {
// Files.write(file.toPath(), Arrays.asList(data), cs);
// }
// }


}
152 changes: 152 additions & 0 deletions src/test/java/org/openrewrite/java/migrate/apache/commons/io/ApacheCommonsFileUtilsTest.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
/*
* Copyright 2023 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.apache.commons.io;

import org.junit.jupiter.api.Test;
import org.openrewrite.DocumentExample;
import org.openrewrite.java.JavaParser;
import org.openrewrite.test.RecipeSpec;
import org.openrewrite.test.RewriteTest;

import static org.openrewrite.java.Assertions.java;

class ApacheCommonsFileUtilsTest implements RewriteTest {
@Override
public void defaults(RecipeSpec spec) {
spec.parser(JavaParser.fromJavaVersion().classpath("commons-io"))
.recipe(new ApacheCommonsFileUtilsRecipes());
}

@Test
@DocumentExample
void ubertest() {
rewriteRun(
//language=java
java(
"""
import org.apache.commons.io.FileUtils;
import java.io.File;
import java.io.FileFilter;
import java.net.URL;
import java.nio.charset.Charset;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
class Foo {
void bar(File fileA, File fileB, URL url, Charset cs, FileFilter filter, CharSequence charSeq) throws Exception {
long l = 10L;
String s = "hello world";
String[] stringArray = new String[4];
Collection<String> collection = Collections.EMPTY_LIST;
byte[] bytes = new byte[0];
String str;
boolean bool;
List<String> strList;
List<File> fileList;
File f;
FileUtils.write(fileA, s, cs);
f = FileUtils.getFile(s);
f = FileUtils.getFile(s, s);
f = FileUtils.toFile(url);
str = FileUtils.byteCountToDisplaySize(l);
FileUtils.cleanDirectory(fileA);
bool = FileUtils.contentEquals(fileA, fileB);
bool = FileUtils.contentEqualsIgnoreEOL(fileA, fileB, s);
FileUtils.copyDirectory(fileA, fileB);
FileUtils.copyFileToDirectory(fileA, fileB);
FileUtils.copyFile(fileA, fileB);
FileUtils.copyURLToFile(url, fileA);
f = FileUtils.current();
FileUtils.deleteDirectory(fileA);
f = FileUtils.delete(fileA);
bool = FileUtils.deleteQuietly(fileA);
FileUtils.forceDeleteOnExit(fileA);
FileUtils.forceDelete(fileA);
FileUtils.forceMkdir(fileA);
FileUtils.forceMkdirParent(fileA);
f = FileUtils.getTempDirectory();
str = FileUtils.readFileToString(fileA, cs);
str = FileUtils.readFileToString(fileA, s);
strList = FileUtils.readLines(fileA, cs);
FileUtils.writeByteArrayToFile(fileA, bytes);
FileUtils.writeLines(fileA, collection);
FileUtils.writeStringToFile(fileA, s);
}
}
""",
"""
import org.apache.commons.io.FileUtils;
import java.io.File;
import java.io.FileFilter;
import java.net.URL;
import java.nio.charset.Charset;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
class Foo {
void bar(File fileA, File fileB, URL url, Charset cs, FileFilter filter, CharSequence charSeq) throws Exception {
long l = 10L;
String s = "hello world";
String[] stringArray = new String[4];
Collection<String> collection = Collections.EMPTY_LIST;
byte[] bytes = new byte[0];
String str;
boolean bool;
List<String> strList;
List<File> fileList;
File f;
FileUtils.write(fileA, s, cs);
f = new File(s);
f = FileUtils.getFile(s, s);
f = FileUtils.toFile(url);
str = FileUtils.byteCountToDisplaySize(l);
FileUtils.cleanDirectory(fileA);
bool = FileUtils.contentEquals(fileA, fileB);
bool = FileUtils.contentEqualsIgnoreEOL(fileA, fileB, s);
FileUtils.copyDirectory(fileA, fileB);
FileUtils.copyFileToDirectory(fileA, fileB);
FileUtils.copyFile(fileA, fileB);
FileUtils.copyURLToFile(url, fileA);
f = FileUtils.current();
FileUtils.deleteDirectory(fileA);
f = FileUtils.delete(fileA);
bool = FileUtils.deleteQuietly(fileA);
FileUtils.forceDeleteOnExit(fileA);
FileUtils.forceDelete(fileA);
FileUtils.forceMkdir(fileA);
FileUtils.forceMkdirParent(fileA);
f = FileUtils.getTempDirectory();
str = FileUtils.readFileToString(fileA, cs);
str = FileUtils.readFileToString(fileA, s);
strList = FileUtils.readLines(fileA, cs);
FileUtils.writeByteArrayToFile(fileA, bytes);
FileUtils.writeLines(fileA, collection);
FileUtils.writeStringToFile(fileA, s);
}
}
"""
)
);
}
}

0 comments on commit 29a24e1

Please sign in to comment.