Files
sgard/garden/garden.go
Kyle Isom 661c050d83 Step 5: Checkpoint and Status.
Checkpoint re-hashes all tracked files, stores changed blobs, and
updates per-file timestamps only when content changes. Missing files
are skipped gracefully. Status compares each tracked entry against
the filesystem and reports ok/modified/missing.

CLI: sgard checkpoint [-m message], sgard status.
4 new tests (changed file, unchanged file, missing file, status).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-23 21:36:55 -07:00

315 lines
7.7 KiB
Go

// Package garden is the core business logic for sgard. It orchestrates the
// manifest and blob store to implement dotfile management operations.
package garden
import (
"fmt"
"os"
"path/filepath"
"strings"
"time"
"github.com/kisom/sgard/manifest"
"github.com/kisom/sgard/store"
)
// Garden ties a manifest and blob store together to manage dotfiles.
type Garden struct {
manifest *manifest.Manifest
store *store.Store
root string // repository root directory
manifestPath string // path to manifest.yaml
}
// Init creates a new sgard repository at root. It creates the directory
// structure and an empty manifest.
func Init(root string) (*Garden, error) {
absRoot, err := filepath.Abs(root)
if err != nil {
return nil, fmt.Errorf("resolving repo path: %w", err)
}
manifestPath := filepath.Join(absRoot, "manifest.yaml")
if _, err := os.Stat(manifestPath); err == nil {
return nil, fmt.Errorf("repository already exists at %s", absRoot)
}
if err := os.MkdirAll(absRoot, 0o755); err != nil {
return nil, fmt.Errorf("creating repo directory: %w", err)
}
s, err := store.New(absRoot)
if err != nil {
return nil, fmt.Errorf("creating store: %w", err)
}
m := manifest.New()
if err := m.Save(manifestPath); err != nil {
return nil, fmt.Errorf("saving initial manifest: %w", err)
}
return &Garden{
manifest: m,
store: s,
root: absRoot,
manifestPath: manifestPath,
}, nil
}
// Open loads an existing sgard repository from root.
func Open(root string) (*Garden, error) {
absRoot, err := filepath.Abs(root)
if err != nil {
return nil, fmt.Errorf("resolving repo path: %w", err)
}
manifestPath := filepath.Join(absRoot, "manifest.yaml")
m, err := manifest.Load(manifestPath)
if err != nil {
return nil, fmt.Errorf("loading manifest: %w", err)
}
s, err := store.New(absRoot)
if err != nil {
return nil, fmt.Errorf("opening store: %w", err)
}
return &Garden{
manifest: m,
store: s,
root: absRoot,
manifestPath: manifestPath,
}, nil
}
// Add tracks new files, directories, or symlinks. Each path is resolved
// to an absolute path, inspected for its type, and added to the manifest.
// Regular files are hashed and stored in the blob store.
func (g *Garden) Add(paths []string) error {
now := time.Now().UTC()
for _, p := range paths {
abs, err := filepath.Abs(p)
if err != nil {
return fmt.Errorf("resolving path %s: %w", p, err)
}
info, err := os.Lstat(abs)
if err != nil {
return fmt.Errorf("stat %s: %w", abs, err)
}
tilded := toTildePath(abs)
// Check if already tracked.
if g.findEntry(tilded) != nil {
return fmt.Errorf("already tracking %s", tilded)
}
entry := manifest.Entry{
Path: tilded,
Mode: fmt.Sprintf("%04o", info.Mode().Perm()),
Updated: now,
}
switch {
case info.Mode()&os.ModeSymlink != 0:
target, err := os.Readlink(abs)
if err != nil {
return fmt.Errorf("reading symlink %s: %w", abs, err)
}
entry.Type = "link"
entry.Target = target
case info.IsDir():
entry.Type = "directory"
default:
data, err := os.ReadFile(abs)
if err != nil {
return fmt.Errorf("reading file %s: %w", abs, err)
}
hash, err := g.store.Write(data)
if err != nil {
return fmt.Errorf("storing blob for %s: %w", abs, err)
}
entry.Type = "file"
entry.Hash = hash
}
g.manifest.Files = append(g.manifest.Files, entry)
}
g.manifest.Updated = now
if err := g.manifest.Save(g.manifestPath); err != nil {
return fmt.Errorf("saving manifest: %w", err)
}
return nil
}
// FileStatus reports the state of a tracked entry relative to the filesystem.
type FileStatus struct {
Path string // tilde path from manifest
State string // "ok", "modified", "missing"
}
// Checkpoint re-hashes all tracked files, stores any changed blobs, and
// updates the manifest timestamps. The optional message is recorded in
// the manifest.
func (g *Garden) Checkpoint(message string) error {
now := time.Now().UTC()
for i := range g.manifest.Files {
entry := &g.manifest.Files[i]
abs, err := ExpandTildePath(entry.Path)
if err != nil {
return fmt.Errorf("expanding path %s: %w", entry.Path, err)
}
info, err := os.Lstat(abs)
if err != nil {
// File is missing — leave the manifest entry as-is so status
// can report it. Don't fail the whole checkpoint.
continue
}
entry.Mode = fmt.Sprintf("%04o", info.Mode().Perm())
switch entry.Type {
case "file":
data, err := os.ReadFile(abs)
if err != nil {
return fmt.Errorf("reading %s: %w", abs, err)
}
hash, err := g.store.Write(data)
if err != nil {
return fmt.Errorf("storing blob for %s: %w", abs, err)
}
if hash != entry.Hash {
entry.Hash = hash
entry.Updated = now
}
case "link":
target, err := os.Readlink(abs)
if err != nil {
return fmt.Errorf("reading symlink %s: %w", abs, err)
}
if target != entry.Target {
entry.Target = target
entry.Updated = now
}
case "directory":
// Nothing to hash; just update mode (already done above).
}
}
g.manifest.Updated = now
g.manifest.Message = message
if err := g.manifest.Save(g.manifestPath); err != nil {
return fmt.Errorf("saving manifest: %w", err)
}
return nil
}
// Status compares each tracked entry against the current filesystem state
// and returns a status for each.
func (g *Garden) Status() ([]FileStatus, error) {
var results []FileStatus
for i := range g.manifest.Files {
entry := &g.manifest.Files[i]
abs, err := ExpandTildePath(entry.Path)
if err != nil {
return nil, fmt.Errorf("expanding path %s: %w", entry.Path, err)
}
_, err = os.Lstat(abs)
if os.IsNotExist(err) {
results = append(results, FileStatus{Path: entry.Path, State: "missing"})
continue
}
if err != nil {
return nil, fmt.Errorf("stat %s: %w", abs, err)
}
switch entry.Type {
case "file":
hash, err := HashFile(abs)
if err != nil {
return nil, fmt.Errorf("hashing %s: %w", abs, err)
}
if hash != entry.Hash {
results = append(results, FileStatus{Path: entry.Path, State: "modified"})
} else {
results = append(results, FileStatus{Path: entry.Path, State: "ok"})
}
case "link":
target, err := os.Readlink(abs)
if err != nil {
return nil, fmt.Errorf("reading symlink %s: %w", abs, err)
}
if target != entry.Target {
results = append(results, FileStatus{Path: entry.Path, State: "modified"})
} else {
results = append(results, FileStatus{Path: entry.Path, State: "ok"})
}
case "directory":
results = append(results, FileStatus{Path: entry.Path, State: "ok"})
}
}
return results, nil
}
// findEntry returns the entry for the given tilde path, or nil if not found.
func (g *Garden) findEntry(tildePath string) *manifest.Entry {
for i := range g.manifest.Files {
if g.manifest.Files[i].Path == tildePath {
return &g.manifest.Files[i]
}
}
return nil
}
// toTildePath converts an absolute path to a ~/... path if it falls under
// the user's home directory. Otherwise returns the path unchanged.
func toTildePath(abs string) string {
home, err := os.UserHomeDir()
if err != nil {
return abs
}
// Ensure trailing separator for prefix matching.
homePrefix := home + string(filepath.Separator)
if abs == home {
return "~"
}
if strings.HasPrefix(abs, homePrefix) {
return "~/" + abs[len(homePrefix):]
}
return abs
}
// ExpandTildePath converts a ~/... path to an absolute path using the
// current user's home directory. Non-tilde paths are returned unchanged.
func ExpandTildePath(p string) (string, error) {
if p == "~" || strings.HasPrefix(p, "~/") {
home, err := os.UserHomeDir()
if err != nil {
return "", fmt.Errorf("expanding ~: %w", err)
}
if p == "~" {
return home, nil
}
return filepath.Join(home, p[2:]), nil
}
return p, nil
}