goldsmith/goldsmith.go

/*
 * Copyright (c) 2015 Alex Yatskov <alex@foosoft.net>
 * Author: Alex Yatskov <alex@foosoft.net>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package goldsmith

import (
	"os"
	"path"
	"path/filepath"
	"sync"
)

const (
	FileFlagStatic = 1 << iota
)

type stage struct {
	input, output chan *File
}

type goldsmith struct {
	srcDir, dstDir string
	stages         []stage
	refs           map[string]bool
	err            error
}

func New(srcDir, dstDir string) Goldsmith {
	gs := &goldsmith{
		srcDir: srcDir,
		dstDir: dstDir,
		refs:   make(map[string]bool),
	}

	gs.err = gs.scanFs()
	return gs
}

func (gs *goldsmith) scanFs() error {
	fileMatches, _, err := scanDir(gs.srcDir)
	if err != nil {
		return err
	}

	s := gs.makeStage()

	go func() {
		defer close(s.output)

		for _, match := range fileMatches {
			relPath, err := filepath.Rel(gs.srcDir, match)
			if err != nil {
				panic(err)
			}

			file := gs.NewFile(relPath)

			var f *os.File
			if f, file.Err = os.Open(match); file.Err == nil {
				_, file.Err = file.Buff.ReadFrom(f)
				f.Close()
			}

			s.output <- file
		}
	}()

	return nil
}

func (gs *goldsmith) cleanupFiles() error {
	fileMatches, dirMatches, err := scanDir(gs.dstDir)
	if err != nil {
		return err
	}

	matches := append(fileMatches, dirMatches...)

	for _, match := range matches {
		relPath, err := filepath.Rel(gs.dstDir, match)
		if err != nil {
			panic(err)
		}

		if contained, _ := gs.refs[relPath]; contained {
			continue
		}

		if err := os.RemoveAll(match); err != nil {
			return err
		}
	}

	return nil
}

func (gs *goldsmith) exportFile(file *File) {
	defer file.Buff.Reset()

	if file.Err != nil {
		return
	}

	absPath := filepath.Join(gs.dstDir, file.Path)
	if file.Err = os.MkdirAll(path.Dir(absPath), 0755); file.Err != nil {
		return
	}

	var f *os.File
	if f, file.Err = os.Create(absPath); file.Err == nil {
		defer f.Close()
		if _, file.Err = f.Write(file.Buff.Bytes()); file.Err == nil {
			gs.RefFile(file.Path)
		}
	}
}

func (gs *goldsmith) makeStage() stage {
	s := stage{output: make(chan *File)}
	if len(gs.stages) > 0 {
		s.input = gs.stages[len(gs.stages)-1].output
	}

	gs.stages = append(gs.stages, s)
	return s
}

func (gs *goldsmith) chain(s stage, c Chainer) {
	var (
		wg     sync.WaitGroup
		output = make(chan *File)
		input  = make(chan *File)
	)

	defer func() {
		wg.Wait()
		close(s.output)
	}()

	wg.Add(1)
	go func() {
		defer wg.Done()
		for file := range output {
			s.output <- file
		}
	}()

	wg.Add(1)
	go func() {
		defer func() {
			close(input)
			wg.Done()
		}()

		f, _ := c.(Filterer)
		for file := range s.input {
			if file.flags&FileFlagStatic != 0 || (f != nil && f.Filter(file.Path)) {
				s.output <- file
			} else {
				input <- file
			}
		}
	}()

	go c.Chain(gs, input, output)
}

func (gs *goldsmith) NewFile(path string) *File {
	if filepath.IsAbs(path) {
		var err error
		path, err = filepath.Rel("/", path)
		if err != nil {
			panic(err)
		}
	}

	return &File{
		Path: filepath.Clean(path),
		Meta: make(map[string]interface{}),
	}
}

func (gs *goldsmith) NewFileStatic(path string) *File {
	file := gs.NewFile(path)
	file.flags |= FileFlagStatic
	return file
}

func (gs *goldsmith) RefFile(path string) {
	if filepath.IsAbs(path) {
		var err error
		path, err = filepath.Rel("/", path)
		if err != nil {
			panic(err)
		}
	}

	path = filepath.Clean(path)

	for {
		gs.refs[path] = true
		if path == "." {
			break
		}

		path = filepath.Dir(path)
	}
}

func (gs *goldsmith) SrcDir() string {
	return gs.srcDir
}

func (gs *goldsmith) DstDir() string {
	return gs.dstDir
}

func (gs *goldsmith) Chain(c Chainer, err error) Goldsmith {
	if gs.err != nil {
		return gs
	}

	if gs.err = err; gs.err == nil {
		go gs.chain(gs.makeStage(), c)
	}

	return gs
}

func (gs *goldsmith) Complete() ([]*File, error) {
	if gs.err != nil {
		return nil, gs.err
	}

	s := gs.stages[len(gs.stages)-1]

	var files []*File
	for file := range s.output {
		gs.exportFile(file)
		files = append(files, file)
	}

	gs.err = gs.cleanupFiles()
	return files, gs.err
}

func scanDir(root string) (files, dirs []string, err error) {
	err = filepath.Walk(root, func(path string, info os.FileInfo, err error) error {
		if err != nil {
			return err
		}

		if info.IsDir() {
			dirs = append(dirs, path)
		} else {
			files = append(files, path)
		}

		return nil
	})

	return
}