ammonite.ops.package.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ammonite-ops_2.10 Show documentation
ammonite-ops
There is a newer version: 0.8.3-3
package ammonite


package object ops extends Extensions with RelPathStuff{
  implicit val postfixOps = scala.language.postfixOps

  /**
   * The root of the filesystem
   */
  val root = ops.Path.root

  def resource(implicit resRoot: ResourceRoot = Thread.currentThread().getContextClassLoader) ={
    ops.ResourcePath.resource(resRoot)
  }

  /**
   * The user's home directory
   */
  val home = Path(System.getProperty("user.home"))

  /**
    * Alias for `java.nio.file.Files.createTempFile` and
    * `java.io.File.deleteOnExit`. Pass in `deleteOnExit = false` if you want
    * the temp file to stick around.
    */
  object tmp{
    /**
      * Creates a temporary directory
      */
    def dir(dir: Path = null,
            prefix: String = null,
            deleteOnExit: Boolean = true): Path = {
      val nioPath = dir match{
        case null => java.nio.file.Files.createTempDirectory(prefix)
        case _ => java.nio.file.Files.createTempDirectory(dir.toNIO, prefix)
      }
      if (deleteOnExit) nioPath.toFile.deleteOnExit()
      Path(nioPath)
    }

    /**
      * Creates a temporary file with the provided contents
      */
    def apply(contents: Internals.Writable = null,
              dir: Path = null,
              prefix: String = null,
              suffix: String = null,
              deleteOnExit: Boolean = true): Path = {

      val nioPath = dir match{
        case null => java.nio.file.Files.createTempFile(prefix, suffix)
        case _ => java.nio.file.Files.createTempFile(dir.toNIO, prefix, suffix)
      }

      if (contents != null) write.over(Path(nioPath), contents)
      if (deleteOnExit) nioPath.toFile.deleteOnExit()
      Path(nioPath)
    }
  }

  /**
   * The current working directory for this process.
   */
  lazy val pwd = ops.Path(new java.io.File("").getCanonicalPath)
  @deprecated("replaced by pwd","0.7.5")
  lazy val cwd = pwd

  /**
    * If you want to call subprocesses using [[%]] or [[%%]] and don't care
    * what working directory they use, import this via
    *
    * `import ammonite.ops.ImplicitWd._`
    *
    * To make them use the process's working directory for each subprocess
    */
  object ImplicitWd{
    implicit lazy val implicitCwd = ops.pwd
  }

  /**
    * Extractor to let you easily pattern match on [[ops.Path]]s. Lets you do
    *
    * {{{
    *   @ val base/segment/filename = pwd
    *   base: Path = Path(Vector("Users", "haoyi", "Dropbox (Personal)"))
    *   segment: String = "Workspace"
    *   filename: String = "Ammonite"
    * }}}
    *
    * To break apart a path and extract various pieces of it.
    */
  object /{
    def unapply[T <: BasePath](p: T): Option[(p.ThisType, String)] = {
      if (p.segments.length > 0)
        Some((p / up, p.last))
      else None
    }
  }

  /**
    * Lets you treat any path as a file, letting you access any property you'd
    * normally access through [[stat]]-ing it by [[stat]]-ing the file for you
    * when necessary.
    */
  implicit def fileData(p: Path): stat.full = stat.full(p)

  /**
    * Used to spawn a subprocess interactively; any output gets printed to the
    * console and any input gets requested from the current console. Can be
    * used to run interactive subprocesses like `%vim`, `%python`,
    * `%ssh "www.google.com"` or `%sbt`.
    */
  val % = Shellout.%
  /**
    * Spawns a subprocess non-interactively, waiting for it to complete and
    * collecting all output into a [[CommandResult]] which exposes it in a
    * convenient form. Call via `%%('whoami).out.trim` or
    * `%%('git, 'commit, "-am", "Hello!").exitCode`
    */
  val %% = Shellout.%%
}