orgstats

Documentation

Index

• Variables
• type Extract
• type Stat
• type StatPair
  • func Sort(s Stats, extract Extract) []StatPair
• type Stats
  • func Gather(ctx context.Context, client *github.Client, org string, ...) (Stats, error)
  • func NewStats(since time.Time) Stats
  • func (s Stats) For(login string) Stat
  • func (s Stats) Logins() []string

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

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

Reviews extract the reviewed prs 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, Reviews 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 struct {
	// contains filtered or unexported fields
}

Stats contains the user->Stat mapping

func Gather

func Gather(
	ctx context.Context,
	client *github.Client,
	org string,
	userBlacklist, repoBlacklist []string,
	since time.Time,
	includeReviewStats bool,
	excludeForks bool,
) (Stats, error)

Gather a given organization's stats

func NewStats

func NewStats(since time.Time) Stats

NewStats return a new Stats map

func (Stats) For

func (s Stats) For(login string) Stat

func (Stats) Logins

func (s Stats) Logins() []string