Merge pull request #1 from go-sharp/pre-v2

Relase v2.0.0

Author: snmed

.gitignore

@@ -12,3 +12,6 @@
 
 # Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736
 .glide/
+
+# Exclude generated test data
+testdata/gen/

README.md

@@ -2,6 +2,10 @@
 
 Vault is a simple tool to embed resource and asset files into a go binary. It generates go source files containing encoded and compressed resource files. The generated source code provides an api to retrieve the embedded resources without any additional dependencies and therefore the vault package is only needed to generate those source files.
 
+## Requirements
+
+go 1.9.7+
+
 ## Installation
 
 Install tool with `go get`:
@@ -116,7 +120,7 @@ import (
 func main() {
     // Create a loader (default: New{source folder name}Loader() -> can be changed with ResourceNameOption)
     loader := res.NewDistLoader()
-    f, err := loader.Load("/bg.jpg")
+    f, err := loader.Open("/bg.jpg")
     if err != nil {
         log.Fatalln(err)
     }
@@ -136,7 +140,7 @@ func main() {
         log.Fatalln(err)
     }
 
-    f2, err := loader.Load("/js/app.js")
+    f2, err := loader.Open("/js/app.js")
     if err != nil {
         log.Fatalln(err)
     }
@@ -162,28 +166,32 @@ The asset loader implements only one method:
 ```go
 // AssetLoader implements a function to load an asset from the vault
 type AssetLoader interface {
-	// Load loads a file from the vault.
-	Load(name string) (File, error)
+	// Open loads a file from the vault.
+	Open(name string) (File, error)
 }
 ```
 
-Load returns a file instance with the following interface or an error:
+Load returns a file instance with the following interface (see http.File) or an error:
 
 ```go
-// File is the vault abstraction of a file.
+// File is the interface definition in the http package.
 type File interface {
-	io.ReadCloser
-	// Size returns the size of the file.
-	Size() int64
-	// Name returns the name of the file.
-	Name() string
-	// ModTime returns the modification time.
-	ModTime() time.Time
-	// Path is the registered path within the vault.
-	Path() string
+        io.Closer
+        io.Reader
+        io.Seeker
+        Readdir(count int) ([]os.FileInfo, error)
+        Stat() (os.FileInfo, error)
 }
 ```
 
+#### Use Loader in the http.FileServer handler
+
+The asset loader implements the `http.FileSystem` interface and can be used with the `http.FileServer` handler. Just pass the loader to the _FileServer_ function as follows:
+
+```go
+http.Handle("/", http.FileServer(res.NewDistLoader()))
+```
+
 #### Development Mode
 
 Run or build a program with `go run -tags debug main.go` to enable the development mode. In development mode the loader bypasses the embedded files and reads directly from the source directory. Therefore it is important to run the program in the same folder as the vault-cli tool was invoked. Otherwise invoke vault-cli with the flag `-rp` and specify the relative path to the source directory from the directory where the program will be executed. For example (folder structure as above):

example/webapp-backend/main.go

@@ -4,16 +4,13 @@ package main
 
 import (
 	"fmt"
-	"io/ioutil"
 	"log"
-	"mime"
 	"net/http"
-	"path/filepath"
 	"time"
 
 	"github.com/pkg/browser"
 
-	"github.com/go-sharp/vault/example/webapp-backend/res"
+	res "github.com/go-sharp/vault/example/webapp-backend/res"
 )
 
 func sayHelloHandler(w http.ResponseWriter, r *http.Request) {
@@ -38,27 +35,7 @@ func main() {
 	http.HandleFunc("/api/sayhello", sayHelloHandler)
 	http.HandleFunc("/api/time", timeHandler)
 
-	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
-		fp := r.URL.Path
-		if fp == "/" {
-			fp = "/index.html"
-		}
-		log.Printf("requesting: %v...", r.URL.Path)
-
-		f, err := loader.Load(fp)
-		if err != nil {
-			w.WriteHeader(http.StatusNotFound)
-			return
-		}
-		data, err := ioutil.ReadAll(f)
-		if err != nil {
-			w.WriteHeader(http.StatusInternalServerError)
-		}
-		defer f.Close()
-
-		w.Header().Set("Content-Type", mime.TypeByExtension(filepath.Ext(f.Name())))
-		w.Write(data)
-	})
+	http.Handle("/", http.FileServer(loader))
 
 	log.Println("webapp started, listening on port :8080...")
 	browser.OpenURL("http://localhost:8080")

example/webapp-backend/res/debug_react_vault.go

@@ -8,63 +8,17 @@ package res
 
 import (
 	"fmt"
+	"net/http"
 	"os"
 	"path"
-	"strings"
-	"time"
 )
 
-type memFile struct {
-	f    *os.File
-	stat os.FileInfo
-	path string
-	base string
-}
-
-func (m memFile) Size() int64 {
-	return m.stat.Size()
-}
-
-func (m memFile) Name() string {
-	return m.stat.Name()
-}
-
-func (m memFile) ModTime() time.Time {
-	return m.stat.ModTime()
-}
-
-func (m memFile) Path() string {
-	return m.path
-}
-
-func (m memFile) Read(p []byte) (n int, err error) {
-	return m.f.Read(p)
-}
-
-func (m memFile) Close() error {
-	return m.f.Close()
-}
-
 type debugLoader struct {
 	base string
 }
 
-func (d debugLoader) Load(name string) (File, error) {
-	if !strings.HasPrefix(name, "/") {
-		name = "/" + name
-	}
-
-	f, err := os.Open(getFullPath(d.base, name))
-	if err != nil {
-		return nil, err
-	}
-
-	stat, err := f.Stat()
-	if err != nil {
-		return nil, err
-	}
-
-	return &memFile{base: d.base, path: path.Clean(strings.TrimSuffix(name, stat.Name())), f: f, stat: stat}, nil
+func (d debugLoader) Open(name string) (http.File, error) {
+	return os.Open(getFullPath(d.base, name))
 }
 
 func getFullPath(b, p string) string {

example/webapp-backend/res/release_react_vault.go

@@ -5,29 +5,11 @@
 package res
 
 import (
-	"errors"
-	"io"
-	"time"
+	"net/http"
 )
 
-// ErrNotFound is returned if the requested file was not found.
-var ErrNotFound = errors.New("file not found")
-
-// File is the vault abstraction of a file.
-type File interface {
-	io.ReadCloser
-	// Size returns the size of the file.
-	Size() int64
-	// Name returns the name of the file.
-	Name() string
-	// ModTime returns the modification time.
-	ModTime() time.Time
-	// Path is the registered path within the vault.
-	Path() string
-}
-
 // AssetLoader implements a function to load an asset from the vault
 type AssetLoader interface {
-	// Load loads a file from the vault.
-	Load(name string) (File, error)
+	// Open loads a file from the vault.
+	Open(name string) (http.File, error)
 }