index

Documentation

Index

• type Dependency
• type EmptyLibraryError
  • func (e EmptyLibraryError) Error() string
• type GroupedIndex
  • func (g GroupedIndex) Selected() *Index
  • func (g GroupedIndex) SortByRating() GroupedIndex
• type Index
  • func LoadIndex(verbose bool) (*Index, error)
  • func NewIndex() *Index
  • func (ind *Index) BuildGraph(verbose bool) (graph.Resolver, error)
  • func (i Index) Find(name string, version semver.Version) (VersionDetails, error)
  • func (i *Index) GetLibrary(name string, uri string, owner_uri string) recorder.LibraryRecorder
  • func (i Index) Group(disamb map[string]string) GroupedIndex
  • func (i Index) JSON() (string, error)
  • func (i1 *Index) Merge(i2 Index) error
  • func (index *Index) ParseIndex(index_url string) error
  • func (i Index) Reduce(disamb map[string]string) *Index
• type LibList
  • func (l LibList) Len() int
  • func (l LibList) Less(i int, j int) bool
  • func (l LibList) Swap(i int, j int)
• type Library
  • func NewLibrary(name string, uri string, owner_uri string) *Library
  • func (lib *Library) AddVersion(v semver.Version) recorder.VersionRecorder
  • func (lib Library) Matches(term string) bool
  • func (lib *Library) SetDescription(desc string)
  • func (lib *Library) SetEmail(email string)
  • func (lib *Library) SetHomepage(url string)
  • func (lib *Library) SetRepository(url string, format string)
  • func (lib *Library) SetStars(stars int)
• type MissingLibraryError
  • func (e MissingLibraryError) Error() string
• type MissingVersionError
  • func (e MissingVersionError) Error() string
• type VersionConflictError
  • func (e VersionConflictError) Error() string
• type VersionDetails
  • func NewVersionDetails(v semver.Version) *VersionDetails
  • func (v *VersionDetails) AddDependency(library string, version semver.Version)
  • func (v *VersionDetails) SetHash(hash string)
  • func (v *VersionDetails) SetPath(path string, file bool)
  • func (v *VersionDetails) SetTarballURL(url string)
  • func (v *VersionDetails) SetZipballURL(url string)

Types

type Dependency

type Dependency struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

type EmptyLibraryError

type EmptyLibraryError struct {
	Name string
}

func (EmptyLibraryError) Error

func (e EmptyLibraryError) Error() string

type GroupedIndex

type GroupedIndex struct {
	Libraries map[string]LibList
}

func (GroupedIndex) Selected

func (g GroupedIndex) Selected() *Index

Return and index that has no "extra" libraries in it, only the ones that can possibly be chosen.

func (GroupedIndex) SortByRating

func (g GroupedIndex) SortByRating() GroupedIndex

This sorts **all but the first** match by rating. This is because the first match is the one that is first in the install path so it should always be listed first. Among those not in the search path, this rearranges them by rating.

type Index

type Index struct {
	Version   string     `json:"version"`
	Libraries []*Library `json:"libraries"`
}

func LoadIndex

func LoadIndex(verbose bool) (*Index, error)

func NewIndex

func NewIndex() *Index

func (*Index) BuildGraph

func (ind *Index) BuildGraph(verbose bool) (graph.Resolver, error)

func (Index) Find

func (i Index) Find(name string, version semver.Version) (VersionDetails, error)

func (*Index) GetLibrary

func (i *Index) GetLibrary(name string, uri string, owner_uri string) recorder.LibraryRecorder

func (Index) Group

func (i Index) Group(disamb map[string]string) GroupedIndex

func (Index) JSON

func (i Index) JSON() (string, error)

func (*Index) Merge

func (i1 *Index) Merge(i2 Index) error

This function merges two indices. The libraries from i2 will be appended to the list from i1.

func (*Index) ParseIndex

func (index *Index) ParseIndex(index_url string) error

The ParseIndex function reads index information from a given URL and then merges it into the associated index.

TODO: This will eventually need to be able to handle different index versions (by parsing the Version field in the index first and then determining how, or if, to parse it).

func (Index) Reduce

func (i Index) Reduce(disamb map[string]string) *Index

type LibList

type LibList []*Library

func (LibList) Len

func (l LibList) Len() int

func (LibList) Less

func (l LibList) Less(i int, j int) bool

func (LibList) Swap

func (l LibList) Swap(i int, j int)

type Library

type Library struct {
	// Library name
	Name string `json:"name"`
	// Canonical URI for this library (used for disambiguation)
	URI string `json:"uri"`

	// Versions of this library that are available
	Versions map[string]*VersionDetails `json:"versions"`

	// Owner of library
	OwnerURI string `json:"owner_uri"`
	// Email for library contact
	Email string `json:"email"`
	// Web site
	Homepage string `json:"homepage"`
	// Repository
	Repository string `json:"repository_uri"`
	// Repository format
	Format string `json:"repository_format"`
	// Textual description
	Description string `json:"description"`
	// Stars (if applicable, otherwise -1)
	Stars int `json:"stars"`
}

func NewLibrary

func NewLibrary(name string, uri string, owner_uri string) *Library

func (*Library) AddVersion

func (lib *Library) AddVersion(v semver.Version) recorder.VersionRecorder

func (Library) Matches

func (lib Library) Matches(term string) bool

func (*Library) SetDescription

func (lib *Library) SetDescription(desc string)

func (*Library) SetEmail

func (lib *Library) SetEmail(email string)

func (*Library) SetHomepage

func (lib *Library) SetHomepage(url string)

func (*Library) SetRepository

func (lib *Library) SetRepository(url string, format string)

func (*Library) SetStars

func (lib *Library) SetStars(stars int)

type MissingLibraryError

type MissingLibraryError struct {
	Name string
}

func (MissingLibraryError) Error

func (e MissingLibraryError) Error() string

type MissingVersionError

type MissingVersionError struct {
	Name    string
	Version string
}

func (MissingVersionError) Error

func (e MissingVersionError) Error() string

type VersionConflictError

type VersionConflictError struct {
	Name       string
	Existing   VersionDetails
	Additional VersionDetails
}

func (VersionConflictError) Error

func (e VersionConflictError) Error() string

type VersionDetails

type VersionDetails struct {
	Version semver.Version `json:"version"`
	Tarball string         `json:"tarball_url"`
	Zipball string         `json:"zipball_url"`

	// This indicates where (within an archive) the library can be found:
	Path string `json:"path"`
	// This indicates whether the specified path is to a file or directory:
	IsFile bool `json:"isfile"`

	Dependencies []Dependency `json:"dependencies"`
	Sha          string       `json:"sha"`
}

func NewVersionDetails

func NewVersionDetails(v semver.Version) *VersionDetails

func (*VersionDetails) AddDependency

func (v *VersionDetails) AddDependency(library string, version semver.Version)

func (*VersionDetails) SetHash

func (v *VersionDetails) SetHash(hash string)

func (*VersionDetails) SetPath

func (v *VersionDetails) SetPath(path string, file bool)

func (*VersionDetails) SetTarballURL

func (v *VersionDetails) SetTarballURL(url string)

func (*VersionDetails) SetZipballURL

func (v *VersionDetails) SetZipballURL(url string)