Introduce temporary file creation Refaster rules

PicnicSupermarket · Apr 30, 2024 · 879ba3a · 879ba3a
1 parent 32778ed
commit 879ba3a
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 0 deletions.
diff --git a/error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/FileRules.java b/error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/FileRules.java
@@ -4,10 +4,12 @@
 
 import com.google.errorprone.refaster.annotation.AfterTemplate;
 import com.google.errorprone.refaster.annotation.BeforeTemplate;
+import java.io.File;
 import java.io.IOException;
 import java.nio.charset.Charset;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.attribute.FileAttribute;
 import tech.picnic.errorprone.refaster.annotation.OnlineDocumentation;
 
 /** Refaster rules related to expressions dealing with files. */
@@ -40,4 +42,34 @@ String after(Path path) throws IOException {
       return Files.readString(path);
     }
   }
+
+  /** Prefer {@link File#createTempFile(String, String)} over more verbose alternatives. */
+  static final class FileCreateTempFile {
+    @BeforeTemplate
+    File before(String prefix, String suffix) throws IOException {
+      return File.createTempFile(prefix, suffix, null);
+    }
+
+    @AfterTemplate
+    File after(String prefix, String suffix) throws IOException {
+      return File.createTempFile(prefix, suffix);
+    }
+  }
+
+  /**
+   * Prefer {@link Files#createTempFile(String, String, FileAttribute[])} over {@link
+   * File#createTempFile(String, String)}, as the former creates files with more restrictive
+   * permissions.
+   */
+  static final class FilesCreateTempFileToFile {
+    @BeforeTemplate
+    File before(String prefix, String suffix) throws IOException {
+      return File.createTempFile(prefix, suffix);
+    }
+
+    @AfterTemplate
+    File after(String prefix, String suffix) throws IOException {
+      return Files.createTempFile(prefix, suffix).toFile();
+    }
+  }
 }
diff --git a/...e-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/FileRulesTestInput.java b/...e-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/FileRulesTestInput.java
@@ -1,5 +1,6 @@
 package tech.picnic.errorprone.refasterrules;
 
+import java.io.File;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
@@ -14,4 +15,12 @@ String testFilesReadStringWithCharset() throws IOException {
   String testFilesReadString() throws IOException {
     return Files.readString(Paths.get("foo"), StandardCharsets.UTF_8);
   }
+
+  File testFileCreateTempFile() throws IOException {
+    return File.createTempFile("foo", "bar", null);
+  }
+
+  File testFilesCreateTempFileToFile() throws IOException {
+    return File.createTempFile("foo", "bar");
+  }
 }
diff --git a/...-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/FileRulesTestOutput.java b/...-contrib/src/test/resources/tech/picnic/errorprone/refasterrules/FileRulesTestOutput.java
@@ -1,5 +1,6 @@
 package tech.picnic.errorprone.refasterrules;
 
+import java.io.File;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
@@ -14,4 +15,12 @@ String testFilesReadStringWithCharset() throws IOException {
   String testFilesReadString() throws IOException {
     return Files.readString(Paths.get("foo"));
   }
+
+  File testFileCreateTempFile() throws IOException {
+    return File.createTempFile("foo", "bar");
+  }
+
+  File testFilesCreateTempFileToFile() throws IOException {
+    return Files.createTempFile("foo", "bar").toFile();
+  }
 }