chore: Wiz I know you don't like to see many commits, so, I give my w…

…ord to 100% force push everything back to a single commit.

Everything will nice and tidy, so your commit OCD can calm down :)

.gitignore

@@ -12,6 +12,3 @@ Cargo.lock
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
-
-# Test generated junk
-db.json

src/model/mod.rs

@@ -1,3 +1,5 @@
+//! Provides structs to handle Pacstall's data models.
+
 mod pacbuild;
 mod repository;
 

src/model/pacbuild.rs

@@ -30,7 +30,7 @@ pub struct PacBuild {
 /// ```
 pub type Version = String;
 
-/// Represents a PACBUILD or Apt package name.
+/// Represents a `PacBuild` or Apt package name.
 /// # Examples
 /// ```
 /// use libpacstall::model::PackageId;
@@ -46,7 +46,7 @@ pub type PackageId = String;
 /// let url: URL = "https://example.com".into();
 /// ```
 pub type URL = String;
-/// Represents a file SHA1 checksum
+/// Represents a file checksum
 /// # Examples
 /// ```
 /// use libpacstall::model::Hash;
@@ -83,7 +83,7 @@ impl InstallState {
     pub fn is_installed(&self) -> bool { !matches!(self, Self::None) }
 }
 
-/// Represents the type of the package. Usually deduced by the `PACBUILD.name`
+/// Represents the type of the package. Usually deduced by the [PacBuild#name]
 /// suffix.
 ///
 /// # Examples
@@ -94,18 +94,18 @@ impl InstallState {
 /// ```
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
 pub enum Kind {
-    /// PACBUILD will install an `AppImage`.
+    /// [PacBuild] will install an `AppImage`.
     AppImage(Hash),
 
-    /// PACBUILD will install a prebuilt, usually `tar.gz`, package.
+    /// [PacBuild] will install a prebuilt, usually `tar.gz`, package.
     Binary(Hash),
 
-    /// PACBUILD will install an existing `.deb` file.
+    /// [PacBuild] will install an existing `.deb` file.
     DebFile(Hash),
 
-    /// PACBUILD will install the source of a given Git branch.
+    /// [PacBuild] will install the source of a given Git branch.
     GitBranch,
 
-    /// PACBUILD will install the source of a given Git release.
+    /// [PacBuild] will install the source of a given Git release.
     GitRelease,
 }

src/model/repository.rs

@@ -1,6 +1,6 @@
 use serde_derive::{Deserialize, Serialize};
 
-/// The extracted `repositories` array of tables.
+/// Representation of a Pacstall repository.
 ///
 /// Defaults to the official repository.
 #[derive(Deserialize, Debug, Eq, PartialEq, Serialize, Clone)]

src/store/base.rs

@@ -1,3 +1,5 @@
+//! Abstraction over the caching implementation
+
 use std::fmt::Debug;
 
 use crate::model::{PacBuild, Repository};
@@ -6,58 +8,56 @@ use crate::store::filters::{InstallState, Kind};
 
 pub type StoreResult<T> = Result<T, StoreError>;
 
+/// Abstraction over the caching implementation
 pub trait Base: Debug {
-    /// Removes `PACBUILD` by name that belongs to the given repository.
+    /// Removes `PacBuild` by name that belongs to the given repository.
     ///
     /// # Errors
     /// * `StoreError::RepositoryNotFound`
     /// * `StoreError::PacBuildNotFound`
     fn remove_pacbuild(&mut self, name: &str, repository_url: &str) -> StoreResult<()>;
 
-    /// Adds `PACBUILD` to the given repository.
+    /// Adds `PacBuild` to the given repository.
     ///
     /// # Errors
     /// * `StoreError::RepositoryConflict`
     /// * `StoreError::PacBuildConflict`
     fn add_pacbuild(&mut self, pacbuild: PacBuild, repository_url: &str) -> StoreResult<()>;
 
-    /// Updates `PACBUILD` that belongs to the given repository.
+    /// Updates `PacBuild` that belongs to the given repository.
     ///
     /// # Errors
     /// * `StoreError::RepositoryNotFound`
     /// * `StoreError::PacBuildNotFound`
     fn update_pacbuild(&mut self, pacbuild: PacBuild, repository_url: &str) -> StoreResult<()>;
 
-    /// Removes all `PACBUILD` by name that belongs to the given repository.
+    /// Removes all `PacBuild` by name that belongs to the given repository.
     ///
     /// # Errors
-    /// * `StoreError::RepositoryNotFound`
-    /// * `StoreError::PacBuildNotFound`
+    /// * `StoreError::Aggregate`
     fn remove_all_pacbuilds(&mut self, name: &[&str], repository_url: &str) -> StoreResult<()>;
 
-    /// Adds all `PACBUILD` to the given repository.
+    /// Adds all `PacBuild` to the given repository.
     ///
     /// # Errors
-    /// * `StoreError::RepositoryConflict`
-    /// * `StoreError::PacBuildConflict`
+    /// * `StoreError::Aggregate`
     fn add_all_pacbuilds(
         &mut self,
         pacbuilds: Vec<PacBuild>,
         repository_url: &str,
     ) -> StoreResult<()>;
 
-    /// Updates all `PACBUILD` that belongs to the given repository.
+    /// Updates all `PacBuild` that belongs to the given repository.
     ///
     /// # Errors
-    /// * `StoreError::RepositoryNotFound`
-    /// * `StoreError::PacBuildNotFound`
+    /// * `StoreError::Aggregate`
     fn update_all_pacbuilds(
         &mut self,
         pacbuilds: Vec<PacBuild>,
         repository_url: &str,
     ) -> StoreResult<()>;
 
-    /// Removes `Repository` by url.
+    /// Removes [Repository] by url.
     ///
     /// # Errors
     /// * `StoreError::RepositoryNotFound`
@@ -69,7 +69,7 @@ pub trait Base: Debug {
     /// * `StoreError::RepositoryConflict`
     fn add_repository(&mut self, repository: Repository) -> StoreResult<()>;
 
-    /// Updates `Repository`.
+    /// Updates [Repository].
     ///
     /// # Errors
     /// * `StoreError::RepositoryConflict`

src/store/errors.rs

@@ -1,3 +1,6 @@
+//! Errors used by the caching system
+
+/// Errors used by Base
 #[derive(Debug, Clone)]
 pub enum StoreError {
     RepositoryNotFound(String),

src/store/filters.rs

@@ -1,3 +1,6 @@
+//! Provides various structs for querying and filtering packages.
+
+/// Used to query packages by installation state
 #[derive(Debug, PartialEq, Eq, Clone)]
 pub enum InstallState {
     Direct,
@@ -15,6 +18,7 @@ impl InstallState {
     }
 }
 
+/// Used to query packages by kind.
 #[derive(Debug, PartialEq, Eq, Clone)]
 pub enum Kind {
     AppImage,

src/store/fs.rs

@@ -1,3 +1,5 @@
+//! Provides a JSON file-based implementation for the caching system.
+
 use std::collections::HashMap;
 
 use serde::{Deserialize, Serialize};
@@ -7,9 +9,12 @@ use crate::model::{PacBuild, Repository};
 use crate::store::base::{Base, StoreResult};
 use crate::store::filters::{InstallState, Kind};
 
+#[cfg(not(test))]
 const FSS_PATH: &str = "/etc/pacstall/fss.json";
+#[cfg(test)]
+const FSS_PATH: &str = "./fss.json";
 
-/// `FileSystem` implementation for caching
+/// `FileSystem` implementation for the caching system
 #[derive(Debug, Serialize, Deserialize, Clone)]
 pub struct FileSystemStore {
     repositories: Vec<Repository>,

src/store/mod.rs

@@ -1,3 +1,5 @@
+//! Provides traits and structs to handle Pacstall's cache.
+
 pub mod base;
 pub mod errors;
 pub mod filters;