git-bug/repository/repo.go

130 lines
3.6 KiB
Go
Raw Normal View History

2018-07-12 10:55:13 +03:00
// Package repository contains helper methods for working with a Git repo.
package repository
import (
"bytes"
"strings"
2018-08-13 19:32:11 +03:00
"github.com/MichaelMure/git-bug/util/git"
"github.com/MichaelMure/git-bug/util/lamport"
)
2018-07-12 16:14:37 +03:00
type RepoCommon interface {
2018-07-12 10:55:13 +03:00
// GetPath returns the path to the repo.
GetPath() string
// GetUserName returns the name the the user has used to configure git
GetUserName() (string, error)
2018-07-12 10:55:13 +03:00
// GetUserEmail returns the email address that the user has used to configure git.
GetUserEmail() (string, error)
// GetCoreEditor returns the name of the editor that the user has used to configure git.
GetCoreEditor() (string, error)
}
// Repo represents a source code repository.
type Repo interface {
RepoCommon
2018-07-12 10:55:13 +03:00
2018-07-17 02:52:56 +03:00
// FetchRefs fetch git refs from a remote
2018-08-12 22:09:30 +03:00
FetchRefs(remote string, refSpec string) (string, error)
2018-07-12 10:55:13 +03:00
// PushRefs push git refs to a remote
2018-08-12 22:09:30 +03:00
PushRefs(remote string, refSpec string) (string, error)
2018-07-12 16:14:37 +03:00
// StoreData will store arbitrary data and return the corresponding hash
StoreData(data []byte) (git.Hash, error)
// ReadData will attempt to read arbitrary data from the given hash
ReadData(hash git.Hash) ([]byte, error)
// StoreTree will store a mapping key-->Hash as a Git tree
StoreTree(mapping []TreeEntry) (git.Hash, error)
// StoreCommit will store a Git commit with the given Git tree
StoreCommit(treeHash git.Hash) (git.Hash, error)
// StoreCommit will store a Git commit with the given Git tree
StoreCommitWithParent(treeHash git.Hash, parent git.Hash) (git.Hash, error)
// UpdateRef will create or update a Git reference
UpdateRef(ref string, hash git.Hash) error
// ListRefs will return a list of Git ref matching the given refspec
ListRefs(refspec string) ([]string, error)
2018-07-17 02:52:56 +03:00
// RefExist will check if a reference exist in Git
RefExist(ref string) (bool, error)
// CopyRef will create a new reference with the same value as another one
CopyRef(source string, dest string) error
// ListCommits will return the list of tree hashes of a ref, in chronological order
ListCommits(ref string) ([]git.Hash, error)
// ListEntries will return the list of entries in a Git tree
ListEntries(hash git.Hash) ([]TreeEntry, error)
2018-07-17 02:52:56 +03:00
// FindCommonAncestor will return the last common ancestor of two chain of commit
FindCommonAncestor(hash1 git.Hash, hash2 git.Hash) (git.Hash, error)
2018-07-17 02:52:56 +03:00
2018-08-13 16:28:16 +03:00
// GetTreeHash return the git tree hash referenced in a commit
GetTreeHash(commit git.Hash) (git.Hash, error)
}
type ClockedRepo interface {
Repo
2018-09-24 13:46:39 +03:00
// LoadClocks read the clocks values from the on-disk repo
LoadClocks() error
2018-09-24 13:46:39 +03:00
// WriteClocks write the clocks values into the repo
WriteClocks() error
2018-09-24 13:46:39 +03:00
// CreateTimeIncrement increment the creation clock and return the new value.
CreateTimeIncrement() (lamport.Time, error)
2018-09-24 13:46:39 +03:00
// EditTimeIncrement increment the edit clock and return the new value.
EditTimeIncrement() (lamport.Time, error)
2018-09-24 13:46:39 +03:00
// CreateWitness witness another create time and increment the corresponding
// clock if needed.
CreateWitness(time lamport.Time) error
2018-09-24 13:46:39 +03:00
// EditWitness witness another edition time and increment the corresponding
// clock if needed.
EditWitness(time lamport.Time) error
}
func prepareTreeEntries(entries []TreeEntry) bytes.Buffer {
var buffer bytes.Buffer
for _, entry := range entries {
buffer.WriteString(entry.Format())
}
return buffer
}
func readTreeEntries(s string) ([]TreeEntry, error) {
2018-09-09 21:17:12 +03:00
split := strings.Split(s, "\n")
2018-09-09 21:17:12 +03:00
casted := make([]TreeEntry, len(split))
for i, line := range split {
if line == "" {
continue
}
entry, err := ParseTreeEntry(line)
if err != nil {
return nil, err
}
casted[i] = entry
}
return casted, nil
2018-07-12 10:55:13 +03:00
}