adapters

Documentation

Index

• type ArgumentParser
• type DB
• type DBAdapter
  • func NewDBAdapter(db *sql.DB) DBAdapter
  • func (adapter DBAdapter) Exec(query string, args ...interface{}) (sql.Result, error)
  • func (adapter DBAdapter) Ping() error
  • func (adapter DBAdapter) Query(query string, args ...interface{}) (DBRows, error)
• type DBRows
• type File
• type FileSystem
• type FlagArgumentParser
  • func NewArgumentParser() FlagArgumentParser
  • func (adapter FlagArgumentParser) OptionString(name string, value string) *string
  • func (adapter FlagArgumentParser) Parse() error
  • func (adapter FlagArgumentParser) ParseArguments(args []string) error
  • func (adapter FlagArgumentParser) PositionalArguments() []string
• type IOUtilAdapter
  • func (adapter IOUtilAdapter) ReadDir(dirname string) ([]os.FileInfo, error)
  • func (adapter IOUtilAdapter) ReadFile(filename string) ([]byte, error)
  • func (adapter IOUtilAdapter) WriteFile(filename string, data []byte, perm fs.FileMode) error
• type NilPrinterAdapter
  • func (adapter NilPrinterAdapter) Print(writer io.Writer, format string, a ...interface{}) error
• type Printer
• type PrinterAdapter
  • func (adapter PrinterAdapter) Print(writer io.Writer, format string, a ...interface{}) error
• type SQLResult

Types

type ArgumentParser

type ArgumentParser interface {
	OptionString(name string, value string) *string
	PositionalArguments() []string
	ParseArguments(args []string) error
	Parse() error
}

ArgumentParser parses command line flags.

type DB

type DB interface {
	Ping() error
	Query(query string, args ...interface{}) (DBRows, error)
	Exec(query string, args ...interface{}) (sql.Result, error)
}

DB is an adapter interface for database/sql.DB.

type DBAdapter

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

func NewDBAdapter

func NewDBAdapter(db *sql.DB) DBAdapter

NewDBAdapter returns an implementation of DB.

func (DBAdapter) Exec

func (adapter DBAdapter) Exec(query string, args ...interface{}) (sql.Result, error)

Exec executes a query without returning any rows. The args are for any placeholder parameters in the query.

func (DBAdapter) Ping

func (adapter DBAdapter) Ping() error

Ping verifies a connection to the database is still alive, establishing a connection if necessary.

func (DBAdapter) Query

func (adapter DBAdapter) Query(query string, args ...interface{}) (DBRows, error)

Query executes a query that returns rows, typically a SELECT. The args are for any placeholder parameters in the query.

type DBRows

type DBRows interface {
	Next() bool
	Scan(dest ...interface{}) error
	Close() error
}

DBRows is the result of a query. Its cursor starts before the first row of the result set. Use Next to advance from row to row.

type File

type File interface {
	os.FileInfo
}

File is used to mock os.FileInfo

type FileSystem

type FileSystem interface {
	ReadDir(dirname string) ([]os.FileInfo, error)
	ReadFile(filename string) ([]byte, error)
	WriteFile(filename string, data []byte, perm fs.FileMode) error
}

FileSystem is an interface to read contents from the file system.

type FlagArgumentParser

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

FlagArgumentParser is an implementation of ArgumentParser using the package flag.

func NewArgumentParser

func NewArgumentParser() FlagArgumentParser

func (FlagArgumentParser) OptionString

func (adapter FlagArgumentParser) OptionString(name string, value string) *string

OptionString defines a string flag with specified name, default value, and usage string. The return value is the address of a string variable that stores the value of the flag.

func (FlagArgumentParser) Parse

func (adapter FlagArgumentParser) Parse() error

Deprecated: use ParseArguments instead. Parse is deprecated.

func (FlagArgumentParser) ParseArguments

func (adapter FlagArgumentParser) ParseArguments(args []string) error

ParseArguments parses the command-line flags from os.Args[1:]. Must be called after all flags are defined and before flags are accessed by the program.

func (FlagArgumentParser) PositionalArguments

func (adapter FlagArgumentParser) PositionalArguments() []string

PositionalArguments returns the non-flag command-line arguments.

type IOUtilAdapter

type IOUtilAdapter struct{}

IOUtilAdapter is an implementation of FileSystem using io/ioutil and os.

func (IOUtilAdapter) ReadDir

func (adapter IOUtilAdapter) ReadDir(dirname string) ([]os.FileInfo, error)

ReadDir list the files on a given directory.

func (IOUtilAdapter) ReadFile

func (adapter IOUtilAdapter) ReadFile(filename string) ([]byte, error)

ReadFile reads the contents of a file.

func (IOUtilAdapter) WriteFile

func (adapter IOUtilAdapter) WriteFile(filename string, data []byte, perm fs.FileMode) error

type NilPrinterAdapter

type NilPrinterAdapter struct{}

func (NilPrinterAdapter) Print

func (adapter NilPrinterAdapter) Print(writer io.Writer, format string, a ...interface{}) error

Print outputs a string given a format.

type Printer

type Printer interface {
	Print(writer io.Writer, format string, a ...interface{}) error
}

Printer formats and prints messages to the given writer.

type PrinterAdapter

type PrinterAdapter struct{}

PrinterAdapter is an implementation of Printer.

func (PrinterAdapter) Print

func (adapter PrinterAdapter) Print(writer io.Writer, format string, a ...interface{}) error

Print outputs a string given a format.

type SQLResult

type SQLResult interface {
	sql.Result
}

SQLResult is used to mock sql.Result