goldsmith/types.go

84 lines
2.1 KiB
Go
Raw Normal View History

2015-10-29 14:26:43 +00:00
/*
* 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
2015-12-17 09:09:45 +00:00
import (
"bytes"
"runtime"
)
2015-12-17 08:55:59 +00:00
2015-10-31 07:06:38 +00:00
type Goldsmith interface {
2015-12-17 03:52:14 +00:00
Chain(p Plugin) Goldsmith
2015-12-17 03:37:11 +00:00
Complete() ([]*File, []error)
2015-10-31 07:06:38 +00:00
}
2015-12-17 04:20:41 +00:00
func New(srcDir, dstDir string) Goldsmith {
2015-12-17 09:09:45 +00:00
return NewThrottled(srcDir, dstDir, uint(runtime.NumCPU()))
2015-12-17 08:55:59 +00:00
}
func NewThrottled(srcDir, dstDir string, targetFileCount uint) Goldsmith {
2015-12-17 04:20:41 +00:00
gs := &goldsmith{srcDir: srcDir, dstDir: dstDir}
2015-12-17 08:55:59 +00:00
gs.queueFiles(targetFileCount)
2015-12-17 04:20:41 +00:00
return gs
2015-10-29 14:26:43 +00:00
}
2015-11-01 05:09:46 +00:00
type File struct {
Path string
Meta map[string]interface{}
2015-11-09 04:35:24 +00:00
Buff bytes.Buffer
2015-11-01 05:09:46 +00:00
Err error
2015-10-29 14:26:43 +00:00
}
2015-11-01 07:41:56 +00:00
2015-12-17 04:20:41 +00:00
func NewFile(path string) *File {
return &File{
Path: cleanPath(path),
Meta: make(map[string]interface{}),
}
}
2015-11-02 08:11:11 +00:00
type Context interface {
SrcDir() string
DstDir() string
2015-12-17 03:37:11 +00:00
2015-12-17 04:20:41 +00:00
AddFile(file *File)
2015-12-17 04:06:44 +00:00
RefFile(path string)
2015-11-02 08:11:11 +00:00
}
2015-12-17 04:20:41 +00:00
type Plugin interface{}
2015-12-17 05:12:01 +00:00
type Accepter interface {
Accept(file *File) bool
}
2015-12-17 04:20:41 +00:00
type Initializer interface {
Initialize(ctx Context) error
}
type Finalizer interface {
2015-12-17 07:16:18 +00:00
Finalize(ctx Context, files []*File) error
2015-12-17 04:20:41 +00:00
}
type Processor interface {
Process(ctx Context, file *File) bool
}