Append I to interface traits

This commit is contained in:
Wojciech Kozlowski 2023-05-10 22:21:31 +02:00
parent 712d3a65a7
commit aabb4076ff
9 changed files with 23 additions and 23 deletions

View File

@ -6,7 +6,7 @@ use serde::Serialize;
#[cfg(test)] #[cfg(test)]
use mockall::automock; use mockall::automock;
use super::{Database, Error}; use super::{Error, IDatabase};
pub mod backend; pub mod backend;
@ -39,7 +39,7 @@ impl<JDB: JsonDatabaseBackend> JsonDatabase<JDB> {
} }
} }
impl<JDB: JsonDatabaseBackend> Database for JsonDatabase<JDB> { impl<JDB: JsonDatabaseBackend> IDatabase for JsonDatabase<JDB> {
fn read<D: DeserializeOwned>(&self, collection: &mut D) -> Result<(), Error> { fn read<D: DeserializeOwned>(&self, collection: &mut D) -> Result<(), Error> {
let serialized = self.backend.read()?; let serialized = self.backend.read()?;
*collection = serde_json::from_str(&serialized)?; *collection = serde_json::from_str(&serialized)?;

View File

@ -38,7 +38,7 @@ impl From<std::io::Error> for Error {
/// Trait for interacting with the database. /// Trait for interacting with the database.
#[cfg_attr(test, automock)] #[cfg_attr(test, automock)]
pub trait Database { pub trait IDatabase {
/// Read collection from the database. /// Read collection from the database.
fn read<D: DeserializeOwned + 'static>(&self, collection: &mut D) -> Result<(), Error>; fn read<D: DeserializeOwned + 'static>(&self, collection: &mut D) -> Result<(), Error>;

View File

@ -5,8 +5,8 @@ pub mod library;
use std::fmt; use std::fmt;
use database::Database; use database::IDatabase;
use library::{Library, Query}; use library::{ILibrary, Query};
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use uuid::Uuid; use uuid::Uuid;
@ -99,7 +99,7 @@ pub struct MusicHoard<LIB, DB> {
collection: Collection, collection: Collection,
} }
impl<LIB: Library, DB: Database> MusicHoard<LIB, DB> { impl<LIB: ILibrary, DB: IDatabase> MusicHoard<LIB, DB> {
/// Create a new [`MusicHoard`] with the provided [`Library`] and [`Database`]. /// Create a new [`MusicHoard`] with the provided [`Library`] and [`Database`].
pub fn new(library: LIB, database: DB) -> Self { pub fn new(library: LIB, database: DB) -> Self {
MusicHoard { MusicHoard {
@ -133,7 +133,7 @@ mod tests {
use mockall::predicate; use mockall::predicate;
use once_cell::sync::Lazy; use once_cell::sync::Lazy;
use crate::{database::MockDatabase, library::MockLibrary}; use crate::{database::MockIDatabase, library::MockILibrary};
use super::*; use super::*;
@ -141,8 +141,8 @@ mod tests {
#[test] #[test]
fn read_get_write() { fn read_get_write() {
let mut library = MockLibrary::new(); let mut library = MockILibrary::new();
let mut database = MockDatabase::new(); let mut database = MockIDatabase::new();
let library_input = Query::new(); let library_input = Query::new();
let library_result = Ok(COLLECTION.to_owned()); let library_result = Ok(COLLECTION.to_owned());
@ -171,8 +171,8 @@ mod tests {
#[test] #[test]
fn library_error() { fn library_error() {
let mut library = MockLibrary::new(); let mut library = MockILibrary::new();
let database = MockDatabase::new(); let database = MockIDatabase::new();
let library_result = Err(library::Error::Invalid(String::from("invalid data"))); let library_result = Err(library::Error::Invalid(String::from("invalid data")));
@ -193,8 +193,8 @@ mod tests {
#[test] #[test]
fn database_error() { fn database_error() {
let library = MockLibrary::new(); let library = MockILibrary::new();
let mut database = MockDatabase::new(); let mut database = MockIDatabase::new();
let database_result = Err(database::Error::IoError(String::from("I/O error"))); let database_result = Err(database::Error::IoError(String::from("I/O error")));

View File

@ -11,7 +11,7 @@ use mockall::automock;
use crate::{Album, AlbumId, Artist, ArtistId, Track, TrackFormat}; use crate::{Album, AlbumId, Artist, ArtistId, Track, TrackFormat};
use super::{Error, Field, Library, Query}; use super::{Error, Field, ILibrary, Query};
pub mod executor; pub mod executor;
@ -101,7 +101,7 @@ impl<BLE: BeetsLibraryExecutor> BeetsLibrary<BLE> {
} }
} }
impl<BLE: BeetsLibraryExecutor> Library for BeetsLibrary<BLE> { impl<BLE: BeetsLibraryExecutor> ILibrary for BeetsLibrary<BLE> {
fn list(&mut self, query: &Query) -> Result<Vec<Artist>, Error> { fn list(&mut self, query: &Query) -> Result<Vec<Artist>, Error> {
let cmd = Self::list_cmd_and_args(query); let cmd = Self::list_cmd_and_args(query);
let output = self.executor.exec(&cmd)?; let output = self.executor.exec(&cmd)?;

View File

@ -105,7 +105,7 @@ impl From<Utf8Error> for Error {
/// Trait for interacting with the music library. /// Trait for interacting with the music library.
#[cfg_attr(test, automock)] #[cfg_attr(test, automock)]
pub trait Library { pub trait ILibrary {
/// List lirbary items that match the a specific query. /// List lirbary items that match the a specific query.
fn list(&mut self, query: &Query) -> Result<Vec<Artist>, Error>; fn list(&mut self, query: &Query) -> Result<Vec<Artist>, Error>;
} }

View File

@ -7,14 +7,14 @@ use structopt::StructOpt;
use musichoard::{ use musichoard::{
database::{ database::{
json::{backend::JsonDatabaseFileBackend, JsonDatabase}, json::{backend::JsonDatabaseFileBackend, JsonDatabase},
Database, IDatabase,
}, },
library::{ library::{
beets::{ beets::{
executor::{ssh::BeetsLibrarySshExecutor, BeetsLibraryProcessExecutor}, executor::{ssh::BeetsLibrarySshExecutor, BeetsLibraryProcessExecutor},
BeetsLibrary, BeetsLibrary,
}, },
Library, ILibrary,
}, },
MusicHoard, MusicHoard,
}; };
@ -39,7 +39,7 @@ struct Opt {
database_file_path: PathBuf, database_file_path: PathBuf,
} }
fn with<LIB: Library, DB: Database>(lib: LIB, db: DB) { fn with<LIB: ILibrary, DB: IDatabase>(lib: LIB, db: DB) {
let music_hoard = MusicHoard::new(lib, db); let music_hoard = MusicHoard::new(lib, db);
// Initialize the terminal user interface. // Initialize the terminal user interface.

View File

@ -1,4 +1,4 @@
use musichoard::{MusicHoard, library::Library, database::Database, Collection}; use musichoard::{database::IDatabase, library::ILibrary, Collection, MusicHoard};
#[cfg(test)] #[cfg(test)]
use mockall::automock; use mockall::automock;
@ -18,7 +18,7 @@ impl From<musichoard::Error> for Error {
} }
// GRCOV_EXCL_START // GRCOV_EXCL_START
impl<LIB: Library, DB: Database> IMusicHoard for MusicHoard<LIB, DB> { impl<LIB: ILibrary, DB: IDatabase> IMusicHoard for MusicHoard<LIB, DB> {
fn rescan_library(&mut self) -> Result<(), Error> { fn rescan_library(&mut self) -> Result<(), Error> {
Ok(MusicHoard::rescan_library(self)?) Ok(MusicHoard::rescan_library(self)?)
} }

View File

@ -3,7 +3,7 @@ use std::{fs, path::PathBuf};
use musichoard::{ use musichoard::{
database::{ database::{
json::{backend::JsonDatabaseFileBackend, JsonDatabase}, json::{backend::JsonDatabaseFileBackend, JsonDatabase},
Database, IDatabase,
}, },
Artist, Artist,
}; };

View File

@ -9,7 +9,7 @@ use once_cell::sync::Lazy;
use musichoard::{ use musichoard::{
library::{ library::{
beets::{executor::BeetsLibraryProcessExecutor, BeetsLibrary}, beets::{executor::BeetsLibraryProcessExecutor, BeetsLibrary},
Field, Library, Query, Field, ILibrary, Query,
}, },
Artist, Artist,
}; };