config.go

package gitdb

import (
	"errors"
	"time"
)

// Config represents configuration options for GitDB
type Config struct {
	ConnectionName string
	DBPath         string
	OnlineRemote   string
	EncryptionKey  string
	SyncInterval   time.Duration
	User           *User
	Factory        func(string) Model
	EnableUI       bool
	UIPort         int
	// Mock is a hook for testing apps. If true will return a Mock DB connection
	Mock   bool
	Driver dbDriver
}

const defaultConnectionName = "default"
const defaultSyncInterval = time.Second * 5
const defaultUserName = "ghost"
const defaultUserEmail = "ghost@gitdb.local"
const defaultUIPort = 4120

// NewConfig constructs a *Config
func NewConfig(dbPath string) *Config {
	return &Config{
		DBPath:         dbPath,
		SyncInterval:   defaultSyncInterval,
		User:           NewUser(defaultUserName, defaultUserEmail),
		ConnectionName: defaultConnectionName,
		UIPort:         defaultUIPort,
		Driver:         &gitDriver{driver: &gitBinaryDriver{}},
	}
}

// NewConfigWithLocalDriver constructs a *Config
func NewConfigWithLocalDriver(dbPath string) *Config {
	return &Config{
		DBPath:         dbPath,
		SyncInterval:   defaultSyncInterval,
		User:           NewUser(defaultUserName, defaultUserEmail),
		ConnectionName: defaultConnectionName,
		UIPort:         defaultUIPort,
		Driver:         &localDriver{},
	}
}

// Validate returns an error is *Config.DBPath is not set
func (c *Config) Validate() error {
	if len(c.DBPath) == 0 {
		return errors.New("Config.DbPath must be set")
	}

	return nil
}