aboutsummaryrefslogtreecommitdiffstats
path: root/bug
diff options
context:
space:
mode:
authorMichael Muré <batolettre@gmail.com>2018-07-23 00:04:46 +0200
committerMichael Muré <batolettre@gmail.com>2018-07-23 00:04:46 +0200
commit17e2ec8f5679c1ba7ae2ea45290e9303beb3c227 (patch)
treec8862ebf6e9e9314361120127bf3fc59877c3e02 /bug
parente1f597639bfc2f796f74afa87e41581087f0b26e (diff)
downloadgit-bug-17e2ec8f5679c1ba7ae2ea45290e9303beb3c227.tar.gz
bug: refactor to limit abstraction leak and to have a more reusable code for the UIs
Diffstat (limited to 'bug')
-rw-r--r--bug/bug.go98
-rw-r--r--bug/remote_actions.go119
2 files changed, 197 insertions, 20 deletions
diff --git a/bug/bug.go b/bug/bug.go
index 4df6996c..d698a055 100644
--- a/bug/bug.go
+++ b/bug/bug.go
@@ -8,16 +8,16 @@ import (
"strings"
)
-const BugsRefPattern = "refs/bugs/"
-const BugsRemoteRefPattern = "refs/remote/%s/bugs/"
-const OpsEntryName = "ops"
-const RootEntryName = "root"
+const bugsRefPattern = "refs/bugs/"
+const bugsRemoteRefPattern = "refs/remote/%s/bugs/"
+const opsEntryName = "ops"
+const rootEntryName = "root"
-const IdLength = 40
-const HumanIdLength = 7
+const idLength = 40
+const humanIdLength = 7
// Bug hold the data of a bug thread, organized in a way close to
-// how it will be persisted inside Git. This is the datastructure
+// how it will be persisted inside Git. This is the data structure
// used for merge of two different version.
type Bug struct {
// Id used as unique identifier
@@ -40,8 +40,8 @@ func NewBug() *Bug {
}
// Find an existing Bug matching a prefix
-func FindBug(repo repository.Repo, prefix string) (*Bug, error) {
- ids, err := repo.ListRefs(BugsRefPattern)
+func FindLocalBug(repo repository.Repo, prefix string) (*Bug, error) {
+ ids, err := repo.ListRefs(bugsRefPattern)
if err != nil {
return nil, err
@@ -64,11 +64,21 @@ func FindBug(repo repository.Repo, prefix string) (*Bug, error) {
return nil, fmt.Errorf("Multiple matching bug found:\n%s", strings.Join(matching, "\n"))
}
- return ReadBug(repo, BugsRefPattern+matching[0])
+ return ReadLocalBug(repo, matching[0])
+}
+
+func ReadLocalBug(repo repository.Repo, id string) (*Bug, error) {
+ ref := bugsRefPattern + id
+ return readBug(repo, ref)
+}
+
+func ReadRemoteBug(repo repository.Repo, remote string, id string) (*Bug, error) {
+ ref := fmt.Sprintf(bugsRemoteRefPattern, remote) + id
+ return readBug(repo, ref)
}
// Read and parse a Bug from git
-func ReadBug(repo repository.Repo, ref string) (*Bug, error) {
+func readBug(repo repository.Repo, ref string) (*Bug, error) {
hashes, err := repo.ListCommits(ref)
if err != nil {
@@ -78,7 +88,7 @@ func ReadBug(repo repository.Repo, ref string) (*Bug, error) {
refSplitted := strings.Split(ref, "/")
id := refSplitted[len(refSplitted)-1]
- if len(id) != IdLength {
+ if len(id) != idLength {
return nil, fmt.Errorf("Invalid ref length")
}
@@ -102,12 +112,12 @@ func ReadBug(repo repository.Repo, ref string) (*Bug, error) {
rootFound := false
for _, entry := range entries {
- if entry.Name == OpsEntryName {
+ if entry.Name == opsEntryName {
opsEntry = entry
opsFound = true
continue
}
- if entry.Name == RootEntryName {
+ if entry.Name == rootEntryName {
rootEntry = entry
rootFound = true
}
@@ -150,6 +160,50 @@ func ReadBug(repo repository.Repo, ref string) (*Bug, error) {
return &bug, nil
}
+type StreamedBug struct {
+ Bug *Bug
+ Err error
+}
+
+// Read and parse all local bugs
+func ReadAllLocalBugs(repo repository.Repo) <-chan StreamedBug {
+ return readAllBugs(repo, bugsRefPattern)
+}
+
+// Read and parse all remote bugs for a given remote
+func ReadAllRemoteBugs(repo repository.Repo, remote string) <-chan StreamedBug {
+ refPrefix := fmt.Sprintf(bugsRemoteRefPattern, remote)
+ return readAllBugs(repo, refPrefix)
+}
+
+// Read and parse all available bug with a given ref prefix
+func readAllBugs(repo repository.Repo, refPrefix string) <-chan StreamedBug {
+ out := make(chan StreamedBug)
+
+ go func() {
+ defer close(out)
+
+ refs, err := repo.ListRefs(refPrefix)
+ if err != nil {
+ out <- StreamedBug{Err: err}
+ return
+ }
+
+ for _, ref := range refs {
+ b, err := readBug(repo, ref)
+
+ if err != nil {
+ out <- StreamedBug{Err: err}
+ return
+ }
+
+ out <- StreamedBug{Bug: b}
+ }
+ }()
+
+ return out
+}
+
// IsValid check if the Bug data is valid
func (bug *Bug) IsValid() bool {
// non-empty
@@ -216,9 +270,9 @@ func (bug *Bug) Commit(repo repository.Repo) error {
// Write a Git tree referencing this blob
hash, err = repo.StoreTree([]repository.TreeEntry{
// the last pack of ops
- {ObjectType: repository.Blob, Hash: hash, Name: OpsEntryName},
+ {ObjectType: repository.Blob, Hash: hash, Name: opsEntryName},
// always the first pack of ops (might be the same)
- {ObjectType: repository.Blob, Hash: bug.rootPack, Name: RootEntryName},
+ {ObjectType: repository.Blob, Hash: bug.rootPack, Name: rootEntryName},
})
if err != nil {
@@ -244,7 +298,7 @@ func (bug *Bug) Commit(repo repository.Repo) error {
}
// Create or update the Git reference for this bug
- ref := fmt.Sprintf("%s%s", BugsRefPattern, bug.id)
+ ref := fmt.Sprintf("%s%s", bugsRefPattern, bug.id)
err = repo.UpdateRef(ref, hash)
if err != nil {
@@ -326,7 +380,7 @@ func (bug *Bug) Merge(repo repository.Repo, other *Bug) (bool, error) {
// Update the git ref
if updated {
- err := repo.UpdateRef(BugsRefPattern+bug.id, bug.lastCommit)
+ err := repo.UpdateRef(bugsRefPattern+bug.id, bug.lastCommit)
if err != nil {
return false, err
}
@@ -347,8 +401,12 @@ func (bug *Bug) Id() string {
// Return the Bug identifier truncated for human consumption
func (bug *Bug) HumanId() string {
- format := fmt.Sprintf("%%.%ds", HumanIdLength)
- return fmt.Sprintf(format, bug.Id())
+ return formatHumanId(bug.Id())
+}
+
+func formatHumanId(id string) string {
+ format := fmt.Sprintf("%%.%ds", humanIdLength)
+ return fmt.Sprintf(format, id)
}
// Lookup for the very first operation of the bug.
diff --git a/bug/remote_actions.go b/bug/remote_actions.go
new file mode 100644
index 00000000..2070ba21
--- /dev/null
+++ b/bug/remote_actions.go
@@ -0,0 +1,119 @@
+package bug
+
+import (
+ "fmt"
+ "github.com/MichaelMure/git-bug/repository"
+ "strings"
+)
+
+const MsgNew = "new"
+const MsgInvalid = "invalid data"
+const MsgUpdated = "updated"
+const MsgNothing = "nothing to do"
+
+func Fetch(repo repository.Repo, remote string) error {
+ remoteRefSpec := fmt.Sprintf(bugsRemoteRefPattern, remote)
+ fetchRefSpec := fmt.Sprintf("%s*:%s*", bugsRefPattern, remoteRefSpec)
+
+ return repo.FetchRefs(remote, fetchRefSpec)
+}
+
+func Push(repo repository.Repo, remote string) error {
+ return repo.PushRefs(remote, bugsRefPattern+"*")
+}
+
+type MergeResult struct {
+ Err error
+
+ Id string
+ HumanId string
+ Status string
+}
+
+func newMergeError(id string, err error) MergeResult {
+ return MergeResult{
+ Id: id,
+ HumanId: formatHumanId(id),
+ Status: err.Error(),
+ }
+}
+
+func newMergeStatus(id string, status string) MergeResult {
+ return MergeResult{
+ Id: id,
+ HumanId: formatHumanId(id),
+ Status: status,
+ }
+}
+
+func MergeAll(repo repository.Repo, remote string) <-chan MergeResult {
+ out := make(chan MergeResult)
+
+ go func() {
+ defer close(out)
+
+ remoteRefSpec := fmt.Sprintf(bugsRemoteRefPattern, remote)
+ remoteRefs, err := repo.ListRefs(remoteRefSpec)
+
+ if err != nil {
+ out <- MergeResult{Err: err}
+ return
+ }
+
+ for _, remoteRef := range remoteRefs {
+ refSplitted := strings.Split(remoteRef, "/")
+ id := refSplitted[len(refSplitted)-1]
+
+ remoteBug, err := readBug(repo, remoteRef)
+
+ if err != nil {
+ out <- newMergeError(id, err)
+ continue
+ }
+
+ // Check for error in remote data
+ if !remoteBug.IsValid() {
+ out <- newMergeStatus(id, MsgInvalid)
+ continue
+ }
+
+ localRef := bugsRefPattern + remoteBug.Id()
+ localExist, err := repo.RefExist(localRef)
+
+ // the bug is not local yet, simply create the reference
+ if !localExist {
+ err := repo.CopyRef(remoteRef, localRef)
+
+ if err != nil {
+ out <- newMergeError(id, err)
+ return
+ }
+
+ out <- newMergeStatus(id, MsgNew)
+ continue
+ }
+
+ localBug, err := readBug(repo, localRef)
+
+ if err != nil {
+ out <- newMergeError(id, err)
+ return
+ }
+
+ updated, err := localBug.Merge(repo, remoteBug)
+
+ if err != nil {
+ out <- newMergeError(id, err)
+ return
+ }
+
+ if updated {
+ out <- newMergeStatus(id, MsgUpdated)
+ } else {
+ out <- newMergeStatus(id, MsgNothing)
+ }
+ }
+ }()
+
+ return out
+}