Fix #9: File.resource APIs

CHANGES.md

@@ -1,5 +1,6 @@
 ## v3.0.0
 
+* [Issue #9](https://github.com/pathikrit/better-files/issues/9): File resource utils
 * [Issue #114](https://github.com/pathikrit/better-files/issues/114): Glob with automatic path
 * [Issue #107](https://github.com/pathikrit/better-files/issues/107): Handle Byte-order markers
 * [PR #113](https://github.com/pathikrit/better-files/pull/113): File anchor util

README.md

@@ -320,6 +320,8 @@ File.usingTempFile() {tempFile =>
 File.newTempFile().applyAndDelete(tempFile =>  ...)
 ```
 
+You can also load resources from your classpath using `File.resource` or `File.copyResource`.
+
 ### UNIX DSL
 All the above can also be expressed using [methods](http://pathikrit.github.io/better-files/latest/api/better/files/Dsl$.html) reminiscent of the command line:
 ```scala

core/src/main/scala/better/files/File.scala

@@ -870,20 +870,27 @@ object File {
   implicit val defaultCharset: Charset =
     UnicodeCharset(Charset.defaultCharset())
 
+  /**
+    * Get a file from a resource
+    * Note: Use resourceToFile instead as this may not actually always load the file
+    * See: http://stackoverflow.com/questions/676250/different-ways-of-loading-a-file-as-an-inputstream
+    *
+    * @param name
+    * @return
+    */
   def resource(name: String): File =
-    File(Thread.currentThread().getContextClassLoader.getResource(name))
+    File(currentClassLoader().getResource(name))
 
   /**
-    * Copies a resource into a tempFile
+    * Copies a resource into a file
     *
     * @param name
+    * @param out File where resource is copied into, if not specified a temp file is created
     * @return
     */
-  def resourceAsTempFile(name: String): File = {
-    val in = getClass.getResourceAsStream(name)
-    val file = File.newTemporaryFile(prefix = name)
-    in.pipeTo(file.newOutputStream)
-    file
+  def copyResource(name: String)(out: File = File.newTemporaryFile(prefix = name)): out.type = {
+    resourceAsStream(name) > out.newOutputStream
+    out
   }
 
   def newTemporaryDirectory(prefix: String = "", parent: Option[File] = None)(implicit attributes: Attributes = Attributes.default): File = {

core/src/main/scala/better/files/package.scala

@@ -1,5 +1,7 @@
 package better
 
+import java.io.InputStream
+
 import scala.collection.mutable
 import scala.util.{Failure, Success, Try}
 
@@ -17,6 +19,8 @@ package object files extends Implicits {
     def close(): Unit
   }
 
+  def resourceAsStream(name: String): InputStream = currentClassLoader().getResourceAsStream(name)
+
   type ManagedResource[A <: Closeable] = Traversable[A]
 
   // Some utils:
@@ -26,6 +30,8 @@ package object files extends Implicits {
 
   @inline private[files] def repeat[U](n: Int)(f: => U): Unit = (1 to n).foreach(_ => f)
 
+  private[files] def currentClassLoader() = Thread.currentThread().getContextClassLoader
+
   private[files] def using[A <: Closeable, U](resource: A)(f: A => U): U = try { f(resource) } finally {resource.close()}
 
   private[files] def produce[A](f: => A) = new {