cot 0.5.0

use crate::db::{DatabaseBackend, DatabaseError, Model, Result};

/// A foreign key to another model.
///
/// Internally, this is represented either as a primary key (in case the
/// model has not been retrieved from the database) or as the model itself.
///
/// # Examples
///
/// ```
/// use cot::db::{Auto, Database, ForeignKey, Model, model};
/// use cot::response::Response;
///
/// #[model]
/// struct MyModel {
///     #[model(primary_key)]
///     id: Auto<i32>,
///     user: ForeignKey<User>,
/// }
///
/// #[model]
/// struct User {
///     #[model(primary_key)]
///     id: Auto<i32>,
/// }
///
/// async fn index(db: Database) -> cot::Result<Response> {
///     let mut user = User { id: Auto::auto() };
///     user.save(&db).await?;
///
///     let mut my_model = MyModel {
///         id: Auto::auto(),
///         user: ForeignKey::from(user),
///     };
///     my_model.save(&db).await?;
///
///     // ...
/// #   unimplemented!()
/// }
/// ```
#[derive(Debug, Clone)]
pub enum ForeignKey<T: Model> {
    /// The primary key of the referenced model; used when the model has not
    /// been retrieved from the database yet or when it's unnecessary to
    /// store the entire model instance.
    PrimaryKey(T::PrimaryKey),
    /// The referenced model.
    Model(Box<T>),
}

impl<T: Model> ForeignKey<T> {
    /// Returns the primary key of the referenced model.
    pub fn primary_key(&self) -> &T::PrimaryKey {
        match self {
            Self::PrimaryKey(pk) => pk,
            Self::Model(model) => model.primary_key(),
        }
    }

    /// Returns the model, if it has been stored in this [`ForeignKey`]
    /// instance, or [`None`] otherwise.
    pub fn model(&self) -> Option<&T> {
        match self {
            Self::Model(model) => Some(model),
            Self::PrimaryKey(_) => None,
        }
    }

    /// Unwrap the foreign key, returning the model.
    ///
    /// # Panics
    ///
    /// Panics if the model has not been stored in this [`ForeignKey`] instance.
    #[track_caller]
    pub fn unwrap(self) -> T {
        match self {
            Self::Model(model) => *model,
            Self::PrimaryKey(_) => panic!("object has not been retrieved from the database"),
        }
    }

    /// Retrieve the model from the database, if needed, and return it.
    ///
    /// If the model has already been retrieved, this method will return it.
    ///
    /// This method will replace the primary key with the model instance if
    /// the primary key is stored in this [`ForeignKey`] instance.
    ///
    /// # Errors
    ///
    /// Returns a [`DatabaseError::ForeignKeyNotFound`] error if the model
    /// could not be found in the database.
    ///
    /// Returns an error if there was a problem communicating with the database.
    pub async fn get<DB: DatabaseBackend>(&mut self, db: &DB) -> Result<&T> {
        match self {
            Self::Model(model) => Ok(model),
            Self::PrimaryKey(pk) => {
                let model = T::get_by_primary_key(db, pk.clone())
                    .await?
                    .ok_or(DatabaseError::ForeignKeyNotFound)?;
                *self = Self::Model(Box::new(model));
                match self.model() {
                    Some(model) => Ok(model),
                    None => unreachable!("model was just set"),
                }
            }
        }
    }
}

impl<T: Model> PartialEq for ForeignKey<T>
where
    T::PrimaryKey: PartialEq,
{
    fn eq(&self, other: &Self) -> bool {
        self.primary_key() == other.primary_key()
    }
}

impl<T: Model> Eq for ForeignKey<T> where T::PrimaryKey: Eq {}

impl<T: Model> From<T> for ForeignKey<T> {
    fn from(model: T) -> Self {
        Self::Model(Box::new(model))
    }
}

impl<T: Model> From<&T> for ForeignKey<T> {
    fn from(model: &T) -> Self {
        Self::PrimaryKey(model.primary_key().clone())
    }
}

/// A foreign key on delete constraint.
///
/// This is used to define the behavior of a foreign key when the referenced row
/// is deleted.
///
/// # See also
///
/// - [`ForeignKeyOnUpdatePolicy`]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, Default)]
pub enum ForeignKeyOnDeletePolicy {
    /// Don't do any additional actions on delete.
    NoAction,
    /// Prevent the delete if this model instance is referenced by another row.
    #[default]
    Restrict,
    /// Remove the referencing row if the referenced row is deleted.
    Cascade,
    /// Set the foreign key in the referencing row to [`None`].
    SetNone,
}

impl From<ForeignKeyOnDeletePolicy> for sea_query::ForeignKeyAction {
    fn from(value: ForeignKeyOnDeletePolicy) -> Self {
        match value {
            ForeignKeyOnDeletePolicy::NoAction => Self::NoAction,
            ForeignKeyOnDeletePolicy::Restrict => Self::Restrict,
            ForeignKeyOnDeletePolicy::Cascade => Self::Cascade,
            ForeignKeyOnDeletePolicy::SetNone => Self::SetNull,
        }
    }
}

/// A foreign key on update constraint.
///
/// This is used to define the behavior of a foreign key when the referenced row
/// is updated.
///
/// # See also
///
/// - [`ForeignKeyOnDeletePolicy`]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, Default)]
pub enum ForeignKeyOnUpdatePolicy {
    /// Don't do any additional actions on update.
    NoAction,
    /// Prevent the update if this model instance is referenced by another row.
    Restrict,
    /// Update the foreign key in the referencing row if the referenced row is
    /// updated.
    #[default]
    Cascade,
    /// Set the foreign key in the referencing row to [`None`].
    SetNone,
}

impl From<ForeignKeyOnUpdatePolicy> for sea_query::ForeignKeyAction {
    fn from(value: ForeignKeyOnUpdatePolicy) -> Self {
        match value {
            ForeignKeyOnUpdatePolicy::NoAction => Self::NoAction,
            ForeignKeyOnUpdatePolicy::Restrict => Self::Restrict,
            ForeignKeyOnUpdatePolicy::Cascade => Self::Cascade,
            ForeignKeyOnUpdatePolicy::SetNone => Self::SetNull,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::db::{Auto, model};

    #[derive(Debug, Clone, PartialEq)]
    #[model]
    struct TestModel {
        #[model(primary_key)]
        id: Auto<i32>,
    }

    #[test]
    fn test_primary_key() {
        let fk = ForeignKey::<TestModel>::PrimaryKey(Auto::fixed(1));

        assert_eq!(fk.primary_key(), &Auto::fixed(1));
    }

    #[test]
    fn test_model() {
        let model = TestModel { id: Auto::fixed(1) };
        let fk = ForeignKey::Model(Box::new(model.clone()));

        assert_eq!(fk.model().unwrap(), &model);
        assert_eq!(fk.primary_key(), &Auto::fixed(1));
    }

    #[test]
    fn test_unwrap_model() {
        let model = TestModel { id: Auto::fixed(1) };
        let fk = ForeignKey::Model(Box::new(model.clone()));

        assert_eq!(fk.unwrap(), model);
    }

    #[should_panic(expected = "object has not been retrieved from the database")]
    #[test]
    fn unwrap_primary_key() {
        let fk = ForeignKey::<TestModel>::PrimaryKey(Auto::fixed(1));
        fk.unwrap();
    }

    #[test]
    fn test_partial_eq() {
        let fk1 = ForeignKey::<TestModel>::PrimaryKey(Auto::fixed(1));
        let fk2 = ForeignKey::<TestModel>::PrimaryKey(Auto::fixed(1));

        assert_eq!(fk1, fk2);
    }

    #[test]
    fn test_from_model() {
        let model = TestModel { id: Auto::fixed(1) };
        let fk: ForeignKey<TestModel> = ForeignKey::from(model.clone());

        assert_eq!(fk.model().unwrap(), &model);
    }

    #[test]
    fn test_from_model_ref() {
        let model = TestModel { id: Auto::fixed(1) };
        let fk: ForeignKey<TestModel> = ForeignKey::from(&model);

        assert_eq!(fk.primary_key(), &Auto::fixed(1));
    }
}