gg_deployer

README

Deployer

Deploy files into output directory.

Use a Virtual File System approach, so you can write your own file writer (FTP, Google Drive, etc...).

Sample usage:

package main

import (
	"bitbucket.org/digi-sense/gg-core"
	"bitbucket.org/digi-sense/gg-core/gg_deployer"
)

func main(){
	// init workspace
	gg.Paths.SetWorkspacePath("./")

	// load options for deployer
	options, err := gg_deployer.NewDeployerOptions("./deployer.json")
	if nil!=err{
		panic(err)
    }

	// create a deployer
	deployer, err := gg_deployer.NewDeployer(options)
	if nil!=err{
		panic(err)
	}
	
	// open and load from "DirLoad" option 
	err = deployer.Open()
	if nil!=err{
		panic(err)
	}

	// load a file to deploy later
	err = deployer.LoadFilename("./sample.txt")
	if nil!=err{
		panic(err)
	}
	
	// deploy anything loaded from "DirLoad" option and LoadFile method
	err = deployer.DeployAll()
	if nil!=err{
		panic(err)
	}
	
	// close and remove all deployed files if "empty-dir-deploy-on-close" options is true
    err = deployer.Close()
	if nil!=err{
		panic(err)
	}
}

Documentation

Index

• type DeployCtrl
  • func NewDeployer(args ...interface{}) (instance *DeployCtrl, err error)
  • func (instance *DeployCtrl) Close() (err error)
  • func (instance *DeployCtrl) CountLoaded() int
  • func (instance *DeployCtrl) Deploy(content string, fileName string, overwrite bool) (err error)
  • func (instance *DeployCtrl) DeployAll() (count int, err error)
  • func (instance *DeployCtrl) DeployFile(file *DeployerFile) (err error)
  • func (instance *DeployCtrl) DeployFileWithOptions(file *DeployerFile, options *DeployerFileWriteOptions) (err error)
  • func (instance *DeployCtrl) DeployFilename(filename string) (err error)
  • func (instance *DeployCtrl) Deployed() []string
  • func (instance *DeployCtrl) LoadFile(file *DeployerFile) (err error)
  • func (instance *DeployCtrl) LoadFilename(filename string) (err error)
  • func (instance *DeployCtrl) Loaded() []*DeployerFile
  • func (instance *DeployCtrl) Map() (response map[string]interface{})
  • func (instance *DeployCtrl) Open() (err error)
  • func (instance *DeployCtrl) String() string
  • func (instance *DeployCtrl) Uid() string
  • func (instance *DeployCtrl) WalkLoaded(callback func(file *DeployerFile)) *DeployCtrl
• type DeployerFile
  • func NewDeployerFile(filename string, content []byte, dirDeploy string, overwrite, minify bool) (response *DeployerFile)
  • func (instance *DeployerFile) GetAbsolutePath() string
  • func (instance *DeployerFile) String() string
• type DeployerFileSystemOptions
• type DeployerFileWriteOptions
• type DeployerHelper
  • func (instance *DeployerHelper) New(args ...interface{}) (response *DeployCtrl, err error)
• type DeployerOptions
  • func NewDeployerOptions(args ...interface{}) (instance *DeployerOptions, err error)
  • func (instance *DeployerOptions) Map() (response map[string]interface{})
  • func (instance *DeployerOptions) String() string

Types

type DeployCtrl

type DeployCtrl struct {
	// contains filtered or unexported fields
}

func NewDeployer

func NewDeployer(args ...interface{}) (instance *DeployCtrl, err error)

func (*DeployCtrl) Close

func (instance *DeployCtrl) Close() (err error)

func (*DeployCtrl) CountLoaded

func (instance *DeployCtrl) CountLoaded() int

func (*DeployCtrl) Deploy

func (instance *DeployCtrl) Deploy(content string, fileName string, overwrite bool) (err error)

func (*DeployCtrl) DeployAll

func (instance *DeployCtrl) DeployAll() (count int, err error)

func (*DeployCtrl) DeployFile

func (instance *DeployCtrl) DeployFile(file *DeployerFile) (err error)

func (*DeployCtrl) DeployFileWithOptions

func (instance *DeployCtrl) DeployFileWithOptions(file *DeployerFile, options *DeployerFileWriteOptions) (err error)

func (*DeployCtrl) DeployFilename

func (instance *DeployCtrl) DeployFilename(filename string) (err error)

func (*DeployCtrl) Deployed

func (instance *DeployCtrl) Deployed() []string

func (*DeployCtrl) LoadFile

func (instance *DeployCtrl) LoadFile(file *DeployerFile) (err error)

func (*DeployCtrl) LoadFilename

func (instance *DeployCtrl) LoadFilename(filename string) (err error)

func (*DeployCtrl) Loaded

func (instance *DeployCtrl) Loaded() []*DeployerFile

func (*DeployCtrl) Map

func (instance *DeployCtrl) Map() (response map[string]interface{})

func (*DeployCtrl) Open

func (instance *DeployCtrl) Open() (err error)

func (*DeployCtrl) String

func (instance *DeployCtrl) String() string

func (*DeployCtrl) Uid

func (instance *DeployCtrl) Uid() string

func (*DeployCtrl) WalkLoaded

func (instance *DeployCtrl) WalkLoaded(callback func(file *DeployerFile)) *DeployCtrl

WalkLoaded pass all loaded files to a callback function for changes

type DeployerFile

type DeployerFile struct {
	Filename  string `json:"filename"` // name of the file. i.e. "index.html"
	Content   []byte `json:"content"`  // content in bytes
	Path      string `json:"path"`     // Output path. For example, "/files/out/". If empty is used the default value
	Overwrite bool   `json:"overwrite"`
	Minify    bool   `json:"minify"`
}

func NewDeployerFile

func NewDeployerFile(filename string, content []byte, dirDeploy string, overwrite, minify bool) (response *DeployerFile)

func (*DeployerFile) GetAbsolutePath

func (instance *DeployerFile) GetAbsolutePath() string

func (*DeployerFile) String

func (instance *DeployerFile) String() string

type DeployerFileSystemOptions

type DeployerFileSystemOptions struct {
	DriverName string                 `json:"driver-name"`
	Payload    map[string]interface{} `json:"payload"`
}

type DeployerFileWriteOptions

type DeployerFileWriteOptions struct {
	FileSystem *DeployerFileSystemOptions `json:"file-system"`
	DirDeploy  string                     `json:"dir-deploy"`
	Overwrite  bool                       `json:"overwrite"` // default overwrite
	Minify     bool                       `json:"minify"`
}

type DeployerHelper

type DeployerHelper struct {
}

var Deployer *DeployerHelper

func (*DeployerHelper) New

func (instance *DeployerHelper) New(args ...interface{}) (response *DeployCtrl, err error)

type DeployerOptions

type DeployerOptions struct {
	DeployerFileWriteOptions
	DirLoad               []string `json:"dir-load"`
	DirLoadFileFilter     string   `json:"dir-load-file-filter"`
	EmptyDirDeployOnClose bool     `json:"empty-dir-deploy-on-close"`
}

func NewDeployerOptions

func NewDeployerOptions(args ...interface{}) (instance *DeployerOptions, err error)

func (*DeployerOptions) Map

func (instance *DeployerOptions) Map() (response map[string]interface{})

func (*DeployerOptions) String

func (instance *DeployerOptions) String() string