alox-48 0.7.0

// Copyright (c) 2024 Lily Lyons
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

use std::borrow::Borrow;

use crate::{
    de::Result as DeResult, ser::Result as SerResult, Deserialize, DeserializerTrait, Serialize,
    SerializerTrait, Sym, Visitor,
};

/// An owned symbol from ruby.
/// It's a newtype around a String, meant to preserve types during (de)serialization.
///
/// When serializing, a [`String`] will be serialized as a String, but a [`Symbol`] will be serialized as a Symbol.
#[derive(Eq, Default, Clone)]
pub struct Symbol(pub(crate) String);

#[allow(clippy::must_use_candidate)]
impl Symbol {
    /// Create a new symbol from a string.
    pub fn new(string: String) -> Self {
        Self(string)
    }

    /// Get this symbol as a borrowed str.
    pub fn as_str(&self) -> &str {
        &self.0
    }

    /// Get this symbol as a borrowed Sym.
    pub fn as_sym(&self) -> &Sym {
        Sym::new(&self.0)
    }

    /// Get the length of this symbol.
    pub fn len(&self) -> usize {
        self.0.len()
    }

    /// Returns true if the string data is empty.
    pub fn is_empty(&self) -> bool {
        self.0.is_empty()
    }

    /// Returns true if the string data starts with an '@'.
    ///
    /// (aka it's an instance variable name.)
    pub fn is_ivar(&self) -> bool {
        self.0.starts_with('@')
    }

    /// Returns a new symbol with the '@' stripped from the inner string.
    ///
    /// If the inner string does not start with an '@', this will return None.
    pub fn as_rust_field_name(&self) -> Option<&Sym> {
        self.0.strip_prefix('@').map(Sym::new)
    }
}

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

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

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

impl std::fmt::Debug for Symbol {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_tuple("Symbol").field(&self.0).finish()
    }
}

impl std::fmt::Display for Symbol {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_fmt(format_args!(":{}", self.0))
    }
}

impl PartialEq<str> for Symbol {
    fn eq(&self, other: &str) -> bool {
        self.0.eq(other)
    }
}

impl PartialEq<&str> for Symbol {
    fn eq(&self, other: &&str) -> bool {
        self.0.eq(other)
    }
}

impl PartialEq<String> for Symbol {
    fn eq(&self, other: &String) -> bool {
        self.0.eq(other)
    }
}

impl PartialEq<Symbol> for Symbol {
    fn eq(&self, other: &Symbol) -> bool {
        self.0.eq(&other.0)
    }
}

impl PartialEq<Sym> for Symbol {
    fn eq(&self, other: &Sym) -> bool {
        self.0.eq(&other.0)
    }
}

impl std::hash::Hash for Symbol {
    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
        self.0.hash(state);
    }
}

impl Borrow<str> for Symbol {
    fn borrow(&self) -> &str {
        &self.0
    }
}

impl Borrow<Sym> for Symbol {
    fn borrow(&self) -> &Sym {
        self.as_sym()
    }
}

impl AsRef<str> for Symbol {
    fn as_ref(&self) -> &str {
        &self.0
    }
}

impl AsRef<[u8]> for Symbol {
    fn as_ref(&self) -> &[u8] {
        self.0.as_bytes()
    }
}

impl AsRef<Sym> for Symbol {
    fn as_ref(&self) -> &Sym {
        self.as_sym()
    }
}

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

impl std::ops::Deref for Symbol {
    type Target = Sym;

    fn deref(&self) -> &Self::Target {
        Sym::new(&self.0)
    }
}

struct SymbolVisitor;

impl<'de> Visitor<'de> for SymbolVisitor {
    type Value = Symbol;

    fn expecting(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        formatter.write_str("a symbol")
    }

    fn visit_symbol(self, symbol: &'de Sym) -> DeResult<Self::Value> {
        Ok(symbol.to_symbol())
    }
}

impl<'de> Deserialize<'de> for Symbol {
    fn deserialize<D>(deserializer: D) -> DeResult<Self>
    where
        D: DeserializerTrait<'de>,
    {
        deserializer.deserialize(SymbolVisitor)
    }
}

impl Serialize for Symbol {
    fn serialize<S>(&self, serializer: S) -> SerResult<S::Ok>
    where
        S: SerializerTrait,
    {
        serializer.serialize_symbol(self.as_sym())
    }
}