Initial commit
This commit is contained in:
448
brittle-core/src/store/fs.rs
Normal file
448
brittle-core/src/store/fs.rs
Normal file
@@ -0,0 +1,448 @@
|
||||
use crate::error::{EntityType, StoreError};
|
||||
use crate::model::{AnnotationSet, Library, LibraryId, Reference, ReferenceId, Snapshot};
|
||||
use crate::store::Store;
|
||||
use chrono::{DateTime, TimeZone, Utc};
|
||||
use git2::{IndexAddOption, Repository, Signature};
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
const REFERENCES_DIR: &str = "references";
|
||||
const LIBRARIES_DIR: &str = "libraries";
|
||||
const ANNOTATIONS_DIR: &str = "annotations";
|
||||
const PDFS_DIR: &str = "pdfs";
|
||||
|
||||
/// Filesystem + git-backed store. Each entity is a TOML file.
|
||||
/// Snapshots are git commits; time travel is git checkout.
|
||||
pub struct FsStore {
|
||||
root: PathBuf,
|
||||
repo: Repository,
|
||||
}
|
||||
|
||||
impl FsStore {
|
||||
/// Create a new Brittle repository at the given path.
|
||||
/// Fails if the path already contains a git repository.
|
||||
pub fn create(path: &Path) -> Result<Self, StoreError> {
|
||||
if path.join(".git").exists() {
|
||||
return Err(StoreError::RepoAlreadyExists {
|
||||
path: path.to_owned(),
|
||||
});
|
||||
}
|
||||
|
||||
let repo = Repository::init(path).map_err(StoreError::Git)?;
|
||||
|
||||
// Create subdirectories.
|
||||
for dir in [REFERENCES_DIR, LIBRARIES_DIR, ANNOTATIONS_DIR, PDFS_DIR] {
|
||||
std::fs::create_dir_all(path.join(dir))?;
|
||||
}
|
||||
|
||||
let mut store = Self {
|
||||
root: path.to_owned(),
|
||||
repo,
|
||||
};
|
||||
|
||||
// Create the initial commit so the repo has a HEAD.
|
||||
store.commit_all("Initialize Brittle repository")?;
|
||||
|
||||
Ok(store)
|
||||
}
|
||||
|
||||
/// Open an existing Brittle repository.
|
||||
pub fn open(path: &Path) -> Result<Self, StoreError> {
|
||||
let repo = Repository::open(path).map_err(|_| StoreError::RepoNotFound {
|
||||
path: path.to_owned(),
|
||||
})?;
|
||||
Ok(Self {
|
||||
root: path.to_owned(),
|
||||
repo,
|
||||
})
|
||||
}
|
||||
|
||||
/// Stage all changes and create a git commit. Returns the commit OID as hex.
|
||||
fn commit_all(&mut self, message: &str) -> Result<String, StoreError> {
|
||||
let mut index = self.repo.index().map_err(StoreError::Git)?;
|
||||
index
|
||||
.add_all(["*"].iter(), IndexAddOption::DEFAULT, None)
|
||||
.map_err(StoreError::Git)?;
|
||||
index.write().map_err(StoreError::Git)?;
|
||||
|
||||
let tree_oid = index.write_tree().map_err(StoreError::Git)?;
|
||||
let tree = self.repo.find_tree(tree_oid).map_err(StoreError::Git)?;
|
||||
|
||||
let sig = Signature::now("Brittle", "brittle@local").map_err(StoreError::Git)?;
|
||||
|
||||
let parent_commit = self.repo.head().ok().and_then(|h| h.peel_to_commit().ok());
|
||||
|
||||
let oid = match &parent_commit {
|
||||
Some(parent) => self
|
||||
.repo
|
||||
.commit(Some("HEAD"), &sig, &sig, message, &tree, &[parent])
|
||||
.map_err(StoreError::Git)?,
|
||||
None => self
|
||||
.repo
|
||||
.commit(Some("HEAD"), &sig, &sig, message, &tree, &[])
|
||||
.map_err(StoreError::Git)?,
|
||||
};
|
||||
|
||||
Ok(oid.to_string())
|
||||
}
|
||||
|
||||
fn reference_path(&self, id: ReferenceId) -> PathBuf {
|
||||
self.root.join(REFERENCES_DIR).join(format!("{id}.toml"))
|
||||
}
|
||||
|
||||
fn library_path(&self, id: LibraryId) -> PathBuf {
|
||||
self.root.join(LIBRARIES_DIR).join(format!("{id}.toml"))
|
||||
}
|
||||
|
||||
fn annotation_path(&self, ref_id: ReferenceId) -> PathBuf {
|
||||
self.root
|
||||
.join(ANNOTATIONS_DIR)
|
||||
.join(format!("{ref_id}.toml"))
|
||||
}
|
||||
|
||||
pub fn pdf_dir(&self) -> PathBuf {
|
||||
self.root.join(PDFS_DIR)
|
||||
}
|
||||
|
||||
/// Returns the repository root directory.
|
||||
pub fn root(&self) -> &Path {
|
||||
&self.root
|
||||
}
|
||||
|
||||
fn write_toml<T: serde::Serialize>(&self, path: &Path, value: &T) -> Result<(), StoreError> {
|
||||
let content = toml::to_string(value).map_err(|e| StoreError::Serialization {
|
||||
message: e.to_string(),
|
||||
})?;
|
||||
std::fs::write(path, content)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn read_toml<T: serde::de::DeserializeOwned>(&self, path: &Path) -> Result<T, StoreError> {
|
||||
let content = std::fs::read_to_string(path)?;
|
||||
toml::from_str(&content).map_err(|e| StoreError::Deserialization {
|
||||
path: path.to_owned(),
|
||||
message: e.to_string(),
|
||||
})
|
||||
}
|
||||
|
||||
fn ids_from_dir<T, F>(&self, dir: &str, parse: F) -> Result<Vec<T>, StoreError>
|
||||
where
|
||||
F: Fn(&str) -> Option<T>,
|
||||
{
|
||||
let dir_path = self.root.join(dir);
|
||||
let mut ids = Vec::new();
|
||||
for entry in std::fs::read_dir(&dir_path)? {
|
||||
let entry = entry?;
|
||||
let name = entry.file_name();
|
||||
let name = name.to_string_lossy();
|
||||
if let Some(stem) = name.strip_suffix(".toml")
|
||||
&& let Some(id) = parse(stem)
|
||||
{
|
||||
ids.push(id);
|
||||
}
|
||||
}
|
||||
Ok(ids)
|
||||
}
|
||||
}
|
||||
|
||||
impl Store for FsStore {
|
||||
fn save_reference(&mut self, reference: &Reference) -> Result<(), StoreError> {
|
||||
self.write_toml(&self.reference_path(reference.id), reference)
|
||||
}
|
||||
|
||||
fn load_reference(&self, id: ReferenceId) -> Result<Reference, StoreError> {
|
||||
let path = self.reference_path(id);
|
||||
if !path.exists() {
|
||||
return Err(StoreError::NotFound {
|
||||
entity_type: EntityType::Reference,
|
||||
id: id.to_string(),
|
||||
});
|
||||
}
|
||||
self.read_toml(&path)
|
||||
}
|
||||
|
||||
fn delete_reference(&mut self, id: ReferenceId) -> Result<(), StoreError> {
|
||||
let path = self.reference_path(id);
|
||||
if !path.exists() {
|
||||
return Err(StoreError::NotFound {
|
||||
entity_type: EntityType::Reference,
|
||||
id: id.to_string(),
|
||||
});
|
||||
}
|
||||
std::fs::remove_file(path)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn list_reference_ids(&self) -> Result<Vec<ReferenceId>, StoreError> {
|
||||
self.ids_from_dir(REFERENCES_DIR, |s| {
|
||||
s.parse::<uuid::Uuid>().ok().map(ReferenceId::from)
|
||||
})
|
||||
}
|
||||
|
||||
fn save_library(&mut self, library: &Library) -> Result<(), StoreError> {
|
||||
self.write_toml(&self.library_path(library.id), library)
|
||||
}
|
||||
|
||||
fn load_library(&self, id: LibraryId) -> Result<Library, StoreError> {
|
||||
let path = self.library_path(id);
|
||||
if !path.exists() {
|
||||
return Err(StoreError::NotFound {
|
||||
entity_type: EntityType::Library,
|
||||
id: id.to_string(),
|
||||
});
|
||||
}
|
||||
self.read_toml(&path)
|
||||
}
|
||||
|
||||
fn delete_library(&mut self, id: LibraryId) -> Result<(), StoreError> {
|
||||
let path = self.library_path(id);
|
||||
if !path.exists() {
|
||||
return Err(StoreError::NotFound {
|
||||
entity_type: EntityType::Library,
|
||||
id: id.to_string(),
|
||||
});
|
||||
}
|
||||
std::fs::remove_file(path)?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn list_library_ids(&self) -> Result<Vec<LibraryId>, StoreError> {
|
||||
self.ids_from_dir(LIBRARIES_DIR, |s| {
|
||||
s.parse::<uuid::Uuid>().ok().map(LibraryId::from)
|
||||
})
|
||||
}
|
||||
|
||||
fn load_annotations(&self, ref_id: ReferenceId) -> Result<AnnotationSet, StoreError> {
|
||||
let path = self.annotation_path(ref_id);
|
||||
if !path.exists() {
|
||||
return Ok(AnnotationSet::new(ref_id));
|
||||
}
|
||||
self.read_toml(&path)
|
||||
}
|
||||
|
||||
fn save_annotations(&mut self, set: &AnnotationSet) -> Result<(), StoreError> {
|
||||
self.write_toml(&self.annotation_path(set.reference_id), set)
|
||||
}
|
||||
|
||||
fn delete_annotations(&mut self, ref_id: ReferenceId) -> Result<(), StoreError> {
|
||||
let path = self.annotation_path(ref_id);
|
||||
if path.exists() {
|
||||
std::fs::remove_file(path)?;
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn create_snapshot(&mut self, message: &str) -> Result<Snapshot, StoreError> {
|
||||
let oid = self.commit_all(message)?;
|
||||
let commit = self
|
||||
.repo
|
||||
.find_commit(git2::Oid::from_str(&oid).map_err(StoreError::Git)?)
|
||||
.map_err(StoreError::Git)?;
|
||||
let timestamp = commit_timestamp(&commit)?;
|
||||
|
||||
Ok(Snapshot {
|
||||
id: oid,
|
||||
message: message.to_owned(),
|
||||
timestamp,
|
||||
})
|
||||
}
|
||||
|
||||
fn list_snapshots(&self) -> Result<Vec<Snapshot>, StoreError> {
|
||||
let mut revwalk = self.repo.revwalk().map_err(StoreError::Git)?;
|
||||
revwalk.push_head().map_err(StoreError::Git)?;
|
||||
revwalk
|
||||
.set_sorting(git2::Sort::TIME)
|
||||
.map_err(StoreError::Git)?;
|
||||
|
||||
let mut snapshots = Vec::new();
|
||||
for oid in revwalk {
|
||||
let oid = oid.map_err(StoreError::Git)?;
|
||||
let commit = self.repo.find_commit(oid).map_err(StoreError::Git)?;
|
||||
let message = commit.message().unwrap_or("").to_owned();
|
||||
let timestamp = commit_timestamp(&commit)?;
|
||||
snapshots.push(Snapshot {
|
||||
id: oid.to_string(),
|
||||
message,
|
||||
timestamp,
|
||||
});
|
||||
}
|
||||
|
||||
Ok(snapshots)
|
||||
}
|
||||
|
||||
fn restore_snapshot(&mut self, snapshot_id: &str) -> Result<(), StoreError> {
|
||||
let oid = git2::Oid::from_str(snapshot_id).map_err(|_| StoreError::NotFound {
|
||||
entity_type: EntityType::Snapshot,
|
||||
id: snapshot_id.to_owned(),
|
||||
})?;
|
||||
|
||||
let commit = self
|
||||
.repo
|
||||
.find_commit(oid)
|
||||
.map_err(|_| StoreError::NotFound {
|
||||
entity_type: EntityType::Snapshot,
|
||||
id: snapshot_id.to_owned(),
|
||||
})?;
|
||||
|
||||
let tree = commit.tree().map_err(StoreError::Git)?;
|
||||
|
||||
// Checkout the tree, updating both the index and the working directory.
|
||||
// `force` overwrites modified tracked files; `remove_untracked` removes
|
||||
// files that were written since the last snapshot but never committed.
|
||||
let mut checkout_opts = git2::build::CheckoutBuilder::new();
|
||||
checkout_opts.force().remove_untracked(true);
|
||||
self.repo
|
||||
.checkout_tree(tree.as_object(), Some(&mut checkout_opts))
|
||||
.map_err(StoreError::Git)?;
|
||||
|
||||
// Move HEAD to point at the restored commit.
|
||||
self.repo.set_head_detached(oid).map_err(StoreError::Git)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn has_uncommitted_changes(&self) -> Result<bool, StoreError> {
|
||||
let statuses = self
|
||||
.repo
|
||||
.statuses(Some(
|
||||
git2::StatusOptions::new()
|
||||
.include_untracked(true)
|
||||
.recurse_untracked_dirs(true),
|
||||
))
|
||||
.map_err(StoreError::Git)?;
|
||||
Ok(!statuses.is_empty())
|
||||
}
|
||||
}
|
||||
|
||||
fn commit_timestamp(commit: &git2::Commit<'_>) -> Result<DateTime<Utc>, StoreError> {
|
||||
let time = commit.time();
|
||||
Utc.timestamp_opt(time.seconds(), 0)
|
||||
.single()
|
||||
.ok_or_else(|| StoreError::Serialization {
|
||||
message: "invalid commit timestamp".into(),
|
||||
})
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::model::{EntryType, Library, Reference};
|
||||
|
||||
fn make_store(dir: &Path) -> FsStore {
|
||||
FsStore::create(dir).expect("create store")
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn create_and_open() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let store = make_store(tmp.path());
|
||||
drop(store);
|
||||
FsStore::open(tmp.path()).expect("re-open store");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn create_fails_if_repo_exists() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
make_store(tmp.path());
|
||||
assert!(FsStore::create(tmp.path()).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn save_load_delete_reference() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let mut store = make_store(tmp.path());
|
||||
let r = Reference::new("test2024", EntryType::Article);
|
||||
let id = r.id;
|
||||
|
||||
store.save_reference(&r).unwrap();
|
||||
let loaded = store.load_reference(id).unwrap();
|
||||
assert_eq!(loaded.cite_key, "test2024");
|
||||
|
||||
store.delete_reference(id).unwrap();
|
||||
assert!(store.load_reference(id).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn list_reference_ids() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let mut store = make_store(tmp.path());
|
||||
let r1 = Reference::new("a2024", EntryType::Article);
|
||||
let r2 = Reference::new("b2024", EntryType::Book);
|
||||
store.save_reference(&r1).unwrap();
|
||||
store.save_reference(&r2).unwrap();
|
||||
|
||||
let ids = store.list_reference_ids().unwrap();
|
||||
assert_eq!(ids.len(), 2);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn save_load_library() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let mut store = make_store(tmp.path());
|
||||
let lib = Library::new("ML Papers", None);
|
||||
let id = lib.id;
|
||||
|
||||
store.save_library(&lib).unwrap();
|
||||
let loaded = store.load_library(id).unwrap();
|
||||
assert_eq!(loaded.name, "ML Papers");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn annotations_missing_returns_empty_set() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let store = make_store(tmp.path());
|
||||
let ref_id = ReferenceId::new();
|
||||
let set = store.load_annotations(ref_id).unwrap();
|
||||
assert!(set.annotations.is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn create_and_list_snapshot() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let mut store = make_store(tmp.path());
|
||||
|
||||
// Save something so there's content to commit beyond the initial commit.
|
||||
let r = Reference::new("snap2024", EntryType::Misc);
|
||||
store.save_reference(&r).unwrap();
|
||||
let snap = store.create_snapshot("my first snapshot").unwrap();
|
||||
|
||||
let snapshots = store.list_snapshots().unwrap();
|
||||
assert!(snapshots.iter().any(|s| s.id == snap.id));
|
||||
assert!(snapshots.iter().any(|s| s.message == "my first snapshot"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn restore_snapshot_reverts_state() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let mut store = make_store(tmp.path());
|
||||
|
||||
let r = Reference::new("before2024", EntryType::Article);
|
||||
let ref_id = r.id;
|
||||
store.save_reference(&r).unwrap();
|
||||
let snap = store.create_snapshot("baseline").unwrap();
|
||||
|
||||
// Modify state: add another reference.
|
||||
let r2 = Reference::new("after2024", EntryType::Book);
|
||||
store.save_reference(&r2).unwrap();
|
||||
assert_eq!(store.list_reference_ids().unwrap().len(), 2);
|
||||
|
||||
// Restore to baseline — should have only 1 reference.
|
||||
store.restore_snapshot(&snap.id).unwrap();
|
||||
|
||||
let store2 = FsStore::open(tmp.path()).unwrap();
|
||||
assert_eq!(store2.list_reference_ids().unwrap().len(), 1);
|
||||
assert!(store2.load_reference(ref_id).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn has_uncommitted_changes_detects_new_files() {
|
||||
let tmp = tempfile::tempdir().unwrap();
|
||||
let mut store = make_store(tmp.path());
|
||||
|
||||
assert!(!store.has_uncommitted_changes().unwrap());
|
||||
|
||||
let r = Reference::new("new2024", EntryType::Misc);
|
||||
store.save_reference(&r).unwrap();
|
||||
|
||||
assert!(store.has_uncommitted_changes().unwrap());
|
||||
}
|
||||
}
|
||||
302
brittle-core/src/store/memory.rs
Normal file
302
brittle-core/src/store/memory.rs
Normal file
@@ -0,0 +1,302 @@
|
||||
use crate::error::{EntityType, StoreError};
|
||||
use crate::model::{AnnotationSet, Library, LibraryId, Reference, ReferenceId, Snapshot};
|
||||
use crate::store::Store;
|
||||
use chrono::Utc;
|
||||
use std::collections::HashMap;
|
||||
|
||||
/// In-memory store for testing. Not suitable for production use.
|
||||
#[derive(Debug, Default)]
|
||||
pub struct MemoryStore {
|
||||
references: HashMap<ReferenceId, Reference>,
|
||||
libraries: HashMap<LibraryId, Library>,
|
||||
annotations: HashMap<ReferenceId, AnnotationSet>,
|
||||
/// Checkpoints for snapshot simulation: (id, message, cloned state).
|
||||
snapshots: Vec<(String, String, Box<MemorySnapshot>)>,
|
||||
next_snapshot_idx: usize,
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
struct MemorySnapshot {
|
||||
references: HashMap<ReferenceId, Reference>,
|
||||
libraries: HashMap<LibraryId, Library>,
|
||||
annotations: HashMap<ReferenceId, AnnotationSet>,
|
||||
}
|
||||
|
||||
impl MemoryStore {
|
||||
pub fn new() -> Self {
|
||||
Self::default()
|
||||
}
|
||||
}
|
||||
|
||||
impl Store for MemoryStore {
|
||||
fn save_reference(&mut self, reference: &Reference) -> Result<(), StoreError> {
|
||||
self.references.insert(reference.id, reference.clone());
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn load_reference(&self, id: ReferenceId) -> Result<Reference, StoreError> {
|
||||
self.references
|
||||
.get(&id)
|
||||
.cloned()
|
||||
.ok_or_else(|| StoreError::NotFound {
|
||||
entity_type: EntityType::Reference,
|
||||
id: id.to_string(),
|
||||
})
|
||||
}
|
||||
|
||||
fn delete_reference(&mut self, id: ReferenceId) -> Result<(), StoreError> {
|
||||
self.references
|
||||
.remove(&id)
|
||||
.ok_or_else(|| StoreError::NotFound {
|
||||
entity_type: EntityType::Reference,
|
||||
id: id.to_string(),
|
||||
})?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn list_reference_ids(&self) -> Result<Vec<ReferenceId>, StoreError> {
|
||||
Ok(self.references.keys().copied().collect())
|
||||
}
|
||||
|
||||
fn save_library(&mut self, library: &Library) -> Result<(), StoreError> {
|
||||
self.libraries.insert(library.id, library.clone());
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn load_library(&self, id: LibraryId) -> Result<Library, StoreError> {
|
||||
self.libraries
|
||||
.get(&id)
|
||||
.cloned()
|
||||
.ok_or_else(|| StoreError::NotFound {
|
||||
entity_type: EntityType::Library,
|
||||
id: id.to_string(),
|
||||
})
|
||||
}
|
||||
|
||||
fn delete_library(&mut self, id: LibraryId) -> Result<(), StoreError> {
|
||||
self.libraries
|
||||
.remove(&id)
|
||||
.ok_or_else(|| StoreError::NotFound {
|
||||
entity_type: EntityType::Library,
|
||||
id: id.to_string(),
|
||||
})?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn list_library_ids(&self) -> Result<Vec<LibraryId>, StoreError> {
|
||||
Ok(self.libraries.keys().copied().collect())
|
||||
}
|
||||
|
||||
fn load_annotations(&self, ref_id: ReferenceId) -> Result<AnnotationSet, StoreError> {
|
||||
Ok(self
|
||||
.annotations
|
||||
.get(&ref_id)
|
||||
.cloned()
|
||||
.unwrap_or_else(|| AnnotationSet::new(ref_id)))
|
||||
}
|
||||
|
||||
fn save_annotations(&mut self, set: &AnnotationSet) -> Result<(), StoreError> {
|
||||
self.annotations.insert(set.reference_id, set.clone());
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn delete_annotations(&mut self, ref_id: ReferenceId) -> Result<(), StoreError> {
|
||||
self.annotations.remove(&ref_id);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn create_snapshot(&mut self, message: &str) -> Result<Snapshot, StoreError> {
|
||||
let id = format!("mem-snapshot-{:04}", self.next_snapshot_idx);
|
||||
self.next_snapshot_idx += 1;
|
||||
let snapshot_data = Box::new(MemorySnapshot {
|
||||
references: self.references.clone(),
|
||||
libraries: self.libraries.clone(),
|
||||
annotations: self.annotations.clone(),
|
||||
});
|
||||
let timestamp = Utc::now();
|
||||
self.snapshots
|
||||
.push((id.clone(), message.to_owned(), snapshot_data));
|
||||
Ok(Snapshot {
|
||||
id,
|
||||
message: message.to_owned(),
|
||||
timestamp,
|
||||
})
|
||||
}
|
||||
|
||||
fn list_snapshots(&self) -> Result<Vec<Snapshot>, StoreError> {
|
||||
let snapshots = self
|
||||
.snapshots
|
||||
.iter()
|
||||
.rev()
|
||||
.map(|(id, message, _)| Snapshot {
|
||||
id: id.clone(),
|
||||
message: message.clone(),
|
||||
timestamp: Utc::now(), // timestamps not stored in MemoryStore
|
||||
})
|
||||
.collect();
|
||||
Ok(snapshots)
|
||||
}
|
||||
|
||||
fn restore_snapshot(&mut self, snapshot_id: &str) -> Result<(), StoreError> {
|
||||
let snapshot = self
|
||||
.snapshots
|
||||
.iter()
|
||||
.find(|(id, _, _)| id == snapshot_id)
|
||||
.ok_or_else(|| StoreError::NotFound {
|
||||
entity_type: EntityType::Snapshot,
|
||||
id: snapshot_id.to_owned(),
|
||||
})?;
|
||||
self.references = snapshot.2.references.clone();
|
||||
self.libraries = snapshot.2.libraries.clone();
|
||||
self.annotations = snapshot.2.annotations.clone();
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn has_uncommitted_changes(&self) -> Result<bool, StoreError> {
|
||||
// MemoryStore has no concept of uncommitted changes.
|
||||
Ok(false)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::model::{AnnotationType, EntryType, Library, Reference, TextMarkupType};
|
||||
|
||||
fn make_reference() -> Reference {
|
||||
Reference::new("test2024", EntryType::Article)
|
||||
}
|
||||
|
||||
fn make_library() -> Library {
|
||||
Library::new("Test Library", None)
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn save_and_load_reference() {
|
||||
let mut store = MemoryStore::new();
|
||||
let r = make_reference();
|
||||
let id = r.id;
|
||||
store.save_reference(&r).unwrap();
|
||||
let r2 = store.load_reference(id).unwrap();
|
||||
assert_eq!(r.cite_key, r2.cite_key);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn load_missing_reference_returns_error() {
|
||||
let store = MemoryStore::new();
|
||||
let id = ReferenceId::new();
|
||||
let err = store.load_reference(id).unwrap_err();
|
||||
assert!(matches!(
|
||||
err,
|
||||
StoreError::NotFound {
|
||||
entity_type: EntityType::Reference,
|
||||
..
|
||||
}
|
||||
));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn delete_reference() {
|
||||
let mut store = MemoryStore::new();
|
||||
let r = make_reference();
|
||||
let id = r.id;
|
||||
store.save_reference(&r).unwrap();
|
||||
store.delete_reference(id).unwrap();
|
||||
assert!(store.load_reference(id).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn list_reference_ids() {
|
||||
let mut store = MemoryStore::new();
|
||||
let r1 = make_reference();
|
||||
let r2 = make_reference();
|
||||
store.save_reference(&r1).unwrap();
|
||||
store.save_reference(&r2).unwrap();
|
||||
let ids = store.list_reference_ids().unwrap();
|
||||
assert_eq!(ids.len(), 2);
|
||||
assert!(ids.contains(&r1.id));
|
||||
assert!(ids.contains(&r2.id));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn save_and_load_library() {
|
||||
let mut store = MemoryStore::new();
|
||||
let lib = make_library();
|
||||
let id = lib.id;
|
||||
store.save_library(&lib).unwrap();
|
||||
let lib2 = store.load_library(id).unwrap();
|
||||
assert_eq!(lib.name, lib2.name);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn delete_library() {
|
||||
let mut store = MemoryStore::new();
|
||||
let lib = make_library();
|
||||
let id = lib.id;
|
||||
store.save_library(&lib).unwrap();
|
||||
store.delete_library(id).unwrap();
|
||||
assert!(store.load_library(id).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn annotations_default_to_empty_set() {
|
||||
let store = MemoryStore::new();
|
||||
let ref_id = ReferenceId::new();
|
||||
let set = store.load_annotations(ref_id).unwrap();
|
||||
assert_eq!(set.reference_id, ref_id);
|
||||
assert!(set.annotations.is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn save_and_load_annotations() {
|
||||
use crate::model::{Annotation, Color};
|
||||
|
||||
let mut store = MemoryStore::new();
|
||||
let ref_id = ReferenceId::new();
|
||||
let ann = Annotation::new(
|
||||
ref_id,
|
||||
0,
|
||||
AnnotationType::TextMarkup {
|
||||
markup_type: TextMarkupType::Highlight,
|
||||
quads: vec![],
|
||||
color: Color::YELLOW,
|
||||
selected_text: None,
|
||||
},
|
||||
);
|
||||
let set = AnnotationSet {
|
||||
reference_id: ref_id,
|
||||
annotations: vec![ann],
|
||||
};
|
||||
store.save_annotations(&set).unwrap();
|
||||
let set2 = store.load_annotations(ref_id).unwrap();
|
||||
assert_eq!(set2.annotations.len(), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn snapshot_create_and_restore() {
|
||||
let mut store = MemoryStore::new();
|
||||
let r = make_reference();
|
||||
let ref_id = r.id;
|
||||
store.save_reference(&r).unwrap();
|
||||
|
||||
let snap = store.create_snapshot("first snapshot").unwrap();
|
||||
|
||||
// Modify state after snapshot.
|
||||
store.delete_reference(ref_id).unwrap();
|
||||
assert!(store.load_reference(ref_id).is_err());
|
||||
|
||||
// Restore snapshot.
|
||||
store.restore_snapshot(&snap.id).unwrap();
|
||||
assert!(store.load_reference(ref_id).is_ok());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn list_snapshots_in_reverse_order() {
|
||||
let mut store = MemoryStore::new();
|
||||
store.create_snapshot("first").unwrap();
|
||||
store.create_snapshot("second").unwrap();
|
||||
let snaps = store.list_snapshots().unwrap();
|
||||
assert_eq!(snaps.len(), 2);
|
||||
assert_eq!(snaps[0].message, "second"); // most recent first
|
||||
}
|
||||
}
|
||||
44
brittle-core/src/store/mod.rs
Normal file
44
brittle-core/src/store/mod.rs
Normal file
@@ -0,0 +1,44 @@
|
||||
pub mod fs;
|
||||
pub mod memory;
|
||||
|
||||
use crate::error::StoreError;
|
||||
use crate::model::{AnnotationSet, Library, LibraryId, Reference, ReferenceId, Snapshot};
|
||||
|
||||
/// Abstraction over the storage backend.
|
||||
///
|
||||
/// The git-backed filesystem (`FsStore`) is the production implementation.
|
||||
/// An in-memory implementation (`MemoryStore`) exists for testing.
|
||||
pub trait Store {
|
||||
// ---- References ----
|
||||
|
||||
fn save_reference(&mut self, reference: &Reference) -> Result<(), StoreError>;
|
||||
fn load_reference(&self, id: ReferenceId) -> Result<Reference, StoreError>;
|
||||
fn delete_reference(&mut self, id: ReferenceId) -> Result<(), StoreError>;
|
||||
fn list_reference_ids(&self) -> Result<Vec<ReferenceId>, StoreError>;
|
||||
|
||||
// ---- Libraries ----
|
||||
|
||||
fn save_library(&mut self, library: &Library) -> Result<(), StoreError>;
|
||||
fn load_library(&self, id: LibraryId) -> Result<Library, StoreError>;
|
||||
fn delete_library(&mut self, id: LibraryId) -> Result<(), StoreError>;
|
||||
fn list_library_ids(&self) -> Result<Vec<LibraryId>, StoreError>;
|
||||
|
||||
// ---- Annotations ----
|
||||
|
||||
/// Load the annotation set for a reference. Returns an empty set if none exists.
|
||||
fn load_annotations(&self, ref_id: ReferenceId) -> Result<AnnotationSet, StoreError>;
|
||||
fn save_annotations(&mut self, set: &AnnotationSet) -> Result<(), StoreError>;
|
||||
fn delete_annotations(&mut self, ref_id: ReferenceId) -> Result<(), StoreError>;
|
||||
|
||||
// ---- Snapshots ----
|
||||
|
||||
fn create_snapshot(&mut self, message: &str) -> Result<Snapshot, StoreError>;
|
||||
fn list_snapshots(&self) -> Result<Vec<Snapshot>, StoreError>;
|
||||
/// Restore to a previous snapshot. Caller must ensure no uncommitted changes exist.
|
||||
fn restore_snapshot(&mut self, snapshot_id: &str) -> Result<(), StoreError>;
|
||||
fn has_uncommitted_changes(&self) -> Result<bool, StoreError>;
|
||||
}
|
||||
|
||||
// Re-export concrete types for convenience.
|
||||
pub use fs::FsStore;
|
||||
pub use memory::MemoryStore;
|
||||
Reference in New Issue
Block a user