AppFlowy/shared-lib/flowy-grid-data-model/src/revision/grid_rev.rs

use crate::revision::GridBlockRevision;
use bytes::Bytes;
use indexmap::IndexMap;
use nanoid::nanoid;
use serde::{Deserialize, Serialize};
use std::sync::Arc;

pub fn gen_grid_id() -> String {
    // nanoid calculator https://zelark.github.io/nano-id-cc/
    nanoid!(10)
}

pub fn gen_block_id() -> String {
    nanoid!(10)
}

pub fn gen_field_id() -> String {
    nanoid!(6)
}

#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GridRevision {
    pub grid_id: String,
    pub fields: Vec<Arc<FieldRevision>>,
    pub blocks: Vec<Arc<GridBlockMetaRevision>>,
}

impl GridRevision {
    pub fn new(grid_id: &str) -> Self {
        Self {
            grid_id: grid_id.to_owned(),
            fields: vec![],
            blocks: vec![],
        }
    }

    pub fn from_build_context(grid_id: &str, context: BuildGridContext) -> Self {
        Self {
            grid_id: grid_id.to_owned(),
            fields: context.field_revs,
            blocks: context.block_metas.into_iter().map(Arc::new).collect(),
        }
    }
}

#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct GridBlockMetaRevision {
    pub block_id: String,
    pub start_row_index: i32,
    pub row_count: i32,
}

impl GridBlockMetaRevision {
    pub fn len(&self) -> i32 {
        self.row_count
    }

    pub fn is_empty(&self) -> bool {
        self.row_count == 0
    }
}

impl GridBlockMetaRevision {
    pub fn new() -> Self {
        GridBlockMetaRevision {
            block_id: gen_block_id(),
            ..Default::default()
        }
    }
}

pub struct GridBlockMetaRevisionChangeset {
    pub block_id: String,
    pub start_row_index: Option<i32>,
    pub row_count: Option<i32>,
}

impl GridBlockMetaRevisionChangeset {
    pub fn from_row_count(block_id: String, row_count: i32) -> Self {
        Self {
            block_id,
            start_row_index: None,
            row_count: Some(row_count),
        }
    }
}

#[derive(Debug, Clone, Default, Serialize, Deserialize, Eq, PartialEq)]
pub struct FieldRevision {
    pub id: String,

    pub name: String,

    pub desc: String,

    #[serde(rename = "field_type")]
    pub ty: FieldTypeRevision,

    pub frozen: bool,

    pub visibility: bool,

    pub width: i32,

    /// type_options contains key/value pairs
    /// key: id of the FieldType
    /// value: type option data that can be parsed into specified TypeOptionStruct.
    ///
    /// For example, CheckboxTypeOption, MultiSelectTypeOption etc.
    #[serde(with = "indexmap::serde_seq")]
    pub type_options: IndexMap<String, String>,

    #[serde(default = "DEFAULT_IS_PRIMARY")]
    pub is_primary: bool,
}

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

const DEFAULT_IS_PRIMARY: fn() -> bool = || false;

impl FieldRevision {
    pub fn new<T: Into<FieldTypeRevision>>(
        name: &str,
        desc: &str,
        field_type: T,
        width: i32,
        is_primary: bool,
    ) -> Self {
        Self {
            id: gen_field_id(),
            name: name.to_string(),
            desc: desc.to_string(),
            ty: field_type.into(),
            frozen: false,
            visibility: true,
            width,
            type_options: Default::default(),
            is_primary,
        }
    }

    pub fn insert_type_option_entry<T>(&mut self, entry: &T)
    where
        T: TypeOptionDataEntry + ?Sized,
    {
        let id = self.ty.to_string();
        self.type_options.insert(id, entry.json_str());
    }

    pub fn get_type_option_entry<T: TypeOptionDataDeserializer>(&self, field_type_rev: FieldTypeRevision) -> Option<T> {
        let id = field_type_rev.to_string();
        // TODO: cache the deserialized type option
        self.type_options.get(&id).map(|s| T::from_json_str(s))
    }

    pub fn insert_type_option_str(&mut self, field_type: &FieldTypeRevision, json_str: String) {
        let id = field_type.to_string();
        self.type_options.insert(id, json_str);
    }

    pub fn get_type_option_str<T: Into<FieldTypeRevision>>(&self, field_type: T) -> Option<String> {
        let field_type_rev = field_type.into();
        let id = field_type_rev.to_string();
        self.type_options.get(&id).map(|s| s.to_owned())
    }
}

/// The macro [impl_type_option] will implement the [TypeOptionDataEntry] for the type that
/// supports the serde trait and the TryInto<Bytes> trait.
pub trait TypeOptionDataEntry {
    fn json_str(&self) -> String;
    fn protobuf_bytes(&self) -> Bytes;
}

/// The macro [impl_type_option] will implement the [TypeOptionDataDeserializer] for the type that
/// supports the serde trait and the TryFrom<Bytes> trait.
pub trait TypeOptionDataDeserializer {
    fn from_json_str(s: &str) -> Self;
    fn from_protobuf_bytes(bytes: Bytes) -> Self;
}

#[derive(Clone, Default, Deserialize, Serialize)]
pub struct BuildGridContext {
    pub field_revs: Vec<Arc<FieldRevision>>,
    pub block_metas: Vec<GridBlockMetaRevision>,
    pub blocks: Vec<GridBlockRevision>,
}

impl BuildGridContext {
    pub fn new() -> Self {
        Self::default()
    }
}

impl std::convert::From<BuildGridContext> for Bytes {
    fn from(ctx: BuildGridContext) -> Self {
        let bytes = serde_json::to_vec(&ctx).unwrap_or_else(|_| vec![]);
        Bytes::from(bytes)
    }
}

impl std::convert::TryFrom<Bytes> for BuildGridContext {
    type Error = serde_json::Error;

    fn try_from(bytes: Bytes) -> Result<Self, Self::Error> {
        let ctx: BuildGridContext = serde_json::from_slice(&bytes)?;
        Ok(ctx)
    }
}

pub type FieldTypeRevision = u8;