authorship

Documentation

Index

• type AuthorStats
• type AuthorshipInfo
• type ClientStats
• type RefAuthorship
• type RepoAuthor
• type RepoClient
• type RepoContribution
• type RepoUsageByClient
• type RepoUsageOfAuthor
• type SymbolAuthor
• type SymbolAuthorship
• type SymbolClient

Types

type AuthorStats

type AuthorStats struct {
	AuthorshipInfo

	// SymbolCount is the number of symbols that this author contributed (where
	// "contributed" means "committed any hunk of code to source code files").
	SymbolCount int `db:"symbol_count"`

	SymbolsProportion float64 `db:"symbols_proportion"`

	// ExportedSymbolCount is the number of exported symbols that this author
	// contributed (where "contributed to" means "committed any hunk of code to
	// source code files").
	ExportedSymbolCount int `db:"exported_symbol_count"`

	ExportedSymbolsProportion float64 `db:"exported_symbols_proportion"`
}

type AuthorshipInfo

type AuthorshipInfo struct {
	AuthorEmail    string    `db:"author_email"`
	LastCommitDate time.Time `db:"last_commit_date"`

	// LastCommitID is the commit ID of the last commit that this author made to
	// the thing that this info describes.
	LastCommitID string `db:"last_commit_id"`
}

type ClientStats

type ClientStats struct {
	AuthorshipInfo

	// SymbolRepo is the repository that defines symbols that this client
	// referred to.
	SymbolRepo repo.URI `db:"symbol_repo"`

	// SymbolUnitType and SymbolUnit are the unit in SymbolRepo that defines
	// symbols that this client referred to. If SymbolUnitType == "" and
	// SymbolUnit == "", then this ClientStats is an aggregate of this client's
	// refs to all units in SymbolRepo.
	SymbolUnitType nnz.String `db:"symbol_unit_type"`
	SymbolUnit     nnz.String `db:"symbol_unit"`

	// RefCount is the number of references this client made in this repository
	// to SymbolRepo.
	RefCount int `db:"ref_count"`
}

type RefAuthorship

type RefAuthorship struct {
	graph.RefKey
	AuthorshipInfo
}

RefAuthorship describes the authorship information (author email, date, and commit ID) of a ref. A ref may only have one author.

type RepoAuthor

type RepoAuthor struct {
	UID   nnz.Int
	Email nnz.String
	AuthorStats
}

type RepoClient

type RepoClient struct {
	UID   nnz.Int
	Email nnz.String
	ClientStats
}

type RepoContribution

type RepoContribution struct {
	RepoURI repo.URI `db:"repo"`
	AuthorStats
}

type RepoUsageByClient

type RepoUsageByClient struct {
	// SymbolRepo is the repository that defines the code that was referenced.
	// It's called SymbolRepo because "Repo" usually refers to the repository
	// whose analysis created this linkage (i.e., the repository that contains
	// the reference).
	SymbolRepo repo.URI `db:"symbol_repo"`

	RefCount int `db:"ref_count"`

	AuthorshipInfo
}

RepoUsageByClient describes a repository whose code is referenced by a specific person.

type RepoUsageOfAuthor

type RepoUsageOfAuthor struct {
	Repo repo.URI

	RefCount int `db:"ref_count"`
}

RepoUsageOfAuthor describes a repository referencing code committed by a specific person.

type SymbolAuthor

type SymbolAuthor struct {
	UID   nnz.Int
	Email nnz.String
	SymbolAuthorship
}

type SymbolAuthorship

type SymbolAuthorship struct {
	AuthorshipInfo

	// Exported is whether the symbol is exported.
	Exported bool

	Chars           int     `db:"chars"`
	CharsProportion float64 `db:"chars_proportion"`
}

type SymbolClient

type SymbolClient struct {
	UID   nnz.Int
	Email nnz.String

	AuthorshipInfo

	// UseCount is the number of times this person referred to the symbol.
	UseCount int `db:"use_count"`
}