groups

Documentation

Overview

Package groups deals with group names and their initialisms.

Index

• Variables
• func Contains(x string, sorted []string) bool
• func Count(name string) (int, error)
• func Cronjob(force bool) error
• func Exact(name string) (int, error)
• func Fix() error
• func Format(name string) string
• func Initialism(name string) (string, error)
• func List() ([]string, int, error)
• func MatchStdOut() error
• func Slug(s string) string
• func SwapAll(group, str, swap string) string
• func SwapNumeral(group string, i int) string
• func SwapOne(group, str, swap string) string
• func SwapOrdinal(group string, i int) string
• func SwapPrefix(group, prefix, swap string) string
• func SwapSuffix(group, suffix, swap string) string
• func TrimSP(name string) (string, string, string)
• func Update(newName, group string) (count int64, err error)
• func Variations(name string) ([]string, error)
• func Wheres() []string
• type Request
  • func (r Request) DataList(name string) error
  • func (r Request) HTML(name string) error
  • func (r Request) Print() (total int, err error)

Variables

var (
	ErrCJDir  = errors.New("cronjob directory does not exist")
	ErrCJFile = errors.New("cronjob file to save html does not exist")
	ErrCfg    = errors.New("the directory.html setting is empty")
)

Functions

func Contains

func Contains(x string, sorted []string) bool

Contains returns true whenever sorted contains x. The slice value must be stored in increasing order.

func Count

func Count(name string) (int, error)

Count returns the number of file entries associated with a named group.

func Cronjob

func Cronjob(force bool) error

Cronjob is used for system automation to generate dynamic HTML pages.

func Exact

func Exact(name string) (int, error)

Exact returns the number of file entries that match an exact named group. The casing is ignored, but comma separated multi-groups are not matched to their parents. The name "tristar" will match "Tristar" but will not match records using "Tristar, Red Sector Inc".

func Fix

func Fix() error

Fix any malformed group names found in the database.

func Format

func Format(name string) string

Format returns a copy of name with custom formatting.

func Initialism

func Initialism(name string) (string, error)

Initialism returns a named group initialism or acronym.

func List

func List() ([]string, int, error)

List returns all the distinct groups.

func MatchStdOut

func MatchStdOut() error

MatchStdOut scans over the groups and attempts to match possible misnamed duplicates. The results are printed to stdout in realtime.

func Slug

func Slug(s string) string

Slug takes a string and makes it into a URL friendly slug.

func SwapAll

func SwapAll(group, str, swap string) string

SwapAll finds all occurrences of str within a group name and replaces it with swap.

func SwapNumeral

func SwapNumeral(group string, i int) string

SwapNumeral finds any occurrences of i within a group name and swaps it for a cardinal number.

func SwapOne

func SwapOne(group, str, swap string) string

SwapOne finds the first occurrence of str within a group name and replaces it with swap.

func SwapOrdinal

func SwapOrdinal(group string, i int) string

SwapOrdinal finds any occurrences of i within a group name and swaps it for a ordinal number.

func SwapPrefix

func SwapPrefix(group, prefix, swap string) string

SwapPrefix replaces the prefix value at the start of a group name and replaces it with swap. An empty string is returned if the prefix does not exist in the name.

func SwapSuffix

func SwapSuffix(group, suffix, swap string) string

SwapSuffix replaces the suffix value at the end of a group name and replaces it with swap. An empty string is returned if the suffix does not exist in the name.

func TrimSP

func TrimSP(name string) (string, string, string)

TrimSP removes all spaces from a named group, BBS or FTP site. The first string returns the spaceless name. The second string returns a spaceless name appended with the plural "s". The third string is spaceless name appended with the plural "z".

func Update

func Update(newName, group string) (count int64, err error)

Update replaces all instances of the group name with the new group name.

func Variations

func Variations(name string) ([]string, error)

Variations creates format variations for a named group.

func Wheres

func Wheres() []string

Wheres are group categories.

Types

type Request

type Request request.Flags

Request flags for group functions.

func (Request) DataList

func (r Request) DataList(name string) error

DataList prints an auto-complete list for HTML input elements.

func (Request) HTML

func (r Request) HTML(name string) error

HTML prints a snippet listing links to each group, with an optional file count.

func (Request) Print

func (r Request) Print() (total int, err error)

Print a list of organisations or groups filtered by a name and summarizes the results.