dynamodb-expression 0.2.0-beta.9

use core::fmt::{self, Write};

use super::Value;

/// A DynamoDB value, or a reference to one stored in the collected expression values.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub(crate) enum ValueOrRef {
    Value(Value),
    Ref(Ref),
}

impl fmt::Display for ValueOrRef {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            ValueOrRef::Value(value) => value.fmt(f),
            ValueOrRef::Ref(value) => value.fmt(f),
        }
    }
}

impl<T> From<T> for ValueOrRef
where
    T: Into<Value>,
{
    fn from(value: T) -> Self {
        Self::Value(value.into())
    }
}

impl From<Ref> for ValueOrRef {
    fn from(value: Ref) -> Self {
        Self::Ref(value)
    }
}

/// A reference to a DynamoDB value stored in expression attribute values.
/// Automatically prefixed with `:`.
///
/// ```
/// use dynamodb_expression::value::Ref;
/// # use pretty_assertions::assert_eq;
///
/// let value = Ref::new("expression_value");
/// assert_eq!(":expression_value", value.to_string())
/// ```
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Ref(String);

impl Ref {
    pub fn new<T>(value_ref: T) -> Self
    where
        T: Into<String>,
    {
        Self(value_ref.into())
    }
}

impl From<String> for Ref {
    fn from(value: String) -> Self {
        Self(value)
    }
}

impl From<&String> for Ref {
    fn from(value: &String) -> Self {
        Self(value.to_owned())
    }
}

impl From<&str> for Ref {
    fn from(value: &str) -> Self {
        Self(value.to_owned())
    }
}

impl From<&&str> for Ref {
    fn from(value: &&str) -> Self {
        Self((*value).to_owned())
    }
}

impl fmt::Display for Ref {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_char(':')?;
        self.0.fmt(f)
    }
}

impl From<Ref> for String {
    fn from(mut value: Ref) -> Self {
        value.0.insert(0, ':');

        value.0
    }
}

/// Represents a value that is either a string, or a reference to a value
/// already in the expression attribute values.
///
/// ```
/// use dynamodb_expression::value::{StringOrRef, Ref};
///
/// let value: StringOrRef = "a string value".into();
/// let value: StringOrRef = Ref::new("expression_value").into();
/// ```
///
/// For example, the [`BeginsWith`] operator can take a string or a reference to
/// an extended attribute value. Here's how [`StringOrRef`] works with that.
///
/// ```
/// # fn string_or_ref() -> Result<(), Box<dyn std::error::Error>> {
/// use dynamodb_expression::{condition::BeginsWith, value::Ref, Path};
/// # use pretty_assertions::assert_eq;
///
/// let begins_with = BeginsWith::new("foo".parse::<Path>()?, "T");
/// assert_eq!(r#"begins_with(foo, "T")"#, begins_with.to_string());
///
/// let begins_with = BeginsWith::new("foo".parse::<Path>()?, Ref::new("prefix"));
/// assert_eq!(r#"begins_with(foo, :prefix)"#, begins_with.to_string());
/// #
/// # Ok(())
/// # }
/// ```
///
/// See also: [`Ref`]
///
/// [`BeginsWith`]: crate::condition::BeginsWith
pub enum StringOrRef {
    String(String),
    Ref(Ref),
}

impl From<String> for StringOrRef {
    fn from(value: String) -> Self {
        Self::String(value)
    }
}

impl From<&String> for StringOrRef {
    fn from(value: &String) -> Self {
        Self::String(value.to_owned())
    }
}

impl From<&str> for StringOrRef {
    fn from(value: &str) -> Self {
        Self::String(value.to_owned())
    }
}

impl From<&&str> for StringOrRef {
    fn from(value: &&str) -> Self {
        Self::String((*value).to_owned())
    }
}

impl From<Ref> for StringOrRef {
    fn from(value: Ref) -> Self {
        Self::Ref(value)
    }
}

impl From<StringOrRef> for ValueOrRef {
    fn from(value: StringOrRef) -> Self {
        match value {
            StringOrRef::String(value) => value.into(),
            StringOrRef::Ref(value) => value.into(),
        }
    }
}

#[cfg(test)]
mod test {
    use pretty_assertions::assert_str_eq;

    use crate::Scalar;

    use super::{Ref, ValueOrRef};

    #[test]
    fn display_value() {
        let vr = ValueOrRef::from(Scalar::new_string("foo"));
        assert_str_eq!("\"foo\"", vr.to_string());
    }

    #[test]
    fn display_ref() {
        let vr = ValueOrRef::Ref(Ref("foo".into()));
        assert_str_eq!(":foo", vr.to_string());
    }
}

#[cfg(test)]
mod examples {
    #[ignore = "This is just here for formatting."]
    #[test]
    fn string_or_ref() -> Result<(), Box<dyn std::error::Error>> {
        use crate::{condition::BeginsWith, value::Ref, Path};
        use pretty_assertions::assert_eq;

        let begins_with = BeginsWith::new("foo".parse::<Path>()?, "T");
        assert_eq!(r#"begins_with(foo, "T")"#, begins_with.to_string());

        let begins_with = BeginsWith::new("foo".parse::<Path>()?, Ref::new("prefix"));
        assert_eq!(r#"begins_with(foo, :prefix)"#, begins_with.to_string());

        Ok(())
    }
}