summaryrefslogtreecommitdiff
path: root/internal/cli
diff options
context:
space:
mode:
Diffstat (limited to 'internal/cli')
-rw-r--r--internal/cli/cli.go12
-rw-r--r--internal/cli/cli_backend.go10
-rw-r--r--internal/cli/git.go48
3 files changed, 59 insertions, 11 deletions
diff --git a/internal/cli/cli.go b/internal/cli/cli.go
index 94c9f57..01342be 100644
--- a/internal/cli/cli.go
+++ b/internal/cli/cli.go
@@ -22,7 +22,6 @@ import (
"codeberg.org/snonux/foostore/internal/backend"
"codeberg.org/snonux/foostore/internal/clipboard"
"codeberg.org/snonux/foostore/internal/config"
- "codeberg.org/snonux/foostore/internal/git"
"codeberg.org/snonux/foostore/internal/shell"
"codeberg.org/snonux/foostore/internal/store"
)
@@ -59,10 +58,11 @@ var SearchActions = map[string]store.Action{
// backend is *store.Store, which satisfies Backend via the compile-time check
// in internal/backend/backend.go.
//
-// g is declared as git.Gitter (interface) rather than *git.Git so that the
-// keepass backend can supply a git.NoOp when the kdbx file lives outside a git
-// repository. Dispatch code requires no nil checks; it always calls through the
-// interface regardless of whether real git operations or no-ops are performed.
+// g is declared as Gitter (defined in git.go in this package) rather than
+// *git.Git so that the keepass backend can supply a *git.NoOp when the kdbx
+// file lives outside a git repository. Dispatch code requires no nil checks;
+// it always calls through the interface regardless of whether real git
+// operations or no-ops are performed.
//
// effectiveBackend is the resolved backend name (after applying the --backend
// flag override on top of cfg.Backend). Guards such as cmdMigrateKDBX use
@@ -70,7 +70,7 @@ var SearchActions = map[string]store.Action{
type CLI struct {
cfg *config.Config
st backend.Backend
- g git.Gitter // real *git.Git or *git.NoOp when kdbx is outside a repo
+ g Gitter // real *git.Git or *git.NoOp when kdbx is outside a repo
clip *clipboard.Clipboard
sh *shell.Shell
openKDBX func(string, string) (KDBXStore, error)
diff --git a/internal/cli/cli_backend.go b/internal/cli/cli_backend.go
index 96058ae..698c9f3 100644
--- a/internal/cli/cli_backend.go
+++ b/internal/cli/cli_backend.go
@@ -38,7 +38,7 @@ func resolveBackend(flagValue, cfgValue string) string {
// buildBackend constructs the Backend and its associated Gitter based on
// effectiveBackend ("geheim" or "keepass"). Returns the Backend and git client
// so the caller can wire them into the CLI struct.
-func buildBackend(ctx context.Context, cfg *config.Config, effectiveBackend string) (backend.Backend, git.Gitter, error) {
+func buildBackend(ctx context.Context, cfg *config.Config, effectiveBackend string) (backend.Backend, Gitter, error) {
switch effectiveBackend {
case "keepass":
return buildKeepassBackend(ctx, cfg)
@@ -50,7 +50,7 @@ func buildBackend(ctx context.Context, cfg *config.Config, effectiveBackend stri
// buildGeheimBackend initialises the original AES-encrypted geheim backend:
// reads the PIN, builds the cipher, creates a *store.Store, and points git at
// cfg.DataDir via buildGeheimGit.
-func buildGeheimBackend(cfg *config.Config) (backend.Backend, git.Gitter, error) {
+func buildGeheimBackend(cfg *config.Config) (backend.Backend, Gitter, error) {
pin, err := readPIN()
if err != nil {
return nil, nil, fmt.Errorf("reading PIN: %w", err)
@@ -75,7 +75,7 @@ func buildGeheimBackend(cfg *config.Config) (backend.Backend, git.Gitter, error)
// directory is always a git repository (it is the store itself), so a real
// git client is always appropriate here — unlike the keepass backend which
// may live outside a repo and needs a NoOp fallback.
-func buildGeheimGit(cfg *config.Config) git.Gitter {
+func buildGeheimGit(cfg *config.Config) Gitter {
return git.New(cfg.DataDir)
}
@@ -89,7 +89,7 @@ func buildGeheimGit(cfg *config.Config) git.Gitter {
// repository, a *git.NoOp is returned instead — its methods print an
// informational message ("kdbx file is not in a git repo; skipping") and return
// nil, keeping the UX transparent without crashing.
-func buildKeepassBackend(ctx context.Context, cfg *config.Config) (backend.Backend, git.Gitter, error) {
+func buildKeepassBackend(ctx context.Context, cfg *config.Config) (backend.Backend, Gitter, error) {
passphrase, err := readKeepassPassphrase(cfg)
if err != nil {
return nil, nil, fmt.Errorf("reading keepass passphrase: %w", err)
@@ -113,7 +113,7 @@ func buildKeepassBackend(ctx context.Context, cfg *config.Config) (backend.Backe
// the kdbx file. When the directory is a git repository, a real *git.Git is
// returned. Otherwise, a *git.NoOp is returned so that callers receive
// informational messages rather than errors when running git commands.
-func buildKeepassGit(kdbxPath string) git.Gitter {
+func buildKeepassGit(kdbxPath string) Gitter {
kdbxDir := filepath.Dir(kdbxPath)
if git.IsGitRepo(kdbxDir) {
return git.New(kdbxDir)
diff --git a/internal/cli/git.go b/internal/cli/git.go
new file mode 100644
index 0000000..4921a38
--- /dev/null
+++ b/internal/cli/git.go
@@ -0,0 +1,48 @@
+// Package cli — git abstraction for the CLI layer.
+//
+// This file defines the Gitter interface, which the CLI uses to abstract over
+// real git operations (*git.Git) and no-op stubs (*git.NoOp). The interface
+// lives here in the consumer package (internal/cli) rather than in the
+// producer package (internal/git), following Go best practice #6 from
+// "100 Go Mistakes": interfaces should be defined where they are used, not
+// where they are implemented.
+//
+// Keeping the interface here avoids tight coupling between internal/git and its
+// callers: internal/git does not need to know who depends on it, and new
+// consumers can define their own narrower interfaces as needed.
+package cli
+
+import (
+ "context"
+
+ "codeberg.org/snonux/foostore/internal/git"
+)
+
+// Gitter abstracts git operations so that the CLI dispatch logic works
+// identically whether backed by a real git repository (*git.Git) or a no-op
+// stub (*git.NoOp — used when the KeePass database file lives outside a repo).
+type Gitter interface {
+ // Add stages a single file for the next commit.
+ Add(ctx context.Context, filePath string) error
+
+ // Remove stages a file deletion for the next commit.
+ Remove(ctx context.Context, filePath string) error
+
+ // Status prints the current git status of the working directory.
+ Status(ctx context.Context) error
+
+ // Commit records all staged changes with a generic commit message.
+ Commit(ctx context.Context) error
+
+ // Reset discards all uncommitted changes in the working directory.
+ Reset(ctx context.Context) error
+
+ // Sync pulls from and pushes to each configured remote repository.
+ Sync(ctx context.Context, syncRepos []string) error
+}
+
+// Compile-time assertions: both concrete git types must satisfy Gitter.
+// These assertions live in the consumer (cli), not the producer (git),
+// so that internal/git remains free of any dependency on this package.
+var _ Gitter = (*git.Git)(nil)
+var _ Gitter = (*git.NoOp)(nil)