Skip to content

Commit 59c9846

Browse files
Rename methods for clarity
1 parent ea820c1 commit 59c9846

File tree

5 files changed

+22
-16
lines changed

5 files changed

+22
-16
lines changed

src/main/java/com/conveyal/analysis/controllers/BundleController.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ private Bundle create (Request req, Response res) {
119119
throw AnalysisServerException.badRequest("Selected OSM does not exist.");
120120
}
121121
} else {
122-
osmPbfFile = HttpUtils.storeFileItem(files.get("osm").get(0));
122+
osmPbfFile = HttpUtils.saveFileItemLocally(files.get("osm").get(0));
123123
}
124124

125125
if (files.get("feedGroupId") != null) {
@@ -139,7 +139,7 @@ private Bundle create (Request req, Response res) {
139139
bundle.feedsComplete = bundleWithFeed.feedsComplete;
140140
bundle.totalFeeds = bundleWithFeed.totalFeeds;
141141
} else {
142-
gtfsZipFiles = HttpUtils.storeFileItems(files.get("feedGroup"));
142+
gtfsZipFiles = HttpUtils.saveFileItemsLocally(files.get("feedGroup"));
143143
}
144144
UserPermissions userPermissions = UserPermissions.from(req);
145145
bundle.accessGroup = userPermissions.accessGroup;

src/main/java/com/conveyal/analysis/controllers/OpportunityDatasetController.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ private OpportunityDatasetUploadStatus createOpportunityDataset(Request req, Res
333333
try {
334334
// Validate inputs and parameters, which will throw an exception if there's anything wrong with them.
335335
// Call remove() rather than get() so that subsequent code will see only string parameters, not the files.
336-
files = HttpUtils.storeFileItemsAndUnzip(formFields.remove("files"));
336+
files = HttpUtils.extractFilesFromFileItemsAndUnzip(formFields.remove("files"));
337337
uploadFormat = DataSourceUtil.detectUploadFormatAndValidate(files);
338338
parameters = extractStringParameters(formFields);
339339
} catch (Exception e) {

src/main/java/com/conveyal/analysis/datasource/DataSourceUploadAction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ public static DataSourceUploadAction forFormFields (
121121
// Extract required parameters. Throws AnalysisServerException on failure, e.g. if a field is missing.
122122
final String sourceName = getFormField(formFields, "sourceName", true);
123123
final String regionId = getFormField(formFields, "regionId", true);
124-
final List<File> files = HttpUtils.storeFileItemsAndUnzip(formFields.get("sourceFiles"));
124+
final List<File> files = HttpUtils.extractFilesFromFileItemsAndUnzip(formFields.get("sourceFiles"));
125125

126126
FileStorageFormat format = DataSourceUtil.detectUploadFormatAndValidate(files);
127127
DataSourceIngester ingester = DataSourceIngester.forFormat(format);

src/main/java/com/conveyal/analysis/util/HttpUtils.java

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,17 @@ public static String getFormField(Map<String, List<FileItem>> formFields, String
7171
}
7272

7373
/**
74-
* Convert `FileItem`s into `File`s and move them into a temp directory. Automatically unzip files. Return the list
75-
* of new `File` handles.
74+
* Extracts `FileItem`s contents locally in a temp directory. Automatically unzip files. Return the list of new
75+
* `File` handles.
7676
*/
77-
public static List<File> storeFileItemsAndUnzip(List<FileItem> fileItems) {
77+
public static List<File> extractFilesFromFileItemsAndUnzip(List<FileItem> fileItems) {
7878
File directory = FileUtils.createScratchDirectory();
7979
List<File> files = new ArrayList<>();
8080
for (FileItem fi : fileItems) {
81-
File file = storeFileItemInDirectory(fi, directory);
81+
File file = moveFileItemIntoDirectory(fi, directory);
8282
String name = file.getName();
8383
if (name.toLowerCase().endsWith(".zip")) {
84-
files.addAll(FileUtils.unZipFileIntoDirectory(file, directory));
84+
files.addAll(FileUtils.unzipFileIntoDirectory(file, directory));
8585
} else {
8686
files.add(file);
8787
}
@@ -90,22 +90,28 @@ public static List<File> storeFileItemsAndUnzip(List<FileItem> fileItems) {
9090
}
9191

9292
/**
93-
* Convert `FileItem`s into `File`s and move them into a temporary directory. Return the list of new `File` handles.
93+
* Move `FileItem`s contents into a temporary directory. Return the list of new `File` handles.
9494
*/
95-
public static List<File> storeFileItems(List<FileItem> fileItems) {
95+
public static List<File> saveFileItemsLocally(List<FileItem> fileItems) {
9696
File directory = FileUtils.createScratchDirectory();
9797
List<File> files = new ArrayList<>();
9898
for (FileItem fileItem : fileItems) {
99-
files.add(storeFileItemInDirectory(fileItem, directory));
99+
files.add(moveFileItemIntoDirectory(fileItem, directory));
100100
}
101101
return files;
102102
}
103103

104-
public static File storeFileItem(FileItem fileItem) {
105-
return storeFileItemInDirectory(fileItem, FileUtils.createScratchDirectory());
104+
/**
105+
* Save the contents of a `FileItem` in a temporary directory and return the `File`.
106+
*/
107+
public static File saveFileItemLocally(FileItem fileItem) {
108+
return moveFileItemIntoDirectory(fileItem, FileUtils.createScratchDirectory());
106109
}
107110

108-
public static File storeFileItemInDirectory(FileItem fileItem, File directory) {
111+
/**
112+
* Move the contents of a `FileItem` to the given directory by calling `renameTo`.
113+
*/
114+
public static File moveFileItemIntoDirectory(FileItem fileItem, File directory) {
109115
File file = new File(directory, fileItem.getName());
110116
boolean renameSuccessful = ((DiskFileItem) fileItem).getStoreLocation().renameTo(file);
111117
if (!renameSuccessful) {

src/main/java/com/conveyal/file/FileUtils.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ public static boolean isGzip (File file) {
123123
/**
124124
* Extract the files inside a zipped file into a given directory and return the `File` handles to the new files.
125125
*/
126-
public static List<File> unZipFileIntoDirectory(File zipFile, File directory) {
126+
public static List<File> unzipFileIntoDirectory(File zipFile, File directory) {
127127
List<File> files = new ArrayList<>();
128128
ZipInputStream zis = new ZipInputStream(FileUtils.getInputStream(zipFile));
129129
ZipEntry zipEntry;

0 commit comments

Comments
 (0)