domain

Documentation

Index

• Constants
• type CfgReader
• type Config
• type DefaultConfiguration
• type Dest
• type FileSystem
• type ImportSpec
• type ImportSpecs
• type Importer
• type Item
• type Method
• type MockTemplateArg
• type Src
• type SrcDefaultConfiguration
• type Var

Constants

const ConfigTpl = `` /* 203-byte string literal not displayed */

ConfigTpl is a configuration file template.

const MockTpl = `` /* 1955-byte string literal not displayed */

MockTpl is a mock's template.

const (
	// URL is the repository url.
	URL = "https://github.com/suzuki-shunsuke/gomic"
)

const Version = "0.5.4-0"

Version is the gomic's version.

Types

type CfgReader

type CfgReader interface {
	Read(string) (Config, error)
}

CfgReader reads and parses a configuration file.

type Config

type Config struct {
	Default DefaultConfiguration
	Items   []Item
}

Config represents configuration.

type DefaultConfiguration

type DefaultConfiguration struct {
	SrcDefaultConfiguration `yaml:",inline"`
}

DefaultConfiguration represents default configuration.

type Dest

type Dest struct {
	Package string
	File    string
}

Dest represents generated file's configuration.

type FileSystem

type FileSystem interface {
	Exist(string) bool
	MkdirAll(string) error
	Write(string, []byte) error
	GetWriteCloser(string) (io.WriteCloser, error)
	Getwd() (string, error)
}

FileSystem abstracts operations of the file system.

type ImportSpec

type ImportSpec interface {
	Host() string
	Name() string
	Path() string
	String() string
}

ImportSpec represents an import statement.

type ImportSpecs

type ImportSpecs interface {
	Add(ImportSpec) (ImportSpec, error)
	Names() map[string]ImportSpec
	Paths() map[string]ImportSpec
}

ImportSpecs represents a collection of ImportSpec.

type Importer

type Importer interface {
	GetFileByFilePath(filePath string, mode parser.Mode) (*ast.File, error)
	GetPkgsInDir(dirPath string, filter func(os.FileInfo) bool, mode parser.Mode) (map[string]*ast.Package, error)
	GetBuildPkgInDir(dir string, mode build.ImportMode) (*build.Package, error)
	GetBuildPkgByPkgPath(pkgPath, srcDir string, mode build.ImportMode) (*build.Package, error)
}

Importer imports go's file and packages.

type Item

type Item struct {
	Src                  Src
	Dest                 Dest
	DefaultConfiguration `yaml:",inline"`
}

Item represents configuration of each mock.

type Method

type Method interface {
	Name() string
	Declaration() string
	Definition() string
	SetReturnDefinition() string
	SetReturnInternalDefinition() string
	ParamsStr() string
	ResultValuesStr() string
	HasResultNames() bool
	Imports() map[string]ImportSpec
	Results() []Var
	IsEllipsis() bool
}

Method represents a mock's method.

type MockTemplateArg

type MockTemplateArg interface {
	Version() string
	URL() string
	PackageName() string
	MockName() string
	Imports() [][]string
	Methods() []Method
}

MockTemplateArg is a template argument and represents a mock.

type Src

type Src struct {
	Package                 string
	Interface               string
	Name                    string
	File                    string
	Dir                     string
	SrcDefaultConfiguration `yaml:",inline"`
}

Src represents source configuration.

type SrcDefaultConfiguration

type SrcDefaultConfiguration struct {
	InterfacePrefix string `yaml:"interface_prefix"`
	InterfaceSuffix string `yaml:"interface_suffix"`
	VendorDir       string `yaml:"vendor_dir"`
}

SrcDefaultConfiguration represents source's default configuration.

type Var

type Var interface {
	Name() string
	Type() string
	PkgName() string
	PkgPath() string
}

Var represents a method's parameter and return value.