musichoard/src/lib.rs

//! MusicHoard - a music collection manager.

pub mod database;
pub mod library;

use std::{
    cmp::Ordering,
    collections::{HashMap, HashSet},
    fmt::{self, Debug, Display},
    iter::Peekable,
    mem,
};

use database::IDatabase;
use library::{ILibrary, Item, Query};
use paste::paste;
use serde::{Deserialize, Serialize};
use url::Url;
use uuid::Uuid;

/// An object with the [`IUrl`] trait contains a valid URL.
pub trait IUrl {
    fn url(&self) -> &str;
}

/// An object with the [`IMbid`] trait contains a [MusicBrainz
/// Identifier](https://musicbrainz.org/doc/MusicBrainz_Identifier) (MBID).
pub trait IMbid {
    fn mbid(&self) -> &str;
}

#[derive(Debug)]
enum UrlType {
    MusicBrainz,
    MusicButler,
    Bandcamp,
    Qobuz,
}

struct InvalidUrlError {
    url_type: UrlType,
    url: String,
}

impl Display for InvalidUrlError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "invalid url of type {:?}: {}", self.url_type, self.url)
    }
}

/// MusicBrainz reference.
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq, PartialOrd, Ord)]
pub struct MusicBrainz(Url);

impl MusicBrainz {
    pub fn new<S: AsRef<str>>(url: S) -> Result<Self, Error> {
        let url = Url::parse(url.as_ref())?;

        if !url
            .domain()
            .map(|u| u.ends_with("musicbrainz.org"))
            .unwrap_or(false)
        {
            return Err(Self::invalid_url_error(url).into());
        }

        match url.path_segments().and_then(|mut ps| ps.nth(1)) {
            Some(segment) => Uuid::try_parse(segment)?,
            None => return Err(Self::invalid_url_error(url).into()),
        };

        Ok(MusicBrainz(url))
    }

    fn invalid_url_error<S: Into<String>>(url: S) -> InvalidUrlError {
        InvalidUrlError {
            url_type: UrlType::MusicBrainz,
            url: url.into(),
        }
    }
}

impl TryFrom<&str> for MusicBrainz {
    type Error = Error;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        MusicBrainz::new(value)
    }
}

impl Display for MusicBrainz {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl IUrl for MusicBrainz {
    fn url(&self) -> &str {
        self.0.as_str()
    }
}

impl IMbid for MusicBrainz {
    fn mbid(&self) -> &str {
        // The URL is assumed to have been validated.
        self.0.path_segments().and_then(|mut ps| ps.nth(1)).unwrap()
    }
}

/// MusicButler reference.
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq, PartialOrd, Ord)]
pub struct MusicButler(Url);

impl MusicButler {
    pub fn new<S: AsRef<str>>(url: S) -> Result<Self, Error> {
        let url = Url::parse(url.as_ref())?;

        if !url
            .domain()
            .map(|u| u.ends_with("musicbutler.io"))
            .unwrap_or(false)
        {
            return Err(Self::invalid_url_error(url).into());
        }

        Ok(MusicButler(url))
    }

    pub fn as_str(&self) -> &str {
        self.0.as_str()
    }

    fn invalid_url_error<S: Into<String>>(url: S) -> InvalidUrlError {
        InvalidUrlError {
            url_type: UrlType::MusicButler,
            url: url.into(),
        }
    }
}

impl TryFrom<&str> for MusicButler {
    type Error = Error;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        MusicButler::new(value)
    }
}

impl IUrl for MusicButler {
    fn url(&self) -> &str {
        self.0.as_str()
    }
}

/// Bandcamp reference.
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq, PartialOrd, Ord)]
pub struct Bandcamp(Url);

impl Bandcamp {
    pub fn new<S: AsRef<str>>(url: S) -> Result<Self, Error> {
        let url = Url::parse(url.as_ref())?;

        if !url
            .domain()
            .map(|u| u.ends_with("bandcamp.com"))
            .unwrap_or(false)
        {
            return Err(Self::invalid_url_error(url).into());
        }

        Ok(Bandcamp(url))
    }

    pub fn as_str(&self) -> &str {
        self.0.as_str()
    }

    fn invalid_url_error<S: Into<String>>(url: S) -> InvalidUrlError {
        InvalidUrlError {
            url_type: UrlType::Bandcamp,
            url: url.into(),
        }
    }
}

impl TryFrom<&str> for Bandcamp {
    type Error = Error;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        Bandcamp::new(value)
    }
}

impl IUrl for Bandcamp {
    fn url(&self) -> &str {
        self.0.as_str()
    }
}

/// Qobuz reference.
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq, PartialOrd, Ord)]
pub struct Qobuz(Url);

impl Qobuz {
    pub fn new<S: AsRef<str>>(url: S) -> Result<Self, Error> {
        let url = Url::parse(url.as_ref())?;

        if !url
            .domain()
            .map(|u| u.ends_with("qobuz.com"))
            .unwrap_or(false)
        {
            return Err(Self::invalid_url_error(url).into());
        }

        Ok(Qobuz(url))
    }

    fn invalid_url_error<S: Into<String>>(url: S) -> InvalidUrlError {
        InvalidUrlError {
            url_type: UrlType::Qobuz,
            url: url.into(),
        }
    }
}

impl TryFrom<&str> for Qobuz {
    type Error = Error;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        Qobuz::new(value)
    }
}

impl Display for Qobuz {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl IUrl for Qobuz {
    fn url(&self) -> &str {
        self.0.as_str()
    }
}

/// The track file format.
#[derive(Clone, Copy, Debug, Deserialize, Serialize, PartialEq, Eq, Hash)]
pub enum Format {
    Flac,
    Mp3,
}

/// The track quality. Combines format and bitrate information.
#[derive(Clone, Copy, Debug, Deserialize, Serialize, PartialEq, Eq)]
pub struct Quality {
    pub format: Format,
    pub bitrate: u32,
}

/// The track identifier.
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct TrackId {
    pub number: u32,
    pub title: String,
}

/// A single track on an album.
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
pub struct Track {
    pub id: TrackId,
    pub artist: Vec<String>,
    pub quality: Quality,
}

impl PartialOrd for Track {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for Track {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        self.id.cmp(&other.id)
    }
}

impl Merge for Track {
    fn merge(self, other: Self) -> Self {
        assert_eq!(self.id, other.id);
        self
    }
}

/// The album identifier.
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, PartialOrd, Ord, Eq, Hash)]
pub struct AlbumId {
    pub year: u32,
    pub title: String,
}

/// An album is a collection of tracks that were released together.
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
pub struct Album {
    pub id: AlbumId,
    pub tracks: Vec<Track>,
}

impl PartialOrd for Album {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for Album {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        self.id.cmp(&other.id)
    }
}

impl Merge for Album {
    fn merge(mut self, other: Self) -> Self {
        assert_eq!(self.id, other.id);
        self.tracks = MergeSorted::new(self.tracks.into_iter(), other.tracks.into_iter()).collect();
        self
    }
}

/// The artist identifier.
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct ArtistId {
    pub name: String,
}

impl AsRef<ArtistId> for ArtistId {
    fn as_ref(&self) -> &ArtistId {
        self
    }
}

impl ArtistId {
    pub fn new<S: Into<String>>(name: S) -> ArtistId {
        ArtistId { name: name.into() }
    }
}

impl Display for ArtistId {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.name)
    }
}

/// The artist properties.
#[derive(Clone, Debug, Default, Deserialize, Serialize, PartialEq, Eq)]
pub struct ArtistProperties {
    pub musicbrainz: Option<MusicBrainz>,
    pub musicbutler: Vec<MusicButler>,
    pub bandcamp: Vec<Bandcamp>,
    pub qobuz: Option<Qobuz>,
}

impl Merge for ArtistProperties {
    fn merge(mut self, other: Self) -> Self {
        self.musicbrainz = Self::merge_opts(self.musicbrainz, other.musicbrainz);
        self.musicbutler = Self::merge_vecs(self.musicbutler, other.musicbutler);
        self.bandcamp = Self::merge_vecs(self.bandcamp, other.bandcamp);
        self.qobuz = Self::merge_opts(self.qobuz, other.qobuz);

        self
    }
}

/// An artist.
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
pub struct Artist {
    pub id: ArtistId,
    pub properties: ArtistProperties,
    pub albums: Vec<Album>,
}

macro_rules! artist_unique_url_dispatch {
    ($field:ident) => {
        paste! {
            fn [<add_ $field _url>]<S: AsRef<str>>(&mut self, url: S) -> Result<(), Error> {
                Self::add_unique_url(&mut self.properties.$field, url)
            }

            fn [<remove_ $field _url>]<S: AsRef<str>>(&mut self, url: S) -> Result<(), Error> {
                Self::remove_unique_url(&mut self.properties.$field, url)
            }

            fn [<set_ $field _url>]<S: AsRef<str>>(&mut self, url: S) -> Result<(), Error> {
                Self::set_unique_url(&mut self.properties.$field, url)
            }

            fn [<clear_ $field _url>](&mut self) {
                Self::clear_unique_url(&mut self.properties.$field);
            }
        }
    };
}

macro_rules! artist_multi_url_dispatch {
    ($field:ident) => {
        paste! {
            fn [<add_ $field _urls>]<S: AsRef<str>>(&mut self, urls: Vec<S>) -> Result<(), Error> {
                Self::add_multi_urls(&mut self.properties.$field, urls)
            }

            fn [<remove_ $field _urls>]<S: AsRef<str>>(&mut self, urls: Vec<S>) -> Result<(), Error> {
                Self::remove_multi_urls(&mut self.properties.$field, urls)
            }

            fn [<set_ $field _urls>]<S: AsRef<str>>(&mut self, urls: Vec<S>) -> Result<(), Error> {
                Self::set_multi_urls(&mut self.properties.$field, urls)
            }

            fn [<clear_ $field _urls>](&mut self) {
                Self::clear_multi_urls(&mut self.properties.$field);
            }
        }
    };
}

impl Artist {
    pub fn new<ID: Into<ArtistId>>(id: ID) -> Self {
        Artist {
            id: id.into(),
            properties: ArtistProperties::default(),
            albums: vec![],
        }
    }

    fn add_unique_url<S: AsRef<str>, T: for<'a> TryFrom<&'a str, Error = Error> + Eq + Display>(
        container: &mut Option<T>,
        url: S,
    ) -> Result<(), Error> {
        let url: T = url.as_ref().try_into()?;

        match container {
            Some(current) => {
                if current != &url {
                    return Err(Error::CollectionError(format!(
                        "artist already has a different URL: {}",
                        current
                    )));
                }
            }
            None => {
                _ = container.insert(url);
            }
        }

        Ok(())
    }

    fn remove_unique_url<S: AsRef<str>, T: for<'a> TryFrom<&'a str, Error = Error> + Eq>(
        container: &mut Option<T>,
        url: S,
    ) -> Result<(), Error> {
        let url: T = url.as_ref().try_into()?;

        if container == &Some(url) {
            _ = container.take();
        }

        Ok(())
    }

    fn set_unique_url<S: AsRef<str>, T: for<'a> TryFrom<&'a str, Error = Error>>(
        container: &mut Option<T>,
        url: S,
    ) -> Result<(), Error> {
        _ = container.insert(url.as_ref().try_into()?);
        Ok(())
    }

    fn clear_unique_url<T>(container: &mut Option<T>) {
        _ = container.take();
    }

    fn add_multi_urls<S: AsRef<str>, T: for<'a> TryFrom<&'a str, Error = Error> + Eq>(
        container: &mut Vec<T>,
        urls: Vec<S>,
    ) -> Result<(), Error> {
        let mut new_urls = urls
            .iter()
            .map(|url| url.as_ref().try_into())
            .filter(|res| {
                res.as_ref()
                    .map(|url| !container.contains(url))
                    .unwrap_or(true) // Propagate errors.
            })
            .collect::<Result<Vec<T>, Error>>()?;

        container.append(&mut new_urls);
        Ok(())
    }

    fn remove_multi_urls<S: AsRef<str>, T: for<'a> TryFrom<&'a str, Error = Error> + Eq>(
        container: &mut Vec<T>,
        urls: Vec<S>,
    ) -> Result<(), Error> {
        let urls = urls
            .iter()
            .map(|url| url.as_ref().try_into())
            .collect::<Result<Vec<T>, Error>>()?;

        container.retain(|url| !urls.contains(url));
        Ok(())
    }

    fn set_multi_urls<S: AsRef<str>, T: for<'a> TryFrom<&'a str, Error = Error>>(
        container: &mut Vec<T>,
        urls: Vec<S>,
    ) -> Result<(), Error> {
        let mut urls = urls
            .iter()
            .map(|url| url.as_ref().try_into())
            .collect::<Result<Vec<T>, Error>>()?;

        container.clear();
        container.append(&mut urls);
        Ok(())
    }

    fn clear_multi_urls<T>(container: &mut Vec<T>) {
        container.clear();
    }

    artist_unique_url_dispatch!(musicbrainz);

    artist_multi_url_dispatch!(musicbutler);

    artist_multi_url_dispatch!(bandcamp);

    artist_unique_url_dispatch!(qobuz);
}

impl PartialOrd for Artist {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for Artist {
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        self.id.cmp(&other.id)
    }
}

impl Merge for Artist {
    fn merge(mut self, other: Self) -> Self {
        assert_eq!(self.id, other.id);
        self.properties = self.properties.merge(other.properties);
        self.albums = MergeSorted::new(self.albums.into_iter(), other.albums.into_iter()).collect();
        self
    }
}

/// The collection type. Currently, a collection is a list of artists.
pub type Collection = Vec<Artist>;

trait Merge {
    fn merge(self, other: Self) -> Self;

    fn merge_opts<T>(this: Option<T>, other: Option<T>) -> Option<T> {
        match &this {
            Some(_) => this,
            None => other,
        }
    }

    fn merge_vecs<T: Ord + Eq>(mut this: Vec<T>, mut other: Vec<T>) -> Vec<T> {
        this.append(&mut other);
        this.sort_unstable();
        this.dedup();
        this
    }
}

struct MergeSorted<L, R>
where
    L: Iterator<Item = R::Item>,
    R: Iterator,
{
    left: Peekable<L>,
    right: Peekable<R>,
}

impl<L, R> MergeSorted<L, R>
where
    L: Iterator<Item = R::Item>,
    R: Iterator,
{
    fn new(left: L, right: R) -> MergeSorted<L, R> {
        MergeSorted {
            left: left.peekable(),
            right: right.peekable(),
        }
    }
}

impl<L, R> Iterator for MergeSorted<L, R>
where
    L: Iterator<Item = R::Item>,
    R: Iterator,
    L::Item: Ord + Merge,
{
    type Item = L::Item;

    fn next(&mut self) -> Option<L::Item> {
        let which = match (self.left.peek(), self.right.peek()) {
            (Some(l), Some(r)) => l.cmp(r),
            (Some(_), None) => Ordering::Less,
            (None, Some(_)) => Ordering::Greater,
            (None, None) => return None,
        };

        match which {
            Ordering::Less => self.left.next(),
            Ordering::Equal => Some(self.left.next().unwrap().merge(self.right.next().unwrap())),
            Ordering::Greater => self.right.next(),
        }
    }
}

/// Error type for `musichoard`.
#[derive(Debug, PartialEq, Eq)]
pub enum Error {
    /// The [`MusicHoard`] is not able to read/write its in-memory collection.
    CollectionError(String),
    /// The [`MusicHoard`] failed to read/write from/to the library.
    LibraryError(String),
    /// The [`MusicHoard`] failed to read/write from/to the database.
    DatabaseError(String),
    /// The [`MusicHoard`] failed to parse a user-provided URL.
    UrlParseError(String),
    /// The user-provided URL is not valid.
    InvalidUrlError(String),
}

impl Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            Self::CollectionError(ref s) => write!(f, "failed to read/write the collection: {s}"),
            Self::LibraryError(ref s) => write!(f, "failed to read/write from/to the library: {s}"),
            Self::DatabaseError(ref s) => {
                write!(f, "failed to read/write from/to the database: {s}")
            }
            Self::UrlParseError(ref s) => write!(f, "failed to parse a user-provided URL: {s}"),
            Self::InvalidUrlError(ref s) => write!(f, "user-provided URL is invalid: {s}"),
        }
    }
}

impl From<library::Error> for Error {
    fn from(err: library::Error) -> Error {
        Error::LibraryError(err.to_string())
    }
}

impl From<database::LoadError> for Error {
    fn from(err: database::LoadError) -> Error {
        Error::DatabaseError(err.to_string())
    }
}

impl From<database::SaveError> for Error {
    fn from(err: database::SaveError) -> Error {
        Error::DatabaseError(err.to_string())
    }
}

impl From<url::ParseError> for Error {
    fn from(err: url::ParseError) -> Error {
        Error::UrlParseError(err.to_string())
    }
}

impl From<uuid::Error> for Error {
    fn from(err: uuid::Error) -> Error {
        Error::UrlParseError(err.to_string())
    }
}

impl From<InvalidUrlError> for Error {
    fn from(err: InvalidUrlError) -> Error {
        Error::InvalidUrlError(err.to_string())
    }
}

/// The Music Hoard. It is responsible for pulling information from both the library and the
/// database, ensuring its consistent and writing back any changes.
pub struct MusicHoard<LIB, DB> {
    library: Option<LIB>,
    database: Option<DB>,
    collection: Collection,
}

macro_rules! music_hoard_unique_url_dispatch {
    ($field:ident) => {
        paste! {
            pub fn [<add_ $field _url>]<ID: AsRef<ArtistId>, S: AsRef<str>>(
                &mut self,
                artist_id: ID,
                url: S,
            ) -> Result<(), Error> {
                self.get_artist_or_err(artist_id.as_ref())?.[<add_ $field _url>](url)
            }

            pub fn [<remove_ $field _url>]<ID: AsRef<ArtistId>, S: AsRef<str>>(
                &mut self,
                artist_id: ID,
                url: S,
            ) -> Result<(), Error> {
                self.get_artist_or_err(artist_id.as_ref())?.[<remove_ $field _url>](url)
            }

            pub fn [<set_ $field _url>]<ID: AsRef<ArtistId>, S: AsRef<str>>(
                &mut self,
                artist_id: ID,
                url: S,
            ) -> Result<(), Error> {
                self.get_artist_or_err(artist_id.as_ref())?.[<set_ $field _url>](url)
            }

            pub fn [<clear_ $field _url>]<ID: AsRef<ArtistId>>(
                &mut self,
                artist_id: ID,
            ) -> Result<(), Error> {
                self.get_artist_or_err(artist_id.as_ref())?.[<clear_ $field _url>]();
                Ok(())
            }
        }
    };
}

macro_rules! music_hoard_multi_url_dispatch {
    ($field:ident) => {
        paste! {
            pub fn [<add_ $field _urls>]<ID: AsRef<ArtistId>, S: AsRef<str>>(
                &mut self,
                artist_id: ID,
                urls: Vec<S>,
            ) -> Result<(), Error> {
                self.get_artist_or_err(artist_id.as_ref())?.[<add_ $field _urls>](urls)
            }

            pub fn [<remove_ $field _urls>]<ID: AsRef<ArtistId>, S: AsRef<str>>(
                &mut self,
                artist_id: ID,
                urls: Vec<S>,
            ) -> Result<(), Error> {
                self.get_artist_or_err(artist_id.as_ref())?.[<remove_ $field _urls>](urls)
            }

            pub fn [<set_ $field _urls>]<ID: AsRef<ArtistId>, S: AsRef<str>>(
                &mut self,
                artist_id: ID,
                urls: Vec<S>,
            ) -> Result<(), Error> {
                self.get_artist_or_err(artist_id.as_ref())?.[<set_ $field _urls>](urls)
            }

            pub fn [<clear_ $field _urls>]<ID: AsRef<ArtistId>>(
                &mut self, artist_id: ID,
            ) -> Result<(), Error> {
                self.get_artist_or_err(artist_id.as_ref())?.[<clear_ $field _urls>]();
                Ok(())
            }
        }
    };
}

impl<LIB: ILibrary, DB: IDatabase> MusicHoard<LIB, DB> {
    /// Create a new [`MusicHoard`] with the provided [`ILibrary`] and [`IDatabase`].
    pub fn new(library: Option<LIB>, database: Option<DB>) -> Self {
        MusicHoard {
            library,
            database,
            collection: vec![],
        }
    }

    pub fn get_collection(&self) -> &Collection {
        &self.collection
    }

    pub fn rescan_library(&mut self) -> Result<(), Error> {
        match self.library {
            Some(ref mut library) => {
                let items = library.list(&Query::new())?;
                let mut library_collection = Self::items_to_artists(items);
                Self::sort(&mut library_collection);

                let collection = mem::take(&mut self.collection);
                self.collection = Self::merge(library_collection, collection);

                Ok(())
            }
            None => Err(Error::LibraryError(String::from("library not provided"))),
        }
    }

    pub fn load_from_database(&mut self) -> Result<(), Error> {
        match self.database {
            Some(ref mut database) => {
                let mut database_collection: Collection = vec![];
                database.load(&mut database_collection)?;
                Self::sort(&mut database_collection);

                let collection = mem::take(&mut self.collection);
                self.collection = Self::merge(collection, database_collection);

                Ok(())
            }
            None => Err(Error::DatabaseError(String::from("database not provided"))),
        }
    }

    pub fn save_to_database(&mut self) -> Result<(), Error> {
        match self.database {
            Some(ref mut database) => {
                database.save(&self.collection)?;
                Ok(())
            }
            None => Err(Error::DatabaseError(String::from("database not provided"))),
        }
    }

    pub fn new_artist<ID: Into<ArtistId>>(&mut self, artist_id: ID) -> Result<(), Error> {
        let artist_id: ArtistId = artist_id.into();
        if let Ok(artist) = self.get_artist_or_err(&artist_id) {
            return Err(Error::CollectionError(format!(
                "artist '{}' is already in the collection",
                artist.id
            )));
        }

        let new_artist = vec![Artist::new(artist_id)];

        let collection = mem::take(&mut self.collection);
        self.collection = Self::merge(collection, new_artist);

        Ok(())
    }

    pub fn delete_artist<ID: AsRef<ArtistId>>(&mut self, artist_id: ID) -> Result<(), Error> {
        let index_opt = self
            .collection
            .iter()
            .position(|a| &a.id == artist_id.as_ref());

        match index_opt {
            Some(index) => {
                self.collection.remove(index);
                Ok(())
            }
            None => Err(Error::CollectionError(format!(
                "artist '{}' is not in the collection",
                artist_id.as_ref()
            ))),
        }
    }

    music_hoard_unique_url_dispatch!(musicbrainz);

    music_hoard_multi_url_dispatch!(musicbutler);

    music_hoard_multi_url_dispatch!(bandcamp);

    music_hoard_unique_url_dispatch!(qobuz);

    fn sort(collection: &mut [Artist]) {
        collection.sort_unstable();
        for artist in collection.iter_mut() {
            artist.albums.sort_unstable();
            for album in artist.albums.iter_mut() {
                album.tracks.sort_unstable();
            }
        }
    }

    fn merge(primary: Vec<Artist>, secondary: Vec<Artist>) -> Vec<Artist> {
        MergeSorted::new(primary.into_iter(), secondary.into_iter()).collect()
    }

    fn items_to_artists(items: Vec<Item>) -> Vec<Artist> {
        let mut artists: Vec<Artist> = vec![];
        let mut album_ids = HashMap::<ArtistId, HashSet<AlbumId>>::new();

        for item in items.into_iter() {
            let artist_id = ArtistId {
                name: item.album_artist,
            };

            let album_id = AlbumId {
                year: item.album_year,
                title: item.album_title,
            };

            let track = Track {
                id: TrackId {
                    number: item.track_number,
                    title: item.track_title,
                },
                artist: item.track_artist,
                quality: Quality {
                    format: item.track_format,
                    bitrate: item.track_bitrate,
                },
            };

            let artist = if album_ids.contains_key(&artist_id) {
                // Assume results are in some order which means they will likely be grouped by
                // artist. Therefore, we look from the back since the last inserted artist is most
                // likely the one we are looking for.
                artists
                    .iter_mut()
                    .rev()
                    .find(|a| a.id == artist_id)
                    .unwrap()
            } else {
                album_ids.insert(artist_id.clone(), HashSet::<AlbumId>::new());
                artists.push(Artist::new(artist_id.clone()));
                artists.last_mut().unwrap()
            };

            if album_ids[&artist_id].contains(&album_id) {
                // Assume results are in some order which means they will likely be grouped by
                // album. Therefore, we look from the back since the last inserted album is most
                // likely the one we are looking for.
                let album = artist
                    .albums
                    .iter_mut()
                    .rev()
                    .find(|a| a.id == album_id)
                    .unwrap();
                album.tracks.push(track);
            } else {
                album_ids
                    .get_mut(&artist_id)
                    .unwrap()
                    .insert(album_id.clone());
                artist.albums.push(Album {
                    id: album_id,
                    tracks: vec![track],
                });
            }
        }

        artists
    }

    fn get_artist_or_err(&mut self, artist_id: &ArtistId) -> Result<&mut Artist, Error> {
        self.collection
            .iter_mut()
            .find(|a| &a.id == artist_id)
            .ok_or_else(|| {
                Error::CollectionError(format!("artist '{}' is not in the collection", artist_id))
            })
    }
}

#[cfg(test)]
#[macro_use]
mod testlib;

#[cfg(test)]
mod tests {
    use mockall::predicate;
    use once_cell::sync::Lazy;

    use crate::{
        database::{MockIDatabase, NoDatabase},
        library::{MockILibrary, NoLibrary},
    };

    use super::*;

    static MUSICBRAINZ: &str =
        "https://musicbrainz.org/artist/d368baa8-21ca-4759-9731-0b2753071ad8";
    static MUSICBRAINZ_2: &str =
        "https://musicbrainz.org/artist/823869a5-5ded-4f6b-9fb7-2a9344d83c6b";
    static MUSICBUTLER: &str = "https://www.musicbutler.io/artist-page/483340948";
    static MUSICBUTLER_2: &str = "https://www.musicbutler.io/artist-page/658903042/";
    static BANDCAMP: &str = "https://thelasthangmen.bandcamp.com/";
    static BANDCAMP_2: &str = "https://viciouscrusade.bandcamp.com/";
    static QOBUZ: &str = "https://www.qobuz.com/nl-nl/interpreter/the-last-hangmen/1244413";
    static QOBUZ_2: &str = "https://www.qobuz.com/nl-nl/interpreter/vicious-crusade/7522386";

    pub static COLLECTION: Lazy<Vec<Artist>> = Lazy::new(|| collection!());

    pub fn artist_to_items(artist: &Artist) -> Vec<Item> {
        let mut items = vec![];

        for album in artist.albums.iter() {
            for track in album.tracks.iter() {
                items.push(Item {
                    album_artist: artist.id.name.clone(),
                    album_year: album.id.year,
                    album_title: album.id.title.clone(),
                    track_number: track.id.number,
                    track_title: track.id.title.clone(),
                    track_artist: track.artist.clone(),
                    track_format: track.quality.format,
                    track_bitrate: track.quality.bitrate,
                });
            }
        }

        items
    }

    pub fn artists_to_items(artists: &[Artist]) -> Vec<Item> {
        let mut items = vec![];
        for artist in artists.iter() {
            items.append(&mut artist_to_items(artist));
        }
        items
    }

    fn clean_collection(mut collection: Collection) -> Collection {
        for artist in collection.iter_mut() {
            artist.properties = ArtistProperties::default();
        }
        collection
    }

    #[test]
    fn musicbrainz() {
        let uuid = "d368baa8-21ca-4759-9731-0b2753071ad8";
        let url = format!("https://musicbrainz.org/artist/{uuid}");
        let mb = MusicBrainz::new(&url).unwrap();
        assert_eq!(url, mb.url());
        assert_eq!(uuid, mb.mbid());

        let url = "not a url at all".to_string();
        let expected_error: Error = url::ParseError::RelativeUrlWithoutBase.into();
        let actual_error = MusicBrainz::new(url).unwrap_err();
        assert_eq!(actual_error, expected_error);
        assert_eq!(actual_error.to_string(), expected_error.to_string());

        let url = "https://musicbrainz.org/artist/i-am-not-a-uuid".to_string();
        let expected_error: Error = Uuid::try_parse("i-am-not-a-uuid").unwrap_err().into();
        let actual_error = MusicBrainz::new(url).unwrap_err();
        assert_eq!(actual_error, expected_error);
        assert_eq!(actual_error.to_string(), expected_error.to_string());

        let url = "https://musicbrainz.org/artist".to_string();
        let expected_error: Error = InvalidUrlError {
            url_type: UrlType::MusicBrainz,
            url: url.clone(),
        }
        .into();
        let actual_error = MusicBrainz::new(&url).unwrap_err();
        assert_eq!(actual_error, expected_error);
        assert_eq!(actual_error.to_string(), expected_error.to_string());
    }

    #[test]
    fn urls() {
        assert!(MusicBrainz::new(MUSICBRAINZ).is_ok());
        assert!(MusicBrainz::new(MUSICBUTLER).is_err());
        assert!(MusicBrainz::new(BANDCAMP).is_err());
        assert!(MusicBrainz::new(QOBUZ).is_err());

        assert!(MusicButler::new(MUSICBRAINZ).is_err());
        assert!(MusicButler::new(MUSICBUTLER).is_ok());
        assert!(MusicButler::new(BANDCAMP).is_err());
        assert!(MusicButler::new(QOBUZ).is_err());

        assert!(Bandcamp::new(MUSICBRAINZ).is_err());
        assert!(Bandcamp::new(MUSICBUTLER).is_err());
        assert!(Bandcamp::new(BANDCAMP).is_ok());
        assert!(Bandcamp::new(QOBUZ).is_err());

        assert!(Qobuz::new(MUSICBRAINZ).is_err());
        assert!(Qobuz::new(MUSICBUTLER).is_err());
        assert!(Qobuz::new(BANDCAMP).is_err());
        assert!(Qobuz::new(QOBUZ).is_ok());
    }

    #[test]
    fn artist_new_delete() {
        let artist_id = ArtistId::new("an artist");
        let artist_id_2 = ArtistId::new("another artist");
        let mut music_hoard = MusicHoard::<NoLibrary, NoDatabase>::new(None, None);

        assert!(music_hoard.new_artist(artist_id.clone()).is_ok());

        let actual_err = music_hoard.new_artist(artist_id.clone()).unwrap_err();
        let expected_err = Error::CollectionError(String::from(
            "artist 'an artist' is already in the collection",
        ));
        assert_eq!(actual_err, expected_err);
        assert_eq!(actual_err.to_string(), expected_err.to_string());

        let actual_err = music_hoard.delete_artist(&artist_id_2).unwrap_err();
        let expected_err = Error::CollectionError(String::from(
            "artist 'another artist' is not in the collection",
        ));
        assert_eq!(actual_err, expected_err);
        assert_eq!(actual_err.to_string(), expected_err.to_string());

        assert!(music_hoard.delete_artist(&artist_id).is_ok());
    }

    #[test]
    fn add_remove_musicbrainz_url() {
        let artist_id = ArtistId::new("an artist");
        let artist_id_2 = ArtistId::new("another artist");
        let mut music_hoard = MusicHoard::<NoLibrary, NoDatabase>::new(None, None);

        assert!(music_hoard.new_artist(artist_id.clone()).is_ok());

        let mut expected: Option<MusicBrainz> = None;
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        // Adding incorect URL is an error.
        assert!(music_hoard
            .add_musicbrainz_url(&artist_id, MUSICBUTLER)
            .is_err());
        assert!(music_hoard
            .add_musicbrainz_url(&artist_id, BANDCAMP)
            .is_err());
        assert!(music_hoard.add_musicbrainz_url(&artist_id, QOBUZ).is_err());
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        // Adding URL to an artist not in the collection is an error.
        assert!(music_hoard
            .add_musicbrainz_url(&artist_id_2, MUSICBRAINZ)
            .is_err());
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        // Adding URL to artist.
        assert!(music_hoard
            .add_musicbrainz_url(&artist_id, MUSICBRAINZ)
            .is_ok());
        _ = expected.insert(MusicBrainz::new(MUSICBRAINZ).unwrap());
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        // Adding the same URL again is ok, but does not do anything.
        assert!(music_hoard
            .add_musicbrainz_url(&artist_id, MUSICBRAINZ)
            .is_ok());
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        // Adding further URLs is an error.
        assert!(music_hoard
            .add_musicbrainz_url(&artist_id, MUSICBRAINZ_2)
            .is_err());
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        // Removing a URL from an artist not in the collection is an error.
        assert!(music_hoard
            .remove_musicbrainz_url(&artist_id_2, MUSICBRAINZ)
            .is_err());
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        // Removing a URL not in the collection is okay, but does not do anything.
        assert!(music_hoard
            .remove_musicbrainz_url(&artist_id, MUSICBRAINZ_2)
            .is_ok());
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        // Removing a URL in the collection removes it.
        assert!(music_hoard
            .remove_musicbrainz_url(&artist_id, MUSICBRAINZ)
            .is_ok());
        _ = expected.take();
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        assert!(music_hoard
            .remove_musicbrainz_url(&artist_id, MUSICBRAINZ)
            .is_ok());
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);
    }

    #[test]
    fn set_clear_musicbrainz_url() {
        let artist_id = ArtistId::new("an artist");
        let artist_id_2 = ArtistId::new("another artist");
        let mut music_hoard = MusicHoard::<NoLibrary, NoDatabase>::new(None, None);

        assert!(music_hoard.new_artist(artist_id.clone()).is_ok());

        let mut expected: Option<MusicBrainz> = None;
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        // Setting an incorrect URL is an error.
        assert!(music_hoard
            .set_musicbrainz_url(&artist_id, MUSICBUTLER)
            .is_err());
        assert!(music_hoard
            .set_musicbrainz_url(&artist_id, BANDCAMP)
            .is_err());
        assert!(music_hoard.set_musicbrainz_url(&artist_id, QOBUZ).is_err());
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        // Setting a URL on an artist not in the collection is an error.
        assert!(music_hoard
            .set_musicbrainz_url(&artist_id_2, MUSICBRAINZ)
            .is_err());
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        // Setting a URL on an artist.
        assert!(music_hoard
            .set_musicbrainz_url(&artist_id, MUSICBRAINZ)
            .is_ok());
        _ = expected.insert(MusicBrainz::new(MUSICBRAINZ).unwrap());
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        assert!(music_hoard
            .set_musicbrainz_url(&artist_id, MUSICBRAINZ)
            .is_ok());
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        assert!(music_hoard
            .set_musicbrainz_url(&artist_id, MUSICBRAINZ_2)
            .is_ok());
        _ = expected.insert(MusicBrainz::new(MUSICBRAINZ_2).unwrap());
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        // Clearing URLs on an artist that does not exist is an error.
        assert!(music_hoard.clear_musicbrainz_url(&artist_id_2).is_err());
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);

        // Clearing URLs.
        assert!(music_hoard.clear_musicbrainz_url(&artist_id).is_ok());
        _ = expected.take();
        assert_eq!(music_hoard.collection[0].properties.musicbrainz, expected);
    }

    #[test]
    fn add_remove_musicbutler_urls() {
        let artist_id = ArtistId::new("an artist");
        let artist_id_2 = ArtistId::new("another artist");
        let mut music_hoard = MusicHoard::<NoLibrary, NoDatabase>::new(None, None);

        assert!(music_hoard.new_artist(artist_id.clone()).is_ok());

        let mut expected: Vec<MusicButler> = vec![];
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // If any URL is incorrect adding URLs is an error.
        assert!(music_hoard
            .add_musicbutler_urls(&artist_id, vec![MUSICBRAINZ, MUSICBRAINZ_2])
            .is_err());
        assert!(music_hoard
            .add_musicbutler_urls(&artist_id, vec![BANDCAMP, BANDCAMP_2])
            .is_err());
        assert!(music_hoard
            .add_musicbutler_urls(&artist_id, vec![QOBUZ, QOBUZ_2])
            .is_err());
        assert!(music_hoard
            .add_musicbutler_urls(&artist_id, vec![MUSICBRAINZ, MUSICBUTLER, BANDCAMP, QOBUZ])
            .is_err());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Adding URLs to an artist not in the collection is an error.
        assert!(music_hoard
            .add_musicbutler_urls(&artist_id_2, vec![MUSICBUTLER])
            .is_err());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Adding a single URL.
        assert!(music_hoard
            .add_musicbutler_urls(&artist_id, vec![MUSICBUTLER])
            .is_ok());
        expected.push(MusicButler::new(MUSICBUTLER).unwrap());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Adding a URL that already exists is ok, but does not do anything.
        assert!(music_hoard
            .add_musicbutler_urls(&artist_id, vec![MUSICBUTLER])
            .is_ok());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Adding another single URL.
        assert!(music_hoard
            .add_musicbutler_urls(&artist_id, vec![MUSICBUTLER_2])
            .is_ok());
        expected.push(MusicButler::new(MUSICBUTLER_2).unwrap());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        assert!(music_hoard
            .add_musicbutler_urls(&artist_id, vec![MUSICBUTLER_2])
            .is_ok());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Removing URLs from an artist not in the collection is an error.
        assert!(music_hoard
            .remove_musicbutler_urls(&artist_id_2, vec![MUSICBUTLER])
            .is_err());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Removing a URL.
        assert!(music_hoard
            .remove_musicbutler_urls(&artist_id, vec![MUSICBUTLER])
            .is_ok());
        expected.retain(|url| url.as_str() != MUSICBUTLER);
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Removing URls that do not exist is okay, they will be ignored.
        assert!(music_hoard
            .remove_musicbutler_urls(&artist_id, vec![MUSICBUTLER])
            .is_ok());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Removing a URL.
        assert!(music_hoard
            .remove_musicbutler_urls(&artist_id, vec![MUSICBUTLER_2])
            .is_ok());
        expected.retain(|url| url.as_str() != MUSICBUTLER_2);
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        assert!(music_hoard
            .remove_musicbutler_urls(&artist_id, vec![MUSICBUTLER_2])
            .is_ok());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Adding URLs if some exist is okay, they will be ignored.
        assert!(music_hoard
            .add_musicbutler_urls(&artist_id, vec![MUSICBUTLER])
            .is_ok());
        expected.push(MusicButler::new(MUSICBUTLER).unwrap());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        assert!(music_hoard
            .add_musicbutler_urls(&artist_id, vec![MUSICBUTLER, MUSICBUTLER_2])
            .is_ok());
        expected.push(MusicButler::new(MUSICBUTLER_2).unwrap());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Removing URLs if some do not exist is okay, they will be ignored.
        assert!(music_hoard
            .remove_musicbutler_urls(&artist_id, vec![MUSICBUTLER])
            .is_ok());
        expected.retain(|url| url.as_str() != MUSICBUTLER);
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        assert!(music_hoard
            .remove_musicbutler_urls(&artist_id, vec![MUSICBUTLER, MUSICBUTLER_2])
            .is_ok());
        expected.retain(|url| url.as_str() != MUSICBUTLER_2);
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Adding mutliple URLs without clashes.
        assert!(music_hoard
            .add_musicbutler_urls(&artist_id, vec![MUSICBUTLER, MUSICBUTLER_2])
            .is_ok());
        expected.push(MusicButler::new(MUSICBUTLER).unwrap());
        expected.push(MusicButler::new(MUSICBUTLER_2).unwrap());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Removing multiple URLs without clashes.
        assert!(music_hoard
            .remove_musicbutler_urls(&artist_id, vec![MUSICBUTLER, MUSICBUTLER_2])
            .is_ok());
        expected.clear();
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);
    }

    #[test]
    fn set_clear_musicbutler_urls() {
        let artist_id = ArtistId::new("an artist");
        let artist_id_2 = ArtistId::new("another artist");
        let mut music_hoard = MusicHoard::<NoLibrary, NoDatabase>::new(None, None);

        assert!(music_hoard.new_artist(artist_id.clone()).is_ok());

        let mut expected: Vec<MusicButler> = vec![];
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // If any URL is incorrect setting URLs is an error.
        assert!(music_hoard
            .set_musicbutler_urls(&artist_id, vec![MUSICBRAINZ, MUSICBRAINZ_2])
            .is_err());
        assert!(music_hoard
            .set_musicbutler_urls(&artist_id, vec![BANDCAMP, BANDCAMP_2])
            .is_err());
        assert!(music_hoard
            .set_musicbutler_urls(&artist_id, vec![QOBUZ, QOBUZ_2])
            .is_err());
        assert!(music_hoard
            .set_musicbutler_urls(&artist_id, vec![MUSICBRAINZ, MUSICBUTLER, BANDCAMP, QOBUZ])
            .is_err());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Seting URL on an artist not in the collection is an error.
        assert!(music_hoard
            .set_musicbutler_urls(&artist_id_2, vec![MUSICBUTLER])
            .is_err());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Set URLs.
        assert!(music_hoard
            .set_musicbutler_urls(&artist_id, vec![MUSICBUTLER])
            .is_ok());
        expected.push(MusicButler::new(MUSICBUTLER).unwrap());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        assert!(music_hoard
            .set_musicbutler_urls(&artist_id, vec![MUSICBUTLER_2])
            .is_ok());
        expected.clear();
        expected.push(MusicButler::new(MUSICBUTLER_2).unwrap());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        assert!(music_hoard
            .set_musicbutler_urls(&artist_id, vec![MUSICBUTLER, MUSICBUTLER_2])
            .is_ok());
        expected.clear();
        expected.push(MusicButler::new(MUSICBUTLER).unwrap());
        expected.push(MusicButler::new(MUSICBUTLER_2).unwrap());
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);

        // Clearing URLs on an artist that does not exist is an error.
        assert!(music_hoard.clear_musicbutler_urls(&artist_id_2).is_err());

        // Clear URLs.
        assert!(music_hoard.clear_musicbutler_urls(&artist_id).is_ok());
        expected.clear();
        assert_eq!(music_hoard.collection[0].properties.musicbutler, expected);
    }

    #[test]
    fn add_remove_bandcamp_urls() {
        let artist_id = ArtistId::new("an artist");
        let artist_id_2 = ArtistId::new("another artist");
        let mut music_hoard = MusicHoard::<NoLibrary, NoDatabase>::new(None, None);

        assert!(music_hoard.new_artist(artist_id.clone()).is_ok());

        let mut expected: Vec<Bandcamp> = vec![];
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // If any URL is incorrect adding URLs is an error.
        assert!(music_hoard
            .add_bandcamp_urls(&artist_id, vec![MUSICBRAINZ, MUSICBRAINZ_2])
            .is_err());
        assert!(music_hoard
            .add_bandcamp_urls(&artist_id, vec![MUSICBUTLER, MUSICBUTLER_2])
            .is_err());
        assert!(music_hoard
            .add_bandcamp_urls(&artist_id, vec![QOBUZ, QOBUZ_2])
            .is_err());
        assert!(music_hoard
            .add_bandcamp_urls(&artist_id, vec![MUSICBRAINZ, MUSICBUTLER, BANDCAMP, QOBUZ])
            .is_err());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Adding URLs to an artist not in the collection is an error.
        assert!(music_hoard
            .add_bandcamp_urls(&artist_id_2, vec![BANDCAMP])
            .is_err());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Adding a single URL.
        assert!(music_hoard
            .add_bandcamp_urls(&artist_id, vec![BANDCAMP])
            .is_ok());
        expected.push(Bandcamp::new(BANDCAMP).unwrap());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Adding a URL that already exists is ok, but does not do anything.
        assert!(music_hoard
            .add_bandcamp_urls(&artist_id, vec![BANDCAMP])
            .is_ok());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Adding another single URL.
        assert!(music_hoard
            .add_bandcamp_urls(&artist_id, vec![BANDCAMP_2])
            .is_ok());
        expected.push(Bandcamp::new(BANDCAMP_2).unwrap());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        assert!(music_hoard
            .add_bandcamp_urls(&artist_id, vec![BANDCAMP_2])
            .is_ok());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Removing URLs from an artist not in the collection is an error.
        assert!(music_hoard
            .remove_bandcamp_urls(&artist_id_2, vec![BANDCAMP])
            .is_err());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Removing a URL.
        assert!(music_hoard
            .remove_bandcamp_urls(&artist_id, vec![BANDCAMP])
            .is_ok());
        expected.retain(|url| url.as_str() != BANDCAMP);
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Removing URls that do not exist is okay, they will be ignored.
        assert!(music_hoard
            .remove_bandcamp_urls(&artist_id, vec![BANDCAMP])
            .is_ok());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Removing a URL.
        assert!(music_hoard
            .remove_bandcamp_urls(&artist_id, vec![BANDCAMP_2])
            .is_ok());
        expected.retain(|url| url.as_str() != BANDCAMP_2);
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        assert!(music_hoard
            .remove_bandcamp_urls(&artist_id, vec![BANDCAMP_2])
            .is_ok());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Adding URLs if some exist is okay, they will be ignored.
        assert!(music_hoard
            .add_bandcamp_urls(&artist_id, vec![BANDCAMP])
            .is_ok());
        expected.push(Bandcamp::new(BANDCAMP).unwrap());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        assert!(music_hoard
            .add_bandcamp_urls(&artist_id, vec![BANDCAMP, BANDCAMP_2])
            .is_ok());
        expected.push(Bandcamp::new(BANDCAMP_2).unwrap());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Removing URLs if some do not exist is okay, they will be ignored.
        assert!(music_hoard
            .remove_bandcamp_urls(&artist_id, vec![BANDCAMP])
            .is_ok());
        expected.retain(|url| url.as_str() != BANDCAMP);
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        assert!(music_hoard
            .remove_bandcamp_urls(&artist_id, vec![BANDCAMP, BANDCAMP_2])
            .is_ok());
        expected.retain(|url| url.as_str() != BANDCAMP_2);
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Adding mutliple URLs without clashes.
        assert!(music_hoard
            .add_bandcamp_urls(&artist_id, vec![BANDCAMP, BANDCAMP_2])
            .is_ok());
        expected.push(Bandcamp::new(BANDCAMP).unwrap());
        expected.push(Bandcamp::new(BANDCAMP_2).unwrap());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Removing multiple URLs without clashes.
        assert!(music_hoard
            .remove_bandcamp_urls(&artist_id, vec![BANDCAMP, BANDCAMP_2])
            .is_ok());
        expected.clear();
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);
    }

    #[test]
    fn set_clear_bandcamp_urls() {
        let artist_id = ArtistId::new("an artist");
        let artist_id_2 = ArtistId::new("another artist");
        let mut music_hoard = MusicHoard::<NoLibrary, NoDatabase>::new(None, None);

        assert!(music_hoard.new_artist(artist_id.clone()).is_ok());

        let mut expected: Vec<Bandcamp> = vec![];
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // If any URL is incorrect setting URLs is an error.
        assert!(music_hoard
            .set_bandcamp_urls(&artist_id, vec![MUSICBRAINZ, MUSICBRAINZ_2])
            .is_err());
        assert!(music_hoard
            .set_bandcamp_urls(&artist_id, vec![MUSICBUTLER, MUSICBUTLER_2])
            .is_err());
        assert!(music_hoard
            .set_bandcamp_urls(&artist_id, vec![QOBUZ, QOBUZ_2])
            .is_err());
        assert!(music_hoard
            .set_bandcamp_urls(&artist_id, vec![MUSICBRAINZ, MUSICBUTLER, BANDCAMP, QOBUZ])
            .is_err());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Seting URL on an artist not in the collection is an error.
        assert!(music_hoard
            .set_bandcamp_urls(&artist_id_2, vec![BANDCAMP])
            .is_err());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Set URLs.
        assert!(music_hoard
            .set_bandcamp_urls(&artist_id, vec![BANDCAMP])
            .is_ok());
        expected.push(Bandcamp::new(BANDCAMP).unwrap());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        assert!(music_hoard
            .set_bandcamp_urls(&artist_id, vec![BANDCAMP_2])
            .is_ok());
        expected.clear();
        expected.push(Bandcamp::new(BANDCAMP_2).unwrap());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        assert!(music_hoard
            .set_bandcamp_urls(&artist_id, vec![BANDCAMP, BANDCAMP_2])
            .is_ok());
        expected.clear();
        expected.push(Bandcamp::new(BANDCAMP).unwrap());
        expected.push(Bandcamp::new(BANDCAMP_2).unwrap());
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);

        // Clearing URLs on an artist that does not exist is an error.
        assert!(music_hoard.clear_bandcamp_urls(&artist_id_2).is_err());

        // Clear URLs.
        assert!(music_hoard.clear_bandcamp_urls(&artist_id).is_ok());
        expected.clear();
        assert_eq!(music_hoard.collection[0].properties.bandcamp, expected);
    }

    #[test]
    fn add_remove_qobuz_url() {
        let artist_id = ArtistId::new("an artist");
        let artist_id_2 = ArtistId::new("another artist");
        let mut music_hoard = MusicHoard::<NoLibrary, NoDatabase>::new(None, None);

        assert!(music_hoard.new_artist(artist_id.clone()).is_ok());

        let mut expected: Option<Qobuz> = None;
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        // Adding incorect URL is an error.
        assert!(music_hoard.add_qobuz_url(&artist_id, MUSICBRAINZ).is_err());
        assert!(music_hoard.add_qobuz_url(&artist_id, MUSICBUTLER).is_err());
        assert!(music_hoard.add_qobuz_url(&artist_id, BANDCAMP).is_err());
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        // Adding URL to an artist not in the collection is an error.
        assert!(music_hoard.add_qobuz_url(&artist_id_2, QOBUZ).is_err());
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        // Adding URL to artist.
        assert!(music_hoard.add_qobuz_url(&artist_id, QOBUZ).is_ok());
        _ = expected.insert(Qobuz::new(QOBUZ).unwrap());
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        // Adding the same URL again is ok, but does not do anything.
        assert!(music_hoard.add_qobuz_url(&artist_id, QOBUZ).is_ok());
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        // Adding further URLs is an error.
        assert!(music_hoard.add_qobuz_url(&artist_id, QOBUZ_2).is_err());
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        // Removing a URL from an artist not in the collection is an error.
        assert!(music_hoard.remove_qobuz_url(&artist_id_2, QOBUZ).is_err());
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        // Removing a URL not in the collection is okay, but does not do anything.
        assert!(music_hoard.remove_qobuz_url(&artist_id, QOBUZ_2).is_ok());
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        // Removing a URL in the collection removes it.
        assert!(music_hoard.remove_qobuz_url(&artist_id, QOBUZ).is_ok());
        _ = expected.take();
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        assert!(music_hoard.remove_qobuz_url(&artist_id, QOBUZ).is_ok());
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);
    }

    #[test]
    fn set_clear_qobuz_url() {
        let artist_id = ArtistId::new("an artist");
        let artist_id_2 = ArtistId::new("another artist");
        let mut music_hoard = MusicHoard::<NoLibrary, NoDatabase>::new(None, None);

        assert!(music_hoard.new_artist(artist_id.clone()).is_ok());

        let mut expected: Option<Qobuz> = None;
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        // Setting an incorrect URL is an error.
        assert!(music_hoard.set_qobuz_url(&artist_id, MUSICBUTLER).is_err());
        assert!(music_hoard.set_qobuz_url(&artist_id, BANDCAMP).is_err());
        assert!(music_hoard.set_qobuz_url(&artist_id, MUSICBRAINZ).is_err());
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        // Setting a URL on an artist not in the collection is an error.
        assert!(music_hoard.set_qobuz_url(&artist_id_2, QOBUZ).is_err());
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        // Setting a URL on an artist.
        assert!(music_hoard.set_qobuz_url(&artist_id, QOBUZ).is_ok());
        _ = expected.insert(Qobuz::new(QOBUZ).unwrap());
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        assert!(music_hoard.set_qobuz_url(&artist_id, QOBUZ).is_ok());
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        assert!(music_hoard.set_qobuz_url(&artist_id, QOBUZ_2).is_ok());
        _ = expected.insert(Qobuz::new(QOBUZ_2).unwrap());
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        // Clearing URLs on an artist that does not exist is an error.
        assert!(music_hoard.clear_qobuz_url(&artist_id_2).is_err());
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);

        // Clearing URLs.
        assert!(music_hoard.clear_qobuz_url(&artist_id).is_ok());
        _ = expected.take();
        assert_eq!(music_hoard.collection[0].properties.qobuz, expected);
    }

    #[test]
    fn merge_track() {
        let left = Track {
            id: TrackId {
                number: 4,
                title: String::from("a title"),
            },
            artist: vec![String::from("left artist")],
            quality: Quality {
                format: Format::Flac,
                bitrate: 1411,
            },
        };
        let right = Track {
            id: left.id.clone(),
            artist: vec![String::from("right artist")],
            quality: Quality {
                format: Format::Mp3,
                bitrate: 320,
            },
        };

        let merged = left.clone().merge(right);
        assert_eq!(left, merged);
    }

    #[test]
    fn merge_album_no_overlap() {
        let left = COLLECTION[0].albums[0].to_owned();
        let mut right = COLLECTION[0].albums[1].to_owned();
        right.id = left.id.clone();

        let mut expected = left.clone();
        expected.tracks.append(&mut right.tracks.clone());
        expected.tracks.sort_unstable();

        let merged = left.clone().merge(right);
        assert_eq!(expected, merged);
    }

    #[test]
    fn merge_album_overlap() {
        let mut left = COLLECTION[0].albums[0].to_owned();
        let mut right = COLLECTION[0].albums[1].to_owned();
        right.id = left.id.clone();
        left.tracks.push(right.tracks[0].clone());
        left.tracks.sort_unstable();

        let mut expected = left.clone();
        expected.tracks.append(&mut right.tracks.clone());
        expected.tracks.sort_unstable();
        expected.tracks.dedup();

        let merged = left.clone().merge(right);
        assert_eq!(expected, merged);
    }

    #[test]
    fn merge_artist_no_overlap() {
        let left = COLLECTION[0].to_owned();
        let mut right = COLLECTION[1].to_owned();
        right.id = left.id.clone();

        let mut expected = left.clone();
        expected.properties = expected.properties.merge(right.clone().properties);
        expected.albums.append(&mut right.albums.clone());
        expected.albums.sort_unstable();

        let merged = left.clone().merge(right);
        assert_eq!(expected, merged);
    }

    #[test]
    fn merge_artist_overlap() {
        let mut left = COLLECTION[0].to_owned();
        let mut right = COLLECTION[1].to_owned();
        right.id = left.id.clone();
        left.albums.push(right.albums[0].clone());
        left.albums.sort_unstable();

        let mut expected = left.clone();
        expected.properties = expected.properties.merge(right.clone().properties);
        expected.albums.append(&mut right.albums.clone());
        expected.albums.sort_unstable();
        expected.albums.dedup();

        let merged = left.clone().merge(right);
        assert_eq!(expected, merged);
    }

    #[test]
    fn merge_collection_no_overlap() {
        let half: usize = COLLECTION.len() / 2;

        let left = COLLECTION[..half].to_owned();
        let right = COLLECTION[half..].to_owned();

        let mut expected = COLLECTION.to_owned();
        expected.sort_unstable();

        let merged = MusicHoard::<MockILibrary, MockIDatabase>::merge(left.clone(), right);
        assert_eq!(expected, merged);
    }

    #[test]
    fn merge_collection_overlap() {
        let half: usize = COLLECTION.len() / 2;

        let left = COLLECTION[..(half + 1)].to_owned();
        let right = COLLECTION[half..].to_owned();

        let mut expected = COLLECTION.to_owned();
        expected.sort_unstable();

        let merged = MusicHoard::<MockILibrary, MockIDatabase>::merge(left.clone(), right);
        assert_eq!(expected, merged);
    }

    #[test]
    fn rescan_library_ordered() {
        let mut library = MockILibrary::new();
        let database = MockIDatabase::new();

        let library_input = Query::new();
        let library_result = Ok(artists_to_items(&COLLECTION));

        library
            .expect_list()
            .with(predicate::eq(library_input))
            .times(1)
            .return_once(|_| library_result);

        let mut music_hoard = MusicHoard::new(Some(library), Some(database));

        music_hoard.rescan_library().unwrap();
        assert_eq!(
            music_hoard.get_collection(),
            &clean_collection(COLLECTION.to_owned())
        );
    }

    #[test]
    fn rescan_library_unordered() {
        let mut library = MockILibrary::new();
        let database = MockIDatabase::new();

        let library_input = Query::new();
        let mut library_result = Ok(artists_to_items(&COLLECTION));

        // Swap the last item with the first.
        let last = library_result.as_ref().unwrap().len() - 1;
        library_result.as_mut().unwrap().swap(0, last);

        library
            .expect_list()
            .with(predicate::eq(library_input))
            .times(1)
            .return_once(|_| library_result);

        let mut music_hoard = MusicHoard::new(Some(library), Some(database));

        music_hoard.rescan_library().unwrap();
        assert_eq!(
            music_hoard.get_collection(),
            &clean_collection(COLLECTION.to_owned())
        );
    }

    #[test]
    fn rescan_library_album_title_year_clash() {
        let mut library = MockILibrary::new();
        let database = MockIDatabase::new();

        let mut expected = clean_collection(COLLECTION.to_owned());
        expected[0].albums[0].id.year = expected[1].albums[0].id.year;
        expected[0].albums[0].id.title = expected[1].albums[0].id.title.clone();

        let library_input = Query::new();
        let library_result = Ok(artists_to_items(&expected));

        library
            .expect_list()
            .with(predicate::eq(library_input))
            .times(1)
            .return_once(|_| library_result);

        let mut music_hoard = MusicHoard::new(Some(library), Some(database));

        music_hoard.rescan_library().unwrap();
        assert_eq!(music_hoard.get_collection(), &expected);
    }

    #[test]
    fn load_database() {
        let library = MockILibrary::new();
        let mut database = MockIDatabase::new();

        database
            .expect_load()
            .times(1)
            .return_once(|coll: &mut Collection| {
                *coll = COLLECTION.to_owned();
                Ok(())
            });

        let mut music_hoard = MusicHoard::new(Some(library), Some(database));

        music_hoard.load_from_database().unwrap();
        assert_eq!(music_hoard.get_collection(), &*COLLECTION);
    }

    #[test]
    fn rescan_get_save() {
        let mut library = MockILibrary::new();
        let mut database = MockIDatabase::new();

        let library_input = Query::new();
        let library_result = Ok(artists_to_items(&COLLECTION));

        let database_input = clean_collection(COLLECTION.to_owned());
        let database_result = Ok(());

        library
            .expect_list()
            .with(predicate::eq(library_input))
            .times(1)
            .return_once(|_| library_result);

        database
            .expect_save()
            .with(predicate::eq(database_input))
            .times(1)
            .return_once(|_: &Collection| database_result);

        let mut music_hoard = MusicHoard::new(Some(library), Some(database));

        music_hoard.rescan_library().unwrap();
        assert_eq!(
            music_hoard.get_collection(),
            &clean_collection(COLLECTION.to_owned())
        );
        music_hoard.save_to_database().unwrap();
    }

    #[test]
    fn library_not_provided() {
        let library: Option<NoLibrary> = None;
        let database = Some(MockIDatabase::new());
        let mut music_hoard = MusicHoard::new(library, database);

        let actual_err = music_hoard.rescan_library().unwrap_err();
        let expected_err = Error::LibraryError(String::from("library not provided"));

        assert_eq!(actual_err, expected_err);
    }

    #[test]
    fn library_error() {
        let mut library = MockILibrary::new();
        let database = MockIDatabase::new();

        let library_result = Err(library::Error::Invalid(String::from("invalid data")));

        library
            .expect_list()
            .times(1)
            .return_once(|_| library_result);

        let mut music_hoard = MusicHoard::new(Some(library), Some(database));

        let actual_err = music_hoard.rescan_library().unwrap_err();
        let expected_err =
            Error::LibraryError(library::Error::Invalid(String::from("invalid data")).to_string());

        assert_eq!(actual_err, expected_err);
        assert_eq!(actual_err.to_string(), expected_err.to_string());
    }

    #[test]
    fn database_not_provided() {
        let library = Some(MockILibrary::new());
        let database: Option<NoDatabase> = None;
        let mut music_hoard = MusicHoard::new(library, database);

        let expected_err = Error::DatabaseError(String::from("database not provided"));

        let actual_err = music_hoard.load_from_database().unwrap_err();
        assert_eq!(actual_err, expected_err);
        assert_eq!(actual_err.to_string(), expected_err.to_string());

        let actual_err = music_hoard.save_to_database().unwrap_err();
        assert_eq!(actual_err, expected_err);
        assert_eq!(actual_err.to_string(), expected_err.to_string());
    }

    #[test]
    fn database_load_error() {
        let library = MockILibrary::new();
        let mut database = MockIDatabase::new();

        let database_result = Err(database::LoadError::IoError(String::from("I/O error")));

        database
            .expect_load()
            .times(1)
            .return_once(|_: &mut Collection| database_result);

        let mut music_hoard = MusicHoard::new(Some(library), Some(database));

        let actual_err = music_hoard.load_from_database().unwrap_err();
        let expected_err = Error::DatabaseError(
            database::LoadError::IoError(String::from("I/O error")).to_string(),
        );

        assert_eq!(actual_err, expected_err);
        assert_eq!(actual_err.to_string(), expected_err.to_string());
    }

    #[test]
    fn database_save_error() {
        let library = MockILibrary::new();
        let mut database = MockIDatabase::new();

        let database_result = Err(database::SaveError::IoError(String::from("I/O error")));

        database
            .expect_save()
            .times(1)
            .return_once(|_: &Collection| database_result);

        let mut music_hoard = MusicHoard::new(Some(library), Some(database));

        let actual_err = music_hoard.save_to_database().unwrap_err();
        let expected_err = Error::DatabaseError(
            database::SaveError::IoError(String::from("I/O error")).to_string(),
        );

        assert_eq!(actual_err, expected_err);
        assert_eq!(actual_err.to_string(), expected_err.to_string());
    }
}