test

Documentation

Index

• Variables
• type AssignGrouping
• type CollateGroups
• type GroupCollation
• type GroupOptions
  • func (i GroupOptions) String() string
• type GroupSettings
• type GroupedObjects
• type Locals
• type MatchGroups
• type Messages
• type Neatness
  • func (i Neatness) String() string
• type Things

Variables

var (
	B = literal.B
	T = literal.T
)

Types

type AssignGrouping

type AssignGrouping struct {
	In  string
	Out GroupSettings
}

type CollateGroups

type CollateGroups struct {
	// args
	Settings  GroupSettings  // constant input
	Collation GroupCollation // accumulator; FIX: this should be []GroupedObjects -- no need for the wrapping structure.

	// locals
	Found bool
	Group GroupedObjects
}

pattern:

type GroupCollation

type GroupCollation struct {
	Groups []GroupedObjects
}

the pattern collate groups builds a group collation from a list of group settings

type GroupOptions

type GroupOptions int

GroupOptions defines how objects in groups should display.

const (
	// indicates we dont want the individual objects in the group
	// ex. the scrabble tiles, the usual utensils, several things.
	WithoutObjects GroupOptions = iota
	// indicates individual objects should have articles.
	// ex. the X and the W tiles from a Scrabble set.
	ObjectsWithArticles
	// indicates the individual objects shouldnt use articles
	// ex. tiles X and W from a Scrabble set.
	ObjectsWithoutArticles
)

func (GroupOptions) String

func (i GroupOptions) String() string

type GroupSettings

type GroupSettings struct {
	// the name of the object this record describes
	// ex. tile X, or tile W ( from a scrabble set )
	Name string
	// objects with the same label are considered to be in the same group.
	// ex. "scrabble tiles"
	Label string
	// whether and how to print objects.
	GroupOptions
}

the pattern assign grouping builds a list of group settings from a list of objects

type GroupedObjects

type GroupedObjects struct {
	Settings GroupSettings // the settings of the first object in the group
	Objects  []string      // the list of objects with the same settings
}

type Locals

type Locals struct {
	Objects   []string
	Settings  []GroupSettings
	Collation GroupCollation
}

local variables for grouping tests

type MatchGroups

type MatchGroups struct {
	A       GroupSettings
	B       GroupSettings
	Matches bool
}

type Messages

type Messages struct {
	Neatness Neatness
}

a noun with an aspect

type Neatness

type Neatness int

make a fake aspect for testing

const (
	Neat Neatness = iota
	Scuffed
	Trampled
	NumNeatness = iota
)

func (Neatness) String

func (i Neatness) String() string

type Things

type Things struct {
}

a simple noun