cmd

Documentation

Overview

Package cmd contains all CLI commands used by the application.

Index

• Constants
• func Execute()
• func ImportListings(f io.Reader, d datastore.Writer) (string, error)
• func InitConfig(fs afero.Fs, cfg string)
• func MailHash(m Mail, l int) string
• func NewImportListingCmd() *cobra.Command
• func NewImportMailCmd() *cobra.Command
• func NewMailCmd() *cobra.Command
• func NewSearchCmd() *cobra.Command
• func RenderMail(mm []Mail, p bool) string
• func RunImportListingsCmd(cmd *cobra.Command, args []string)
• func RunImportMailCmd(cmd *cobra.Command, args []string)
• func RunMailCmd(cmd *cobra.Command, args []string)
• func RunSearchCmd(cmd *cobra.Command, args []string)
• func UniqueListings(rawListings []lstg.Listing) []lstg.Listing
• func ValidateDate(dd string) (string, error)
• type Mail
  • func SearchMail(member int, ds storm.Finder) ([]Mail, error)
  • func UniqueMails(rawMails []Mail) []Mail
• type Mails

Constants

const (
	// MaxHashLength is the maximum hash length for md5 checksum.
	MaxHashLength = 32

	// MinHashLength is the minimum hash length for md5 checksum.
	MinHashLength = 0

	// RefLength is the default reference length.
	RefLength = 6
)

const (
	DefaultMaxSearchResults  = 10
	DefaultMemberNumber      = 13401
	DefaultConfigFilename    = ".ogma"
	DefaultLoggingLevel      = "info"
	DefaultDatastoreFilename = "ogma.db"
)

default const values for application.

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func ImportListings

func ImportListings(f io.Reader, d datastore.Writer) (string, error)

ImportListings adds one to many listings to the datastore from a file.

func InitConfig

func InitConfig(fs afero.Fs, cfg string)

InitConfig sets up Viper and Logging.

func MailHash

func MailHash(m Mail, l int) string

MailHash creates a 'unique' hash of the sender, receiver, and mail date.

func NewImportListingCmd

func NewImportListingCmd() *cobra.Command

NewImportListingCmd sets up an import subcommand.

func NewImportMailCmd

func NewImportMailCmd() *cobra.Command

NewImportMailCmd sets up an import subcommand.

func NewMailCmd

func NewMailCmd() *cobra.Command

NewMailCmd creates a mail command.

func NewSearchCmd

func NewSearchCmd() *cobra.Command

NewSearchCmd creates a mail command.

func RenderMail

func RenderMail(mm []Mail, p bool) string

RenderMail returns a pretty formatted listing as table.

func RunImportListingsCmd

func RunImportListingsCmd(cmd *cobra.Command, args []string)

RunImportListingsCmd performs action associated with listings-import application command.

func RunImportMailCmd

func RunImportMailCmd(cmd *cobra.Command, args []string)

RunImportMailCmd performs action associated with mail-import application command.

func RunMailCmd

func RunMailCmd(cmd *cobra.Command, args []string)

RunMailCmd implements functionality of a mail command.

func RunSearchCmd

func RunSearchCmd(cmd *cobra.Command, args []string)

RunSearchCmd performs action associated with listings application command.

func UniqueListings

func UniqueListings(rawListings []lstg.Listing) []lstg.Listing

UniqueListings returns the passed in slice of listings with at most one of each listing. Listing order is preserved by first occurrence in initial slice.

func ValidateDate

func ValidateDate(dd string) (string, error)

ValidateDate checks date string format and parses with local time location.

Types

type Mail

type Mail struct {
	ID       int    `storm:"id,increment"`
	Ref      string `json:"reference"`
	Sender   int    `json:"sender"`
	Receiver int    `json:"receiver"`
	Date     string `json:"date"`
	Link     string `json:"link"`
}

Mail contains relevant information for correspondence.

func SearchMail

func SearchMail(member int, ds storm.Finder) ([]Mail, error)

SearchMail returns all mail records with a matching member number.

func UniqueMails

func UniqueMails(rawMails []Mail) []Mail

UniqueMails returns the passed in slice of mail with at most one of each mail. Mail order is preserved by first occurrence in initial slice.

type Mails

type Mails struct {
	Mails []Mail `json:"mails"`
}

Mails is a container for multiple mail objects.