orgstats

Documentation

Index

• Variables
• type Extract
• type Stat
• type StatPair
  • func Sort(s Stats, extract Extract) []StatPair
• type Stats
  • func Gather(token, org string, blacklist []string) (Stats, error)
  • func NewStats() Stats

Variables

var ExtractAdditions = func(st Stat) int {
	return st.Additions
}

ExtractAdditions extract the adds section of the given stat

var ExtractCommits = func(st Stat) int {
	return st.Commits
}

ExtractCommits extract the commit section of the given stat

var ExtractDeletions = func(st Stat) int {
	return st.Deletions
}

ExtractDeletions extract the rms section of the given stat

Types

type Extract

type Extract func(st Stat) int

Extract is a function that converts a multiple stat into a single stat

type Stat

type Stat struct {
	Additions, Deletions, Commits int
}

Stat represents an user adds, rms and commits count

type StatPair

type StatPair struct {
	Key   string
	Value int
}

func Sort

func Sort(s Stats, extract Extract) []StatPair

type Stats

type Stats map[string]Stat

Stats contains the user->Stat mapping

func Gather

func Gather(token, org string, blacklist []string) (Stats, error)

Gather a given organization's stats

func NewStats

func NewStats() Stats

NewStats return a new Stats map