com.github.cukedoctor.util.FileUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cukedoctor-converter Show documentation
The newest version!
package com.github.cukedoctor.util;

import static com.github.cukedoctor.util.Assert.hasText;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.*;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Pattern;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/** Created by pestano on 02/06/15. */
public class FileUtil {

  private static final Logger log = LoggerFactory.getLogger(FileUtil.class);
  public static final Pattern ADOC_FILE_EXTENSION =
      Pattern.compile("([^\\s]+(\\.(?i)(ad|adoc|asciidoc|asc))$)");

  /**
   * @param path full path to the json feature result
   * @return absolute path to to json result file
   */
  public static String findJsonFile(String path) {

    if (path == null) {
      path = "";
    }

    File f = new File(path);
    if (f.exists()) {
      return f.getAbsolutePath();
    }

    // relative path
    if (path.startsWith("/")) { // remove slash to use relative paths
      path = path.substring(1);
    }

    return Paths.get(path.trim()).toAbsolutePath().toString();
  }

  /**
   * @param startDir initial directory to scan for features
   * @return all found json files path that represent cucumber features
   */
  public static List findJsonFiles(String startDir) {
    return findFiles(startDir, ".json");
  }

  public static List findFiles(String startDir, final String suffix) {
    return findFiles(startDir, suffix, false);
  }

  public static List findFiles(
      String startDir, final String suffix, final boolean singleResult) {
    return findFiles(startDir, suffix, singleResult, null);
  }

  public static List findFiles(
      String startDir, final String suffix, final boolean singleResult, final String relativePath) {
    final List foundPaths = new ArrayList<>();
    if (startDir == null) {
      startDir = "";
    }

    Path startPath = Paths.get(startDir);

    if (!Files.exists(startPath)) {
      if (startDir.startsWith("/")) { // try to find using relative paths
        startDir = startDir.substring(1);
        startPath = Paths.get(startDir);
      }

      if (!Files.exists(startPath)) {
        startPath = Paths.get("");
      }
    }

    try {
      Files.walkFileTree(
          startPath,
          new SimpleFileVisitor() {
            @Override
            public FileVisitResult visitFile(final Path file, final BasicFileAttributes attrs)
                throws IOException {
              final String fileName = file.getFileName().toString();
              if (fileName.endsWith(suffix)) {
                if (hasText(relativePath)) {
                  boolean isFile = file.toFile().isFile();
                  Path computedPath =
                      Paths.get(relativePath)
                          .relativize(
                              isFile ? file.getParent().toAbsolutePath() : file.toAbsolutePath());
                  if (isFile) {
                    foundPaths.add(computedPath.toString() + "/" + file.toFile().getName());
                  } else {
                    foundPaths.add(computedPath.toString());
                  }

                } else {
                  foundPaths.add(file.toAbsolutePath().toString());
                }
                if (singleResult) {
                  return FileVisitResult.TERMINATE;
                }
              }
              if (attrs.isDirectory()) {
                return super.visitFile(file, attrs);
              } else {
                return FileVisitResult.SKIP_SUBTREE;
              }
            }
          });
    } catch (IOException e) {
      log.warn("Problems scanning {} files in path: {}", suffix, startDir, e);
    }
    return foundPaths;
  }

  /**
   * Saves a file into filesystem. Note that name can be saved as absolute (if it has a leading
   * slash) or relative to current path. EX: /target/name.adoc will save the file into
   *
   * @param name file name
   * @param data file content
   * @return the path of saved file
   */
  public static File saveFile(String name, String data) {
    if (name == null) {
      name = "";
    }
    String fullyQualifiedName = name;

    /** if filename is not absolute use current path as base dir */
    if (!new File(fullyQualifiedName).isAbsolute()) {
      fullyQualifiedName = Paths.get("").toAbsolutePath().toString() + "/" + name;
    }
    try {
      // create subdirs (if there any)
      if (fullyQualifiedName.contains("/")) {
        File f = new File(fullyQualifiedName.substring(0, fullyQualifiedName.lastIndexOf("/")));
        f.mkdirs();
      }
      File file = new File(fullyQualifiedName);
      file.createNewFile();
      FileUtils.write(file, data, "UTF-8");
      log.info("Wrote: " + file.getAbsolutePath());
      return file;
    } catch (IOException e) {
      log.error("Could not create file {}", name, e);
      return null;
    }
  }

  public static File loadFile(String path) {
    if (path == null) {
      path = "/";
    }

    File f = new File(path);
    if (f.exists()) {
      return f.getAbsoluteFile();
    }

    if (!path.startsWith("/")) {
      path = "/" + path;
    }

    return new File(Paths.get("").toAbsolutePath().toString() + path.trim());
  }

  public static boolean removeFile(String path) {

    File fileToRemove = loadFile(path);

    return fileToRemove.delete();
  }

  public static void removeDir(String path) throws IOException {
    File directoryToRemove = loadFile(path);
    FileUtils.deleteDirectory(directoryToRemove);
  }

  /**
   * @param source resource from classpath
   * @param dest dest path
   * @return copied file
   */
  public static File copyFileFromClassPath(String source, String dest) {
    if (source != null && dest != null) {
      try {
        InputStream in = FileUtil.class.getResourceAsStream(source);
        return saveFile(dest, IOUtils.toString(in));
      } catch (IOException e) {
        log.error("Could not copy source file: {} to dest file: {}", source, dest, e);
      }
    }
    return null;
  }

  /**
   * @param source file path
   * @param dest dest path
   * @return copied file
   */
  public static File copyFile(String source, String dest) {

    if (source != null && dest != null) {
      File sourcefile = new File(source);
      if (!sourcefile.exists()) {
        log.warn("File {} not found.", sourcefile.getAbsolutePath());
        return null;
      }
      try {
        InputStream in = new FileInputStream(source);
        return saveFile(dest, IOUtils.toString(in));
      } catch (IOException e) {
        log.error("Could not copy source file: {} to dest file: {}", source, dest, e);
      }
    }
    return null;
  }
}