entity/entity.go


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

package entity

import (
	bootstrap "github.com/MichaelMure/git-bug/entity/boostrap"
	"github.com/MichaelMure/git-bug/repository"
	"github.com/MichaelMure/git-bug/util/lamport"
)

type Bare bootstrap.Entity

// Interface define the extended interface of an Entity
type Interface[SnapT Snapshot, OpT Operation] interface {
	Bare
	CompileToSnapshot[SnapT]

	// Validate checks if the Entity data is valid
	Validate() error

	// Append an operation into the staging area, to be committed later
	Append(op OpT)

	// Operations returns the ordered operations
	Operations() []OpT

	// FirstOp lookup for the very first operation of the Entity.
	FirstOp() OpT

	// // LastOp lookup for the very last operation of the Entity.
	// // For a valid Entity, should never be nil
	// LastOp() OpT

	// CreateLamportTime return the Lamport time of creation
	CreateLamportTime() lamport.Time

	// EditLamportTime return the Lamport time of the last edit
	EditLamportTime() lamport.Time
}

type WithCommit[SnapT Snapshot, OpT Operation] interface {
	Interface[SnapT, OpT]
	Committer
}

type Committer interface {
	// NeedCommit indicates that the in-memory state changed and need to be committed in the repository
	NeedCommit() bool

	// Commit writes the staging area in Git and move the operations to the packs
	Commit(repo repository.ClockedRepo) error

	// CommitAsNeeded execute a Commit only if necessary. This function is useful to avoid getting an error if the Entity
	// is already in sync with the repository.
	CommitAsNeeded(repo repository.ClockedRepo) error
}