refactor: provide default type option transform (#1579)

Author: appflowy

frontend/rust-lib/flowy-grid/src/services/field/type_option_builder.rs

@@ -9,24 +9,6 @@ pub trait TypeOptionBuilder {
 
     /// Returns a serializer that can be used to serialize the type-option data
     fn serializer(&self) -> &dyn TypeOptionDataSerializer;
-
-    /// Transform the data from passed-in type-option to current type-option
-    ///
-    /// The current type-option data may be changed if it supports transform
-    /// the data from the other kind of type-option data.
-    ///
-    /// For example, when switching from `checkbox` type-option to `single-select`
-    /// type-option, adding the `Yes` option if the `single-select` type-option doesn't contain it.
-    /// But the cell content is a string, `Yes`, it's need to do the cell content transform.
-    /// The `Yes` string will be transformed to the `Yes` option id.
-    ///
-    ///
-    /// # Arguments
-    ///
-    /// * `field_type`: represents as the field type of the passed-in type-option data
-    /// * `type_option_data`: passed-in type-option data
-    //
-    fn transform(&mut self, field_type: &FieldType, type_option_data: String);
 }
 
 pub fn default_type_option_builder_from_type(field_type: &FieldType) -> Box<dyn TypeOptionBuilder> {

frontend/rust-lib/flowy-grid/src/services/field/type_options/checkbox_type_option/checkbox_type_option.rs

@@ -3,6 +3,7 @@ use crate::impl_type_option;
 use crate::services::cell::{AnyCellChangeset, CellDataChangeset, CellDataDecoder, FromCellString};
 use crate::services::field::{
     BoxTypeOptionBuilder, CheckboxCellData, TypeOption, TypeOptionBuilder, TypeOptionCellData, TypeOptionConfiguration,
+    TypeOptionTransform,
 };
 use bytes::Bytes;
 use flowy_derive::ProtoBuf;
@@ -31,10 +32,6 @@ impl TypeOptionBuilder for CheckboxTypeOptionBuilder {
     fn serializer(&self) -> &dyn TypeOptionDataSerializer {
         &self.0
     }
-
-    fn transform(&mut self, _field_type: &FieldType, _type_option_data: String) {
-        // Do nothing
-    }
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize, Default, ProtoBuf)]
@@ -47,15 +44,17 @@ impl_type_option!(CheckboxTypeOptionPB, FieldType::Checkbox);
 impl TypeOption for CheckboxTypeOptionPB {
     type CellData = CheckboxCellData;
     type CellChangeset = CheckboxCellChangeset;
-    type CellPBType = CheckboxCellData;
+    type CellProtobufType = CheckboxCellData;
 }
 
+impl TypeOptionTransform for CheckboxTypeOptionPB {}
+
 impl TypeOptionConfiguration for CheckboxTypeOptionPB {
     type CellFilterConfiguration = CheckboxFilterPB;
 }
 
 impl TypeOptionCellData for CheckboxTypeOptionPB {
-    fn convert_into_pb_type(&self, cell_data: <Self as TypeOption>::CellData) -> <Self as TypeOption>::CellPBType {
+    fn convert_to_protobuf(&self, cell_data: <Self as TypeOption>::CellData) -> <Self as TypeOption>::CellProtobufType {
         cell_data
     }
 

frontend/rust-lib/flowy-grid/src/services/field/type_options/date_type_option/date_tests.rs

@@ -165,7 +165,7 @@ mod tests {
         let decoded_data = type_option
             .try_decode_cell_data(encoded_data, &FieldType::DateTime, field_rev)
             .unwrap();
-        let decoded_data = type_option.convert_into_pb_type(decoded_data);
+        let decoded_data = type_option.convert_to_protobuf(decoded_data);
         if type_option.include_time {
             format!("{} {}", decoded_data.date, decoded_data.time)
                 .trim_end()

frontend/rust-lib/flowy-grid/src/services/field/type_options/date_type_option/date_type_option.rs

@@ -3,7 +3,7 @@ use crate::impl_type_option;
 use crate::services::cell::{AnyCellChangeset, CellDataChangeset, CellDataDecoder, FromCellString};
 use crate::services::field::{
     BoxTypeOptionBuilder, DateCellChangeset, DateCellData, DateCellDataPB, DateFormat, TimeFormat, TypeOption,
-    TypeOptionBuilder, TypeOptionCellData, TypeOptionConfiguration,
+    TypeOptionBuilder, TypeOptionCellData, TypeOptionConfiguration, TypeOptionTransform,
 };
 use bytes::Bytes;
 use chrono::format::strftime::StrftimeItems;
@@ -30,15 +30,15 @@ impl_type_option!(DateTypeOptionPB, FieldType::DateTime);
 impl TypeOption for DateTypeOptionPB {
     type CellData = DateCellData;
     type CellChangeset = DateCellChangeset;
-    type CellPBType = DateCellDataPB;
+    type CellProtobufType = DateCellDataPB;
 }
 
 impl TypeOptionConfiguration for DateTypeOptionPB {
     type CellFilterConfiguration = DateFilterPB;
 }
 
 impl TypeOptionCellData for DateTypeOptionPB {
-    fn convert_into_pb_type(&self, cell_data: <Self as TypeOption>::CellData) -> <Self as TypeOption>::CellPBType {
+    fn convert_to_protobuf(&self, cell_data: <Self as TypeOption>::CellData) -> <Self as TypeOption>::CellProtobufType {
         self.today_desc_from_timestamp(cell_data)
     }
 
@@ -128,6 +128,8 @@ impl DateTypeOptionPB {
     }
 }
 
+impl TypeOptionTransform for DateTypeOptionPB {}
+
 impl CellDataDecoder for DateTypeOptionPB {
     fn try_decode_cell_data(
         &self,
@@ -207,7 +209,4 @@ impl TypeOptionBuilder for DateTypeOptionBuilder {
     fn serializer(&self) -> &dyn TypeOptionDataSerializer {
         &self.0
     }
-    fn transform(&mut self, _field_type: &FieldType, _type_option_data: String) {
-        // Do nothing
-    }
 }

frontend/rust-lib/flowy-grid/src/services/field/type_options/number_type_option/number_type_option.rs

@@ -4,7 +4,7 @@ use crate::services::cell::{AnyCellChangeset, CellComparable, CellDataChangeset,
 use crate::services::field::type_options::number_type_option::format::*;
 use crate::services::field::{
     BoxTypeOptionBuilder, NumberCellData, StrCellData, TypeOption, TypeOptionBuilder, TypeOptionCellData,
-    TypeOptionConfiguration,
+    TypeOptionConfiguration, TypeOptionTransform,
 };
 use bytes::Bytes;
 use flowy_derive::ProtoBuf;
@@ -51,9 +51,6 @@ impl TypeOptionBuilder for NumberTypeOptionBuilder {
     fn serializer(&self) -> &dyn TypeOptionDataSerializer {
         &self.0
     }
-    fn transform(&mut self, _field_type: &FieldType, _type_option_data: String) {
-        // Do nothing
-    }
 }
 
 // Number
@@ -79,15 +76,15 @@ impl_type_option!(NumberTypeOptionPB, FieldType::Number);
 impl TypeOption for NumberTypeOptionPB {
     type CellData = StrCellData;
     type CellChangeset = NumberCellChangeset;
-    type CellPBType = StrCellData;
+    type CellProtobufType = StrCellData;
 }
 
 impl TypeOptionConfiguration for NumberTypeOptionPB {
     type CellFilterConfiguration = NumberFilterPB;
 }
 
 impl TypeOptionCellData for NumberTypeOptionPB {
-    fn convert_into_pb_type(&self, cell_data: <Self as TypeOption>::CellData) -> <Self as TypeOption>::CellPBType {
+    fn convert_to_protobuf(&self, cell_data: <Self as TypeOption>::CellData) -> <Self as TypeOption>::CellProtobufType {
         cell_data
     }
 
@@ -128,6 +125,8 @@ pub(crate) fn strip_currency_symbol<T: ToString>(s: T) -> String {
     s
 }
 
+impl TypeOptionTransform for NumberTypeOptionPB {}
+
 impl CellDataDecoder for NumberTypeOptionPB {
     fn try_decode_cell_data(
         &self,

frontend/rust-lib/flowy-grid/src/services/field/type_options/selection_type_option/checklist_type_option.rs

@@ -1,7 +1,7 @@
 use crate::entities::{ChecklistFilterPB, FieldType};
 use crate::impl_type_option;
 use crate::services::cell::{AnyCellChangeset, CellDataChangeset, FromCellString, TypeCellData};
-use crate::services::field::selection_type_option::type_option_transform::SelectOptionTypeOptionTransformer;
+
 use crate::services::field::{
     BoxTypeOptionBuilder, SelectOptionCellChangeset, SelectOptionCellDataPB, SelectOptionIds, SelectOptionPB,
     SelectTypeOptionSharedAction, TypeOption, TypeOptionBuilder, TypeOptionCellData, TypeOptionConfiguration,
@@ -26,15 +26,15 @@ impl_type_option!(ChecklistTypeOptionPB, FieldType::Checklist);
 impl TypeOption for ChecklistTypeOptionPB {
     type CellData = SelectOptionIds;
     type CellChangeset = SelectOptionCellChangeset;
-    type CellPBType = SelectOptionCellDataPB;
+    type CellProtobufType = SelectOptionCellDataPB;
 }
 
 impl TypeOptionConfiguration for ChecklistTypeOptionPB {
     type CellFilterConfiguration = ChecklistFilterPB;
 }
 
 impl TypeOptionCellData for ChecklistTypeOptionPB {
-    fn convert_into_pb_type(&self, cell_data: <Self as TypeOption>::CellData) -> <Self as TypeOption>::CellPBType {
+    fn convert_to_protobuf(&self, cell_data: <Self as TypeOption>::CellData) -> <Self as TypeOption>::CellProtobufType {
         self.get_selected_options(cell_data)
     }
 
@@ -113,8 +113,4 @@ impl TypeOptionBuilder for ChecklistTypeOptionBuilder {
     fn serializer(&self) -> &dyn TypeOptionDataSerializer {
         &self.0
     }
-
-    fn transform(&mut self, field_type: &FieldType, type_option_data: String) {
-        SelectOptionTypeOptionTransformer::transform_type_option(&mut self.0, field_type, type_option_data)
-    }
 }

frontend/rust-lib/flowy-grid/src/services/field/type_options/selection_type_option/multi_select_type_option.rs

@@ -1,7 +1,7 @@
 use crate::entities::{FieldType, SelectOptionFilterPB};
 use crate::impl_type_option;
 use crate::services::cell::{AnyCellChangeset, CellDataChangeset, FromCellString, TypeCellData};
-use crate::services::field::selection_type_option::type_option_transform::SelectOptionTypeOptionTransformer;
+
 use crate::services::field::{
     BoxTypeOptionBuilder, SelectOptionCellChangeset, SelectOptionCellDataPB, SelectOptionIds, SelectOptionPB,
     SelectTypeOptionSharedAction, TypeOption, TypeOptionBuilder, TypeOptionCellData, TypeOptionConfiguration,
@@ -26,15 +26,15 @@ impl_type_option!(MultiSelectTypeOptionPB, FieldType::MultiSelect);
 impl TypeOption for MultiSelectTypeOptionPB {
     type CellData = SelectOptionIds;
     type CellChangeset = SelectOptionCellChangeset;
-    type CellPBType = SelectOptionCellDataPB;
+    type CellProtobufType = SelectOptionCellDataPB;
 }
 
 impl TypeOptionConfiguration for MultiSelectTypeOptionPB {
     type CellFilterConfiguration = SelectOptionFilterPB;
 }
 
 impl TypeOptionCellData for MultiSelectTypeOptionPB {
-    fn convert_into_pb_type(&self, cell_data: <Self as TypeOption>::CellData) -> <Self as TypeOption>::CellPBType {
+    fn convert_to_protobuf(&self, cell_data: <Self as TypeOption>::CellData) -> <Self as TypeOption>::CellProtobufType {
         self.get_selected_options(cell_data)
     }
 
@@ -119,31 +119,28 @@ impl TypeOptionBuilder for MultiSelectTypeOptionBuilder {
     fn serializer(&self) -> &dyn TypeOptionDataSerializer {
         &self.0
     }
-
-    fn transform(&mut self, field_type: &FieldType, type_option_data: String) {
-        SelectOptionTypeOptionTransformer::transform_type_option(&mut self.0, field_type, type_option_data)
-    }
 }
+
 #[cfg(test)]
 mod tests {
     use crate::entities::FieldType;
     use crate::services::cell::CellDataChangeset;
     use crate::services::field::type_options::selection_type_option::*;
-    use crate::services::field::{CheckboxTypeOptionBuilder, FieldBuilder, TypeOptionBuilder};
+    use crate::services::field::{CheckboxTypeOptionBuilder, FieldBuilder, TypeOptionBuilder, TypeOptionTransform};
     use crate::services::field::{MultiSelectTypeOptionBuilder, MultiSelectTypeOptionPB};
 
     #[test]
     fn multi_select_transform_with_checkbox_type_option_test() {
         let checkbox_type_option_builder = CheckboxTypeOptionBuilder::default();
         let checkbox_type_option_data = checkbox_type_option_builder.serializer().json_str();
 
-        let mut multi_select = MultiSelectTypeOptionBuilder::default();
-        multi_select.transform(&FieldType::Checkbox, checkbox_type_option_data.clone());
-        debug_assert_eq!(multi_select.0.options.len(), 2);
+        let mut multi_select = MultiSelectTypeOptionBuilder::default().0;
+        multi_select.transform_type_option(FieldType::Checkbox, checkbox_type_option_data.clone());
+        debug_assert_eq!(multi_select.options.len(), 2);
 
         // Already contain the yes/no option. It doesn't need to insert new options
-        multi_select.transform(&FieldType::Checkbox, checkbox_type_option_data);
-        debug_assert_eq!(multi_select.0.options.len(), 2);
+        multi_select.transform_type_option(FieldType::Checkbox, checkbox_type_option_data);
+        debug_assert_eq!(multi_select.options.len(), 2);
     }
 
     #[test]
@@ -158,13 +155,13 @@ mod tests {
 
         let singleselect_type_option_data = singleselect_type_option_builder.serializer().json_str();
 
-        let mut multi_select = MultiSelectTypeOptionBuilder::default();
-        multi_select.transform(&FieldType::MultiSelect, singleselect_type_option_data.clone());
-        debug_assert_eq!(multi_select.0.options.len(), 2);
+        let mut multi_select = MultiSelectTypeOptionBuilder::default().0;
+        multi_select.transform_type_option(FieldType::MultiSelect, singleselect_type_option_data.clone());
+        debug_assert_eq!(multi_select.options.len(), 2);
 
         // Already contain the yes/no option. It doesn't need to insert new options
-        multi_select.transform(&FieldType::MultiSelect, singleselect_type_option_data);
-        debug_assert_eq!(multi_select.0.options.len(), 2);
+        multi_select.transform_type_option(FieldType::MultiSelect, singleselect_type_option_data);
+        debug_assert_eq!(multi_select.options.len(), 2);
     }
 
     // #[test]

frontend/rust-lib/flowy-grid/src/services/field/type_options/selection_type_option/select_type_option.rs

@@ -4,9 +4,10 @@ use crate::services::cell::{
     CellDataDecoder, CellProtobufBlobParser, DecodedCellData, FromCellChangeset, FromCellString,
 };
 
-use crate::services::field::selection_type_option::type_option_transform::SelectOptionTypeOptionTransformer;
+use crate::services::field::selection_type_option::type_option_transform::SelectOptionTypeOptionTransformHelper;
 use crate::services::field::{
     ChecklistTypeOptionPB, MultiSelectTypeOptionPB, SingleSelectTypeOptionPB, TypeOption, TypeOptionCellData,
+    TypeOptionTransform,
 };
 use bytes::Bytes;
 use flowy_derive::{ProtoBuf, ProtoBuf_Enum};
@@ -128,23 +129,42 @@ pub trait SelectTypeOptionSharedAction: TypeOptionDataSerializer + Send + Sync {
     fn mut_options(&mut self) -> &mut Vec<SelectOptionPB>;
 }
 
+impl<T> TypeOptionTransform for T
+where
+    T: SelectTypeOptionSharedAction + TypeOption<CellData = SelectOptionIds> + TypeOptionDataSerializer,
+{
+    fn transformable(&self) -> bool {
+        true
+    }
+
+    fn transform_type_option(&mut self, old_type_option_field_type: FieldType, old_type_option_data: String) {
+        SelectOptionTypeOptionTransformHelper::transform_type_option(
+            self,
+            &old_type_option_field_type,
+            old_type_option_data,
+        );
+    }
+
+    fn transform_type_option_cell_data(
+        &self,
+        cell_data: <Self as TypeOption>::CellData,
+        decoded_field_type: &FieldType,
+    ) -> <Self as TypeOption>::CellData {
+        SelectOptionTypeOptionTransformHelper::transform_type_option_cell_data(self, cell_data, decoded_field_type)
+    }
+}
+
 impl<T> CellDataDecoder for T
 where
     T: SelectTypeOptionSharedAction + TypeOption<CellData = SelectOptionIds> + TypeOptionCellData,
 {
     fn try_decode_cell_data(
         &self,
         cell_data: String,
-        decoded_field_type: &FieldType,
-        field_rev: &FieldRevision,
+        _decoded_field_type: &FieldType,
+        _field_rev: &FieldRevision,
     ) -> FlowyResult<<Self as TypeOption>::CellData> {
-        let cell_data = self.decode_type_option_cell_data(cell_data)?;
-        Ok(SelectOptionTypeOptionTransformer::transform_type_option_cell_data(
-            self,
-            cell_data,
-            decoded_field_type,
-            field_rev,
-        ))
+        self.decode_type_option_cell_data(cell_data)
     }
 
     fn decode_cell_data_to_str(