diff --git a/CHANGELOG.md b/CHANGELOG.md index 5ee49d36f3..14cc9abcc4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,17 @@ # Release Notes -## Version 0.0.4 - 2022-06-06 +## Version 0.0.5 - beta.1 - 08/25/2022 + +New features +- Board-view database + - Group by single select + - drag and drop cards + - insert / delete cards + +![Aug-25-2022 16-22-38](https://user-images.githubusercontent.com/86001920/186614248-23186dfe-410e-427a-8cc6-865b1f79e074.gif) + + +## Version 0.0.4 - 06/06/2022 - Drag to adjust the width of a column - Upgrade to Flutter 3.0 - Native support for M1 chip @@ -12,12 +23,12 @@ - Fixed some bugs -## Version 0.0.4 - beta.3 - 2022-05-02 +## Version 0.0.4 - beta.3 - 05/02/2022 - Drag to reorder app/ view/ field - Row record open as a page - Auto resize the height of the row in the grid - Support more number formats -- Search column options, supporting Single select, Multi-select, and number format +- Search column options, supporting Single-select, Multi-select, and number format ![May-03-2022 10-03-00](https://user-images.githubusercontent.com/86001920/166394640-a8f1f3bc-5f20-4033-93e9-16bc308d7005.gif) @@ -27,7 +38,7 @@ - Fixed some bugs -## Version 0.0.4 - beta.2 - 2022-04-11 +## Version 0.0.4 - beta.2 - 04/11/2022 - Support properties: Text, Number, Date, Checkbox, Select, Multi-select - Insert / delete rows @@ -35,16 +46,16 @@ - Edit property ![](https://user-images.githubusercontent.com/12026239/162753644-bf2f4e7a-2367-4d48-87e6-35e244e83a5b.png) -## Version 0.0.4 - beta.1 - 2022-04-08 +## Version 0.0.4 - beta.1 - 04/08/2022 v0.0.4 - beta.1 is pre-release New features - Table-view database - - supported column types: Text, Checbox, Single-select, Multi-select, Numbers + - supported column types: Text, Checkbox, Single-select, Multi-select, Numbers - hide / delete columns - insert rows -## Version 0.0.3 - 2022-02-23 +## Version 0.0.3 - 02/23/2022 v0.0.3 is production ready, available on Linux, macOS, and Windows New features diff --git a/README.md b/README.md index e441496c96..e77238e0dc 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,12 @@ Please see the [changelog](https://www.appflowy.io/whatsnew) for more details ab ## Contributing -Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Please look at [CONTRIBUTING.md](https://github.com/AppFlowy-IO/appflowy/blob/main/doc/CONTRIBUTING.md) for details. +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. Please look at [Contributing to AppFlowy](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/contributing-to-appflowy) for details. + +If your Pull Request is accepted as it fixes a bug, adds functionality, or makes AppFlowy's codebase significantly easier to use or understand, congratulations! If your administrative and managerial work behind the scenes that sustains the community as a whole, congratulations! You are now an official contributor to AppFlowy. Get in touch with us ([link](https://tally.so/r/mKP5z3)) to receive the very special Contributor T-shirt! +Proudly wear your T-shirt and show it to us by tagging [@appflowy](https://twitter.com/appflowy) on Twitter. + +![DSCF3560](https://user-images.githubusercontent.com/12026239/186106423-a923f6fe-b169-477b-87e4-ffb2e375e0f6.jpg) ## Why Are We Building This? diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md index d6879070ab..349c087c70 100644 --- a/doc/CONTRIBUTING.md +++ b/doc/CONTRIBUTING.md @@ -2,6 +2,6 @@ # Contributing to AppFlowy -Hello, and welcome! Whether you are trying to report a bug, proposing a feature request, or want to work on the code you should go visit [our documentation](https://appflowy.gitbook.io) +Hello, and welcome! Whether you are trying to report a bug, proposing a feature request, or want to work on the code you should go visit [Contributing to AppFlowy](https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/contributing-to-appflowy) We look forward to hearing from you! diff --git a/frontend/.vscode/launch.json b/frontend/.vscode/launch.json index e70b9ffb97..0efc79b00e 100644 --- a/frontend/.vscode/launch.json +++ b/frontend/.vscode/launch.json @@ -29,7 +29,7 @@ "program": "./lib/main.dart", "type": "dart", "env": { - "RUST_LOG": "trace" + "RUST_LOG": "debug" }, "cwd": "${workspaceRoot}/app_flowy" }, diff --git a/frontend/Makefile.toml b/frontend/Makefile.toml index 337b9efd76..f6e8194efa 100644 --- a/frontend/Makefile.toml +++ b/frontend/Makefile.toml @@ -22,7 +22,7 @@ CARGO_MAKE_EXTEND_WORKSPACE_MAKEFILE = true CARGO_MAKE_CRATE_FS_NAME = "dart_ffi" CARGO_MAKE_CRATE_NAME = "dart-ffi" LIB_NAME = "dart_ffi" -CURRENT_APP_VERSION = "0.0.4" +CURRENT_APP_VERSION = "0.0.5" FEATURES = "flutter" PRODUCT_NAME = "AppFlowy" # CRATE_TYPE: https://doc.rust-lang.org/reference/linkage.html diff --git a/frontend/app_flowy/assets/translations/fr-FR.json b/frontend/app_flowy/assets/translations/fr-FR.json index 773ae93e9f..e6ccdb3b78 100644 --- a/frontend/app_flowy/assets/translations/fr-FR.json +++ b/frontend/app_flowy/assets/translations/fr-FR.json @@ -145,5 +145,71 @@ "sideBar": { "openSidebar": "Open sidebar", "closeSidebar": "Close sidebar" + }, + "grid": { + "settings": { + "filter": "Filtrer", + "sortBy": "Trier par", + "Properties": "Propriétés" + }, + "field": { + "hide": "Cacher", + "insertLeft": "Insérer à gauche", + "insertRight": "Insérer à droite", + "duplicate": "Dupliquer", + "delete": "Supprimer", + "textFieldName": "Texte", + "checkboxFieldName": "Case à cocher", + "dateFieldName": "Date", + "numberFieldName": "Nombre", + "singleSelectFieldName": "Sélectionner", + "multiSelectFieldName": "Multisélection", + "urlFieldName": "URL", + "numberFormat": " Format du nombre", + "dateFormat": " Format de la date", + "includeTime": " Inclure l'heure", + "dateFormatFriendly": "Mois Jour, Année", + "dateFormatISO": "Année-Mois-Jour", + "dateFormatLocal": "Année/Mois/Jour", + "dateFormatUS": "Année/Mois/Jour", + "timeFormat": " Format du temps", + "invalidTimeFormat": "Format invalide", + "timeFormatTwelveHour": "12 heures", + "timeFormatTwentyFourHour": "24 heures", + "addSelectOption": "Ajouter une option", + "optionTitle": "Options", + "addOption": "Ajouter une option", + "editProperty": "Modifier la propriété" + }, + "row": { + "duplicate": "Dupliquer", + "delete": "Supprimer", + "textPlaceholder": "Vide", + "copyProperty": "Copie de la propriété dans le presse-papiers" + }, + "selectOption": { + "create": "Créer", + "purpleColor": "Violet", + "pinkColor": "Rose", + "lightPinkColor": "Rose clair", + "orangeColor": "Orange", + "yellowColor": "Jaune", + "limeColor": "Citron vert", + "greenColor": "Vert", + "aquaColor": "Aqua", + "blueColor": "Bleu", + "deleteTag": "Supprimer l'étiquette", + "colorPannelTitle": "Couleurs", + "pannelTitle": "Sélectionnez une option ou créez-en une", + "searchOption": "Rechercher une option" + }, + "menuName": "Grille" + }, + "document": { + "menuName": "Doc", + "date": { + "timeHintTextInTwelveHour": "12:00 AM", + "timeHintTextInTwentyFourHour": "12:00" + } } } diff --git a/frontend/app_flowy/assets/translations/zh-CN.json b/frontend/app_flowy/assets/translations/zh-CN.json index 7304610714..514a1cd338 100644 --- a/frontend/app_flowy/assets/translations/zh-CN.json +++ b/frontend/app_flowy/assets/translations/zh-CN.json @@ -93,8 +93,14 @@ "highlight": "高亮" }, "tooltip": { - "lightMode": "切换到灯光模式", - "darkMode": "切换到暗模式" + "lightMode": "切换到亮色模式", + "darkMode": "切换到暗色模式" + }, + "notifications": { + "export": { + "markdown": "导出笔记为Markdown文档", + "path": "Documents/flowy" + } }, "contactsPage": { "title": "联系人", @@ -135,6 +141,7 @@ "menu": { "appearance": "外观", "language": "语言", + "user": "用户", "open": "打开设置" }, "appearance": { @@ -145,5 +152,71 @@ "sideBar": { "openSidebar": "打开侧边栏", "closeSidebar": "关闭侧边栏" + }, + "grid": { + "settings": { + "filter": "过滤器", + "sortBy": "排序", + "Properties": "属性" + }, + "field": { + "hide": "隐藏", + "insertLeft": "左侧插入", + "insertRight": "右侧插入", + "duplicate": "拷贝", + "delete": "删除", + "textFieldName": "文本", + "checkboxFieldName": "勾选框", + "dateFieldName": "日期", + "numberFieldName": "数字", + "singleSelectFieldName": "单项选择器", + "multiSelectFieldName": "多项选择器", + "urlFieldName": "链接", + "numberFormat": " 数字格式", + "dateFormat": " 日期格式", + "includeTime": " 包含时间", + "dateFormatFriendly": "月 日,年", + "dateFormatISO": "年-月-日", + "dateFormatLocal": "年/月/日", + "dateFormatUS": "年/月/日", + "timeFormat": " 时间格式", + "invalidTimeFormat": "时间格式错误", + "timeFormatTwelveHour": "12小时制", + "timeFormatTwentyFourHour": "24小时制", + "addSelectOption": "添加一个标签", + "optionTitle": "标签", + "addOption": "添加标签", + "editProperty": "编辑列属性" + }, + "row": { + "duplicate": "复制", + "delete": "删除", + "textPlaceholder": "空", + "copyProperty": "复制列" + }, + "selectOption": { + "create": "新建", + "purpleColor": "紫色", + "pinkColor": "粉色", + "lightPinkColor": "浅粉色", + "orangeColor": "橙色", + "yellowColor": "黄色", + "limeColor": "鲜绿色", + "greenColor": "绿色", + "aquaColor": "水蓝色", + "blueColor": "蓝色", + "deleteTag": "删除标签", + "colorPannelTitle": "颜色", + "pannelTitle": "选择或新建一个标签", + "searchOption": "搜索标签" + }, + "menuName": "网格" + }, + "document": { + "menuName": "文档", + "date": { + "timeHintTextInTwelveHour": "12:00 AM", + "timeHintTextInTwentyFourHour": "12:00" + } } -} +} \ No newline at end of file diff --git a/frontend/app_flowy/lib/plugins/board/application/board_bloc.dart b/frontend/app_flowy/lib/plugins/board/application/board_bloc.dart index ac72b6e24e..7c04dec814 100644 --- a/frontend/app_flowy/lib/plugins/board/application/board_bloc.dart +++ b/frontend/app_flowy/lib/plugins/board/application/board_bloc.dart @@ -20,23 +20,27 @@ import 'group_controller.dart'; part 'board_bloc.freezed.dart'; class BoardBloc extends Bloc { - final BoardDataController _dataController; - late final AFBoardDataController afBoardDataController; + final BoardDataController _gridDataController; + late final AFBoardDataController boardController; final MoveRowFFIService _rowService; - Map groupControllers = {}; + LinkedHashMap groupControllers = LinkedHashMap.new(); - GridFieldCache get fieldCache => _dataController.fieldCache; - String get gridId => _dataController.gridId; + GridFieldCache get fieldCache => _gridDataController.fieldCache; + String get gridId => _gridDataController.gridId; BoardBloc({required ViewPB view}) : _rowService = MoveRowFFIService(gridId: view.id), - _dataController = BoardDataController(view: view), + _gridDataController = BoardDataController(view: view), super(BoardState.initial(view.id)) { - afBoardDataController = AFBoardDataController( + boardController = AFBoardDataController( onMoveColumn: ( + fromColumnId, fromIndex, + toColumnId, toIndex, - ) {}, + ) { + _moveGroup(fromColumnId, toColumnId); + }, onMoveColumnItem: ( columnId, fromIndex, @@ -44,7 +48,7 @@ class BoardBloc extends Bloc { ) { final fromRow = groupControllers[columnId]?.rowAtIndex(fromIndex); final toRow = groupControllers[columnId]?.rowAtIndex(toIndex); - _moveRow(fromRow, toRow); + _moveRow(fromRow, columnId, toRow); }, onMoveColumnItemToColumn: ( fromColumnId, @@ -54,7 +58,7 @@ class BoardBloc extends Bloc { ) { final fromRow = groupControllers[fromColumnId]?.rowAtIndex(fromIndex); final toRow = groupControllers[toColumnId]?.rowAtIndex(toIndex); - _moveRow(fromRow, toRow); + _moveRow(fromRow, toColumnId, toRow); }, ); @@ -66,7 +70,7 @@ class BoardBloc extends Bloc { await _loadGrid(emit); }, createRow: (groupId) async { - final result = await _dataController.createBoardCard(groupId); + final result = await _gridDataController.createBoardCard(groupId); result.fold( (rowPB) { emit(state.copyWith(editingRow: some(rowPB))); @@ -95,12 +99,13 @@ class BoardBloc extends Bloc { ); } - void _moveRow(RowPB? fromRow, RowPB? toRow) { - if (fromRow != null && toRow != null) { + void _moveRow(RowPB? fromRow, String columnId, RowPB? toRow) { + if (fromRow != null) { _rowService - .moveRow( + .moveGroupRow( fromRowId: fromRow.id, - toRowId: toRow.id, + toGroupId: columnId, + toRowId: toRow?.id, ) .then((result) { result.fold((l) => null, (r) => add(BoardEvent.didReceiveError(r))); @@ -108,9 +113,20 @@ class BoardBloc extends Bloc { } } + void _moveGroup(String fromColumnId, String toColumnId) { + _rowService + .moveGroup( + fromGroupId: fromColumnId, + toGroupId: toColumnId, + ) + .then((result) { + result.fold((l) => null, (r) => add(BoardEvent.didReceiveError(r))); + }); + } + @override Future close() async { - await _dataController.dispose(); + await _gridDataController.dispose(); for (final controller in groupControllers.values) { controller.dispose(); } @@ -119,7 +135,7 @@ class BoardBloc extends Bloc { void initializeGroups(List groups) { for (final group in groups) { - final delegate = GroupControllerDelegateImpl(afBoardDataController); + final delegate = GroupControllerDelegateImpl(boardController); final controller = GroupController( gridId: state.gridId, group: group, @@ -131,12 +147,12 @@ class BoardBloc extends Bloc { } GridRowCache? getRowCache(String blockId) { - final GridBlockCache? blockCache = _dataController.blocks[blockId]; + final GridBlockCache? blockCache = _gridDataController.blocks[blockId]; return blockCache?.rowCache; } void _startListening() { - _dataController.addListener( + _gridDataController.addListener( onGridChanged: (grid) { if (!isClosed) { add(BoardEvent.didReceiveGridUpdate(grid)); @@ -146,18 +162,34 @@ class BoardBloc extends Bloc { List columns = groups.map((group) { return AFBoardColumnData( id: group.groupId, - desc: group.desc, + name: group.desc, items: _buildRows(group.rows), customData: group, ); }).toList(); - afBoardDataController.addColumns(columns); + boardController.addColumns(columns); initializeGroups(groups); }, onRowsChanged: (List rowInfos, RowsChangedReason reason) { add(BoardEvent.didReceiveRows(rowInfos)); }, + onDeletedGroup: (groupIds) { + // + }, + onInsertedGroup: (insertedGroups) { + // + }, + onUpdatedGroup: (updatedGroups) { + // + for (final group in updatedGroups) { + final columnController = + boardController.getColumnController(group.groupId); + if (columnController != null) { + columnController.updateColumnName(group.desc); + } + } + }, onError: (err) { Log.error(err); }, @@ -173,7 +205,7 @@ class BoardBloc extends Bloc { } Future _loadGrid(Emitter emit) async { - final result = await _dataController.loadData(); + final result = await _gridDataController.loadData(); result.fold( (grid) => emit( state.copyWith(loadingState: GridLoadingState.finish(left(unit))), @@ -285,6 +317,6 @@ class GroupControllerDelegateImpl extends GroupControllerDelegate { @override void updateRow(String groupId, RowPB row) { - // + controller.updateColumnItem(groupId, BoardColumnItem(row: row)); } } diff --git a/frontend/app_flowy/lib/plugins/board/application/board_data_controller.dart b/frontend/app_flowy/lib/plugins/board/application/board_data_controller.dart index 1d17431713..31b2594497 100644 --- a/frontend/app_flowy/lib/plugins/board/application/board_data_controller.dart +++ b/frontend/app_flowy/lib/plugins/board/application/board_data_controller.dart @@ -10,9 +10,15 @@ import 'dart:async'; import 'package:dartz/dartz.dart'; import 'package:flowy_sdk/protobuf/flowy-grid/protobuf.dart'; +import 'board_listener.dart'; + typedef OnFieldsChanged = void Function(UnmodifiableListView); typedef OnGridChanged = void Function(GridPB); typedef DidLoadGroups = void Function(List); +typedef OnUpdatedGroup = void Function(List); +typedef OnDeletedGroup = void Function(List); +typedef OnInsertedGroup = void Function(List); + typedef OnRowsChanged = void Function( List, RowsChangedReason, @@ -23,6 +29,7 @@ class BoardDataController { final String gridId; final GridFFIService _gridFFIService; final GridFieldCache fieldCache; + final BoardListener _listener; // key: the block id final LinkedHashMap _blocks; @@ -44,16 +51,20 @@ class BoardDataController { BoardDataController({required ViewPB view}) : gridId = view.id, + _listener = BoardListener(view.id), _blocks = LinkedHashMap.new(), _gridFFIService = GridFFIService(gridId: view.id), fieldCache = GridFieldCache(gridId: view.id); void addListener({ - OnGridChanged? onGridChanged, + required OnGridChanged onGridChanged, OnFieldsChanged? onFieldsChanged, - DidLoadGroups? didLoadGroups, - OnRowsChanged? onRowsChanged, - OnError? onError, + required DidLoadGroups didLoadGroups, + required OnRowsChanged onRowsChanged, + required OnUpdatedGroup onUpdatedGroup, + required OnDeletedGroup onDeletedGroup, + required OnInsertedGroup onInsertedGroup, + required OnError? onError, }) { _onGridChanged = onGridChanged; _onFieldsChanged = onFieldsChanged; @@ -64,6 +75,25 @@ class BoardDataController { fieldCache.addListener(onFields: (fields) { _onFieldsChanged?.call(UnmodifiableListView(fields)); }); + + _listener.start(onBoardChanged: (result) { + result.fold( + (changeset) { + if (changeset.updateGroups.isNotEmpty) { + onUpdatedGroup.call(changeset.updateGroups); + } + + if (changeset.insertedGroups.isNotEmpty) { + onInsertedGroup.call(changeset.insertedGroups); + } + + if (changeset.deletedGroups.isNotEmpty) { + onDeletedGroup.call(changeset.deletedGroups); + } + }, + (e) => _onError?.call(e), + ); + }); } Future> loadData() async { diff --git a/frontend/app_flowy/lib/plugins/board/application/board_listener.dart b/frontend/app_flowy/lib/plugins/board/application/board_listener.dart new file mode 100644 index 0000000000..a953a993cc --- /dev/null +++ b/frontend/app_flowy/lib/plugins/board/application/board_listener.dart @@ -0,0 +1,50 @@ +import 'dart:typed_data'; + +import 'package:app_flowy/core/grid_notification.dart'; +import 'package:flowy_infra/notifier.dart'; +import 'package:flowy_sdk/protobuf/flowy-error/errors.pb.dart'; +import 'package:flowy_sdk/protobuf/flowy-grid/dart_notification.pb.dart'; +import 'package:dartz/dartz.dart'; +import 'package:flowy_sdk/protobuf/flowy-grid/group_changeset.pb.dart'; + +typedef UpdateBoardNotifiedValue = Either; + +class BoardListener { + final String viewId; + PublishNotifier? _groupNotifier = PublishNotifier(); + GridNotificationListener? _listener; + BoardListener(this.viewId); + + void start({ + required void Function(UpdateBoardNotifiedValue) onBoardChanged, + }) { + _groupNotifier?.addPublishListener(onBoardChanged); + _listener = GridNotificationListener( + objectId: viewId, + handler: _handler, + ); + } + + void _handler( + GridNotification ty, + Either result, + ) { + switch (ty) { + case GridNotification.DidUpdateGroupView: + result.fold( + (payload) => _groupNotifier?.value = + left(GroupViewChangesetPB.fromBuffer(payload)), + (error) => _groupNotifier?.value = right(error), + ); + break; + default: + break; + } + } + + Future stop() async { + await _listener?.stop(); + _groupNotifier?.dispose(); + _groupNotifier = null; + } +} diff --git a/frontend/app_flowy/lib/plugins/board/application/card/board_select_option_cell_bloc.dart b/frontend/app_flowy/lib/plugins/board/application/card/board_select_option_cell_bloc.dart index df36033cfa..1b70710a35 100644 --- a/frontend/app_flowy/lib/plugins/board/application/card/board_select_option_cell_bloc.dart +++ b/frontend/app_flowy/lib/plugins/board/application/card/board_select_option_cell_bloc.dart @@ -68,7 +68,6 @@ class BoardSelectOptionCellState with _$BoardSelectOptionCellState { factory BoardSelectOptionCellState.initial( GridSelectOptionCellController context) { final data = context.getCellData(); - return BoardSelectOptionCellState( selectedOptions: data?.selectOptions ?? [], ); diff --git a/frontend/app_flowy/lib/plugins/board/application/group_controller.dart b/frontend/app_flowy/lib/plugins/board/application/group_controller.dart index 3f545dae3b..b0a89baaa3 100644 --- a/frontend/app_flowy/lib/plugins/board/application/group_controller.dart +++ b/frontend/app_flowy/lib/plugins/board/application/group_controller.dart @@ -34,9 +34,22 @@ class GroupController { void startListening() { _listener.start(onGroupChanged: (result) { result.fold( - (GroupRowsChangesetPB changeset) { + (GroupChangesetPB changeset) { + for (final deletedRow in changeset.deletedRows) { + group.rows.removeWhere((rowPB) => rowPB.id == deletedRow); + delegate.removeRow(group.groupId, deletedRow); + } + for (final insertedRow in changeset.insertedRows) { final index = insertedRow.hasIndex() ? insertedRow.index : null; + + if (insertedRow.hasIndex() && + group.rows.length > insertedRow.index) { + group.rows.insert(insertedRow.index, insertedRow.row); + } else { + group.rows.add(insertedRow.row); + } + delegate.insertRow( group.groupId, insertedRow.row, @@ -44,11 +57,15 @@ class GroupController { ); } - for (final deletedRow in changeset.deletedRows) { - delegate.removeRow(group.groupId, deletedRow); - } - for (final updatedRow in changeset.updatedRows) { + final index = group.rows.indexWhere( + (rowPB) => rowPB.id == updatedRow.id, + ); + + if (index != -1) { + group.rows[index] = updatedRow; + } + delegate.updateRow(group.groupId, updatedRow); } }, diff --git a/frontend/app_flowy/lib/plugins/board/application/group_listener.dart b/frontend/app_flowy/lib/plugins/board/application/group_listener.dart index 797177deca..e3b626af07 100644 --- a/frontend/app_flowy/lib/plugins/board/application/group_listener.dart +++ b/frontend/app_flowy/lib/plugins/board/application/group_listener.dart @@ -8,7 +8,7 @@ import 'package:flowy_sdk/protobuf/flowy-grid/group.pb.dart'; import 'package:dartz/dartz.dart'; import 'package:flowy_sdk/protobuf/flowy-grid/group_changeset.pb.dart'; -typedef UpdateGroupNotifiedValue = Either; +typedef UpdateGroupNotifiedValue = Either; class GroupListener { final GroupPB group; @@ -34,7 +34,7 @@ class GroupListener { case GridNotification.DidUpdateGroup: result.fold( (payload) => _groupNotifier?.value = - left(GroupRowsChangesetPB.fromBuffer(payload)), + left(GroupChangesetPB.fromBuffer(payload)), (error) => _groupNotifier?.value = right(error), ); break; diff --git a/frontend/app_flowy/lib/plugins/board/board.dart b/frontend/app_flowy/lib/plugins/board/board.dart index c55d7f2e17..213cc8bc3c 100644 --- a/frontend/app_flowy/lib/plugins/board/board.dart +++ b/frontend/app_flowy/lib/plugins/board/board.dart @@ -31,7 +31,7 @@ class BoardPluginBuilder implements PluginBuilder { class BoardPluginConfig implements PluginConfig { @override - bool get creatable => false; + bool get creatable => true; } class BoardPlugin extends Plugin { diff --git a/frontend/app_flowy/lib/plugins/board/presentation/board_page.dart b/frontend/app_flowy/lib/plugins/board/presentation/board_page.dart index e7202e0a6d..45e9b574df 100644 --- a/frontend/app_flowy/lib/plugins/board/presentation/board_page.dart +++ b/frontend/app_flowy/lib/plugins/board/presentation/board_page.dart @@ -9,6 +9,9 @@ import 'package:app_flowy/plugins/grid/application/row/row_data_controller.dart' import 'package:app_flowy/plugins/grid/presentation/widgets/cell/cell_builder.dart'; import 'package:app_flowy/plugins/grid/presentation/widgets/row/row_detail.dart'; import 'package:appflowy_board/appflowy_board.dart'; +import 'package:flowy_infra/image.dart'; +import 'package:flowy_infra/theme.dart'; +import 'package:flowy_infra_ui/style_widget/text.dart'; import 'package:flowy_infra_ui/widget/error_page.dart'; import 'package:flowy_sdk/protobuf/flowy-folder/view.pb.dart'; import 'package:flowy_sdk/protobuf/flowy-grid/block_entities.pb.dart'; @@ -62,12 +65,15 @@ class BoardContent extends StatelessWidget { child: Padding( padding: const EdgeInsets.symmetric(vertical: 10, horizontal: 20), child: AFBoard( - // key: UniqueKey(), scrollController: ScrollController(), - dataController: context.read().afBoardDataController, + dataController: context.read().boardController, headerBuilder: _buildHeader, footBuilder: _buildFooter, - cardBuilder: (_, data) => _buildCard(context, data), + cardBuilder: (_, column, columnItem) => _buildCard( + context, + column, + columnItem, + ), columnConstraints: const BoxConstraints.tightFor(width: 240), config: AFBoardConfig( columnBackgroundColor: HexColor.fromHex('#F7F8FC'), @@ -79,34 +85,64 @@ class BoardContent extends StatelessWidget { ); } - Widget _buildHeader(BuildContext context, AFBoardColumnData columnData) { + Widget _buildHeader( + BuildContext context, AFBoardColumnHeaderData headerData) { return AppFlowyColumnHeader( - icon: const Icon(Icons.lightbulb_circle), - title: Text(columnData.desc), - addIcon: const Icon(Icons.add, size: 20), - moreIcon: const Icon(Icons.more_horiz, size: 20), + title: Flexible( + fit: FlexFit.tight, + child: FlowyText.medium( + headerData.columnName, + fontSize: 14, + overflow: TextOverflow.clip, + color: context.read().textColor, + ), + ), + // addIcon: const Icon(Icons.add, size: 20), + // moreIcon: SizedBox( + // width: 20, + // height: 20, + // child: svgWidget( + // 'grid/details', + // color: context.read().iconColor, + // ), + // ), height: 50, - margin: config.columnItemPadding, + margin: config.headerPadding, ); } Widget _buildFooter(BuildContext context, AFBoardColumnData columnData) { return AppFlowyColumnFooter( - icon: const Icon(Icons.add, size: 20), - title: const Text('New'), + icon: SizedBox( + height: 20, + width: 20, + child: svgWidget( + "home/add", + color: context.read().iconColor, + ), + ), + title: FlowyText.medium( + "New", + fontSize: 14, + color: context.read().textColor, + ), height: 50, - margin: config.columnItemPadding, + margin: config.footerPadding, onAddButtonClick: () { context.read().add(BoardEvent.createRow(columnData.id)); }); } - Widget _buildCard(BuildContext context, AFColumnItem item) { - final rowPB = (item as BoardColumnItem).row; + Widget _buildCard( + BuildContext context, + AFBoardColumnData column, + AFColumnItem columnItem, + ) { + final rowPB = (columnItem as BoardColumnItem).row; final rowCache = context.read().getRowCache(rowPB.blockId); /// Return placeholder widget if the rowCache is null. - if (rowCache == null) return SizedBox(key: ObjectKey(item)); + if (rowCache == null) return SizedBox(key: ObjectKey(columnItem)); final fieldCache = context.read().fieldCache; final gridId = context.read().gridId; @@ -123,9 +159,12 @@ class BoardContent extends StatelessWidget { ); return AppFlowyColumnItemCard( - key: ObjectKey(item), + key: ObjectKey(columnItem), + margin: config.cardPadding, + decoration: _makeBoxDecoration(context), child: BoardCard( gridId: gridId, + groupId: column.id, isEditing: isEditing, cellBuilder: cellBuilder, dataController: cardController, @@ -143,6 +182,16 @@ class BoardContent extends StatelessWidget { ); } + BoxDecoration _makeBoxDecoration(BuildContext context) { + final theme = context.read(); + final borderSide = BorderSide(color: theme.shader6, width: 1.0); + return BoxDecoration( + color: theme.surface, + border: Border.fromBorderSide(borderSide), + borderRadius: const BorderRadius.all(Radius.circular(6)), + ); + } + void _openCard(String gridId, GridFieldCache fieldCache, RowPB rowPB, GridRowCache rowCache, BuildContext context) { final rowInfo = RowInfo( diff --git a/frontend/app_flowy/lib/plugins/board/presentation/card/board_checkbox_cell.dart b/frontend/app_flowy/lib/plugins/board/presentation/card/board_checkbox_cell.dart index c816964d3c..f832d3749d 100644 --- a/frontend/app_flowy/lib/plugins/board/presentation/card/board_checkbox_cell.dart +++ b/frontend/app_flowy/lib/plugins/board/presentation/card/board_checkbox_cell.dart @@ -6,9 +6,11 @@ import 'package:flutter/material.dart'; import 'package:flutter_bloc/flutter_bloc.dart'; class BoardCheckboxCell extends StatefulWidget { + final String groupId; final GridCellControllerBuilder cellControllerBuilder; const BoardCheckboxCell({ + required this.groupId, required this.cellControllerBuilder, Key? key, }) : super(key: key); @@ -34,6 +36,8 @@ class _BoardCheckboxCellState extends State { return BlocProvider.value( value: _cellBloc, child: BlocBuilder( + buildWhen: (previous, current) => + previous.isSelected != current.isSelected, builder: (context, state) { final icon = state.isSelected ? svgWidget('editor/editor_check') diff --git a/frontend/app_flowy/lib/plugins/board/presentation/card/board_date_cell.dart b/frontend/app_flowy/lib/plugins/board/presentation/card/board_date_cell.dart index 4a52d82116..47472a0f9f 100644 --- a/frontend/app_flowy/lib/plugins/board/presentation/card/board_date_cell.dart +++ b/frontend/app_flowy/lib/plugins/board/presentation/card/board_date_cell.dart @@ -1,13 +1,16 @@ import 'package:app_flowy/plugins/board/application/card/board_date_cell_bloc.dart'; import 'package:app_flowy/plugins/grid/application/cell/cell_service/cell_service.dart'; +import 'package:flowy_infra/theme.dart'; import 'package:flowy_infra_ui/style_widget/text.dart'; import 'package:flutter/material.dart'; import 'package:flutter_bloc/flutter_bloc.dart'; class BoardDateCell extends StatefulWidget { + final String groupId; final GridCellControllerBuilder cellControllerBuilder; const BoardDateCell({ + required this.groupId, required this.cellControllerBuilder, Key? key, }) : super(key: key); @@ -34,6 +37,7 @@ class _BoardDateCellState extends State { return BlocProvider.value( value: _cellBloc, child: BlocBuilder( + buildWhen: (previous, current) => previous.dateStr != current.dateStr, builder: (context, state) { if (state.dateStr.isEmpty) { return const SizedBox(); @@ -42,7 +46,8 @@ class _BoardDateCellState extends State { alignment: Alignment.centerLeft, child: FlowyText.regular( state.dateStr, - fontSize: 14, + fontSize: 13, + color: context.read().shader3, ), ); } diff --git a/frontend/app_flowy/lib/plugins/board/presentation/card/board_number_cell.dart b/frontend/app_flowy/lib/plugins/board/presentation/card/board_number_cell.dart index 096592583e..0f4aca6b61 100644 --- a/frontend/app_flowy/lib/plugins/board/presentation/card/board_number_cell.dart +++ b/frontend/app_flowy/lib/plugins/board/presentation/card/board_number_cell.dart @@ -5,9 +5,11 @@ import 'package:flutter/material.dart'; import 'package:flutter_bloc/flutter_bloc.dart'; class BoardNumberCell extends StatefulWidget { + final String groupId; final GridCellControllerBuilder cellControllerBuilder; const BoardNumberCell({ + required this.groupId, required this.cellControllerBuilder, Key? key, }) : super(key: key); @@ -34,13 +36,14 @@ class _BoardNumberCellState extends State { return BlocProvider.value( value: _cellBloc, child: BlocBuilder( + buildWhen: (previous, current) => previous.content != current.content, builder: (context, state) { if (state.content.isEmpty) { return const SizedBox(); } else { return Align( alignment: Alignment.centerLeft, - child: FlowyText.regular( + child: FlowyText.medium( state.content, fontSize: 14, ), diff --git a/frontend/app_flowy/lib/plugins/board/presentation/card/board_select_option_cell.dart b/frontend/app_flowy/lib/plugins/board/presentation/card/board_select_option_cell.dart index 373bb3c850..f75de47651 100644 --- a/frontend/app_flowy/lib/plugins/board/presentation/card/board_select_option_cell.dart +++ b/frontend/app_flowy/lib/plugins/board/presentation/card/board_select_option_cell.dart @@ -5,9 +5,11 @@ import 'package:flutter/material.dart'; import 'package:flutter_bloc/flutter_bloc.dart'; class BoardSelectOptionCell extends StatefulWidget { + final String groupId; final GridCellControllerBuilder cellControllerBuilder; const BoardSelectOptionCell({ + required this.groupId, required this.cellControllerBuilder, Key? key, }) : super(key: key); @@ -33,23 +35,29 @@ class _BoardSelectOptionCellState extends State { return BlocProvider.value( value: _cellBloc, child: BlocBuilder( + buildWhen: (previous, current) => + previous.selectedOptions != current.selectedOptions, builder: (context, state) { - final children = state.selectedOptions - .map((option) => SelectOptionTag.fromOption( + if (state.selectedOptions + .where((element) => element.id == widget.groupId) + .isNotEmpty) { + return const SizedBox(); + } else { + final children = state.selectedOptions + .map( + (option) => SelectOptionTag.fromOption( context: context, option: option, - )) - .toList(); - return Align( - alignment: Alignment.centerLeft, - child: AbsorbPointer( - child: Wrap( - children: children, - spacing: 4, - runSpacing: 2, + ), + ) + .toList(); + return Align( + alignment: Alignment.centerLeft, + child: AbsorbPointer( + child: Wrap(children: children, spacing: 4, runSpacing: 2), ), - ), - ); + ); + } }, ), ); diff --git a/frontend/app_flowy/lib/plugins/board/presentation/card/board_text_cell.dart b/frontend/app_flowy/lib/plugins/board/presentation/card/board_text_cell.dart index 2da156ded8..deea60e793 100644 --- a/frontend/app_flowy/lib/plugins/board/presentation/card/board_text_cell.dart +++ b/frontend/app_flowy/lib/plugins/board/presentation/card/board_text_cell.dart @@ -5,9 +5,13 @@ import 'package:flutter/material.dart'; import 'package:flutter_bloc/flutter_bloc.dart'; class BoardTextCell extends StatefulWidget { + final String groupId; final GridCellControllerBuilder cellControllerBuilder; - const BoardTextCell({required this.cellControllerBuilder, Key? key}) - : super(key: key); + const BoardTextCell({ + required this.groupId, + required this.cellControllerBuilder, + Key? key, + }) : super(key: key); @override State createState() => _BoardTextCellState(); @@ -31,6 +35,7 @@ class _BoardTextCellState extends State { return BlocProvider.value( value: _cellBloc, child: BlocBuilder( + buildWhen: (previous, current) => previous.content != current.content, builder: (context, state) { if (state.content.isEmpty) { return const SizedBox(); @@ -38,13 +43,8 @@ class _BoardTextCellState extends State { return Align( alignment: Alignment.centerLeft, child: ConstrainedBox( - constraints: BoxConstraints.loose( - const Size(double.infinity, 100), - ), - child: FlowyText.regular( - state.content, - fontSize: 14, - ), + constraints: const BoxConstraints(maxHeight: 120), + child: FlowyText.medium(state.content, fontSize: 14), ), ); } diff --git a/frontend/app_flowy/lib/plugins/board/presentation/card/board_url_cell.dart b/frontend/app_flowy/lib/plugins/board/presentation/card/board_url_cell.dart index 31cca41e6a..40cdec7c2f 100644 --- a/frontend/app_flowy/lib/plugins/board/presentation/card/board_url_cell.dart +++ b/frontend/app_flowy/lib/plugins/board/presentation/card/board_url_cell.dart @@ -5,9 +5,11 @@ import 'package:flutter/material.dart'; import 'package:flutter_bloc/flutter_bloc.dart'; class BoardUrlCell extends StatefulWidget { + final String groupId; final GridCellControllerBuilder cellControllerBuilder; const BoardUrlCell({ + required this.groupId, required this.cellControllerBuilder, Key? key, }) : super(key: key); @@ -34,6 +36,7 @@ class _BoardUrlCellState extends State { return BlocProvider.value( value: _cellBloc, child: BlocBuilder( + buildWhen: (previous, current) => previous.content != current.content, builder: (context, state) { if (state.content.isEmpty) { return const SizedBox(); diff --git a/frontend/app_flowy/lib/plugins/board/presentation/card/card.dart b/frontend/app_flowy/lib/plugins/board/presentation/card/card.dart index a5c7b7ba2c..65c7d3dade 100644 --- a/frontend/app_flowy/lib/plugins/board/presentation/card/card.dart +++ b/frontend/app_flowy/lib/plugins/board/presentation/card/card.dart @@ -14,6 +14,7 @@ typedef OnEndEditing = void Function(String rowId); class BoardCard extends StatefulWidget { final String gridId; + final String groupId; final bool isEditing; final CardDataController dataController; final BoardCellBuilder cellBuilder; @@ -22,6 +23,7 @@ class BoardCard extends StatefulWidget { const BoardCard({ required this.gridId, + required this.groupId, required this.isEditing, required this.dataController, required this.cellBuilder, @@ -42,7 +44,7 @@ class _BoardCardState extends State { _cardBloc = BoardCardBloc( gridId: widget.gridId, dataController: widget.dataController, - ); + )..add(const BoardCardEvent.initial()); super.initState(); } @@ -71,14 +73,20 @@ class _BoardCardState extends State { List _makeCells(BuildContext context, GridCellMap cellMap) { return cellMap.values.map( (cellId) { - final child = widget.cellBuilder.buildCell(cellId); + final child = widget.cellBuilder.buildCell(widget.groupId, cellId); return Padding( - padding: const EdgeInsets.symmetric(horizontal: 8, vertical: 5), + padding: const EdgeInsets.only(left: 4, right: 4, top: 6), child: child, ); }, ).toList(); } + + @override + Future dispose() async { + _cardBloc.close(); + super.dispose(); + } } class _CardMoreOption extends StatelessWidget with CardAccessory { @@ -86,7 +94,7 @@ class _CardMoreOption extends StatelessWidget with CardAccessory { @override Widget build(BuildContext context) { - return svgWidget('home/details', color: context.read().iconColor); + return svgWidget('grid/details', color: context.read().iconColor); } @override diff --git a/frontend/app_flowy/lib/plugins/board/presentation/card/card_cell_builder.dart b/frontend/app_flowy/lib/plugins/board/presentation/card/card_cell_builder.dart index 10ae0db680..83dbf584e8 100644 --- a/frontend/app_flowy/lib/plugins/board/presentation/card/card_cell_builder.dart +++ b/frontend/app_flowy/lib/plugins/board/presentation/card/card_cell_builder.dart @@ -19,7 +19,7 @@ class BoardCellBuilder { BoardCellBuilder(this.delegate); - Widget buildCell(GridCellIdentifier cellId) { + Widget buildCell(String groupId, GridCellIdentifier cellId) { final cellControllerBuilder = GridCellControllerBuilder( delegate: delegate, cellId: cellId, @@ -30,36 +30,43 @@ class BoardCellBuilder { switch (cellId.fieldType) { case FieldType.Checkbox: return BoardCheckboxCell( + groupId: groupId, cellControllerBuilder: cellControllerBuilder, key: key, ); case FieldType.DateTime: return BoardDateCell( + groupId: groupId, cellControllerBuilder: cellControllerBuilder, key: key, ); case FieldType.SingleSelect: return BoardSelectOptionCell( + groupId: groupId, cellControllerBuilder: cellControllerBuilder, key: key, ); case FieldType.MultiSelect: return BoardSelectOptionCell( + groupId: groupId, cellControllerBuilder: cellControllerBuilder, key: key, ); case FieldType.Number: return BoardNumberCell( + groupId: groupId, cellControllerBuilder: cellControllerBuilder, key: key, ); case FieldType.RichText: return BoardTextCell( + groupId: groupId, cellControllerBuilder: cellControllerBuilder, key: key, ); case FieldType.URL: return BoardUrlCell( + groupId: groupId, cellControllerBuilder: cellControllerBuilder, key: key, ); diff --git a/frontend/app_flowy/lib/plugins/board/presentation/card/card_container.dart b/frontend/app_flowy/lib/plugins/board/presentation/card/card_container.dart index abca27e5c5..0e0a7287ae 100644 --- a/frontend/app_flowy/lib/plugins/board/presentation/card/card_container.dart +++ b/frontend/app_flowy/lib/plugins/board/presentation/card/card_container.dart @@ -74,6 +74,7 @@ class CardAccessoryContainer extends StatelessWidget { width: 26, height: 26, padding: const EdgeInsets.all(3), + decoration: _makeBoxDecoration(context), child: accessory, ), ); @@ -88,6 +89,23 @@ class CardAccessoryContainer extends StatelessWidget { } } +BoxDecoration _makeBoxDecoration(BuildContext context) { + final theme = context.read(); + final borderSide = BorderSide(color: theme.shader6, width: 1.0); + return BoxDecoration( + color: theme.surface, + border: Border.fromBorderSide(borderSide), + boxShadow: [ + BoxShadow( + color: theme.shader6, + spreadRadius: 0, + blurRadius: 2, + offset: Offset.zero) + ], + borderRadius: const BorderRadius.all(Radius.circular(6)), + ); +} + class _CardEnterRegion extends StatelessWidget { final Widget child; final List accessories; @@ -116,7 +134,7 @@ class _CardEnterRegion extends StatelessWidget { .onEnter = false, child: IntrinsicHeight( child: Stack( - alignment: AlignmentDirectional.center, + alignment: AlignmentDirectional.topEnd, fit: StackFit.expand, children: children, )), diff --git a/frontend/app_flowy/lib/plugins/board/presentation/card/define.dart b/frontend/app_flowy/lib/plugins/board/presentation/card/define.dart new file mode 100644 index 0000000000..5fc55743db --- /dev/null +++ b/frontend/app_flowy/lib/plugins/board/presentation/card/define.dart @@ -0,0 +1,3 @@ +class BoardSizes { + static double get cardCellVPadding => 6; +} diff --git a/frontend/app_flowy/lib/plugins/grid/application/cell/cell_service/cell_data_loader.dart b/frontend/app_flowy/lib/plugins/grid/application/cell/cell_service/cell_data_loader.dart index c4b3430199..a6a1ba43a9 100644 --- a/frontend/app_flowy/lib/plugins/grid/application/cell/cell_service/cell_data_loader.dart +++ b/frontend/app_flowy/lib/plugins/grid/application/cell/cell_service/cell_data_loader.dart @@ -24,18 +24,21 @@ class GridCellDataLoader { Future loadData() { final fut = service.getCell(cellId: cellId); return fut.then( - (result) => result.fold((GridCellPB cell) { - try { - return parser.parserData(cell.data); - } catch (e, s) { - Log.error('$parser parser cellData failed, $e'); - Log.error('Stack trace \n $s'); + (result) => result.fold( + (GridCellPB cell) { + try { + return parser.parserData(cell.data); + } catch (e, s) { + Log.error('$parser parser cellData failed, $e'); + Log.error('Stack trace \n $s'); + return null; + } + }, + (err) { + Log.error(err); return null; - } - }, (err) { - Log.error(err); - return null; - }), + }, + ), ); } } @@ -58,7 +61,8 @@ class DateCellDataParser implements IGridCellDataParser { } } -class SelectOptionCellDataParser implements IGridCellDataParser { +class SelectOptionCellDataParser + implements IGridCellDataParser { @override SelectOptionCellDataPB? parserData(List data) { if (data.isEmpty) { diff --git a/frontend/app_flowy/lib/plugins/grid/application/cell/cell_service/context_builder.dart b/frontend/app_flowy/lib/plugins/grid/application/cell/cell_service/context_builder.dart index 1068cbf36b..8ab486a48c 100644 --- a/frontend/app_flowy/lib/plugins/grid/application/cell/cell_service/context_builder.dart +++ b/frontend/app_flowy/lib/plugins/grid/application/cell/cell_service/context_builder.dart @@ -190,7 +190,10 @@ class IGridCellController extends Equatable { /// cell display: $12 _cellListener?.start(onCellChanged: (result) { result.fold( - (_) => _loadData(), + (_) { + _cellsCache.remove(fieldId); + _loadData(); + }, (err) => Log.error(err), ); }); @@ -279,8 +282,8 @@ class IGridCellController extends Equatable { _loadDataOperation?.cancel(); _loadDataOperation = Timer(const Duration(milliseconds: 10), () { _cellDataLoader.loadData().then((data) { - _cellDataNotifier?.value = data; _cellsCache.insert(_cacheKey, GridCell(object: data)); + _cellDataNotifier?.value = data; }); }); } diff --git a/frontend/app_flowy/lib/plugins/grid/application/grid_service.dart b/frontend/app_flowy/lib/plugins/grid/application/grid_service.dart index 8c46ce18b2..c8b6873d91 100644 --- a/frontend/app_flowy/lib/plugins/grid/application/grid_service.dart +++ b/frontend/app_flowy/lib/plugins/grid/application/grid_service.dart @@ -3,7 +3,6 @@ import 'package:flowy_sdk/dispatch/dispatch.dart'; import 'package:flowy_sdk/protobuf/flowy-error/errors.pb.dart'; import 'package:flowy_sdk/protobuf/flowy-folder/view.pb.dart'; import 'package:flowy_sdk/protobuf/flowy-grid/block_entities.pb.dart'; -import 'package:flowy_sdk/protobuf/flowy-grid/board_card.pb.dart'; import 'package:flowy_sdk/protobuf/flowy-grid/field_entities.pb.dart'; import 'package:flowy_sdk/protobuf/flowy-grid/grid_entities.pb.dart'; import 'package:flowy_sdk/protobuf/flowy-grid/group.pb.dart'; diff --git a/frontend/app_flowy/lib/plugins/grid/application/row/row_service.dart b/frontend/app_flowy/lib/plugins/grid/application/row/row_service.dart index a18c0c8e75..2612f5975c 100644 --- a/frontend/app_flowy/lib/plugins/grid/application/row/row_service.dart +++ b/frontend/app_flowy/lib/plugins/grid/application/row/row_service.dart @@ -3,6 +3,7 @@ import 'package:flowy_sdk/dispatch/dispatch.dart'; import 'package:flowy_sdk/protobuf/flowy-error/errors.pb.dart'; import 'package:flowy_sdk/protobuf/flowy-grid/block_entities.pb.dart'; import 'package:flowy_sdk/protobuf/flowy-grid/grid_entities.pb.dart'; +import 'package:flowy_sdk/protobuf/flowy-grid/group_changeset.pb.dart'; import 'package:flowy_sdk/protobuf/flowy-grid/row_entities.pb.dart'; class RowFFIService { @@ -68,4 +69,33 @@ class MoveRowFFIService { return GridEventMoveRow(payload).send(); } + + Future> moveGroupRow({ + required String fromRowId, + required String toGroupId, + required String? toRowId, + }) { + var payload = MoveGroupRowPayloadPB.create() + ..viewId = gridId + ..fromRowId = fromRowId + ..toGroupId = toGroupId; + + if (toRowId != null) { + payload.toRowId = toRowId; + } + + return GridEventMoveGroupRow(payload).send(); + } + + Future> moveGroup({ + required String fromGroupId, + required String toGroupId, + }) { + final payload = MoveGroupPayloadPB.create() + ..viewId = gridId + ..fromGroupId = fromGroupId + ..toGroupId = toGroupId; + + return GridEventMoveGroup(payload).send(); + } } diff --git a/frontend/app_flowy/lib/plugins/grid/presentation/widgets/cell/select_option_cell/extension.dart b/frontend/app_flowy/lib/plugins/grid/presentation/widgets/cell/select_option_cell/extension.dart index 6fdd8bf6f8..f045984e66 100644 --- a/frontend/app_flowy/lib/plugins/grid/presentation/widgets/cell/select_option_cell/extension.dart +++ b/frontend/app_flowy/lib/plugins/grid/presentation/widgets/cell/select_option_cell/extension.dart @@ -91,8 +91,11 @@ class SelectOptionTag extends StatelessWidget { Widget build(BuildContext context) { return ChoiceChip( pressElevation: 1, - label: - FlowyText.medium(name, fontSize: 12, overflow: TextOverflow.ellipsis), + label: FlowyText.medium( + name, + fontSize: 12, + overflow: TextOverflow.clip, + ), selectedColor: color, backgroundColor: color, labelPadding: const EdgeInsets.symmetric(horizontal: 6), diff --git a/frontend/app_flowy/lib/startup/plugin/plugin.dart b/frontend/app_flowy/lib/startup/plugin/plugin.dart index 6e06450295..168be76359 100644 --- a/frontend/app_flowy/lib/startup/plugin/plugin.dart +++ b/frontend/app_flowy/lib/startup/plugin/plugin.dart @@ -56,7 +56,7 @@ abstract class PluginBuilder { ViewDataTypePB get dataType => ViewDataTypePB.Text; - ViewLayoutTypePB? get subDataType => null; + ViewLayoutTypePB? get subDataType => ViewLayoutTypePB.Document; } abstract class PluginConfig { diff --git a/frontend/app_flowy/packages/appflowy_board/CHANGELOG.md b/frontend/app_flowy/packages/appflowy_board/CHANGELOG.md index 76f33711b1..c4c6495533 100644 --- a/frontend/app_flowy/packages/appflowy_board/CHANGELOG.md +++ b/frontend/app_flowy/packages/appflowy_board/CHANGELOG.md @@ -1,16 +1,21 @@ +# 0.0.5 +* Optimize insert card animation +* Enable insert card at the end of the column +* Fix some bugs + # 0.0.4 -* fix some bugs +* Fix some bugs # 0.0.3 * Support customize UI * Update example * Add AppFlowy style widget -## 0.0.2 +# 0.0.2 * Update documentation -## 0.0.1 +# 0.0.1 * Support drag and drop column * Support drag and drop column items from one to another diff --git a/frontend/app_flowy/packages/appflowy_board/example/lib/multi_board_list_example.dart b/frontend/app_flowy/packages/appflowy_board/example/lib/multi_board_list_example.dart index 83f75d2a0e..e571a0559b 100644 --- a/frontend/app_flowy/packages/appflowy_board/example/lib/multi_board_list_example.dart +++ b/frontend/app_flowy/packages/appflowy_board/example/lib/multi_board_list_example.dart @@ -10,7 +10,7 @@ class MultiBoardListExample extends StatefulWidget { class _MultiBoardListExampleState extends State { final AFBoardDataController boardDataController = AFBoardDataController( - onMoveColumn: (fromIndex, toIndex) { + onMoveColumn: (fromColumnId, fromIndex, toColumnId, toIndex) { debugPrint('Move column from $fromIndex to $toIndex'); }, onMoveColumnItem: (columnId, fromIndex, toIndex) { @@ -26,16 +26,26 @@ class _MultiBoardListExampleState extends State { List a = [ TextItem("Card 1"), TextItem("Card 2"), - // RichTextItem(title: "Card 3", subtitle: 'Aug 1, 2020 4:05 PM'), + RichTextItem(title: "Card 3", subtitle: 'Aug 1, 2020 4:05 PM'), TextItem("Card 4"), + TextItem("Card 5"), + TextItem("Card 6"), + RichTextItem(title: "Card 7", subtitle: 'Aug 1, 2020 4:05 PM'), + RichTextItem(title: "Card 8", subtitle: 'Aug 1, 2020 4:05 PM'), + TextItem("Card 9"), ]; - final column1 = AFBoardColumnData(id: "To Do", items: a); - final column2 = AFBoardColumnData(id: "In Progress", items: [ - // RichTextItem(title: "Card 5", subtitle: 'Aug 1, 2020 4:05 PM'), - // TextItem("Card 6"), - ]); + final column1 = AFBoardColumnData(id: "To Do", name: "To Do", items: a); + final column2 = AFBoardColumnData( + id: "In Progress", + name: "In Progress", + items: [ + RichTextItem(title: "Card 10", subtitle: 'Aug 1, 2020 4:05 PM'), + TextItem("Card 11"), + ], + ); - final column3 = AFBoardColumnData(id: "Done", items: []); + final column3 = + AFBoardColumnData(id: "Done", name: "Done", items: []); boardDataController.addColumn(column1); boardDataController.addColumn(column2); @@ -63,20 +73,31 @@ class _MultiBoardListExampleState extends State { margin: config.columnItemPadding, ); }, - headerBuilder: (context, columnData) { + headerBuilder: (context, headerData) { return AppFlowyColumnHeader( icon: const Icon(Icons.lightbulb_circle), - title: Text(columnData.id), + title: SizedBox( + width: 60, + child: TextField( + controller: TextEditingController() + ..text = headerData.columnName, + onSubmitted: (val) { + boardDataController + .getColumnController(headerData.columnId)! + .updateColumnName(val); + }, + ), + ), addIcon: const Icon(Icons.add, size: 20), moreIcon: const Icon(Icons.more_horiz, size: 20), height: 50, margin: config.columnItemPadding, ); }, - cardBuilder: (context, item) { + cardBuilder: (context, column, columnItem) { return AppFlowyColumnItemCard( - key: ObjectKey(item), - child: _buildCard(item), + key: ObjectKey(columnItem), + child: _buildCard(columnItem), ); }, columnConstraints: const BoxConstraints.tightFor(width: 240), @@ -93,7 +114,7 @@ class _MultiBoardListExampleState extends State { return Align( alignment: Alignment.centerLeft, child: Padding( - padding: const EdgeInsets.symmetric(horizontal: 20), + padding: const EdgeInsets.symmetric(horizontal: 20, vertical: 60), child: Text(item.s), ), ); @@ -103,7 +124,7 @@ class _MultiBoardListExampleState extends State { return Align( alignment: Alignment.centerLeft, child: Padding( - padding: const EdgeInsets.all(20), + padding: const EdgeInsets.symmetric(horizontal: 20, vertical: 60), child: Column( crossAxisAlignment: CrossAxisAlignment.start, children: [ diff --git a/frontend/app_flowy/packages/appflowy_board/example/lib/single_board_list_example.dart b/frontend/app_flowy/packages/appflowy_board/example/lib/single_board_list_example.dart index 97e83df448..f22c562343 100644 --- a/frontend/app_flowy/packages/appflowy_board/example/lib/single_board_list_example.dart +++ b/frontend/app_flowy/packages/appflowy_board/example/lib/single_board_list_example.dart @@ -13,12 +13,16 @@ class _SingleBoardListExampleState extends State { @override void initState() { - final column = AFBoardColumnData(id: "1", items: [ - TextItem("a"), - TextItem("b"), - TextItem("c"), - TextItem("d"), - ]); + final column = AFBoardColumnData( + id: "1", + name: "1", + items: [ + TextItem("a"), + TextItem("b"), + TextItem("c"), + TextItem("d"), + ], + ); boardData.addColumn(column); super.initState(); @@ -28,8 +32,9 @@ class _SingleBoardListExampleState extends State { Widget build(BuildContext context) { return AFBoard( dataController: boardData, - cardBuilder: (context, item) { - return _RowWidget(item: item as TextItem, key: ObjectKey(item)); + cardBuilder: (context, column, columnItem) { + return _RowWidget( + item: columnItem as TextItem, key: ObjectKey(columnItem)); }, ); } diff --git a/frontend/app_flowy/packages/appflowy_board/lib/src/utils/log.dart b/frontend/app_flowy/packages/appflowy_board/lib/src/utils/log.dart index 20f810a966..9c23060b26 100644 --- a/frontend/app_flowy/packages/appflowy_board/lib/src/utils/log.dart +++ b/frontend/app_flowy/packages/appflowy_board/lib/src/utils/log.dart @@ -4,8 +4,6 @@ import 'package:flutter/material.dart'; const DART_LOG = "Dart_LOG"; class Log { - // static const enableLog = bool.hasEnvironment(DART_LOG); - // static final shared = Log(); static const enableLog = false; static void info(String? message) { @@ -16,19 +14,19 @@ class Log { static void debug(String? message) { if (enableLog) { - debugPrint('🐛[Debug]=> $message'); + debugPrint('🐛[Debug] - ${DateTime.now().second}=> $message'); } } static void warn(String? message) { if (enableLog) { - debugPrint('🐛[Warn]=> $message'); + debugPrint('🐛[Warn] - ${DateTime.now().second} => $message'); } } static void trace(String? message) { if (enableLog) { - // debugPrint('❗️[Trace]=> $message'); + debugPrint('❗️[Trace] - ${DateTime.now().second}=> $message'); } } } diff --git a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board.dart b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board.dart index 20824ba6b9..dc7ae1c02f 100644 --- a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board.dart +++ b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board.dart @@ -12,12 +12,18 @@ class AFBoardConfig { final double cornerRadius; final EdgeInsets columnPadding; final EdgeInsets columnItemPadding; + final EdgeInsets footerPadding; + final EdgeInsets headerPadding; + final EdgeInsets cardPadding; final Color columnBackgroundColor; const AFBoardConfig({ this.cornerRadius = 6.0, this.columnPadding = const EdgeInsets.symmetric(horizontal: 8), - this.columnItemPadding = const EdgeInsets.symmetric(horizontal: 10), + this.columnItemPadding = const EdgeInsets.symmetric(horizontal: 12), + this.footerPadding = const EdgeInsets.symmetric(horizontal: 12), + this.headerPadding = const EdgeInsets.symmetric(horizontal: 16), + this.cardPadding = const EdgeInsets.symmetric(horizontal: 3, vertical: 4), this.columnBackgroundColor = Colors.transparent, }); } @@ -159,7 +165,7 @@ class _BoardContentState extends State { dataSource: widget.dataController, direction: Axis.horizontal, interceptor: interceptor, - children: _buildColumns(), + children: _buildColumns(interceptor.columnKeys), ); return Stack( @@ -191,7 +197,7 @@ class _BoardContentState extends State { ); } - List _buildColumns() { + List _buildColumns(List columnKeys) { final List children = widget.dataController.columnDatas.asMap().entries.map( (item) { @@ -205,24 +211,35 @@ class _BoardContentState extends State { return ChangeNotifierProvider.value( key: ValueKey(columnData.id), - value: widget.dataController.columnController(columnData.id), + value: widget.dataController.getColumnController(columnData.id), child: Consumer( builder: (context, value, child) { + final boardColumn = AFBoardColumnWidget( + margin: _marginFromIndex(columnIndex), + itemMargin: widget.config.columnItemPadding, + headerBuilder: _buildHeader, + footBuilder: widget.footBuilder, + cardBuilder: widget.cardBuilder, + dataSource: dataSource, + scrollController: ScrollController(), + phantomController: widget.phantomController, + onReorder: widget.dataController.moveColumnItem, + cornerRadius: widget.config.cornerRadius, + backgroundColor: widget.config.columnBackgroundColor, + ); + + // columnKeys + // .removeWhere((element) => element.columnId == columnData.id); + // columnKeys.add( + // ColumnKey( + // columnId: columnData.id, + // key: boardColumn.columnGlobalKey, + // ), + // ); + return ConstrainedBox( constraints: widget.columnConstraints, - child: AFBoardColumnWidget( - margin: _marginFromIndex(columnIndex), - itemMargin: widget.config.columnItemPadding, - headerBuilder: widget.headerBuilder, - footBuilder: widget.footBuilder, - cardBuilder: widget.cardBuilder, - dataSource: dataSource, - scrollController: ScrollController(), - phantomController: widget.phantomController, - onReorder: widget.dataController.moveColumnItem, - cornerRadius: widget.config.cornerRadius, - backgroundColor: widget.config.columnBackgroundColor, - ), + child: boardColumn, ); }, ), @@ -233,6 +250,19 @@ class _BoardContentState extends State { return children; } + Widget? _buildHeader( + BuildContext context, AFBoardColumnHeaderData headerData) { + if (widget.headerBuilder == null) { + return null; + } + return Selector( + selector: (context, controller) => controller.columnData.headerData, + builder: (context, headerData, _) { + return widget.headerBuilder!(context, headerData)!; + }, + ); + } + EdgeInsets _marginFromIndex(int index) { if (widget.dataController.columnDatas.isEmpty) { return widget.config.columnPadding; @@ -261,7 +291,7 @@ class _BoardColumnDataSourceImpl extends AFBoardColumnDataDataSource { @override AFBoardColumnData get columnData => - dataController.columnController(columnId).columnData; + dataController.getColumnController(columnId)!.columnData; @override List get acceptedColumnIds => dataController.columnIds; diff --git a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board_column/board_column.dart b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board_column/board_column.dart index cbc537810e..ce053b5c79 100644 --- a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board_column/board_column.dart +++ b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board_column/board_column.dart @@ -24,12 +24,13 @@ typedef OnColumnInserted = void Function(String listId, int insertedIndex); typedef AFBoardColumnCardBuilder = Widget Function( BuildContext context, + AFBoardColumnData columnData, AFColumnItem item, ); -typedef AFBoardColumnHeaderBuilder = Widget Function( +typedef AFBoardColumnHeaderBuilder = Widget? Function( BuildContext context, - AFBoardColumnData columnData, + AFBoardColumnHeaderData headerData, ); typedef AFBoardColumnFooterBuilder = Widget Function( @@ -87,7 +88,9 @@ class AFBoardColumnWidget extends StatefulWidget { final Color backgroundColor; - const AFBoardColumnWidget({ + final GlobalKey columnGlobalKey = GlobalKey(); + + AFBoardColumnWidget({ Key? key, this.headerBuilder, this.footBuilder, @@ -123,8 +126,8 @@ class _AFBoardColumnWidgetState extends State { .map((item) => _buildWidget(context, item)) .toList(); - final header = - widget.headerBuilder?.call(context, widget.dataSource.columnData); + final header = widget.headerBuilder + ?.call(context, widget.dataSource.columnData.headerData); final footer = widget.footBuilder?.call(context, widget.dataSource.columnData); @@ -136,8 +139,8 @@ class _AFBoardColumnWidgetState extends State { draggableTargetBuilder: PhantomDraggableBuilder(), ); - final reorderFlex = ReorderFlex( - key: widget.key, + Widget reorderFlex = ReorderFlex( + key: widget.columnGlobalKey, scrollController: widget.scrollController, config: widget.config, onDragStarted: (index) { @@ -160,6 +163,9 @@ class _AFBoardColumnWidgetState extends State { children: children, ); + // reorderFlex = + // KeyedSubtree(key: widget.columnGlobalKey, child: reorderFlex); + return Container( margin: widget.margin, clipBehavior: Clip.hardEdge, @@ -202,7 +208,7 @@ class _AFBoardColumnWidgetState extends State { passthroughPhantomContext: item.phantomContext, ); } else { - return widget.cardBuilder(context, item); + return widget.cardBuilder(context, widget.dataSource.columnData, item); } } } diff --git a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board_column/board_column_data.dart b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board_column/board_column_data.dart index 6e184761c5..bc442acd2a 100644 --- a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board_column/board_column_data.dart +++ b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board_column/board_column_data.dart @@ -34,6 +34,13 @@ class AFBoardColumnDataController extends ChangeNotifier with EquatableMixin { UnmodifiableListView get items => UnmodifiableListView(columnData.items); + void updateColumnName(String newName) { + if (columnData.headerData.columnName != newName) { + columnData.headerData.columnName = newName; + notifyListeners(); + } + } + /// Remove the item at [index]. /// * [index] the index of the item you want to remove /// * [notify] the default value of [notify] is true, it will notify the @@ -114,6 +121,10 @@ class AFBoardColumnDataController extends ChangeNotifier with EquatableMixin { columnData._items.add(newItem); Log.debug('[$AFBoardColumnDataController] $columnData add $newItem'); } else { + if (index >= columnData._items.length) { + return; + } + final removedItem = columnData._items.removeAt(index); columnData._items.insert(index, newItem); Log.debug( @@ -123,6 +134,18 @@ class AFBoardColumnDataController extends ChangeNotifier with EquatableMixin { notifyListeners(); } + void replaceOrInsertItem(AFColumnItem newItem) { + final index = columnData._items.indexWhere((item) => item.id == newItem.id); + if (index != -1) { + columnData._items.removeAt(index); + columnData._items.insert(index, newItem); + notifyListeners(); + } else { + columnData._items.add(newItem); + notifyListeners(); + } + } + bool _containsItem(AFColumnItem item) { return columnData._items.indexWhere((element) => element.id == item.id) != -1; @@ -133,19 +156,24 @@ class AFBoardColumnDataController extends ChangeNotifier with EquatableMixin { class AFBoardColumnData extends ReoderFlexItem with EquatableMixin { @override final String id; - final String desc; + AFBoardColumnHeaderData headerData; final List _items; final CustomData? customData; AFBoardColumnData({ this.customData, required this.id, - this.desc = "", + required String name, List items = const [], - }) : _items = items; + }) : _items = items, + headerData = AFBoardColumnHeaderData( + columnId: id, + columnName: name, + ); /// Returns the readonly List - UnmodifiableListView get items => UnmodifiableListView(_items); + UnmodifiableListView get items => + UnmodifiableListView([..._items]); @override List get props => [id, ..._items]; @@ -155,3 +183,10 @@ class AFBoardColumnData extends ReoderFlexItem with EquatableMixin { return 'Column:[$id]'; } } + +class AFBoardColumnHeaderData { + String columnId; + String columnName; + + AFBoardColumnHeaderData({required this.columnId, required this.columnName}); +} diff --git a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board_data.dart b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board_data.dart index 6208dbd0f0..2cc853d6a5 100644 --- a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board_data.dart +++ b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/board_data.dart @@ -8,7 +8,12 @@ import 'reorder_flex/reorder_flex.dart'; import 'package:flutter/material.dart'; import 'reorder_phantom/phantom_controller.dart'; -typedef OnMoveColumn = void Function(int fromIndex, int toIndex); +typedef OnMoveColumn = void Function( + String fromColumnId, + int fromIndex, + String toColumnId, + int toIndex, +); typedef OnMoveColumnItem = void Function( String columnId, @@ -84,10 +89,6 @@ class AFBoardDataController extends ChangeNotifier if (columnIds.isNotEmpty && notify) notifyListeners(); } - AFBoardColumnDataController columnController(String columnId) { - return _columnControllers[columnId]!; - } - AFBoardColumnDataController? getColumnController(String columnId) { final columnController = _columnControllers[columnId]; if (columnController == null) { @@ -98,9 +99,11 @@ class AFBoardDataController extends ChangeNotifier } void moveColumn(int fromIndex, int toIndex, {bool notify = true}) { - final columnData = _columnDatas.removeAt(fromIndex); - _columnDatas.insert(toIndex, columnData); - onMoveColumn?.call(fromIndex, toIndex); + final toColumnData = _columnDatas[toIndex]; + final fromColumnData = _columnDatas.removeAt(fromIndex); + + _columnDatas.insert(toIndex, fromColumnData); + onMoveColumn?.call(fromColumnData.id, fromIndex, toColumnData.id, toIndex); if (notify) notifyListeners(); } @@ -122,6 +125,10 @@ class AFBoardDataController extends ChangeNotifier getColumnController(columnId)?.removeWhere((item) => item.id == itemId); } + void updateColumnItem(String columnId, AFColumnItem item) { + getColumnController(columnId)?.replaceOrInsertItem(item); + } + @override @protected void swapColumnItem( @@ -130,15 +137,14 @@ class AFBoardDataController extends ChangeNotifier String toColumnId, int toColumnIndex, ) { - final item = columnController(fromColumnId).removeAt(fromColumnIndex); - - if (columnController(toColumnId).items.length > toColumnIndex) { - assert(columnController(toColumnId).items[toColumnIndex] - is PhantomColumnItem); + final fromColumnController = getColumnController(fromColumnId)!; + final toColumnController = getColumnController(toColumnId)!; + final item = fromColumnController.removeAt(fromColumnIndex); + if (toColumnController.items.length > toColumnIndex) { + assert(toColumnController.items[toColumnIndex] is PhantomColumnItem); } - columnController(toColumnId).replace(toColumnIndex, item); - + toColumnController.replace(toColumnIndex, item); onMoveColumnItemToColumn?.call( fromColumnId, fromColumnIndex, @@ -167,9 +173,12 @@ class AFBoardDataController extends ChangeNotifier @override @protected bool removePhantom(String columnId) { - final columnController = this.columnController(columnId); + final columnController = getColumnController(columnId); + if (columnController == null) { + Log.warn('Can not find the column controller with columnId: $columnId'); + return false; + } final index = columnController.items.indexWhere((item) => item.isPhantom); - final isExist = index != -1; if (isExist) { columnController.removeAt(index); @@ -183,14 +192,15 @@ class AFBoardDataController extends ChangeNotifier @override @protected void updatePhantom(String columnId, int newIndex) { - final columnDataController = columnController(columnId); + final columnDataController = getColumnController(columnId)!; final index = columnDataController.items.indexWhere((item) => item.isPhantom); assert(index != -1); if (index != -1) { if (index != newIndex) { - // Log.debug('[$BoardPhantomController] update $toColumnId:$index to $toColumnId:$phantomIndex'); + Log.trace( + '[$BoardPhantomController] update $columnId:$index to $columnId:$newIndex'); final item = columnDataController.removeAt(index, notify: false); columnDataController.insert(newIndex, item, notify: false); } @@ -200,6 +210,6 @@ class AFBoardDataController extends ChangeNotifier @override @protected void insertPhantom(String columnId, int index, PhantomColumnItem item) { - columnController(columnId).insert(index, item); + getColumnController(columnId)!.insert(index, item); } } diff --git a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/drag_state.dart b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/drag_state.dart index f5f7250834..592277afbc 100644 --- a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/drag_state.dart +++ b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/drag_state.dart @@ -43,7 +43,7 @@ class FlexDragTargetData extends DragTargetData { } class DraggingState { - final String id; + final String reorderFlexId; /// The member of widget.children currently being dragged. Widget? _draggingWidget; @@ -72,7 +72,7 @@ class DraggingState { /// The additional margin to place around a computed drop area. static const double _dropAreaMargin = 0.0; - DraggingState(this.id); + DraggingState(this.reorderFlexId); Size get dropAreaSize { if (feedbackSize == null) { @@ -132,7 +132,7 @@ class DraggingState { } void updateNextIndex(int index) { - Log.trace('updateNextIndex: $index'); + Log.debug('$reorderFlexId updateNextIndex: $index'); nextIndex = index; } diff --git a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/drag_target.dart b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/drag_target.dart index 132d3d9bc4..a091e9711a 100644 --- a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/drag_target.dart +++ b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/drag_target.dart @@ -140,7 +140,7 @@ class _ReorderDragTargetState widget.insertAnimationController, widget.deleteAnimationController, ) ?? - LongPressDraggable( + Draggable( maxSimultaneousDrags: 1, data: widget.dragTargetData, ignoringFeedbackSemantics: false, @@ -222,10 +222,10 @@ class DragTargetAnimation { value: 0, vsync: vsync, duration: reorderAnimationDuration); insertController = AnimationController( - value: 0.0, vsync: vsync, duration: const Duration(milliseconds: 100)); + value: 0.0, vsync: vsync, duration: const Duration(milliseconds: 200)); deleteController = AnimationController( - value: 0.0, vsync: vsync, duration: const Duration(milliseconds: 10)); + value: 0.0, vsync: vsync, duration: const Duration(milliseconds: 1)); } void startDragging() { @@ -276,6 +276,31 @@ class IgnorePointerWidget extends StatelessWidget { } } +class AbsorbPointerWidget extends StatelessWidget { + final Widget? child; + final bool useIntrinsicSize; + const AbsorbPointerWidget({ + required this.child, + this.useIntrinsicSize = false, + Key? key, + }) : super(key: key); + + @override + Widget build(BuildContext context) { + final sizedChild = useIntrinsicSize + ? child + : SizedBox(width: 0.0, height: 0.0, child: child); + + final opacity = useIntrinsicSize ? 0.3 : 0.0; + return AbsorbPointer( + child: Opacity( + opacity: opacity, + child: sizedChild, + ), + ); + } +} + class PhantomWidget extends StatelessWidget { final Widget? child; final double opacity; @@ -371,6 +396,7 @@ class _DragTargeMovePlaceholderState extends State { } abstract class FakeDragTargetEventTrigger { + void fakeOnDragStart(void Function(int?) callback); void fakeOnDragEnded(VoidCallback callback); } @@ -421,6 +447,10 @@ class _FakeDragTargetState /// Start insert animation widget.insertAnimationController.forward(from: 0.0); + // widget.eventTrigger.fakeOnDragStart((insertIndex) { + // Log.trace("[$FakeDragTarget] on drag $insertIndex"); + // }); + widget.eventTrigger.fakeOnDragEnded(() { WidgetsBinding.instance.addPostFrameCallback((_) { widget.onDragEnded(widget.eventData.dragTargetData as T); @@ -436,7 +466,7 @@ class _FakeDragTargetState return SizeTransitionWithIntrinsicSize( sizeFactor: widget.deleteAnimationController, axis: Axis.vertical, - child: IgnorePointerWidget( + child: AbsorbPointerWidget( child: widget.child, ), ); @@ -444,7 +474,7 @@ class _FakeDragTargetState return SizeTransitionWithIntrinsicSize( sizeFactor: widget.insertAnimationController, axis: Axis.vertical, - child: IgnorePointerWidget( + child: AbsorbPointerWidget( useIntrinsicSize: true, child: widget.child, ), diff --git a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/drag_target_interceptor.dart b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/drag_target_interceptor.dart index be74b4eef8..36366cd1e0 100644 --- a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/drag_target_interceptor.dart +++ b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/drag_target_interceptor.dart @@ -1,3 +1,5 @@ +import 'dart:async'; + import 'package:flutter/material.dart'; import '../../utils/log.dart'; @@ -8,6 +10,8 @@ import 'reorder_flex.dart'; /// [DragTargetInterceptor] is used to intercept the [DragTarget]'s /// [onWillAccept], [OnAccept], and [onLeave] event. abstract class DragTargetInterceptor { + String get reorderFlexId; + /// Returns [yes] to receive the [DragTarget]'s event. bool canHandler(FlexDragTargetData dragTargetData); @@ -37,7 +41,7 @@ abstract class OverlapDragTargetDelegate { int dragTargetIndex, ); - bool canMoveTo(String dragTargetId); + int canMoveTo(String dragTargetId); } /// [OverlappingDragTargetInterceptor] is used to receive the overlapping @@ -47,9 +51,12 @@ abstract class OverlapDragTargetDelegate { /// Receive the [DragTarget] event if the [acceptedReorderFlexId] contains /// the passed in dragTarget' reorderFlexId. class OverlappingDragTargetInterceptor extends DragTargetInterceptor { + @override final String reorderFlexId; final List acceptedReorderFlexId; final OverlapDragTargetDelegate delegate; + final List columnKeys = []; + Timer? _delayOperation; OverlappingDragTargetInterceptor({ required this.delegate, @@ -72,15 +79,38 @@ class OverlappingDragTargetInterceptor extends DragTargetInterceptor { if (dragTargetId == dragTargetData.reorderFlexId) { delegate.cancel(); } else { - if (delegate.canMoveTo(dragTargetId)) { - delegate.moveTo(dragTargetId, dragTargetData, 0); - } + /// The priority of the column interactions is high than the cross column. + /// Workaround: delay 100 milliseconds to lower the cross column event priority. + _delayOperation?.cancel(); + _delayOperation = Timer(const Duration(milliseconds: 100), () { + final index = delegate.canMoveTo(dragTargetId); + if (index != -1) { + Log.trace( + '[$OverlappingDragTargetInterceptor] move to $dragTargetId at $index'); + delegate.moveTo(dragTargetId, dragTargetData, index); + + // final columnIndex = columnKeys + // .indexWhere((element) => element.columnId == dragTargetId); + // if (columnIndex != -1) { + // final state = columnKeys[columnIndex].key.currentState; + // if (state is ReorderFlexState) { + // state.handleOnWillAccept(context, index); + // } + // } + } + }); } return true; } } +class ColumnKey { + String columnId; + GlobalKey key; + ColumnKey({required this.columnId, required this.key}); +} + abstract class CrossReorderFlexDragTargetDelegate { /// * [reorderFlexId] is the id that the [ReorderFlex] passed in. bool acceptNewDragTargetData( @@ -96,6 +126,7 @@ abstract class CrossReorderFlexDragTargetDelegate { } class CrossReorderFlexDragTargetInterceptor extends DragTargetInterceptor { + @override final String reorderFlexId; final List acceptedReorderFlexIds; final CrossReorderFlexDragTargetDelegate delegate; @@ -119,8 +150,12 @@ class CrossReorderFlexDragTargetInterceptor extends DragTargetInterceptor { /// If the columnId equal to the dragTargetData's columnId, /// it means the dragTarget is dragging on the top of its own list. /// Otherwise, it means the dargTarget was moved to another list. + Log.trace( + "[$CrossReorderFlexDragTargetInterceptor] $reorderFlexId accept ${dragTargetData.reorderFlexId} ${reorderFlexId != dragTargetData.reorderFlexId}"); return reorderFlexId != dragTargetData.reorderFlexId; } else { + Log.trace( + "[$CrossReorderFlexDragTargetInterceptor] not accept ${dragTargetData.reorderFlexId}"); return false; } } @@ -151,6 +186,9 @@ class CrossReorderFlexDragTargetInterceptor extends DragTargetInterceptor { dragTargetIndex, ); + Log.debug( + '[$CrossReorderFlexDragTargetInterceptor] dargTargetIndex: $dragTargetIndex, reorderFlexId: $reorderFlexId'); + if (isNewDragTarget == false) { delegate.updateDragTargetData(reorderFlexId, dragTargetIndex); reorderFlexState.handleOnWillAccept(context, dragTargetIndex); diff --git a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/reorder_flex.dart b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/reorder_flex.dart index 7fa1a405e1..26b68c2304 100644 --- a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/reorder_flex.dart +++ b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_flex/reorder_flex.dart @@ -36,10 +36,10 @@ class ReorderFlexConfig { final double draggingWidgetOpacity = 0.3; // How long an animation to reorder an element - final Duration reorderAnimationDuration = const Duration(milliseconds: 250); + final Duration reorderAnimationDuration = const Duration(milliseconds: 300); // How long an animation to scroll to an off-screen element - final Duration scrollAnimationDuration = const Duration(milliseconds: 250); + final Duration scrollAnimationDuration = const Duration(milliseconds: 300); final bool useMoveAnimation; @@ -214,7 +214,7 @@ class ReorderFlexState extends State } Log.trace( - 'Rebuild: Column:[${dragState.id}] ${dragState.toString()}, childIndex: $childIndex shiftedIndex: $shiftedIndex'); + 'Rebuild: Column:[${dragState.reorderFlexId}] ${dragState.toString()}, childIndex: $childIndex shiftedIndex: $shiftedIndex'); final currentIndex = dragState.currentIndex; final dragPhantomIndex = dragState.phantomIndex; @@ -330,6 +330,8 @@ class ReorderFlexState extends State widget.onDragStarted?.call(draggingIndex); }, onDragEnded: (dragTargetData) { + if (!mounted) return; + Log.debug( "[DragTarget]: Column:[${widget.dataSource.identifier}] end dragging"); _notifier.updateDragTargetIndex(-1); @@ -346,21 +348,21 @@ class ReorderFlexState extends State }); }, onWillAccept: (FlexDragTargetData dragTargetData) { + // Do not receive any events if the Insert item is animating. if (_animation.deleteController.isAnimating) { return false; } assert(widget.dataSource.items.length > dragTargetIndex); - if (_interceptDragTarget( - dragTargetData, - (interceptor) => interceptor.onWillAccept( + if (_interceptDragTarget(dragTargetData, (interceptor) { + interceptor.onWillAccept( context: builderContext, reorderFlexState: this, dragTargetData: dragTargetData, dragTargetId: reorderFlexItem.id, dragTargetIndex: dragTargetIndex, - ), - )) { + ); + })) { return true; } else { return handleOnWillAccept(builderContext, dragTargetIndex); @@ -435,7 +437,7 @@ class ReorderFlexState extends State /// The [willAccept] will be true if the dargTarget is the widget that gets /// dragged and it is dragged on top of the other dragTargets. /// - Log.debug( + Log.trace( '[$ReorderDragTarget] ${widget.dataSource.identifier} on will accept, dragIndex:$dragIndex, dragTargetIndex:$dragTargetIndex, count: ${widget.dataSource.items.length}'); bool willAccept = @@ -524,7 +526,7 @@ class ReorderFlexState extends State // screen, then it is already on-screen. final double margin = widget.direction == Axis.horizontal ? dragState.dropAreaSize.width - : dragState.dropAreaSize.height; + : dragState.dropAreaSize.height / 2.0; if (_scrollController.hasClients) { final double scrollOffset = _scrollController.offset; final double topOffset = max( diff --git a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_phantom/phantom_controller.dart b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_phantom/phantom_controller.dart index 0db70d0bae..4dd4f05a74 100644 --- a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_phantom/phantom_controller.dart +++ b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_phantom/phantom_controller.dart @@ -59,12 +59,13 @@ class BoardPhantomController extends OverlapDragTargetDelegate } void columnStartDragging(String columnId) { - columnsState.setColumnIsDragging(columnId, false); + columnsState.setColumnIsDragging(columnId, true); } /// Remove the phantom in the column when the column is end dragging. void columnEndDragging(String columnId) { - columnsState.setColumnIsDragging(columnId, true); + columnsState.setColumnIsDragging(columnId, false); + if (phantomRecord == null) return; final fromColumnId = phantomRecord!.fromColumnId; @@ -73,19 +74,18 @@ class BoardPhantomController extends OverlapDragTargetDelegate columnsState.notifyDidRemovePhantom(toColumnId); } - if (columnsState.isDragging(fromColumnId) == false) { - return; + if (phantomRecord!.toColumnId == columnId) { + delegate.swapColumnItem( + fromColumnId, + phantomRecord!.fromColumnIndex, + toColumnId, + phantomRecord!.toColumnIndex, + ); + + Log.debug( + "[$BoardPhantomController] did move ${phantomRecord.toString()}"); + phantomRecord = null; } - - delegate.swapColumnItem( - fromColumnId, - phantomRecord!.fromColumnIndex, - toColumnId, - phantomRecord!.toColumnIndex, - ); - - Log.debug("[$BoardPhantomController] did move ${phantomRecord.toString()}"); - phantomRecord = null; } /// Remove the phantom in the column if it contains phantom @@ -113,7 +113,7 @@ class BoardPhantomController extends OverlapDragTargetDelegate PhantomColumnItem(phantomContext), ); - columnsState.notifyDidInsertPhantom(toColumnId); + columnsState.notifyDidInsertPhantom(toColumnId, phantomIndex); } /// Reset or initial the [PhantomRecord] @@ -128,8 +128,9 @@ class BoardPhantomController extends OverlapDragTargetDelegate FlexDragTargetData dragTargetData, int dragTargetIndex, ) { - // Log.debug('[$BoardPhantomController] move Column:[${dragTargetData.reorderFlexId}]:${dragTargetData.draggingIndex} ' - // 'to Column:[$columnId]:$index'); + // Log.debug( + // '[$BoardPhantomController] move Column:[${dragTargetData.reorderFlexId}]:${dragTargetData.draggingIndex} ' + // 'to Column:[$columnId]:$dragTargetIndex'); phantomRecord = PhantomRecord( toColumnId: columnId, @@ -202,8 +203,17 @@ class BoardPhantomController extends OverlapDragTargetDelegate } @override - bool canMoveTo(String dragTargetId) { - return delegate.controller(dragTargetId)?.columnData.items.isEmpty ?? false; + int canMoveTo(String dragTargetId) { + if (columnsState.isDragging(dragTargetId)) { + return -1; + } + + final controller = delegate.controller(dragTargetId); + if (controller != null) { + return controller.columnData.items.length; + } else { + return 0; + } } } @@ -294,7 +304,7 @@ class PassthroughPhantomContext extends FakeDragTargetEventTrigger AFColumnItem get itemData => dragTargetData.reorderFlexItem as AFColumnItem; @override - VoidCallback? onInserted; + void Function(int?)? onInserted; @override VoidCallback? onDragEnded; @@ -308,6 +318,11 @@ class PassthroughPhantomContext extends FakeDragTargetEventTrigger void fakeOnDragEnded(VoidCallback callback) { onDragEnded = callback; } + + @override + void fakeOnDragStart(void Function(int? index) callback) { + onInserted = callback; + } } class PassthroughPhantomWidget extends PhantomWidget { diff --git a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_phantom/phantom_state.dart b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_phantom/phantom_state.dart index d33b53500d..443d7fb936 100644 --- a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_phantom/phantom_state.dart +++ b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/reorder_phantom/phantom_state.dart @@ -14,7 +14,7 @@ class ColumnPhantomStateController { void addColumnListener(String columnId, PassthroughPhantomListener listener) { _stateWithId(columnId).notifier.addListener( - onInserted: (c) => listener.onInserted?.call(), + onInserted: (index) => listener.onInserted?.call(index), onDeleted: () => listener.onDragEnded?.call(), ); } @@ -24,8 +24,8 @@ class ColumnPhantomStateController { _states.remove(columnId); } - void notifyDidInsertPhantom(String columnId) { - _stateWithId(columnId).notifier.insert(); + void notifyDidInsertPhantom(String columnId, int index) { + _stateWithId(columnId).notifier.insert(index); } void notifyDidRemovePhantom(String columnId) { @@ -48,7 +48,7 @@ class ColumnState { } abstract class PassthroughPhantomListener { - VoidCallback? get onInserted; + void Function(int?)? get onInserted; VoidCallback? get onDragEnded; } @@ -57,8 +57,8 @@ class PassthroughPhantomNotifier { final removeNotifier = PhantomDeleteNotifier(); - void insert() { - insertNotifier.insert(); + void insert(int index) { + insertNotifier.insert(index); } void remove() { @@ -66,12 +66,12 @@ class PassthroughPhantomNotifier { } void addListener({ - void Function(PassthroughPhantomContext? insertedPhantom)? onInserted, + void Function(int? insertedIndex)? onInserted, void Function()? onDeleted, }) { if (onInserted != null) { insertNotifier.addListener(() { - onInserted(insertNotifier.insertedPhantom); + onInserted(insertNotifier.insertedIndex); }); } @@ -89,9 +89,11 @@ class PassthroughPhantomNotifier { } class PhantomInsertNotifier extends ChangeNotifier { + int insertedIndex = -1; PassthroughPhantomContext? insertedPhantom; - void insert() { + void insert(int index) { + insertedIndex = index; notifyListeners(); } } diff --git a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/styled_widgets/card.dart b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/styled_widgets/card.dart index 323964c75f..77cfc1cb13 100644 --- a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/styled_widgets/card.dart +++ b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/styled_widgets/card.dart @@ -2,16 +2,17 @@ import 'package:flutter/material.dart'; class AppFlowyColumnItemCard extends StatefulWidget { final Widget? child; - final Color backgroundColor; - final double cornerRadius; final EdgeInsets margin; final BoxConstraints boxConstraints; + final BoxDecoration decoration; const AppFlowyColumnItemCard({ this.child, - this.cornerRadius = 0.0, this.margin = const EdgeInsets.all(4), - this.backgroundColor = Colors.white, + this.decoration = const BoxDecoration( + color: Colors.white, + borderRadius: BorderRadius.zero, + ), this.boxConstraints = const BoxConstraints(minHeight: 40), Key? key, }) : super(key: key); @@ -24,14 +25,11 @@ class _AppFlowyColumnItemCardState extends State { @override Widget build(BuildContext context) { return Padding( - padding: const EdgeInsets.all(4), + padding: widget.margin, child: Container( clipBehavior: Clip.hardEdge, constraints: widget.boxConstraints, - decoration: BoxDecoration( - color: widget.backgroundColor, - borderRadius: BorderRadius.circular(widget.cornerRadius), - ), + decoration: widget.decoration, child: widget.child, ), ); diff --git a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/styled_widgets/footer.dart b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/styled_widgets/footer.dart index 7f5655fe60..c877e4fe4d 100644 --- a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/styled_widgets/footer.dart +++ b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/styled_widgets/footer.dart @@ -12,7 +12,7 @@ class AppFlowyColumnFooter extends StatefulWidget { const AppFlowyColumnFooter({ this.icon, this.title, - this.margin = EdgeInsets.zero, + this.margin = const EdgeInsets.symmetric(horizontal: 12), required this.height, this.onAddButtonClick, Key? key, @@ -30,12 +30,13 @@ class _AppFlowyColumnFooterState extends State { child: SizedBox( height: widget.height, child: Padding( - padding: const EdgeInsets.symmetric(horizontal: 10), + padding: widget.margin, child: Row( mainAxisAlignment: MainAxisAlignment.start, crossAxisAlignment: CrossAxisAlignment.center, children: [ if (widget.icon != null) widget.icon!, + const SizedBox(width: 8), if (widget.title != null) widget.title!, ], ), diff --git a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/styled_widgets/header.dart b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/styled_widgets/header.dart index fdebc7ef21..88f52c9134 100644 --- a/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/styled_widgets/header.dart +++ b/frontend/app_flowy/packages/appflowy_board/lib/src/widgets/styled_widgets/header.dart @@ -45,15 +45,25 @@ class _AppFlowyColumnHeaderState extends State { } if (widget.moreIcon != null) { - children.add(const Spacer()); + // children.add(const Spacer()); children.add( - IconButton(onPressed: widget.onMoreButtonClick, icon: widget.moreIcon!), + IconButton( + onPressed: widget.onMoreButtonClick, + icon: widget.moreIcon!, + padding: const EdgeInsets.all(4), + constraints: const BoxConstraints(), + ), ); } if (widget.addIcon != null) { children.add( - IconButton(onPressed: widget.onAddButtonClick, icon: widget.addIcon!), + IconButton( + onPressed: widget.onAddButtonClick, + icon: widget.addIcon!, + padding: const EdgeInsets.all(4), + constraints: const BoxConstraints(), + ), ); } @@ -61,9 +71,7 @@ class _AppFlowyColumnHeaderState extends State { height: widget.height, child: Padding( padding: widget.margin, - child: Row( - children: children, - ), + child: Row(children: children), ), ); } diff --git a/frontend/app_flowy/packages/appflowy_board/pubspec.yaml b/frontend/app_flowy/packages/appflowy_board/pubspec.yaml index 962fc8be80..6bb2feabfe 100644 --- a/frontend/app_flowy/packages/appflowy_board/pubspec.yaml +++ b/frontend/app_flowy/packages/appflowy_board/pubspec.yaml @@ -1,6 +1,6 @@ name: appflowy_board description: AppFlowy board implementation. -version: 0.0.4 +version: 0.0.5 homepage: https://github.com/AppFlowy-IO/AppFlowy repository: https://github.com/AppFlowy-IO/AppFlowy/tree/main/frontend/app_flowy/packages/appflowy_board diff --git a/frontend/app_flowy/packages/appflowy_editor/assets/images/clear.svg b/frontend/app_flowy/packages/appflowy_editor/assets/images/clear.svg new file mode 100644 index 0000000000..7f303d737f --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/assets/images/clear.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/frontend/app_flowy/packages/appflowy_editor/assets/images/delete.svg b/frontend/app_flowy/packages/appflowy_editor/assets/images/delete.svg new file mode 100644 index 0000000000..b7f242542d --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/assets/images/delete.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/align_center.svg b/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/align_center.svg new file mode 100644 index 0000000000..ae9c2cfd44 --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/align_center.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/align_left.svg b/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/align_left.svg new file mode 100644 index 0000000000..b4f2d0101e --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/align_left.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/align_right.svg b/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/align_right.svg new file mode 100644 index 0000000000..86a1facaac --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/align_right.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/copy.svg b/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/copy.svg new file mode 100644 index 0000000000..101cf34205 --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/copy.svg @@ -0,0 +1,4 @@ + + + + diff --git a/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/delete.svg b/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/delete.svg new file mode 100644 index 0000000000..5a3d972872 --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/delete.svg @@ -0,0 +1,6 @@ + + + + + + diff --git a/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/divider.svg b/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/divider.svg new file mode 100644 index 0000000000..3e57a6b000 --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/divider.svg @@ -0,0 +1,3 @@ + + + diff --git a/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/share.svg b/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/share.svg new file mode 100644 index 0000000000..279e7ac471 --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/assets/images/image_toolbar/share.svg @@ -0,0 +1,4 @@ + + + + diff --git a/frontend/app_flowy/packages/appflowy_editor/assets/images/link.svg b/frontend/app_flowy/packages/appflowy_editor/assets/images/link.svg new file mode 100644 index 0000000000..5fbcc8d787 --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/assets/images/link.svg @@ -0,0 +1,4 @@ + + + + diff --git a/frontend/app_flowy/packages/appflowy_editor/assets/images/selection_menu/image.svg b/frontend/app_flowy/packages/appflowy_editor/assets/images/selection_menu/image.svg new file mode 100644 index 0000000000..0e2aafe0ec --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/assets/images/selection_menu/image.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/frontend/app_flowy/packages/appflowy_editor/assets/images/toolbar/link.svg b/frontend/app_flowy/packages/appflowy_editor/assets/images/toolbar/link.svg index 612e8377b6..279e7ac471 100644 --- a/frontend/app_flowy/packages/appflowy_editor/assets/images/toolbar/link.svg +++ b/frontend/app_flowy/packages/appflowy_editor/assets/images/toolbar/link.svg @@ -1,4 +1,4 @@ - - + + diff --git a/frontend/app_flowy/packages/appflowy_editor/example/assets/example.json b/frontend/app_flowy/packages/appflowy_editor/example/assets/example.json index 901e57f796..48184a6511 100644 --- a/frontend/app_flowy/packages/appflowy_editor/example/assets/example.json +++ b/frontend/app_flowy/packages/appflowy_editor/example/assets/example.json @@ -1,267 +1,102 @@ { "document": { "type": "editor", - "attributes": {}, "children": [ { "type": "image", "attributes": { - "image_src": "https://images.squarespace-cdn.com/content/v1/617f6f16b877c06711e87373/c3f23723-37f4-44d7-9c5d-6e2a53064ae7/Asset+10.png" + "image_src": "https://s1.ax1x.com/2022/08/26/v2sSbR.jpg", + "align": "center" } }, { "type": "text", + "attributes": { "subtype": "heading", "heading": "h1" }, "delta": [ + { "insert": "👋 " }, + { "insert": "Welcome to ", "attributes": { "bold": true } }, { - "insert": "🌶 Read Me" - } - ], - "attributes": { - "subtype": "heading", - "heading": "h1" - } - }, - { - "type": "text", - "delta": [ - { - "insert": "👋 Welcome to FlowyEditor" - } - ], - "attributes": { - "subtype": "heading", - "heading": "h2" - } - }, - { - "type": "text", - "delta": [ - { - "insert": "To be honest, we are still in the alpha stage. There are still many functions that need to be completed. And we are developing more features. Please give us a star if the " - }, - { - "insert": "FlowyEditor", + "insert": "AppFlowy Editor", "attributes": { - "href": "https://github.com/AppFlowy-IO/AppFlowy" + "href": "appflowy.io", + "italic": true, + "bold": true + } + } + ] + }, + { "type": "text", "delta": [] }, + { + "type": "text", + "delta": [ + { "insert": "AppFlowy Editor is a " }, + { "insert": "highly customizable", "attributes": { "bold": true } }, + { "insert": " " }, + { "insert": "rich-text editor", "attributes": { "italic": true } }, + { "insert": " for " }, + { "insert": "Flutter", "attributes": { "underline": true } } + ] + }, + { + "type": "text", + "attributes": { "checkbox": true, "subtype": "checkbox" }, + "delta": [{ "insert": "Customizable" }] + }, + { + "type": "text", + "attributes": { "checkbox": true, "subtype": "checkbox" }, + "delta": [{ "insert": "Test-covered" }] + }, + { + "type": "text", + "attributes": { "checkbox": false, "subtype": "checkbox" }, + "delta": [{ "insert": "more to come!" }] + }, + { "type": "text", "delta": [] }, + { + "type": "text", + "attributes": { "subtype": "quote" }, + "delta": [{ "insert": "Here is an exmaple you can give it a try" }] + }, + { "type": "text", "delta": [] }, + { + "type": "text", + "delta": [ + { "insert": "You can also use " }, + { + "insert": "AppFlowy Editor", + "attributes": { + "italic": true, + "bold": true, + "backgroundColor": "0x6000BCF0" } }, + { "insert": " as a component to build your own app." } + ] + }, + { "type": "text", "delta": [] }, + { + "type": "text", + "attributes": { "subtype": "bulleted-list" }, + "delta": [{ "insert": "Use / to insert blocks" }] + }, + { + "type": "text", + "attributes": { "subtype": "bulleted-list" }, + "delta": [ { - "insert": " helps you. 😊😊😊" + "insert": "Select text to trigger to the toolbar to format your notes." } ] }, + { "type": "text", "delta": [] }, { "type": "text", "delta": [ { - "insert": "Since the FlowyEditor are a community-driven open source editor, we very welcome and appreciate every pull request submissions from everyone.😄😄😄" + "insert": "If you have questions or feedback, please submit an issue on Github or join the community along with 1000+ builders!" } ] - }, - { - "type": "text", - "delta": [ - { - "insert": "Here are the basics:" - } - ], - "attributes": { - "subtype": "heading", - "heading": "h3" - } - }, - { - "type": "text", - "delta": [ - { "insert": "Click " }, - { "insert": "anywhere", "attributes": { "underline": true } }, - { "insert": " and just typing." } - ] - }, - { - "type": "text", - "delta": [ - { - "insert": "Hit" - }, - { - "insert": " / ", - "attributes": { "backgroundColor": "0xFFFFFF00" } - }, - { - "insert": "to see all the types of content you can add - headers, bulleted lists, checkboxes, etc." - } - ] - }, - { - "type": "text", - "delta": [ - { - "insert": "Highlight", - "attributes": { "backgroundColor": "0xFF00BCFB" } - }, - { - "insert": " any text, and use the menu that pops up to " - }, - { "insert": "style", "attributes": { "bold": true } }, - { "insert": " your ", "attributes": { "italic": true } }, - { "insert": "writing", "attributes": { "strikethrough": true } }, - { "insert": "." } - ] - }, - { - "type": "text", - "delta": [ - { - "insert": "Here are the plugins:" - } - ], - "attributes": { - "subtype": "heading", - "heading": "h3" - } - }, - { - "type": "text", - "delta": [ - { - "insert": "Hello world" - } - ], - "attributes": { - "subtype": "checkbox", - "checkbox": false - } - }, - { - "type": "text", - "delta": [ - { - "insert": "Hello world" - } - ], - "attributes": { - "subtype": "checkbox", - "checkbox": false - } - }, - { - "type": "text", - "delta": [ - { - "insert": "Hello world" - } - ], - "attributes": { - "subtype": "checkbox", - "checkbox": false - } - }, - { - "type": "text", - "delta": [ - { - "insert": "Hello world" - } - ], - "attributes": { - "subtype": "bulleted-list" - } - }, - { - "type": "text", - "delta": [ - { - "insert": "Hello world" - } - ], - "attributes": { - "subtype": "bulleted-list" - } - }, - { - "type": "text", - "delta": [ - { - "insert": "Hello " - }, - { - "insert": "world", - "attributes": { "bold": true } - } - ], - "attributes": { - "subtype": "bulleted-list" - } - }, - { - "type": "text", - "delta": [ - { - "insert": "Hello world" - } - ], - "attributes": { - "subtype": "quote" - } - }, - { - "type": "text", - "delta": [ - { - "insert": "Hello world" - } - ], - "attributes": { - "subtype": "quote" - } - }, - { - "type": "text", - "delta": [ - { - "insert": "Hello world" - } - ], - "attributes": { - "subtype": "quote" - } - }, - { - "type": "text", - "delta": [ - { - "insert": "Hello world" - } - ], - "attributes": { - "subtype": "number-list", - "number": 1 - } - }, - { - "type": "text", - "delta": [ - { - "insert": "Hello world" - } - ], - "attributes": { - "subtype": "number-list", - "number": 2 - } - }, - { - "type": "text", - "delta": [ - { - "insert": "Hello world" - } - ], - "attributes": { - "subtype": "number-list", - "number": 3 - } } ] } diff --git a/frontend/app_flowy/packages/appflowy_editor/example/lib/main.dart b/frontend/app_flowy/packages/appflowy_editor/example/lib/main.dart index e17088c954..e72739e246 100644 --- a/frontend/app_flowy/packages/appflowy_editor/example/lib/main.dart +++ b/frontend/app_flowy/packages/appflowy_editor/example/lib/main.dart @@ -1,14 +1,15 @@ import 'dart:convert'; +import 'dart:io'; import 'package:flutter/material.dart'; import 'package:flutter/services.dart'; -import 'expandable_floating_action_button.dart'; -import 'plugin/image_node_widget.dart'; -import 'plugin/youtube_link_node_widget.dart'; +import 'package:path_provider/path_provider.dart'; import 'package:appflowy_editor/appflowy_editor.dart'; +import 'expandable_floating_action_button.dart'; + void main() { runApp(const MyApp()); } @@ -16,20 +17,11 @@ void main() { class MyApp extends StatelessWidget { const MyApp({Key? key}) : super(key: key); - // This widget is the root of your application. @override Widget build(BuildContext context) { return MaterialApp( + debugShowCheckedModeBanner: false, theme: ThemeData( - // This is the theme of your application. - // - // Try running your application with "flutter run". You'll see the - // application has a blue toolbar. Then, without quitting the app, try - // changing the primarySwatch below to Colors.green and then invoke - // "hot reload" (press "r" in the console where you ran "flutter run", - // or simply save your changes to "hot reload" in a Flutter IDE). - // Notice that the counter didn't reset back to zero; the application - // is not restarted. primarySwatch: Colors.blue, ), home: const MyHomePage(title: 'AppFlowyEditor Example'), @@ -39,16 +31,6 @@ class MyApp extends StatelessWidget { class MyHomePage extends StatefulWidget { const MyHomePage({Key? key, required this.title}) : super(key: key); - - // This widget is the home page of your application. It is stateful, meaning - // that it has a State object (defined below) that contains fields that affect - // how it looks. - - // This class is the configuration for the state. It holds the values (in this - // case the title) provided by the parent (in this case the App widget) and - // used by the build method of the State. Fields in a Widget subclass are - // always marked "final". - final String title; @override @@ -56,54 +38,66 @@ class MyHomePage extends StatefulWidget { } class _MyHomePageState extends State { - final editorKey = GlobalKey(); - int page = 0; + int _pageIndex = 0; + late EditorState _editorState; + Future? _jsonString; @override Widget build(BuildContext context) { return Scaffold( body: Container( alignment: Alignment.topCenter, - child: _buildBody(), + child: _buildEditor(context), ), floatingActionButton: _buildExpandableFab(), ); } - Widget _buildBody() { - if (page == 0) { - return _buildAppFlowyEditorWithExample(); - } else if (page == 1) { - return _buildAppFlowyEditorWithEmptyDocument(); - } else if (page == 2) { - return _buildAppFlowyEditorWithBigDocument(); + Widget _buildEditor(BuildContext context) { + if (_jsonString != null) { + return _buildEditorWithJsonString(_jsonString!); } - return Container(); + if (_pageIndex == 0) { + return _buildEditorWithJsonString( + rootBundle.loadString('assets/example.json'), + ); + } else if (_pageIndex == 1) { + return _buildEditorWithJsonString( + rootBundle.loadString('assets/big_document.json'), + ); + } else if (_pageIndex == 2) { + return _buildEditorWithJsonString( + Future.value( + jsonEncode(EditorState.empty().document.toJson()), + ), + ); + } + throw UnimplementedError(); } - Widget _buildAppFlowyEditorWithEmptyDocument() { - final editorState = EditorState.empty(); - final editor = AppFlowyEditor( - editorState: editorState, - keyEventHandlers: const [], - customBuilders: const {}, - ); - return editor; - } - - Widget _buildAppFlowyEditorWithExample() { + Widget _buildEditorWithJsonString(Future jsonString) { return FutureBuilder( - future: rootBundle.loadString('assets/example.json'), - builder: (context, snapshot) { + future: jsonString, + builder: (_, snapshot) { if (snapshot.hasData) { - final data = Map.from(json.decode(snapshot.data!)); - final editorState = EditorState(document: StateTree.fromJson(data)); - editorState.logConfiguration + _editorState = EditorState( + document: StateTree.fromJson( + Map.from( + json.decode(snapshot.data!), + ), + ), + ); + _editorState.logConfiguration ..level = LogLevel.all ..handler = (message) { debugPrint(message); }; - return _buildAppFlowyEditor(editorState); + return Container( + padding: const EdgeInsets.all(20), + child: AppFlowyEditor( + editorState: _editorState, + ), + ); } else { return const Center( child: CircularProgressIndicator(), @@ -113,71 +107,64 @@ class _MyHomePageState extends State { ); } - Widget _buildAppFlowyEditorWithBigDocument() { - return FutureBuilder( - future: rootBundle.loadString('assets/big_document.json'), - builder: (context, snapshot) { - if (snapshot.hasData) { - final data = Map.from(json.decode(snapshot.data!)); - return _buildAppFlowyEditor(EditorState( - document: StateTree.fromJson(data), - )); - } else { - return const Center( - child: CircularProgressIndicator(), - ); - } - }, - ); - } - - Widget _buildAppFlowyEditor(EditorState editorState) { - return Container( - padding: const EdgeInsets.only(left: 20, right: 20), - child: AppFlowyEditor( - key: editorKey, - editorState: editorState, - keyEventHandlers: const [], - customBuilders: { - 'image': ImageNodeBuilder(), - 'youtube_link': YouTubeLinkNodeBuilder() - }, - ), - ); - } - Widget _buildExpandableFab() { return ExpandableFab( distance: 112.0, children: [ ActionButton( - onPressed: () { - if (page == 0) return; - setState(() { - page = 0; - }); - }, - icon: const Icon(Icons.note_add), + icon: const Icon(Icons.abc), + onPressed: () => _switchToPage(0), ), ActionButton( - icon: const Icon(Icons.document_scanner), - onPressed: () { - if (page == 1) return; - setState(() { - page = 1; - }); - }, + icon: const Icon(Icons.abc), + onPressed: () => _switchToPage(1), ), ActionButton( - onPressed: () { - if (page == 2) return; - setState(() { - page = 2; - }); - }, - icon: const Icon(Icons.text_fields), + icon: const Icon(Icons.abc), + onPressed: () => _switchToPage(2), + ), + ActionButton( + icon: const Icon(Icons.print), + onPressed: () => {_exportDocument(_editorState)}), + ActionButton( + icon: const Icon(Icons.import_export), + onPressed: () => _importDocument(), ), ], ); } + + void _exportDocument(EditorState editorState) async { + final document = editorState.document.toJson(); + final json = jsonEncode(document); + final directory = await getTemporaryDirectory(); + final path = directory.path; + final file = File('$path/editor.json'); + await file.writeAsString(json); + + if (mounted) { + ScaffoldMessenger.of(context).showSnackBar( + SnackBar( + content: Text('The document is saved to the ${file.path}'), + ), + ); + } + } + + void _importDocument() async { + final directory = await getTemporaryDirectory(); + final path = directory.path; + final file = File('$path/editor.json'); + setState(() { + _jsonString = file.readAsString(); + }); + } + + void _switchToPage(int pageIndex) { + if (pageIndex != _pageIndex) { + setState(() { + _pageIndex = pageIndex; + }); + } + } } diff --git a/frontend/app_flowy/packages/appflowy_editor/example/macos/Flutter/GeneratedPluginRegistrant.swift b/frontend/app_flowy/packages/appflowy_editor/example/macos/Flutter/GeneratedPluginRegistrant.swift index cc167443dc..08b7c3b866 100644 --- a/frontend/app_flowy/packages/appflowy_editor/example/macos/Flutter/GeneratedPluginRegistrant.swift +++ b/frontend/app_flowy/packages/appflowy_editor/example/macos/Flutter/GeneratedPluginRegistrant.swift @@ -5,11 +5,13 @@ import FlutterMacOS import Foundation +import path_provider_macos import rich_clipboard_macos import url_launcher_macos import wakelock_macos func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) { + PathProviderPlugin.register(with: registry.registrar(forPlugin: "PathProviderPlugin")) RichClipboardPlugin.register(with: registry.registrar(forPlugin: "RichClipboardPlugin")) UrlLauncherPlugin.register(with: registry.registrar(forPlugin: "UrlLauncherPlugin")) WakelockMacosPlugin.register(with: registry.registrar(forPlugin: "WakelockMacosPlugin")) diff --git a/frontend/app_flowy/packages/appflowy_editor/example/macos/Podfile.lock b/frontend/app_flowy/packages/appflowy_editor/example/macos/Podfile.lock index d3a1dd3611..1fcb47735c 100644 --- a/frontend/app_flowy/packages/appflowy_editor/example/macos/Podfile.lock +++ b/frontend/app_flowy/packages/appflowy_editor/example/macos/Podfile.lock @@ -1,5 +1,7 @@ PODS: - FlutterMacOS (1.0.0) + - path_provider_macos (0.0.1): + - FlutterMacOS - rich_clipboard_macos (0.0.1): - FlutterMacOS - url_launcher_macos (0.0.1): @@ -9,6 +11,7 @@ PODS: DEPENDENCIES: - FlutterMacOS (from `Flutter/ephemeral`) + - path_provider_macos (from `Flutter/ephemeral/.symlinks/plugins/path_provider_macos/macos`) - rich_clipboard_macos (from `Flutter/ephemeral/.symlinks/plugins/rich_clipboard_macos/macos`) - url_launcher_macos (from `Flutter/ephemeral/.symlinks/plugins/url_launcher_macos/macos`) - wakelock_macos (from `Flutter/ephemeral/.symlinks/plugins/wakelock_macos/macos`) @@ -16,6 +19,8 @@ DEPENDENCIES: EXTERNAL SOURCES: FlutterMacOS: :path: Flutter/ephemeral + path_provider_macos: + :path: Flutter/ephemeral/.symlinks/plugins/path_provider_macos/macos rich_clipboard_macos: :path: Flutter/ephemeral/.symlinks/plugins/rich_clipboard_macos/macos url_launcher_macos: @@ -25,6 +30,7 @@ EXTERNAL SOURCES: SPEC CHECKSUMS: FlutterMacOS: 57701585bf7de1b3fc2bb61f6378d73bbdea8424 + path_provider_macos: 3c0c3b4b0d4a76d2bf989a913c2de869c5641a19 rich_clipboard_macos: 43364b66b9dc69d203eb8dd6d758e2d12e02723c url_launcher_macos: 597e05b8e514239626bcf4a850fcf9ef5c856ec3 wakelock_macos: bc3f2a9bd8d2e6c89fee1e1822e7ddac3bd004a9 diff --git a/frontend/app_flowy/packages/appflowy_editor/example/pubspec.yaml b/frontend/app_flowy/packages/appflowy_editor/example/pubspec.yaml index 4e2e2d68ab..5ba51433d6 100644 --- a/frontend/app_flowy/packages/appflowy_editor/example/pubspec.yaml +++ b/frontend/app_flowy/packages/appflowy_editor/example/pubspec.yaml @@ -40,6 +40,7 @@ dependencies: video_player: ^2.4.5 pod_player: 0.0.8 flutter_inappwebview: ^5.4.3+7 + path_provider: ^2.0.11 dev_dependencies: flutter_test: diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/document/node.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/document/node.dart index a0c4e33a70..909e7dd494 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/document/node.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/document/node.dart @@ -163,7 +163,8 @@ class Node extends ChangeNotifier with LinkedListEntry { 'type': type, }; if (children.isNotEmpty) { - map['children'] = children.map((node) => node.toJson()); + map['children'] = + (children.map((node) => node.toJson())).toList(growable: false); } if (_attributes.isNotEmpty) { map['attributes'] = _attributes; diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/document/state_tree.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/document/state_tree.dart index 5bf49c0048..a17b2fbf98 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/document/state_tree.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/document/state_tree.dart @@ -33,6 +33,12 @@ class StateTree { return StateTree(root: root); } + Map toJson() { + return { + 'document': root.toJson(), + }; + } + Node? nodeAtPath(Path path) { return root.childAtPath(path); } diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/extensions/text_node_extensions.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/extensions/text_node_extensions.dart index 1d7c68ab80..119cbae8d2 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/extensions/text_node_extensions.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/extensions/text_node_extensions.dart @@ -6,22 +6,57 @@ import 'package:appflowy_editor/src/document/text_delta.dart'; import 'package:appflowy_editor/src/render/rich_text/rich_text_style.dart'; extension TextNodeExtension on TextNode { + dynamic getAttributeInSelection(Selection selection, String styleKey) { + final ops = delta.whereType(); + final startOffset = + selection.isBackward ? selection.start.offset : selection.end.offset; + final endOffset = + selection.isBackward ? selection.end.offset : selection.start.offset; + var start = 0; + for (final op in ops) { + if (start >= endOffset) { + break; + } + final length = op.length; + if (start < endOffset && start + length > startOffset) { + if (op.attributes?.containsKey(styleKey) == true) { + return op.attributes![styleKey]; + } + } + start += length; + } + return null; + } + + bool allSatisfyLinkInSelection(Selection selection) => + allSatisfyInSelection(StyleKey.href, selection, (value) { + return value != null; + }); + bool allSatisfyBoldInSelection(Selection selection) => - allSatisfyInSelection(StyleKey.bold, true, selection); + allSatisfyInSelection(StyleKey.bold, selection, (value) { + return value == true; + }); bool allSatisfyItalicInSelection(Selection selection) => - allSatisfyInSelection(StyleKey.italic, true, selection); + allSatisfyInSelection(StyleKey.italic, selection, (value) { + return value == true; + }); bool allSatisfyUnderlineInSelection(Selection selection) => - allSatisfyInSelection(StyleKey.underline, true, selection); + allSatisfyInSelection(StyleKey.underline, selection, (value) { + return value == true; + }); bool allSatisfyStrikethroughInSelection(Selection selection) => - allSatisfyInSelection(StyleKey.strikethrough, true, selection); + allSatisfyInSelection(StyleKey.strikethrough, selection, (value) { + return value == true; + }); bool allSatisfyInSelection( String styleKey, - dynamic value, Selection selection, + bool Function(dynamic value) test, ) { final ops = delta.whereType(); final startOffset = @@ -37,7 +72,7 @@ extension TextNodeExtension on TextNode { if (start < endOffset && start + length > startOffset) { if (op.attributes == null || !op.attributes!.containsKey(styleKey) || - op.attributes![styleKey] != value) { + !test(op.attributes![styleKey])) { return false; } } @@ -91,13 +126,15 @@ extension TextNodesExtension on List { bool allSatisfyInSelection( String styleKey, Selection selection, - dynamic value, + dynamic matchValue, ) { if (isEmpty) { return false; } if (length == 1) { - return first.allSatisfyInSelection(styleKey, value, selection); + return first.allSatisfyInSelection(styleKey, selection, (value) { + return value == matchValue; + }); } else { for (var i = 0; i < length; i++) { final node = this[i]; @@ -117,7 +154,9 @@ extension TextNodesExtension on List { end: Position(path: node.path, offset: node.toRawString().length), ); } - if (!node.allSatisfyInSelection(styleKey, value, newSelection)) { + if (!node.allSatisfyInSelection(styleKey, newSelection, (value) { + return value == matchValue; + })) { return false; } } diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/infra/log.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/infra/log.dart index 2218b10181..8175ecb705 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/infra/log.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/infra/log.dart @@ -75,6 +75,11 @@ class Log { /// For example, uses the logger when processing scroll events. static Log scroll = Log._(name: 'scroll'); + /// For logging message related to [AppFlowyToolbarService]. + /// + /// For example, uses the logger when processing toolbar events. + static Log toolbar = Log._(name: 'toolbar'); + /// For logging message related to UI. /// /// For example, uses the logger when building the widget. diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/operation/operation.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/operation/operation.dart index d1a0024a98..af2ec831d4 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/operation/operation.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/operation/operation.dart @@ -2,14 +2,14 @@ import 'package:appflowy_editor/appflowy_editor.dart'; abstract class Operation { factory Operation.fromJson(Map map) { - String t = map["type"] as String; - if (t == "insert-operation") { + String t = map["op"] as String; + if (t == "insert") { return InsertOperation.fromJson(map); - } else if (t == "update-operation") { + } else if (t == "update") { return UpdateOperation.fromJson(map); - } else if (t == "delete-operation") { + } else if (t == "delete") { return DeleteOperation.fromJson(map); - } else if (t == "text-edit-operation") { + } else if (t == "text-edit") { return TextEditOperation.fromJson(map); } @@ -51,7 +51,7 @@ class InsertOperation extends Operation { @override Map toJson() { return { - "type": "insert-operation", + "op": "insert", "path": path.toList(), "nodes": nodes.map((n) => n.toJson()), }; @@ -95,7 +95,7 @@ class UpdateOperation extends Operation { @override Map toJson() { return { - "type": "update-operation", + "op": "update", "path": path.toList(), "attributes": {...attributes}, "oldAttributes": {...oldAttributes}, @@ -132,7 +132,7 @@ class DeleteOperation extends Operation { @override Map toJson() { return { - "type": "delete-operation", + "op": "delete", "path": path.toList(), "nodes": nodes.map((n) => n.toJson()), }; @@ -171,7 +171,7 @@ class TextEditOperation extends Operation { @override Map toJson() { return { - "type": "text-edit-operation", + "op": "text-edit", "path": path.toList(), "delta": delta.toJson(), "invert": inverted.toJson(), @@ -207,10 +207,10 @@ Path transformPath(Path preInsertPath, Path b, [int delta = 1]) { Operation transformOperation(Operation a, Operation b) { if (a is InsertOperation) { - final newPath = transformPath(a.path, b.path); + final newPath = transformPath(a.path, b.path, a.nodes.length); return b.copyWithPath(newPath); } else if (a is DeleteOperation) { - final newPath = transformPath(a.path, b.path, -1); + final newPath = transformPath(a.path, b.path, -1 * a.nodes.length); return b.copyWithPath(newPath); } // TODO: transform update and textedit diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/operation/transaction_builder.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/operation/transaction_builder.dart index 4f6de6e9b0..12c13bf2e5 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/operation/transaction_builder.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/operation/transaction_builder.dart @@ -116,11 +116,17 @@ class TransactionBuilder { /// Optionally, you may specify formatting attributes that are applied to the inserted string. /// By default, the formatting attributes before the insert position will be used. insertText(TextNode node, int index, String content, - [Attributes? attributes]) { + {Attributes? attributes, Attributes? removedAttributes}) { var newAttributes = attributes; if (index != 0 && attributes == null) { newAttributes = node.delta.slice(max(index - 1, 0), index).first.attributes; + if (newAttributes != null) { + newAttributes = Attributes.from(newAttributes); + if (removedAttributes != null) { + newAttributes.addAll(removedAttributes); + } + } } textEdit( node, diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/image/image_node_builder.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/image/image_node_builder.dart new file mode 100644 index 0000000000..796e96c250 --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/image/image_node_builder.dart @@ -0,0 +1,72 @@ +import 'package:appflowy_editor/src/document/node.dart'; +import 'package:appflowy_editor/src/operation/transaction_builder.dart'; +import 'package:appflowy_editor/src/service/render_plugin_service.dart'; +import 'package:flutter/material.dart'; +import 'package:rich_clipboard/rich_clipboard.dart'; + +import 'image_node_widget.dart'; + +class ImageNodeBuilder extends NodeWidgetBuilder { + @override + Widget build(NodeWidgetContext context) { + final src = context.node.attributes['image_src']; + final align = context.node.attributes['align']; + double? width; + if (context.node.attributes.containsKey('width')) { + width = context.node.attributes['width'].toDouble(); + } + return ImageNodeWidget( + key: context.node.key, + src: src, + width: width, + alignment: _textToAlignment(align), + onCopy: () { + RichClipboard.setData(RichClipboardData(text: src)); + }, + onDelete: () { + TransactionBuilder(context.editorState) + ..deleteNode(context.node) + ..commit(); + }, + onAlign: (alignment) { + TransactionBuilder(context.editorState) + ..updateNode(context.node, { + 'align': _alignmentToText(alignment), + }) + ..commit(); + }, + onResize: (width) { + TransactionBuilder(context.editorState) + ..updateNode(context.node, { + 'width': width, + }) + ..commit(); + }, + ); + } + + @override + NodeValidator get nodeValidator => ((node) { + return node.type == 'image' && + node.attributes.containsKey('image_src') && + node.attributes.containsKey('align'); + }); + + Alignment _textToAlignment(String text) { + if (text == 'left') { + return Alignment.centerLeft; + } else if (text == 'right') { + return Alignment.centerRight; + } + return Alignment.center; + } + + String _alignmentToText(Alignment alignment) { + if (alignment == Alignment.centerLeft) { + return 'left'; + } else if (alignment == Alignment.centerRight) { + return 'right'; + } + return 'center'; + } +} diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/image/image_node_widget.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/image/image_node_widget.dart new file mode 100644 index 0000000000..2cc0916b66 --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/image/image_node_widget.dart @@ -0,0 +1,340 @@ +import 'package:appflowy_editor/src/infra/flowy_svg.dart'; +import 'package:appflowy_editor/src/render/rich_text/rich_text_style.dart'; +import 'package:flutter/material.dart'; + +class ImageNodeWidget extends StatefulWidget { + const ImageNodeWidget({ + Key? key, + required this.src, + this.width, + required this.alignment, + required this.onCopy, + required this.onDelete, + required this.onAlign, + required this.onResize, + }) : super(key: key); + + final String src; + final double? width; + final Alignment alignment; + final VoidCallback onCopy; + final VoidCallback onDelete; + final void Function(Alignment alignment) onAlign; + final void Function(double width) onResize; + + @override + State createState() => _ImageNodeWidgetState(); +} + +class _ImageNodeWidgetState extends State { + double? _imageWidth; + double _initial = 0; + double _distance = 0; + bool _onFocus = false; + + ImageStream? _imageStream; + late ImageStreamListener _imageStreamListener; + + @override + void initState() { + super.initState(); + + _imageWidth = widget.width; + _imageStreamListener = ImageStreamListener( + (image, _) { + _imageWidth = image.image.width.toDouble(); + }, + ); + } + + @override + void dispose() { + _imageStream?.removeListener(_imageStreamListener); + super.dispose(); + } + + @override + Widget build(BuildContext context) { + // only support network image. + + return Container( + width: defaultMaxTextNodeWidth, + padding: const EdgeInsets.only(top: 8, bottom: 8), + child: _buildNetworkImage(context), + ); + } + + Widget _buildNetworkImage(BuildContext context) { + return Align( + alignment: widget.alignment, + child: MouseRegion( + onEnter: (event) => setState(() { + _onFocus = true; + }), + onExit: (event) => setState(() { + _onFocus = false; + }), + child: _buildResizableImage(context), + ), + ); + } + + Widget _buildResizableImage(BuildContext context) { + final networkImage = Image.network( + widget.src, + width: _imageWidth == null ? null : _imageWidth! - _distance, + gaplessPlayback: true, + loadingBuilder: (context, child, loadingProgress) => + loadingProgress == null ? child : _buildLoading(context), + errorBuilder: (context, error, stackTrace) { + _imageWidth ??= defaultMaxTextNodeWidth; + return _buildError(context); + }, + ); + if (_imageWidth == null) { + _imageStream = networkImage.image.resolve(const ImageConfiguration()) + ..addListener(_imageStreamListener); + } + return Stack( + children: [ + networkImage, + _buildEdgeGesture( + context, + top: 0, + left: 0, + bottom: 0, + width: 5, + onUpdate: (distance) { + setState(() { + _distance = distance; + }); + }, + ), + _buildEdgeGesture( + context, + top: 0, + right: 0, + bottom: 0, + width: 5, + onUpdate: (distance) { + setState(() { + _distance = -distance; + }); + }, + ), + if (_onFocus) + ImageToolbar( + top: 8, + right: 8, + height: 30, + alignment: widget.alignment, + onAlign: widget.onAlign, + onCopy: widget.onCopy, + onDelete: widget.onDelete, + ) + ], + ); + } + + Widget _buildLoading(BuildContext context) { + return SizedBox( + height: 150, + child: Row( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + SizedBox.fromSize( + size: const Size(18, 18), + child: const CircularProgressIndicator(), + ), + SizedBox.fromSize( + size: const Size(10, 10), + ), + const Text('Loading'), + ], + ), + ); + } + + Widget _buildError(BuildContext context) { + return Container( + height: 100, + width: _imageWidth, + alignment: Alignment.center, + padding: const EdgeInsets.only(top: 8.0, bottom: 8.0), + decoration: BoxDecoration( + borderRadius: const BorderRadius.all(Radius.circular(4.0)), + border: Border.all(width: 1, color: Colors.black), + ), + child: const Text('Could not load the image'), + ); + } + + Widget _buildEdgeGesture( + BuildContext context, { + double? top, + double? left, + double? right, + double? bottom, + double? width, + void Function(double distance)? onUpdate, + }) { + return Positioned( + top: top, + left: left, + right: right, + bottom: bottom, + width: width, + child: GestureDetector( + onHorizontalDragStart: (details) { + _initial = details.globalPosition.dx; + }, + onHorizontalDragUpdate: (details) { + if (onUpdate != null) { + onUpdate(details.globalPosition.dx - _initial); + } + }, + onHorizontalDragEnd: (details) { + _imageWidth = _imageWidth! - _distance; + _initial = 0; + _distance = 0; + + widget.onResize(_imageWidth!); + }, + child: MouseRegion( + cursor: SystemMouseCursors.resizeLeftRight, + child: _onFocus + ? Center( + child: Container( + height: 40, + decoration: BoxDecoration( + color: Colors.black.withOpacity(0.2), + borderRadius: const BorderRadius.all( + Radius.circular(5.0), + ), + ), + ), + ) + : null, + ), + ), + ); + } +} + +@visibleForTesting +class ImageToolbar extends StatelessWidget { + const ImageToolbar({ + Key? key, + required this.top, + required this.right, + required this.height, + required this.alignment, + required this.onCopy, + required this.onDelete, + required this.onAlign, + }) : super(key: key); + + final double top; + final double right; + final double height; + final Alignment alignment; + final VoidCallback onCopy; + final VoidCallback onDelete; + final void Function(Alignment alignment) onAlign; + + @override + Widget build(BuildContext context) { + return Positioned( + top: top, + right: right, + height: height, + child: Container( + decoration: BoxDecoration( + color: const Color(0xFF333333), + boxShadow: [ + BoxShadow( + blurRadius: 5, + spreadRadius: 1, + color: Colors.black.withOpacity(0.1), + ), + ], + borderRadius: BorderRadius.circular(8.0), + ), + child: Row( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + IconButton( + hoverColor: Colors.transparent, + constraints: const BoxConstraints(), + padding: const EdgeInsets.fromLTRB(6.0, 4.0, 0.0, 4.0), + icon: FlowySvg( + name: 'image_toolbar/align_left', + color: alignment == Alignment.centerLeft + ? const Color(0xFF00BCF0) + : null, + ), + onPressed: () { + onAlign(Alignment.centerLeft); + }, + ), + IconButton( + hoverColor: Colors.transparent, + constraints: const BoxConstraints(), + padding: const EdgeInsets.fromLTRB(0.0, 4.0, 0.0, 4.0), + icon: FlowySvg( + name: 'image_toolbar/align_center', + color: alignment == Alignment.center + ? const Color(0xFF00BCF0) + : null, + ), + onPressed: () { + onAlign(Alignment.center); + }, + ), + IconButton( + hoverColor: Colors.transparent, + constraints: const BoxConstraints(), + padding: const EdgeInsets.fromLTRB(0.0, 4.0, 4.0, 4.0), + icon: FlowySvg( + name: 'image_toolbar/align_right', + color: alignment == Alignment.centerRight + ? const Color(0xFF00BCF0) + : null, + ), + onPressed: () { + onAlign(Alignment.centerRight); + }, + ), + const Center( + child: FlowySvg( + name: 'image_toolbar/divider', + ), + ), + IconButton( + hoverColor: Colors.transparent, + constraints: const BoxConstraints(), + padding: const EdgeInsets.fromLTRB(4.0, 4.0, 0.0, 4.0), + icon: const FlowySvg( + name: 'image_toolbar/copy', + ), + onPressed: () { + onCopy(); + }, + ), + IconButton( + hoverColor: Colors.transparent, + constraints: const BoxConstraints(), + padding: const EdgeInsets.fromLTRB(0.0, 4.0, 6.0, 4.0), + icon: const FlowySvg( + name: 'image_toolbar/delete', + ), + onPressed: () { + onDelete(); + }, + ), + ], + ), + ), + ); + } +} diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/image/image_upload_widget.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/image/image_upload_widget.dart new file mode 100644 index 0000000000..a8728341df --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/image/image_upload_widget.dart @@ -0,0 +1,202 @@ +import 'dart:collection'; + +import 'package:appflowy_editor/src/document/node.dart'; +import 'package:appflowy_editor/src/editor_state.dart'; +import 'package:appflowy_editor/src/infra/flowy_svg.dart'; +import 'package:appflowy_editor/src/operation/transaction_builder.dart'; +import 'package:appflowy_editor/src/render/selection_menu/selection_menu_service.dart'; +import 'package:flutter/material.dart'; + +OverlayEntry? _imageUploadMenu; +EditorState? _editorState; +void showImageUploadMenu( + EditorState editorState, + SelectionMenuService menuService, + BuildContext context, +) { + menuService.dismiss(); + + _imageUploadMenu?.remove(); + _imageUploadMenu = OverlayEntry(builder: (context) { + return Positioned( + top: menuService.topLeft.dy, + left: menuService.topLeft.dx, + child: Material( + child: ImageUploadMenu( + onSubmitted: (text) { + // _dismissImageUploadMenu(); + editorState.insertImageNode(text); + }, + onUpload: (text) { + // _dismissImageUploadMenu(); + editorState.insertImageNode(text); + }, + ), + ), + ); + }); + + Overlay.of(context)?.insert(_imageUploadMenu!); + + editorState.service.selectionService.currentSelection + .addListener(_dismissImageUploadMenu); +} + +void _dismissImageUploadMenu() { + _imageUploadMenu?.remove(); + _imageUploadMenu = null; + + _editorState?.service.selectionService.currentSelection + .removeListener(_dismissImageUploadMenu); + _editorState = null; +} + +class ImageUploadMenu extends StatefulWidget { + const ImageUploadMenu({ + Key? key, + required this.onSubmitted, + required this.onUpload, + }) : super(key: key); + + final void Function(String text) onSubmitted; + final void Function(String text) onUpload; + + @override + State createState() => _ImageUploadMenuState(); +} + +class _ImageUploadMenuState extends State { + final _textEditingController = TextEditingController(); + final _focusNode = FocusNode(); + + @override + void initState() { + super.initState(); + _focusNode.requestFocus(); + } + + @override + void dispose() { + _focusNode.dispose(); + super.dispose(); + } + + @override + Widget build(BuildContext context) { + return Container( + width: 300, + padding: const EdgeInsets.all(24.0), + decoration: BoxDecoration( + color: Colors.white, + boxShadow: [ + BoxShadow( + blurRadius: 5, + spreadRadius: 1, + color: Colors.black.withOpacity(0.1), + ), + ], + borderRadius: BorderRadius.circular(6.0), + ), + child: Column( + crossAxisAlignment: CrossAxisAlignment.start, + children: [ + _buildHeader(context), + const SizedBox(height: 16.0), + _buildInput(), + const SizedBox(height: 18.0), + _buildUploadButton(context), + ], + ), + ); + } + + Widget _buildHeader(BuildContext context) { + return const Text( + 'URL Image', + textAlign: TextAlign.left, + style: TextStyle( + fontSize: 14.0, + color: Colors.black, + fontWeight: FontWeight.w500, + ), + ); + } + + Widget _buildInput() { + return TextField( + focusNode: _focusNode, + style: const TextStyle(fontSize: 14.0), + textAlign: TextAlign.left, + controller: _textEditingController, + onSubmitted: widget.onSubmitted, + decoration: InputDecoration( + hintText: 'URL', + hintStyle: const TextStyle(fontSize: 14.0), + contentPadding: const EdgeInsets.all(16.0), + isDense: true, + suffixIcon: IconButton( + padding: const EdgeInsets.all(4.0), + icon: const FlowySvg( + name: 'clear', + width: 24, + height: 24, + ), + onPressed: () { + _textEditingController.clear(); + }, + ), + border: const OutlineInputBorder( + borderRadius: BorderRadius.all(Radius.circular(12.0)), + borderSide: BorderSide(color: Color(0xFFBDBDBD)), + ), + ), + ); + } + + Widget _buildUploadButton(BuildContext context) { + return SizedBox( + width: 170, + height: 48, + child: TextButton( + style: ButtonStyle( + backgroundColor: MaterialStateProperty.all(const Color(0xFF00BCF0)), + shape: MaterialStateProperty.all( + RoundedRectangleBorder( + borderRadius: BorderRadius.circular(12.0), + ), + ), + ), + onPressed: () { + widget.onUpload(_textEditingController.text); + }, + child: const Text( + 'Upload', + style: TextStyle(color: Colors.white, fontSize: 14.0), + ), + ), + ); + } +} + +extension on EditorState { + void insertImageNode(String src) { + final selection = service.selectionService.currentSelection.value; + if (selection == null) { + return; + } + final imageNode = Node( + type: 'image', + children: LinkedList(), + attributes: { + 'image_src': src, + 'align': 'center', + }, + ); + TransactionBuilder(this) + ..insertNode( + selection.start.path, + imageNode, + ) + ..commit(); + } +} diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/link_menu/link_menu.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/link_menu/link_menu.dart new file mode 100644 index 0000000000..a33adf3b8c --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/link_menu/link_menu.dart @@ -0,0 +1,151 @@ +import 'package:appflowy_editor/src/infra/flowy_svg.dart'; +import 'package:flutter/material.dart'; + +class LinkMenu extends StatefulWidget { + const LinkMenu({ + Key? key, + this.linkText, + required this.onSubmitted, + required this.onCopyLink, + required this.onRemoveLink, + }) : super(key: key); + + final String? linkText; + final void Function(String text) onSubmitted; + final VoidCallback onCopyLink; + final VoidCallback onRemoveLink; + + @override + State createState() => _LinkMenuState(); +} + +class _LinkMenuState extends State { + final _textEditingController = TextEditingController(); + final _focusNode = FocusNode(); + + @override + void initState() { + super.initState(); + + _textEditingController.text = widget.linkText ?? ''; + _focusNode.requestFocus(); + } + + @override + void dispose() { + _focusNode.dispose(); + + super.dispose(); + } + + @override + Widget build(BuildContext context) { + return SizedBox( + width: 350, + child: Container( + decoration: BoxDecoration( + color: Colors.white, + boxShadow: [ + BoxShadow( + blurRadius: 5, + spreadRadius: 1, + color: Colors.black.withOpacity(0.1), + ), + ], + borderRadius: BorderRadius.circular(6.0), + ), + child: Padding( + padding: const EdgeInsets.all(20.0), + child: Column( + crossAxisAlignment: CrossAxisAlignment.start, + mainAxisSize: MainAxisSize.min, + children: [ + _buildHeader(), + const SizedBox(height: 16.0), + _buildInput(), + const SizedBox(height: 16.0), + if (widget.linkText != null) ...[ + _buildIconButton( + iconName: 'link', + text: 'Copy link', + onPressed: widget.onCopyLink, + ), + _buildIconButton( + iconName: 'delete', + text: 'Remove link', + onPressed: widget.onRemoveLink, + ), + ] + ], + ), + ), + ), + ); + } + + Widget _buildHeader() { + return const Text( + 'Add your link', + style: TextStyle( + color: Colors.grey, + fontWeight: FontWeight.bold, + ), + ); + } + + Widget _buildInput() { + return TextField( + focusNode: _focusNode, + style: const TextStyle(fontSize: 14.0), + textAlign: TextAlign.left, + controller: _textEditingController, + onSubmitted: widget.onSubmitted, + decoration: InputDecoration( + hintText: 'URL', + hintStyle: const TextStyle(fontSize: 14.0), + contentPadding: const EdgeInsets.all(16.0), + isDense: true, + suffixIcon: IconButton( + padding: const EdgeInsets.all(4.0), + icon: const FlowySvg( + name: 'clear', + width: 24, + height: 24, + ), + onPressed: () { + _textEditingController.clear(); + }, + ), + border: const OutlineInputBorder( + borderRadius: BorderRadius.all(Radius.circular(12.0)), + borderSide: BorderSide(color: Color(0xFFBDBDBD)), + ), + ), + ); + } + + Widget _buildIconButton({ + required String iconName, + required String text, + required VoidCallback onPressed, + }) { + return TextButton.icon( + icon: FlowySvg(name: iconName), + style: TextButton.styleFrom( + minimumSize: const Size.fromHeight(40), + padding: EdgeInsets.zero, + tapTargetSize: MaterialTapTargetSize.shrinkWrap, + alignment: Alignment.centerLeft, + ), + label: Text( + text, + textAlign: TextAlign.left, + style: const TextStyle( + color: Colors.black, + fontSize: 14.0, + ), + ), + onPressed: onPressed, + ); + } +} diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/bulleted_list_text.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/bulleted_list_text.dart index 267a5acc66..7d69ff459f 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/bulleted_list_text.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/bulleted_list_text.dart @@ -56,8 +56,6 @@ class _BulletedListTextNodeWidgetState extends State @override Widget build(BuildContext context) { - final topPadding = RichTextStyle.fromTextNode(widget.textNode).topPadding; - return SizedBox( width: defaultMaxTextNodeWidth, child: Padding( @@ -69,8 +67,7 @@ class _BulletedListTextNodeWidgetState extends State key: iconKey, width: _iconWidth, height: _iconWidth, - padding: - EdgeInsets.only(top: topPadding, right: _iconRightPadding), + padding: EdgeInsets.only(right: _iconRightPadding), name: 'point', ), Expanded( diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/checkbox_text.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/checkbox_text.dart index 9b7d3a730f..0255a84049 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/checkbox_text.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/checkbox_text.dart @@ -63,7 +63,6 @@ class _CheckboxNodeWidgetState extends State Widget _buildWithSingle(BuildContext context) { final check = widget.textNode.attributes.check; - final topPadding = RichTextStyle.fromTextNode(widget.textNode).topPadding; return SizedBox( width: defaultMaxTextNodeWidth, child: Padding( @@ -76,10 +75,7 @@ class _CheckboxNodeWidgetState extends State child: FlowySvg( width: _iconWidth, height: _iconWidth, - padding: EdgeInsets.only( - top: topPadding, - right: _iconRightPadding, - ), + padding: EdgeInsets.only(right: _iconRightPadding), name: check ? 'check' : 'uncheck', ), onTap: () { diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/flowy_rich_text.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/flowy_rich_text.dart index fb4dbdc4a1..39f484c23f 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/flowy_rich_text.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/flowy_rich_text.dart @@ -1,5 +1,7 @@ +import 'dart:async'; import 'dart:ui'; +import 'package:flutter/gestures.dart'; import 'package:flutter/material.dart'; import 'package:flutter/rendering.dart'; @@ -11,6 +13,7 @@ import 'package:appflowy_editor/src/document/text_delta.dart'; import 'package:appflowy_editor/src/editor_state.dart'; import 'package:appflowy_editor/src/render/rich_text/rich_text_style.dart'; import 'package:appflowy_editor/src/render/selection/selectable.dart'; +import 'package:url_launcher/url_launcher_string.dart'; typedef FlowyTextSpanDecorator = TextSpan Function(TextSpan textSpan); @@ -65,18 +68,35 @@ class _FlowyRichTextState extends State with Selectable { @override Rect? getCursorRectInPosition(Position position) { final textPosition = TextPosition(offset: position.offset); - final cursorOffset = - _renderParagraph.getOffsetForCaret(textPosition, Rect.zero); - final cursorHeight = widget.cursorHeight ?? - _renderParagraph.getFullHeightForCaret(textPosition) ?? - _placeholderRenderParagraph.getFullHeightForCaret(textPosition) ?? - 16.0; // default height + var cursorHeight = _renderParagraph.getFullHeightForCaret(textPosition); + var cursorOffset = + _renderParagraph.getOffsetForCaret(textPosition, Rect.zero); + if (cursorHeight == null) { + cursorHeight = + _placeholderRenderParagraph.getFullHeightForCaret(textPosition); + cursorOffset = _placeholderRenderParagraph.getOffsetForCaret( + textPosition, Rect.zero); + } + if (cursorHeight != null) { + // workaround: Calling the `getFullHeightForCaret` function will return + // the full height of rich text component instead of the plain text + // if we set the line height. + // So need to divide by the line height to get the expected value. + // + // And the default height of plain text is too short. Add a magic height + // to expand it. + const magicHeight = 3.0; + cursorOffset = cursorOffset.translate( + 0, (cursorHeight - cursorHeight / _lineHeight) / 2.0); + cursorHeight /= _lineHeight; + cursorHeight += magicHeight; + } final rect = Rect.fromLTWH( cursorOffset.dx - (widget.cursorWidth / 2), cursorOffset.dy, widget.cursorWidth, - cursorHeight, + widget.cursorHeight ?? cursorHeight ?? 16.0, ); return rect; } @@ -126,6 +146,11 @@ class _FlowyRichTextState extends State with Selectable { ); } + @override + Offset localToGlobal(Offset offset) { + return _renderParagraph.localToGlobal(offset); + } + Widget _buildRichText(BuildContext context) { return MouseRegion( cursor: SystemMouseCursors.text, @@ -164,44 +189,63 @@ class _FlowyRichTextState extends State with Selectable { ); } - // unused now. - // Widget _buildRichTextWithChildren(BuildContext context) { - // return Column( - // crossAxisAlignment: CrossAxisAlignment.start, - // children: [ - // _buildSingleRichText(context), - // ...widget.textNode.children - // .map( - // (child) => widget.editorState.service.renderPluginService - // .buildPluginWidget( - // NodeWidgetContext( - // context: context, - // node: child, - // editorState: widget.editorState, - // ), - // ), - // ) - // .toList() - // ], - // ); - // } + TextSpan get _textSpan { + var offset = 0; + return TextSpan( + children: widget.textNode.delta.whereType().map((insert) { + GestureRecognizer? gestureDetector; + if (insert.attributes?[StyleKey.href] != null) { + final startOffset = offset; + Timer? timer; + var tapCount = 0; + gestureDetector = TapGestureRecognizer() + ..onTap = () async { + // implement a simple double tap logic + tapCount += 1; + timer?.cancel(); - @override - Offset localToGlobal(Offset offset) { - return _renderParagraph.localToGlobal(offset); + if (tapCount == 2) { + tapCount = 0; + final href = insert.attributes![StyleKey.href]; + final uri = Uri.parse(href); + // url_launcher cannot open a link without scheme. + final newHref = + (uri.scheme.isNotEmpty ? href : 'http://$href').trim(); + if (await canLaunchUrlString(newHref)) { + await launchUrlString(newHref); + } + return; + } + + timer = Timer(const Duration(milliseconds: 200), () { + tapCount = 0; + // update selection + final selection = Selection.single( + path: widget.textNode.path, + startOffset: startOffset, + endOffset: startOffset + insert.length, + ); + widget.editorState.service.selectionService + .updateSelection(selection); + WidgetsBinding.instance.addPostFrameCallback((timeStamp) { + widget.editorState.service.toolbarService + ?.triggerHandler('appflowy.toolbar.link'); + }); + }); + }; + } + offset += insert.length; + final textSpan = RichTextStyle( + attributes: insert.attributes ?? {}, + text: insert.content, + height: _lineHeight, + gestureRecognizer: gestureDetector, + ).toTextSpan(); + return textSpan; + }).toList(growable: false), + ); } - TextSpan get _textSpan => TextSpan( - children: widget.textNode.delta - .whereType() - .map((insert) => RichTextStyle( - attributes: insert.attributes ?? {}, - text: insert.content, - height: _lineHeight, - ).toTextSpan()) - .toList(growable: false), - ); - TextSpan get _placeholderTextSpan => TextSpan(children: [ RichTextStyle( text: widget.placeholderText, diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/number_list_text.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/number_list_text.dart index de3b0b55b6..c1062e1c3c 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/number_list_text.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/number_list_text.dart @@ -56,7 +56,6 @@ class _NumberListTextNodeWidgetState extends State @override Widget build(BuildContext context) { - final topPadding = RichTextStyle.fromTextNode(widget.textNode).topPadding; return Padding( padding: EdgeInsets.only(bottom: defaultLinePadding), child: SizedBox( @@ -68,8 +67,7 @@ class _NumberListTextNodeWidgetState extends State key: iconKey, width: _iconWidth, height: _iconWidth, - padding: - EdgeInsets.only(top: topPadding, right: _iconRightPadding), + padding: EdgeInsets.only(right: _iconRightPadding), number: widget.textNode.attributes.number, ), Expanded( diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/quoted_text.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/quoted_text.dart index 0389dfa50f..78c6653904 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/quoted_text.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/quoted_text.dart @@ -55,39 +55,32 @@ class _QuotedTextNodeWidgetState extends State @override Widget build(BuildContext context) { - final topPadding = RichTextStyle.fromTextNode(widget.textNode).topPadding; return SizedBox( - width: defaultMaxTextNodeWidth, - child: Padding( - padding: EdgeInsets.only(bottom: defaultLinePadding), - child: IntrinsicHeight( - child: Row( - crossAxisAlignment: CrossAxisAlignment.stretch, - children: [ - FlowySvg( - key: iconKey, - width: _iconWidth, - padding: EdgeInsets.only( - top: topPadding, right: _iconRightPadding), - name: 'quote', + width: defaultMaxTextNodeWidth, + child: Padding( + padding: EdgeInsets.only(bottom: defaultLinePadding), + child: IntrinsicHeight( + child: Row( + crossAxisAlignment: CrossAxisAlignment.stretch, + children: [ + FlowySvg( + key: iconKey, + width: _iconWidth, + padding: EdgeInsets.only(right: _iconRightPadding), + name: 'quote', + ), + Expanded( + child: FlowyRichText( + key: _richTextKey, + placeholderText: 'Quote', + textNode: widget.textNode, + editorState: widget.editorState, ), - Expanded( - child: FlowyRichText( - key: _richTextKey, - placeholderText: 'Quote', - textNode: widget.textNode, - editorState: widget.editorState, - ), - ), - ], - ), + ), + ], ), - )); - } - - double get _quoteHeight { - final lines = - widget.textNode.toRawString().characters.where((c) => c == '\n').length; - return (lines + 1) * _iconWidth; + ), + ), + ); } } diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/rich_text_style.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/rich_text_style.dart index 7bd68c45e7..efcdd3790f 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/rich_text_style.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/rich_text/rich_text_style.dart @@ -1,8 +1,6 @@ import 'package:appflowy_editor/src/document/attributes.dart'; -import 'package:appflowy_editor/src/document/node.dart'; import 'package:flutter/gestures.dart'; import 'package:flutter/material.dart'; -import 'package:url_launcher/url_launcher_string.dart'; /// /// Supported partial rendering types: @@ -182,14 +180,13 @@ class RichTextStyle { RichTextStyle({ required this.attributes, required this.text, + this.gestureRecognizer, this.height = 1.5, }); - RichTextStyle.fromTextNode(TextNode textNode) - : this(attributes: textNode.attributes, text: textNode.toRawString()); - final Attributes attributes; final String text; + final GestureRecognizer? gestureRecognizer; final double height; TextSpan toTextSpan() => _toTextSpan(height); @@ -201,6 +198,7 @@ class RichTextStyle { TextSpan _toTextSpan(double? height) { return TextSpan( text: text, + recognizer: _recognizer, style: TextStyle( fontWeight: _fontWeight, fontStyle: _fontStyle, @@ -210,7 +208,6 @@ class RichTextStyle { background: _background, height: height, ), - recognizer: _recognizer, ); } @@ -273,13 +270,6 @@ class RichTextStyle { // recognizer GestureRecognizer? get _recognizer { - final href = attributes.href; - if (href != null) { - return TapGestureRecognizer() - ..onTap = () async { - await launchUrlString(href); - }; - } - return null; + return gestureRecognizer; } } diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection/toolbar_widget.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection/toolbar_widget.dart deleted file mode 100644 index 4c2b621795..0000000000 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection/toolbar_widget.dart +++ /dev/null @@ -1,217 +0,0 @@ -import 'package:appflowy_editor/src/render/rich_text/rich_text_style.dart'; -import 'package:flutter/material.dart'; - -import 'package:appflowy_editor/src/editor_state.dart'; -import 'package:appflowy_editor/src/infra/flowy_svg.dart'; -import 'package:appflowy_editor/src/service/default_text_operations/format_rich_text_style.dart'; - -typedef ToolbarEventHandler = void Function(EditorState editorState); - -typedef ToolbarEventHandlers = Map; - -ToolbarEventHandlers defaultToolbarEventHandlers = { - 'bold': (editorState) => formatBold(editorState), - 'italic': (editorState) => formatItalic(editorState), - 'strikethrough': (editorState) => formatStrikethrough(editorState), - 'underline': (editorState) => formatUnderline(editorState), - 'quote': (editorState) => formatQuote(editorState), - 'bulleted_list': (editorState) => formatBulletedList(editorState), - 'highlight': (editorState) => formatHighlight(editorState), - 'Text': (editorState) => formatText(editorState), - 'h1': (editorState) => formatHeading(editorState, StyleKey.h1), - 'h2': (editorState) => formatHeading(editorState, StyleKey.h2), - 'h3': (editorState) => formatHeading(editorState, StyleKey.h3), -}; - -List defaultListToolbarEventNames = [ - 'Text', - 'H1', - 'H2', - 'H3', -]; - -mixin ToolbarMixin on State { - void hide(); -} - -class ToolbarWidget extends StatefulWidget { - const ToolbarWidget({ - Key? key, - required this.editorState, - required this.layerLink, - required this.offset, - required this.handlers, - }) : super(key: key); - - final EditorState editorState; - final LayerLink layerLink; - final Offset offset; - final ToolbarEventHandlers handlers; - - @override - State createState() => _ToolbarWidgetState(); -} - -class _ToolbarWidgetState extends State with ToolbarMixin { - // final GlobalKey _listToolbarKey = GlobalKey(); - - final toolbarHeight = 32.0; - final topPadding = 5.0; - - final listToolbarWidth = 60.0; - final listToolbarHeight = 120.0; - - final cornerRadius = 8.0; - - OverlayEntry? _listToolbarOverlay; - - @override - Widget build(BuildContext context) { - return Positioned( - top: widget.offset.dx, - left: widget.offset.dy, - child: CompositedTransformFollower( - link: widget.layerLink, - showWhenUnlinked: true, - offset: widget.offset, - child: _buildToolbar(context), - ), - ); - } - - @override - void hide() { - _listToolbarOverlay?.remove(); - _listToolbarOverlay = null; - } - - Widget _buildToolbar(BuildContext context) { - return Material( - borderRadius: BorderRadius.circular(cornerRadius), - color: const Color(0xFF333333), - child: SizedBox( - height: toolbarHeight, - child: Row( - crossAxisAlignment: CrossAxisAlignment.start, - children: [ - // _listToolbar(context), - _centerToolbarIcon('h1', tooltipMessage: 'Heading 1'), - _centerToolbarIcon('h2', tooltipMessage: 'Heading 2'), - _centerToolbarIcon('h3', tooltipMessage: 'Heading 3'), - _centerToolbarIcon('divider', width: 2), - _centerToolbarIcon('bold', tooltipMessage: 'Bold'), - _centerToolbarIcon('italic', tooltipMessage: 'Italic'), - _centerToolbarIcon('strikethrough', - tooltipMessage: 'Strikethrough'), - _centerToolbarIcon('underline', tooltipMessage: 'Underline'), - _centerToolbarIcon('divider', width: 2), - _centerToolbarIcon('quote', tooltipMessage: 'Quote'), - // _centerToolbarIcon('number_list'), - _centerToolbarIcon('bulleted_list', - tooltipMessage: 'Bulleted List'), - _centerToolbarIcon('divider', width: 2), - _centerToolbarIcon('highlight', tooltipMessage: 'Highlight'), - ], - ), - ), - ); - } - - // Widget _listToolbar(BuildContext context) { - // return _centerToolbarIcon( - // 'quote', - // key: _listToolbarKey, - // width: listToolbarWidth, - // onTap: () => _onTapListToolbar(context), - // ); - // } - - Widget _centerToolbarIcon(String name, - {Key? key, String? tooltipMessage, double? width, VoidCallback? onTap}) { - return Tooltip( - key: key, - preferBelow: false, - message: tooltipMessage ?? '', - child: MouseRegion( - cursor: SystemMouseCursors.click, - child: GestureDetector( - onTap: onTap ?? () => _onTap(name), - child: SizedBox.fromSize( - size: - Size(toolbarHeight - (width != null ? 20 : 0), toolbarHeight), - child: Center( - child: FlowySvg( - width: width ?? 20, - name: 'toolbar/$name', - ), - ), - ), - ), - )); - } - - // void _onTapListToolbar(BuildContext context) { - // // TODO: implement more detailed UI. - // final items = defaultListToolbarEventNames; - // final renderBox = - // _listToolbarKey.currentContext?.findRenderObject() as RenderBox; - // final offset = renderBox - // .localToGlobal(Offset.zero) - // .translate(0, toolbarHeight - cornerRadius); - // final rect = offset & Size(listToolbarWidth, listToolbarHeight); - - // _listToolbarOverlay?.remove(); - // _listToolbarOverlay = OverlayEntry(builder: (context) { - // return Positioned.fromRect( - // rect: rect, - // child: Material( - // borderRadius: BorderRadius.only( - // bottomLeft: Radius.circular(cornerRadius), - // bottomRight: Radius.circular(cornerRadius), - // ), - // color: const Color(0xFF333333), - // child: SingleChildScrollView( - // child: ListView.builder( - // itemExtent: toolbarHeight, - // padding: const EdgeInsets.only(bottom: 10.0), - // shrinkWrap: true, - // itemCount: items.length, - // itemBuilder: ((context, index) { - // return ListTile( - // contentPadding: const EdgeInsets.only( - // left: 3.0, - // right: 3.0, - // ), - // minVerticalPadding: 0.0, - // title: FittedBox( - // fit: BoxFit.scaleDown, - // child: Text( - // items[index], - // textAlign: TextAlign.center, - // style: const TextStyle( - // color: Colors.white, - // ), - // ), - // ), - // onTap: () { - // _onTap(items[index]); - // }, - // ); - // }), - // ), - // ), - // ), - // ); - // }); - // // TODO: disable scrolling. - // Overlay.of(context)?.insert(_listToolbarOverlay!); - // } - - void _onTap(String eventName) { - if (defaultToolbarEventHandlers.containsKey(eventName)) { - defaultToolbarEventHandlers[eventName]!(widget.editorState); - return; - } - assert(false, 'Could not find the event handler for $eventName'); - } -} diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection_menu/selection_menu_item_widget.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection_menu/selection_menu_item_widget.dart index 36e0a2e02e..3b7307f039 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection_menu/selection_menu_item_widget.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection_menu/selection_menu_item_widget.dart @@ -45,7 +45,7 @@ class SelectionMenuItemWidget extends StatelessWidget { ), ), onPressed: () { - item.handler(editorState, menuService); + item.handler(editorState, menuService, context); }, ), ), diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection_menu/selection_menu_service.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection_menu/selection_menu_service.dart index 94fa6190d8..7f4f803610 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection_menu/selection_menu_service.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection_menu/selection_menu_service.dart @@ -1,5 +1,6 @@ import 'package:appflowy_editor/src/editor_state.dart'; import 'package:appflowy_editor/src/infra/flowy_svg.dart'; +import 'package:appflowy_editor/src/render/image/image_upload_widget.dart'; import 'package:appflowy_editor/src/render/rich_text/rich_text_style.dart'; import 'package:appflowy_editor/src/render/selection_menu/selection_menu_widget.dart'; import 'package:appflowy_editor/src/service/default_text_operations/format_rich_text_style.dart'; @@ -23,6 +24,7 @@ class SelectionMenu implements SelectionMenuService { OverlayEntry? _selectionMenuEntry; bool _selectionUpdateByInner = false; + Offset? _topLeft; @override void dismiss() { @@ -53,6 +55,7 @@ class SelectionMenu implements SelectionMenuService { return; } final offset = selectionRects.first.bottomRight + const Offset(10, 10); + _topLeft = offset; _selectionMenuEntry = OverlayEntry(builder: (context) { return Positioned( @@ -84,8 +87,9 @@ class SelectionMenu implements SelectionMenuService { } @override - // TODO: implement topLeft - Offset get topLeft => throw UnimplementedError(); + Offset get topLeft { + return _topLeft ?? Offset.zero; + } void _onSelectionChange() { // workaround: SelectionService has been released after hot reload. @@ -115,7 +119,7 @@ final List _defaultSelectionMenuItems = [ name: 'Text', icon: _selectionMenuIcon('text'), keywords: ['text'], - handler: (editorState, menuService) { + handler: (editorState, _, __) { insertTextNodeAfterSelection(editorState, {}); }, ), @@ -123,7 +127,7 @@ final List _defaultSelectionMenuItems = [ name: 'Heading 1', icon: _selectionMenuIcon('h1'), keywords: ['heading 1, h1'], - handler: (editorState, menuService) { + handler: (editorState, _, __) { insertHeadingAfterSelection(editorState, StyleKey.h1); }, ), @@ -131,7 +135,7 @@ final List _defaultSelectionMenuItems = [ name: 'Heading 2', icon: _selectionMenuIcon('h2'), keywords: ['heading 2, h2'], - handler: (editorState, menuService) { + handler: (editorState, _, __) { insertHeadingAfterSelection(editorState, StyleKey.h2); }, ), @@ -139,15 +143,21 @@ final List _defaultSelectionMenuItems = [ name: 'Heading 3', icon: _selectionMenuIcon('h3'), keywords: ['heading 3, h3'], - handler: (editorState, menuService) { + handler: (editorState, _, __) { insertHeadingAfterSelection(editorState, StyleKey.h3); }, ), + SelectionMenuItem( + name: 'Image', + icon: _selectionMenuIcon('image'), + keywords: ['image'], + handler: showImageUploadMenu, + ), SelectionMenuItem( name: 'Bulleted list', icon: _selectionMenuIcon('bulleted_list'), keywords: ['bulleted list', 'list', 'unordered list'], - handler: (editorState, menuService) { + handler: (editorState, _, __) { insertBulletedListAfterSelection(editorState); }, ), @@ -155,7 +165,7 @@ final List _defaultSelectionMenuItems = [ name: 'Checkbox', icon: _selectionMenuIcon('checkbox'), keywords: ['todo list', 'list', 'checkbox list'], - handler: (editorState, menuService) { + handler: (editorState, _, __) { insertCheckboxAfterSelection(editorState); }, ), diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection_menu/selection_menu_widget.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection_menu/selection_menu_widget.dart index 70f7bbc337..1553085349 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection_menu/selection_menu_widget.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/selection_menu/selection_menu_widget.dart @@ -22,8 +22,11 @@ class SelectionMenuItem { /// /// The keywords are used to quickly retrieve items. final List keywords; - final void Function(EditorState editorState, SelectionMenuService menuService) - handler; + final void Function( + EditorState editorState, + SelectionMenuService menuService, + BuildContext context, + ) handler; } class SelectionMenuWidget extends StatefulWidget { @@ -202,8 +205,10 @@ class _SelectionMenuWidgetState extends State { if (event.logicalKey == LogicalKeyboardKey.enter) { if (0 <= _selectedIndex && _selectedIndex < _showingItems.length) { _deleteLastCharacters(length: keyword.length + 1); - _showingItems[_selectedIndex] - .handler(widget.editorState, widget.menuService); + WidgetsBinding.instance.addPostFrameCallback((timeStamp) { + _showingItems[_selectedIndex] + .handler(widget.editorState, widget.menuService, context); + }); return KeyEventResult.handled; } } else if (event.logicalKey == LogicalKeyboardKey.escape) { diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/toolbar/toolbar_item.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/toolbar/toolbar_item.dart new file mode 100644 index 0000000000..107ae23b6f --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/toolbar/toolbar_item.dart @@ -0,0 +1,231 @@ +import 'package:appflowy_editor/appflowy_editor.dart'; +import 'package:appflowy_editor/src/infra/flowy_svg.dart'; +import 'package:appflowy_editor/src/render/link_menu/link_menu.dart'; +import 'package:appflowy_editor/src/render/rich_text/rich_text_style.dart'; +import 'package:appflowy_editor/src/extensions/text_node_extensions.dart'; +import 'package:appflowy_editor/src/service/default_text_operations/format_rich_text_style.dart'; +import 'package:flutter/material.dart'; +import 'package:rich_clipboard/rich_clipboard.dart'; + +typedef ToolbarEventHandler = void Function( + EditorState editorState, BuildContext context); +typedef ToolbarShowValidator = bool Function(EditorState editorState); + +class ToolbarItem { + ToolbarItem({ + required this.id, + required this.type, + required this.icon, + this.tooltipsMessage = '', + required this.validator, + required this.handler, + }); + + final String id; + final int type; + final Widget icon; + final String tooltipsMessage; + final ToolbarShowValidator validator; + final ToolbarEventHandler handler; + + factory ToolbarItem.divider() { + return ToolbarItem( + id: 'divider', + type: -1, + icon: const FlowySvg(name: 'toolbar/divider'), + validator: (editorState) => true, + handler: (editorState, context) {}, + ); + } + + @override + bool operator ==(Object other) { + if (other is! ToolbarItem) { + return false; + } + if (identical(this, other)) { + return true; + } + return id == other.id; + } + + @override + int get hashCode => id.hashCode; +} + +List defaultToolbarItems = [ + ToolbarItem( + id: 'appflowy.toolbar.h1', + type: 1, + tooltipsMessage: 'Heading 1', + icon: const FlowySvg(name: 'toolbar/h1'), + validator: _onlyShowInSingleTextSelection, + handler: (editorState, context) => formatHeading(editorState, StyleKey.h1), + ), + ToolbarItem( + id: 'appflowy.toolbar.h2', + type: 1, + tooltipsMessage: 'Heading 2', + icon: const FlowySvg(name: 'toolbar/h2'), + validator: _onlyShowInSingleTextSelection, + handler: (editorState, context) => formatHeading(editorState, StyleKey.h2), + ), + ToolbarItem( + id: 'appflowy.toolbar.h3', + type: 1, + tooltipsMessage: 'Heading 3', + icon: const FlowySvg(name: 'toolbar/h3'), + validator: _onlyShowInSingleTextSelection, + handler: (editorState, context) => formatHeading(editorState, StyleKey.h3), + ), + ToolbarItem( + id: 'appflowy.toolbar.bold', + type: 2, + tooltipsMessage: 'Bold', + icon: const FlowySvg(name: 'toolbar/bold'), + validator: _showInTextSelection, + handler: (editorState, context) => formatBold(editorState), + ), + ToolbarItem( + id: 'appflowy.toolbar.italic', + type: 2, + tooltipsMessage: 'Italic', + icon: const FlowySvg(name: 'toolbar/italic'), + validator: _showInTextSelection, + handler: (editorState, context) => formatItalic(editorState), + ), + ToolbarItem( + id: 'appflowy.toolbar.underline', + type: 2, + tooltipsMessage: 'Underline', + icon: const FlowySvg(name: 'toolbar/underline'), + validator: _showInTextSelection, + handler: (editorState, context) => formatUnderline(editorState), + ), + ToolbarItem( + id: 'appflowy.toolbar.strikethrough', + type: 2, + tooltipsMessage: 'Strikethrough', + icon: const FlowySvg(name: 'toolbar/strikethrough'), + validator: _showInTextSelection, + handler: (editorState, context) => formatStrikethrough(editorState), + ), + ToolbarItem( + id: 'appflowy.toolbar.quote', + type: 3, + tooltipsMessage: 'Quote', + icon: const FlowySvg(name: 'toolbar/quote'), + validator: _onlyShowInSingleTextSelection, + handler: (editorState, context) => formatQuote(editorState), + ), + ToolbarItem( + id: 'appflowy.toolbar.bulleted_list', + type: 3, + tooltipsMessage: 'Bulleted list', + icon: const FlowySvg(name: 'toolbar/bulleted_list'), + validator: _onlyShowInSingleTextSelection, + handler: (editorState, context) => formatBulletedList(editorState), + ), + ToolbarItem( + id: 'appflowy.toolbar.link', + type: 4, + tooltipsMessage: 'Link', + icon: const FlowySvg(name: 'toolbar/link'), + validator: _onlyShowInSingleTextSelection, + handler: (editorState, context) => _showLinkMenu(editorState, context), + ), + ToolbarItem( + id: 'appflowy.toolbar.highlight', + type: 4, + tooltipsMessage: 'Highlight', + icon: const FlowySvg(name: 'toolbar/highlight'), + validator: _showInTextSelection, + handler: (editorState, context) => formatHighlight(editorState), + ), +]; + +ToolbarShowValidator _onlyShowInSingleTextSelection = (editorState) { + final nodes = editorState.service.selectionService.currentSelectedNodes; + return (nodes.length == 1 && nodes.first is TextNode); +}; + +ToolbarShowValidator _showInTextSelection = (editorState) { + final nodes = editorState.service.selectionService.currentSelectedNodes + .whereType(); + return nodes.isNotEmpty; +}; + +OverlayEntry? _linkMenuOverlay; +EditorState? _editorState; +void _showLinkMenu(EditorState editorState, BuildContext context) { + final rects = editorState.service.selectionService.selectionRects; + var maxBottom = 0.0; + late Rect matchRect; + for (final rect in rects) { + if (rect.bottom > maxBottom) { + maxBottom = rect.bottom; + matchRect = rect; + } + } + + _dismissLinkMenu(); + _editorState = editorState; + + // Since the link menu will only show in single text selection, + // We get the text node directly instead of judging details again. + final selection = + editorState.service.selectionService.currentSelection.value!; + final index = + selection.isBackward ? selection.start.offset : selection.end.offset; + final length = (selection.start.offset - selection.end.offset).abs(); + final node = editorState.service.selectionService.currentSelectedNodes.first + as TextNode; + String? linkText; + if (node.allSatisfyLinkInSelection(selection)) { + linkText = node.getAttributeInSelection(selection, StyleKey.href); + } + _linkMenuOverlay = OverlayEntry(builder: (context) { + return Positioned( + top: matchRect.bottom + 5.0, + left: matchRect.left, + child: Material( + child: LinkMenu( + linkText: linkText, + onSubmitted: (text) { + TransactionBuilder(editorState) + ..formatText(node, index, length, {StyleKey.href: text}) + ..commit(); + _dismissLinkMenu(); + }, + onCopyLink: () { + RichClipboard.setData(RichClipboardData(text: linkText)); + _dismissLinkMenu(); + }, + onRemoveLink: () { + TransactionBuilder(editorState) + ..formatText(node, index, length, {StyleKey.href: null}) + ..commit(); + _dismissLinkMenu(); + }, + ), + ), + ); + }); + Overlay.of(context)?.insert(_linkMenuOverlay!); + + editorState.service.scrollService?.disable(); + editorState.service.keyboardService?.disable(); + editorState.service.selectionService.currentSelection + .addListener(_dismissLinkMenu); +} + +void _dismissLinkMenu() { + _linkMenuOverlay?.remove(); + _linkMenuOverlay = null; + + _editorState?.service.scrollService?.enable(); + _editorState?.service.keyboardService?.enable(); + _editorState?.service.selectionService.currentSelection + .removeListener(_dismissLinkMenu); + _editorState = null; +} diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/toolbar/toolbar_item_widget.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/toolbar/toolbar_item_widget.dart new file mode 100644 index 0000000000..ce89eef126 --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/toolbar/toolbar_item_widget.dart @@ -0,0 +1,35 @@ +import 'package:flutter/material.dart'; + +import 'toolbar_item.dart'; + +class ToolbarItemWidget extends StatelessWidget { + const ToolbarItemWidget({ + Key? key, + required this.item, + required this.onPressed, + }) : super(key: key); + + final ToolbarItem item; + final VoidCallback onPressed; + + @override + Widget build(BuildContext context) { + return SizedBox( + width: 28, + height: 28, + child: Tooltip( + preferBelow: false, + message: item.tooltipsMessage, + child: MouseRegion( + cursor: SystemMouseCursors.click, + child: IconButton( + padding: EdgeInsets.zero, + icon: item.icon, + iconSize: 28, + onPressed: onPressed, + ), + ), + ), + ); + } +} diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/render/toolbar/toolbar_widget.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/toolbar/toolbar_widget.dart new file mode 100644 index 0000000000..395c6818bb --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/render/toolbar/toolbar_widget.dart @@ -0,0 +1,79 @@ +import 'package:appflowy_editor/src/render/toolbar/toolbar_item.dart'; +import 'package:appflowy_editor/src/render/toolbar/toolbar_item_widget.dart'; +import 'package:flutter/material.dart'; + +import 'package:appflowy_editor/src/editor_state.dart'; + +mixin ToolbarMixin on State { + void hide(); +} + +class ToolbarWidget extends StatefulWidget { + const ToolbarWidget({ + Key? key, + required this.editorState, + required this.layerLink, + required this.offset, + required this.items, + }) : super(key: key); + + final EditorState editorState; + final LayerLink layerLink; + final Offset offset; + final List items; + + @override + State createState() => _ToolbarWidgetState(); +} + +class _ToolbarWidgetState extends State with ToolbarMixin { + OverlayEntry? _listToolbarOverlay; + + @override + Widget build(BuildContext context) { + return Positioned( + top: widget.offset.dx, + left: widget.offset.dy, + child: CompositedTransformFollower( + link: widget.layerLink, + showWhenUnlinked: true, + offset: widget.offset, + child: _buildToolbar(context), + ), + ); + } + + @override + void hide() { + _listToolbarOverlay?.remove(); + _listToolbarOverlay = null; + } + + Widget _buildToolbar(BuildContext context) { + return Material( + borderRadius: BorderRadius.circular(8.0), + color: const Color(0xFF333333), + child: Padding( + padding: const EdgeInsets.only(left: 8.0, right: 8.0), + child: SizedBox( + height: 32.0, + child: Row( + crossAxisAlignment: CrossAxisAlignment.start, + children: widget.items + .map( + (item) => Center( + child: ToolbarItemWidget( + item: item, + onPressed: () { + item.handler(widget.editorState, context); + }, + ), + ), + ) + .toList(growable: false), + ), + ), + ), + ); + } +} diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/service/editor_service.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/service/editor_service.dart index d7b4f33914..2781471b46 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/service/editor_service.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/service/editor_service.dart @@ -1,3 +1,4 @@ +import 'package:appflowy_editor/src/render/image/image_node_builder.dart'; import 'package:appflowy_editor/src/render/selection_menu/selection_menu_widget.dart'; import 'package:appflowy_editor/src/service/internal_key_event_handlers/default_key_event_handlers.dart'; import 'package:flutter/material.dart'; @@ -25,6 +26,7 @@ NodeWidgetBuilders defaultBuilders = { 'text/bulleted-list': BulletedListTextNodeWidgetBuilder(), 'text/number-list': NumberListTextNodeWidgetBuilder(), 'text/quote': QuotedTextNodeWidgetBuilder(), + 'image': ImageNodeBuilder(), }; class AppFlowyEditor extends StatefulWidget { diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/service/input_service.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/service/input_service.dart index 9aae2b5fcb..96f0777544 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/service/input_service.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/service/input_service.dart @@ -1,4 +1,5 @@ import 'package:appflowy_editor/src/infra/log.dart'; +import 'package:appflowy_editor/src/render/rich_text/rich_text_style.dart'; import 'package:flutter/material.dart'; import 'package:flutter/services.dart'; @@ -87,15 +88,18 @@ class _AppFlowyInputState extends State @override void attach(TextEditingValue textEditingValue) { - _textInputConnection ??= TextInput.attach( - this, - const TextInputConfiguration( - // TODO: customize - enableDeltaModel: true, - inputType: TextInputType.multiline, - textCapitalization: TextCapitalization.sentences, - ), - ); + if (_textInputConnection == null || + _textInputConnection!.attached == false) { + _textInputConnection = TextInput.attach( + this, + const TextInputConfiguration( + // TODO: customize + enableDeltaModel: true, + inputType: TextInputType.multiline, + textCapitalization: TextCapitalization.sentences, + ), + ); + } _textInputConnection! ..setEditingState(textEditingValue) @@ -146,6 +150,9 @@ class _AppFlowyInputState extends State textNode, delta.insertionOffset, delta.textInserted, + removedAttributes: { + StyleKey.href: null, + }, ) ..commit(); } else { diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers/delete_text_handler.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers/delete_text_handler.dart index b931ee3d61..d2a3d51e64 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers/delete_text_handler.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers/delete_text_handler.dart @@ -13,9 +13,6 @@ KeyEventResult _handleBackspace(EditorState editorState, RawKeyEvent event) { selection = selection.isBackward ? selection : selection.reversed; // make sure all nodes is [TextNode]. final textNodes = nodes.whereType().toList(); - if (textNodes.length != nodes.length) { - return KeyEventResult.ignored; - } final transactionBuilder = TransactionBuilder(editorState); if (textNodes.length == 1) { @@ -37,9 +34,9 @@ KeyEventResult _handleBackspace(EditorState editorState, RawKeyEvent event) { } else { // 2. non-style // find previous text node. - while (textNode.previous != null) { - if (textNode.previous is TextNode) { - final previous = textNode.previous as TextNode; + var previous = textNode.previous; + while (previous != null) { + if (previous is TextNode) { transactionBuilder ..mergeText(previous, textNode) ..deleteNode(textNode) @@ -50,6 +47,8 @@ KeyEventResult _handleBackspace(EditorState editorState, RawKeyEvent event) { ), ); break; + } else { + previous = previous.previous; } } } diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers/update_text_style_by_command_x_handler.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers/update_text_style_by_command_x_handler.dart index 0eb926525b..00b304f527 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers/update_text_style_by_command_x_handler.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/service/internal_key_event_handlers/update_text_style_by_command_x_handler.dart @@ -36,6 +36,12 @@ AppFlowyKeyEventHandler updateTextStyleByCommandXHandler = event.isShiftPressed) { formatHighlight(editorState); return KeyEventResult.handled; + } else if (event.logicalKey == LogicalKeyboardKey.keyK) { + if (editorState.service.toolbarService + ?.triggerHandler('appflowy.toolbar.link') == + true) { + return KeyEventResult.handled; + } } return KeyEventResult.ignored; diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/service/service.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/service/service.dart index e3436ea7ee..b9b6ac390a 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/service/service.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/service/service.dart @@ -36,10 +36,10 @@ class FlowyService { // toolbar service final toolbarServiceKey = GlobalKey(debugLabel: 'flowy_toolbar_service'); - FlowyToolbarService? get toolbarService { + AppFlowyToolbarService? get toolbarService { if (toolbarServiceKey.currentState != null && - toolbarServiceKey.currentState is FlowyToolbarService) { - return toolbarServiceKey.currentState! as FlowyToolbarService; + toolbarServiceKey.currentState is AppFlowyToolbarService) { + return toolbarServiceKey.currentState! as AppFlowyToolbarService; } return null; } diff --git a/frontend/app_flowy/packages/appflowy_editor/lib/src/service/toolbar_service.dart b/frontend/app_flowy/packages/appflowy_editor/lib/src/service/toolbar_service.dart index bf380290f9..e26a186387 100644 --- a/frontend/app_flowy/packages/appflowy_editor/lib/src/service/toolbar_service.dart +++ b/frontend/app_flowy/packages/appflowy_editor/lib/src/service/toolbar_service.dart @@ -1,15 +1,19 @@ +import 'package:appflowy_editor/src/render/toolbar/toolbar_item.dart'; import 'package:flutter/material.dart'; import 'package:appflowy_editor/appflowy_editor.dart'; -import 'package:appflowy_editor/src/render/selection/toolbar_widget.dart'; +import 'package:appflowy_editor/src/render/toolbar/toolbar_widget.dart'; import 'package:appflowy_editor/src/extensions/object_extensions.dart'; -abstract class FlowyToolbarService { +abstract class AppFlowyToolbarService { /// Show the toolbar widget beside the offset. void showInOffset(Offset offset, LayerLink layerLink); /// Hide the toolbar widget. void hide(); + + /// Trigger the specified handler. + bool triggerHandler(String id); } class FlowyToolbar extends StatefulWidget { @@ -27,7 +31,7 @@ class FlowyToolbar extends StatefulWidget { } class _FlowyToolbarState extends State - implements FlowyToolbarService { + implements AppFlowyToolbarService { OverlayEntry? _toolbarOverlay; final _toolbarWidgetKey = GlobalKey(debugLabel: '_toolbar_widget'); @@ -41,7 +45,7 @@ class _FlowyToolbarState extends State editorState: widget.editorState, layerLink: layerLink, offset: offset.translate(0, -37.0), - handlers: const {}, + items: _filterItems(defaultToolbarItems), ), ); Overlay.of(context)?.insert(_toolbarOverlay!); @@ -54,6 +58,17 @@ class _FlowyToolbarState extends State _toolbarOverlay = null; } + @override + bool triggerHandler(String id) { + final items = defaultToolbarItems.where((item) => item.id == id); + if (items.length != 1) { + assert(items.length == 1, 'The toolbar item\'s id must be unique'); + return false; + } + items.first.handler(widget.editorState, context); + return true; + } + @override Widget build(BuildContext context) { return Container( @@ -67,4 +82,24 @@ class _FlowyToolbarState extends State super.dispose(); } + + // Filter items that should not be displayed, sort according to type, + // and insert dividers between different types. + List _filterItems(List items) { + final filterItems = items + .where((item) => item.validator(widget.editorState)) + .toList(growable: false) + ..sort((a, b) => a.type.compareTo(b.type)); + if (items.isEmpty) { + return []; + } + final List dividedItems = [filterItems.first]; + for (var i = 1; i < filterItems.length; i++) { + if (filterItems[i].type != filterItems[i - 1].type) { + dividedItems.add(ToolbarItem.divider()); + } + dividedItems.add(filterItems[i]); + } + return dividedItems; + } } diff --git a/frontend/app_flowy/packages/appflowy_editor/pubspec.yaml b/frontend/app_flowy/packages/appflowy_editor/pubspec.yaml index 33f443d066..9eb730f213 100644 --- a/frontend/app_flowy/packages/appflowy_editor/pubspec.yaml +++ b/frontend/app_flowy/packages/appflowy_editor/pubspec.yaml @@ -22,6 +22,7 @@ dev_dependencies: flutter_test: sdk: flutter flutter_lints: ^2.0.0 + network_image_mock: ^2.1.1 # For information on the generic Dart part of this file, see the # following page: https://dart.dev/tools/pub/pubspec @@ -32,6 +33,7 @@ flutter: assets: - assets/images/toolbar/ - assets/images/selection_menu/ + - assets/images/image_toolbar/ - assets/images/ # # For details regarding assets in packages, see diff --git a/frontend/app_flowy/packages/appflowy_editor/test/infra/test_editor.dart b/frontend/app_flowy/packages/appflowy_editor/test/infra/test_editor.dart index 8c89b603aa..a815d91875 100644 --- a/frontend/app_flowy/packages/appflowy_editor/test/infra/test_editor.dart +++ b/frontend/app_flowy/packages/appflowy_editor/test/infra/test_editor.dart @@ -57,6 +57,19 @@ class EditorWidgetTester { ); } + void insertImageNode(String src, {String? align}) { + insert( + Node( + type: 'image', + children: LinkedList(), + attributes: { + 'image_src': src, + 'align': align ?? 'center', + }, + ), + ); + } + Node? nodeAtPath(Path path) { return root.childAtPath(path); } diff --git a/frontend/app_flowy/packages/appflowy_editor/test/infra/test_raw_key_event.dart b/frontend/app_flowy/packages/appflowy_editor/test/infra/test_raw_key_event.dart index 150a3e2d00..2450c4e6db 100644 --- a/frontend/app_flowy/packages/appflowy_editor/test/infra/test_raw_key_event.dart +++ b/frontend/app_flowy/packages/appflowy_editor/test/infra/test_raw_key_event.dart @@ -115,6 +115,9 @@ extension on LogicalKeyboardKey { if (this == LogicalKeyboardKey.keyI) { return PhysicalKeyboardKey.keyI; } + if (this == LogicalKeyboardKey.keyK) { + return PhysicalKeyboardKey.keyK; + } if (this == LogicalKeyboardKey.keyS) { return PhysicalKeyboardKey.keyS; } diff --git a/frontend/app_flowy/packages/appflowy_editor/test/legacy/operation_test.dart b/frontend/app_flowy/packages/appflowy_editor/test/legacy/operation_test.dart index 1f44ebfd3c..6c20ebd134 100644 --- a/frontend/app_flowy/packages/appflowy_editor/test/legacy/operation_test.dart +++ b/frontend/app_flowy/packages/appflowy_editor/test/legacy/operation_test.dart @@ -84,7 +84,7 @@ void main() { expect(transaction.toJson(), { "operations": [ { - "type": "insert-operation", + "op": "insert", "path": [0], "nodes": [item1.toJson()], } @@ -107,7 +107,7 @@ void main() { expect(transaction.toJson(), { "operations": [ { - "type": "delete-operation", + "op": "delete", "path": [0], "nodes": [item1.toJson()], } diff --git a/frontend/app_flowy/packages/appflowy_editor/test/render/image/image_node_builder_test.dart b/frontend/app_flowy/packages/appflowy_editor/test/render/image/image_node_builder_test.dart new file mode 100644 index 0000000000..9121fa1868 --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/test/render/image/image_node_builder_test.dart @@ -0,0 +1,131 @@ +import 'package:appflowy_editor/src/render/image/image_node_widget.dart'; +import 'package:appflowy_editor/src/service/editor_service.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:network_image_mock/network_image_mock.dart'; + +import '../../infra/test_editor.dart'; + +void main() async { + setUpAll(() { + TestWidgetsFlutterBinding.ensureInitialized(); + }); + + group('image_node_builder.dart', () { + testWidgets('render image node', (tester) async { + mockNetworkImagesFor(() async { + const text = 'Welcome to Appflowy 😁'; + const src = + 'https://images.unsplash.com/photo-1471897488648-5eae4ac6686b?ixlib=rb-1.2.1&dl=sarah-dorweiler-QeVmJxZOv3k-unsplash.jpg&w=640&q=80&fm=jpg&crop=entropy&cs=tinysrgb'; + final editor = tester.editor + ..insertTextNode(text) + ..insertImageNode(src) + ..insertTextNode(text); + await editor.startTesting(); + + expect(editor.documentLength, 3); + expect(find.byType(Image), findsOneWidget); + }); + }); + + testWidgets('render image align', (tester) async { + mockNetworkImagesFor(() async { + const text = 'Welcome to Appflowy 😁'; + const src = + 'https://images.unsplash.com/photo-1471897488648-5eae4ac6686b?ixlib=rb-1.2.1&dl=sarah-dorweiler-QeVmJxZOv3k-unsplash.jpg&w=640&q=80&fm=jpg&crop=entropy&cs=tinysrgb'; + final editor = tester.editor + ..insertTextNode(text) + ..insertImageNode(src, align: 'left') + ..insertImageNode(src, align: 'center') + ..insertImageNode(src, align: 'right') + ..insertTextNode(text); + await editor.startTesting(); + + expect(editor.documentLength, 5); + final imageFinder = find.byType(Image); + expect(imageFinder, findsNWidgets(3)); + + final editorFinder = find.byType(AppFlowyEditor); + final editorRect = tester.getRect(editorFinder); + + final leftImageRect = tester.getRect(imageFinder.at(0)); + expect(leftImageRect.left, editorRect.left); + final rightImageRect = tester.getRect(imageFinder.at(2)); + expect(rightImageRect.right, editorRect.right); + final centerImageRect = tester.getRect(imageFinder.at(1)); + expect(centerImageRect.left, + (leftImageRect.left + rightImageRect.left) / 2.0); + expect(leftImageRect.size, centerImageRect.size); + expect(rightImageRect.size, centerImageRect.size); + + final imageNodeWidgetFinder = find.byType(ImageNodeWidget); + + final leftImage = + tester.firstWidget(imageNodeWidgetFinder) as ImageNodeWidget; + + leftImage.onAlign(Alignment.center); + await tester.pump(const Duration(milliseconds: 100)); + expect( + tester.getRect(imageFinder.at(0)).left, + centerImageRect.left, + ); + + leftImage.onAlign(Alignment.centerRight); + await tester.pump(const Duration(milliseconds: 100)); + expect( + tester.getRect(imageFinder.at(0)).left, + rightImageRect.left, + ); + }); + }); + + testWidgets('render image copy', (tester) async { + mockNetworkImagesFor(() async { + const text = 'Welcome to Appflowy 😁'; + const src = + 'https://images.unsplash.com/photo-1471897488648-5eae4ac6686b?ixlib=rb-1.2.1&dl=sarah-dorweiler-QeVmJxZOv3k-unsplash.jpg&w=640&q=80&fm=jpg&crop=entropy&cs=tinysrgb'; + final editor = tester.editor + ..insertTextNode(text) + ..insertImageNode(src) + ..insertTextNode(text); + await editor.startTesting(); + + expect(editor.documentLength, 3); + final imageFinder = find.byType(Image); + expect(imageFinder, findsOneWidget); + + final imageNodeWidgetFinder = find.byType(ImageNodeWidget); + final image = + tester.firstWidget(imageNodeWidgetFinder) as ImageNodeWidget; + image.onCopy(); + }); + }); + + testWidgets('render image delete', (tester) async { + mockNetworkImagesFor(() async { + const text = 'Welcome to Appflowy 😁'; + const src = + 'https://images.unsplash.com/photo-1471897488648-5eae4ac6686b?ixlib=rb-1.2.1&dl=sarah-dorweiler-QeVmJxZOv3k-unsplash.jpg&w=640&q=80&fm=jpg&crop=entropy&cs=tinysrgb'; + final editor = tester.editor + ..insertTextNode(text) + ..insertImageNode(src) + ..insertImageNode(src) + ..insertTextNode(text); + await editor.startTesting(); + + expect(editor.documentLength, 4); + final imageFinder = find.byType(Image); + expect(imageFinder, findsNWidgets(2)); + + final imageNodeWidgetFinder = find.byType(ImageNodeWidget); + final image = + tester.firstWidget(imageNodeWidgetFinder) as ImageNodeWidget; + image.onDelete(); + + await tester.pump(const Duration(milliseconds: 100)); + expect(editor.documentLength, 3); + expect(find.byType(Image), findsNWidgets(1)); + }); + }); + }); +} diff --git a/frontend/app_flowy/packages/appflowy_editor/test/render/image/image_node_widget_test.dart b/frontend/app_flowy/packages/appflowy_editor/test/render/image/image_node_widget_test.dart new file mode 100644 index 0000000000..d2f774d33f --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/test/render/image/image_node_widget_test.dart @@ -0,0 +1,81 @@ +import 'package:appflowy_editor/src/render/image/image_node_widget.dart'; +import 'package:flutter/gestures.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:network_image_mock/network_image_mock.dart'; + +void main() async { + setUpAll(() { + TestWidgetsFlutterBinding.ensureInitialized(); + }); + + group('image_node_widget.dart', () { + testWidgets('build the image node widget', (tester) async { + mockNetworkImagesFor(() async { + var onCopyHit = false; + var onDeleteHit = false; + var onAlignHit = false; + const src = + 'https://images.unsplash.com/photo-1471897488648-5eae4ac6686b?ixlib=rb-1.2.1&dl=sarah-dorweiler-QeVmJxZOv3k-unsplash.jpg&w=640&q=80&fm=jpg&crop=entropy&cs=tinysrgb'; + + final widget = ImageNodeWidget( + src: src, + alignment: Alignment.center, + onCopy: () { + onCopyHit = true; + }, + onDelete: () { + onDeleteHit = true; + }, + onAlign: (alignment) { + onAlignHit = true; + }, + onResize: (width) {}, + ); + + await tester.pumpWidget( + MaterialApp( + home: Material( + child: widget, + ), + ), + ); + expect(find.byType(ImageNodeWidget), findsOneWidget); + + final gesture = + await tester.createGesture(kind: PointerDeviceKind.mouse); + await gesture.addPointer(location: Offset.zero); + + expect(find.byType(ImageToolbar), findsNothing); + + addTearDown(gesture.removePointer); + await tester.pump(); + await gesture.moveTo(tester.getCenter(find.byType(ImageNodeWidget))); + await tester.pump(); + + expect(find.byType(ImageToolbar), findsOneWidget); + + final iconFinder = find.byType(IconButton); + expect(iconFinder, findsNWidgets(5)); + + await tester.tap(iconFinder.at(0)); + expect(onAlignHit, true); + onAlignHit = false; + + await tester.tap(iconFinder.at(1)); + expect(onAlignHit, true); + onAlignHit = false; + + await tester.tap(iconFinder.at(2)); + expect(onAlignHit, true); + onAlignHit = false; + + await tester.tap(iconFinder.at(3)); + expect(onCopyHit, true); + + await tester.tap(iconFinder.at(4)); + expect(onDeleteHit, true); + }); + }); + }); +} diff --git a/frontend/app_flowy/packages/appflowy_editor/test/render/link_menu/link_menu_test.dart b/frontend/app_flowy/packages/appflowy_editor/test/render/link_menu/link_menu_test.dart new file mode 100644 index 0000000000..7b4541033b --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/test/render/link_menu/link_menu_test.dart @@ -0,0 +1,41 @@ +import 'package:appflowy_editor/src/render/link_menu/link_menu.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; + +void main() async { + setUpAll(() { + TestWidgetsFlutterBinding.ensureInitialized(); + }); + + group('link_menu.dart', () { + testWidgets('test empty link menu actions', (tester) async { + const link = 'appflowy.io'; + var submittedText = ''; + final linkMenu = LinkMenu( + onCopyLink: () {}, + onRemoveLink: () {}, + onSubmitted: (text) { + submittedText = text; + }, + ); + await tester.pumpWidget( + MaterialApp( + home: Material( + child: linkMenu, + ), + ), + ); + + expect(find.byType(TextButton), findsNothing); + expect(find.byType(TextField), findsOneWidget); + + await tester.tap(find.byType(TextField)); + await tester.enterText(find.byType(TextField), link); + await tester.pumpAndSettle(); + await tester.testTextInput.receiveAction(TextInputAction.done); + await tester.pumpAndSettle(); + + expect(submittedText, link); + }); + }); +} diff --git a/frontend/app_flowy/packages/appflowy_editor/test/render/selection_menu/selection_menu_item_widget_test.dart b/frontend/app_flowy/packages/appflowy_editor/test/render/selection_menu/selection_menu_item_widget_test.dart index 1488b15b18..01c1403738 100644 --- a/frontend/app_flowy/packages/appflowy_editor/test/render/selection_menu/selection_menu_item_widget_test.dart +++ b/frontend/app_flowy/packages/appflowy_editor/test/render/selection_menu/selection_menu_item_widget_test.dart @@ -20,7 +20,7 @@ void main() async { name: 'example', icon: icon, keywords: ['example A', 'example B'], - handler: (editorState, menuService) { + handler: (editorState, menuService, context) { flag = true; }, ); diff --git a/frontend/app_flowy/packages/appflowy_editor/test/render/selection_menu/selection_menu_widget_test.dart b/frontend/app_flowy/packages/appflowy_editor/test/render/selection_menu/selection_menu_widget_test.dart index 1efcfa640d..2711921352 100644 --- a/frontend/app_flowy/packages/appflowy_editor/test/render/selection_menu/selection_menu_widget_test.dart +++ b/frontend/app_flowy/packages/appflowy_editor/test/render/selection_menu/selection_menu_widget_test.dart @@ -25,7 +25,9 @@ void main() async { find.byType(SelectionMenuWidget, skipOffstage: false), findsNothing, ); - await _testDefaultSelectionMenuItems(i, editor); + if (defaultSelectionMenuItems[i].name != 'Image') { + await _testDefaultSelectionMenuItems(i, editor); + } }); } }); diff --git a/frontend/app_flowy/packages/appflowy_editor/test/render/toolbar/toolbar_item_widget_test.dart b/frontend/app_flowy/packages/appflowy_editor/test/render/toolbar/toolbar_item_widget_test.dart new file mode 100644 index 0000000000..87ae922d91 --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/test/render/toolbar/toolbar_item_widget_test.dart @@ -0,0 +1,46 @@ +import 'package:appflowy_editor/src/render/toolbar/toolbar_item.dart'; +import 'package:appflowy_editor/src/render/toolbar/toolbar_item_widget.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; + +void main() async { + setUpAll(() { + TestWidgetsFlutterBinding.ensureInitialized(); + }); + + group('toolbar_item_widget.dart', () { + testWidgets('test single toolbar item widget', (tester) async { + final key = GlobalKey(); + var hit = false; + final item = ToolbarItem( + id: 'appflowy.toolbar.test', + type: 1, + icon: const Icon(Icons.abc), + validator: (editorState) => true, + handler: (editorState, context) {}, + ); + final widget = ToolbarItemWidget( + key: key, + item: item, + onPressed: (() { + hit = true; + }), + ); + + await tester.pumpWidget( + MaterialApp( + home: Material( + child: widget, + ), + ), + ); + + expect(find.byKey(key), findsOneWidget); + + await tester.tap(find.byKey(key)); + await tester.pumpAndSettle(); + + expect(hit, true); + }); + }); +} diff --git a/frontend/app_flowy/packages/appflowy_editor/test/render/toolbar/toolbar_widget_test.dart b/frontend/app_flowy/packages/appflowy_editor/test/render/toolbar/toolbar_widget_test.dart new file mode 100644 index 0000000000..d7e6b906f8 --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/test/render/toolbar/toolbar_widget_test.dart @@ -0,0 +1,11 @@ +import 'package:flutter_test/flutter_test.dart'; + +void main() async { + setUpAll(() { + TestWidgetsFlutterBinding.ensureInitialized(); + }); + + group('toolbar_widget.dart', () { + testWidgets('test toolbar widget', (tester) async {}); + }); +} diff --git a/frontend/app_flowy/packages/appflowy_editor/test/service/internal_key_event_handlers/update_text_style_by_command_x_handler_test.dart b/frontend/app_flowy/packages/appflowy_editor/test/service/internal_key_event_handlers/update_text_style_by_command_x_handler_test.dart index 2e93d4c5f5..e29308ebbc 100644 --- a/frontend/app_flowy/packages/appflowy_editor/test/service/internal_key_event_handlers/update_text_style_by_command_x_handler_test.dart +++ b/frontend/app_flowy/packages/appflowy_editor/test/service/internal_key_event_handlers/update_text_style_by_command_x_handler_test.dart @@ -1,6 +1,10 @@ import 'package:appflowy_editor/appflowy_editor.dart'; +import 'package:appflowy_editor/src/render/link_menu/link_menu.dart'; import 'package:appflowy_editor/src/render/rich_text/rich_text_style.dart'; import 'package:appflowy_editor/src/extensions/text_node_extensions.dart'; +import 'package:appflowy_editor/src/render/toolbar/toolbar_item.dart'; +import 'package:appflowy_editor/src/render/toolbar/toolbar_widget.dart'; +import 'package:flutter/material.dart'; import 'package:flutter/services.dart'; import 'package:flutter_test/flutter_test.dart'; import '../../infra/test_editor.dart'; @@ -54,6 +58,10 @@ void main() async { LogicalKeyboardKey.keyH, ); }); + + testWidgets('Presses Command + K to trigger link menu', (tester) async { + await _testLinkMenuInSingleTextSelection(tester); + }); }); } @@ -82,7 +90,14 @@ Future _testUpdateTextStyleByCommandX( ); var textNode = editor.nodeAtPath([1]) as TextNode; expect( - textNode.allSatisfyInSelection(matchStyle, matchValue, selection), true); + textNode.allSatisfyInSelection( + matchStyle, + selection, + (value) { + return value == matchValue; + }, + ), + true); selection = Selection.single(path: [1], startOffset: 0, endOffset: text.length); @@ -94,7 +109,14 @@ Future _testUpdateTextStyleByCommandX( ); textNode = editor.nodeAtPath([1]) as TextNode; expect( - textNode.allSatisfyInSelection(matchStyle, matchValue, selection), true); + textNode.allSatisfyInSelection( + matchStyle, + selection, + (value) { + return value == matchValue; + }, + ), + true); await editor.updateSelection(selection); await editor.pressLogicKey( @@ -123,9 +145,14 @@ Future _testUpdateTextStyleByCommandX( expect( node.allSatisfyInSelection( matchStyle, - matchValue, Selection.single( - path: node.path, startOffset: 0, endOffset: text.length), + path: node.path, + startOffset: 0, + endOffset: text.length, + ), + (value) { + return value == matchValue; + }, ), true, ); @@ -152,3 +179,74 @@ Future _testUpdateTextStyleByCommandX( ); } } + +Future _testLinkMenuInSingleTextSelection(WidgetTester tester) async { + const link = 'appflowy.io'; + const text = 'Welcome to Appflowy 😁'; + final editor = tester.editor + ..insertTextNode(text) + ..insertTextNode(text) + ..insertTextNode(text); + await editor.startTesting(); + + final selection = + Selection.single(path: [1], startOffset: 0, endOffset: text.length); + await editor.updateSelection(selection); + + // show toolbar + expect(find.byType(ToolbarWidget), findsOneWidget); + + final item = defaultToolbarItems + .where((item) => item.id == 'appflowy.toolbar.link') + .first; + expect(find.byWidget(item.icon), findsOneWidget); + + // trigger the link menu + await editor.pressLogicKey(LogicalKeyboardKey.keyK, isMetaPressed: true); + + expect(find.byType(LinkMenu), findsOneWidget); + + await tester.enterText(find.byType(TextField), link); + await tester.testTextInput.receiveAction(TextInputAction.done); + await tester.pumpAndSettle(); + + expect(find.byType(LinkMenu), findsNothing); + + final node = editor.nodeAtPath([1]) as TextNode; + expect( + node.allSatisfyInSelection( + StyleKey.href, + selection, + (value) => value == link, + ), + true); + + await editor.updateSelection(selection); + await editor.pressLogicKey(LogicalKeyboardKey.keyK, isMetaPressed: true); + expect(find.byType(LinkMenu), findsOneWidget); + expect( + find.text(link, findRichText: true, skipOffstage: false), findsOneWidget); + + // Copy link + final copyLink = find.text('Copy link'); + expect(copyLink, findsOneWidget); + await tester.tap(copyLink); + await tester.pumpAndSettle(); + expect(find.byType(LinkMenu), findsNothing); + + // Remove link + await editor.pressLogicKey(LogicalKeyboardKey.keyK, isMetaPressed: true); + final removeLink = find.text('Remove link'); + expect(removeLink, findsOneWidget); + await tester.tap(removeLink); + await tester.pumpAndSettle(); + expect(find.byType(LinkMenu), findsNothing); + + expect( + node.allSatisfyInSelection( + StyleKey.href, + selection, + (value) => value == link, + ), + false); +} diff --git a/frontend/app_flowy/packages/appflowy_editor/test/service/toolbar_service_test.dart b/frontend/app_flowy/packages/appflowy_editor/test/service/toolbar_service_test.dart new file mode 100644 index 0000000000..9d833095e7 --- /dev/null +++ b/frontend/app_flowy/packages/appflowy_editor/test/service/toolbar_service_test.dart @@ -0,0 +1,36 @@ +import 'package:appflowy_editor/appflowy_editor.dart'; +import 'package:appflowy_editor/src/render/toolbar/toolbar_item.dart'; +import 'package:appflowy_editor/src/render/toolbar/toolbar_widget.dart'; +import 'package:flutter_test/flutter_test.dart'; +import '../infra/test_editor.dart'; + +void main() async { + setUpAll(() { + TestWidgetsFlutterBinding.ensureInitialized(); + }); + + group('toolbar_service.dart', () { + testWidgets('Test toolbar service in multi text selection', (tester) async { + const text = 'Welcome to Appflowy 😁'; + final editor = tester.editor + ..insertTextNode(text) + ..insertTextNode(text) + ..insertTextNode(text); + await editor.startTesting(); + + final selection = Selection( + start: Position(path: [0], offset: 0), + end: Position(path: [1], offset: text.length), + ); + await editor.updateSelection(selection); + + expect(find.byType(ToolbarWidget), findsOneWidget); + + // no link item + final item = defaultToolbarItems + .where((item) => item.id == 'appflowy.toolbar.link') + .first; + expect(find.byWidget(item.icon), findsNothing); + }); + }); +} diff --git a/frontend/app_flowy/packages/flowy_infra_ui/lib/src/flowy_overlay/flowy_overlay.dart b/frontend/app_flowy/packages/flowy_infra_ui/lib/src/flowy_overlay/flowy_overlay.dart index ad04dc25c2..25507b8f6d 100644 --- a/frontend/app_flowy/packages/flowy_infra_ui/lib/src/flowy_overlay/flowy_overlay.dart +++ b/frontend/app_flowy/packages/flowy_infra_ui/lib/src/flowy_overlay/flowy_overlay.dart @@ -338,7 +338,9 @@ class FlowyOverlayState extends State { Widget build(BuildContext context) { final overlays = _overlayList.map((item) { var widget = item.widget; - item.focusNode.requestFocus(); + + // requestFocus will cause the children weird focus behaviors. + // item.focusNode.requestFocus(); if (item.delegate?.asBarrier() ?? false) { widget = Container( color: style.barrierColor, diff --git a/frontend/app_flowy/packages/flowy_infra_ui/lib/style_widget/text.dart b/frontend/app_flowy/packages/flowy_infra_ui/lib/style_widget/text.dart index 74cf7e4c31..4b285a9137 100644 --- a/frontend/app_flowy/packages/flowy_infra_ui/lib/style_widget/text.dart +++ b/frontend/app_flowy/packages/flowy_infra_ui/lib/style_widget/text.dart @@ -4,15 +4,16 @@ import 'package:provider/provider.dart'; class FlowyText extends StatelessWidget { final String title; - final TextOverflow overflow; + final TextOverflow? overflow; final double fontSize; final FontWeight fontWeight; final TextAlign? textAlign; final Color? color; + const FlowyText( this.title, { Key? key, - this.overflow = TextOverflow.ellipsis, + this.overflow = TextOverflow.clip, this.fontSize = 16, this.fontWeight = FontWeight.w400, this.textAlign, @@ -20,34 +21,33 @@ class FlowyText extends StatelessWidget { }) : super(key: key); const FlowyText.semibold(this.title, - {Key? key, this.fontSize = 16, TextOverflow? overflow, this.color, this.textAlign}) + {Key? key, this.fontSize = 16, this.overflow, this.color, this.textAlign}) : fontWeight = FontWeight.w600, - overflow = overflow ?? TextOverflow.ellipsis, super(key: key); - const FlowyText.medium(this.title, {Key? key, this.fontSize = 16, TextOverflow? overflow, this.color, this.textAlign}) + const FlowyText.medium(this.title, + {Key? key, this.fontSize = 16, this.overflow, this.color, this.textAlign}) : fontWeight = FontWeight.w500, - overflow = overflow ?? TextOverflow.ellipsis, super(key: key); const FlowyText.regular(this.title, - {Key? key, this.fontSize = 16, TextOverflow? overflow, this.color, this.textAlign}) + {Key? key, this.fontSize = 16, this.overflow, this.color, this.textAlign}) : fontWeight = FontWeight.w400, - overflow = overflow ?? TextOverflow.ellipsis, super(key: key); @override Widget build(BuildContext context) { final theme = context.watch(); - return Text(title, - overflow: overflow, - softWrap: false, - textAlign: textAlign, - style: TextStyle( - color: color ?? theme.textColor, - fontWeight: fontWeight, - fontSize: fontSize, - fontFamily: 'Mulish', - )); + return Text( + title, + textAlign: textAlign, + overflow: overflow ?? TextOverflow.clip, + style: TextStyle( + color: color ?? theme.textColor, + fontWeight: fontWeight, + fontSize: fontSize, + fontFamily: 'Mulish', + ), + ); } } diff --git a/frontend/app_flowy/pubspec.lock b/frontend/app_flowy/pubspec.lock index 5bb7e7344f..cdfd764668 100644 --- a/frontend/app_flowy/pubspec.lock +++ b/frontend/app_flowy/pubspec.lock @@ -28,7 +28,7 @@ packages: path: "packages/appflowy_board" relative: true source: path - version: "0.0.4" + version: "0.0.5" appflowy_editor: dependency: "direct main" description: diff --git a/frontend/rust-lib/Cargo.lock b/frontend/rust-lib/Cargo.lock index 7534492ab0..4119cc1edf 100644 --- a/frontend/rust-lib/Cargo.lock +++ b/frontend/rust-lib/Cargo.lock @@ -1618,6 +1618,12 @@ dependencies = [ "serde", ] +[[package]] +name = "indextree" +version = "4.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42b4b46b3311ebd8e5cd44f6b03b36e0f48a70552cf6b036afcebc5626794066" + [[package]] name = "instant" version = "0.1.12" @@ -1766,6 +1772,7 @@ dependencies = [ "bytes", "dashmap", "derive_more", + "indextree", "lazy_static", "log", "md5", diff --git a/frontend/rust-lib/flowy-error/src/errors.rs b/frontend/rust-lib/flowy-error/src/errors.rs index e19ebb15b2..bc453054aa 100644 --- a/frontend/rust-lib/flowy-error/src/errors.rs +++ b/frontend/rust-lib/flowy-error/src/errors.rs @@ -66,6 +66,7 @@ impl FlowyError { static_flowy_error!(user_not_exist, ErrorCode::UserNotExist); static_flowy_error!(text_too_long, ErrorCode::TextTooLong); static_flowy_error!(invalid_data, ErrorCode::InvalidData); + static_flowy_error!(out_of_bounds, ErrorCode::OutOfBounds); } impl std::convert::From for FlowyError { diff --git a/frontend/rust-lib/flowy-grid/src/dart_notification.rs b/frontend/rust-lib/flowy-grid/src/dart_notification.rs index 0bba5bbc11..a0030c6773 100644 --- a/frontend/rust-lib/flowy-grid/src/dart_notification.rs +++ b/frontend/rust-lib/flowy-grid/src/dart_notification.rs @@ -11,7 +11,8 @@ pub enum GridNotification { DidUpdateRow = 30, DidUpdateCell = 40, DidUpdateField = 50, - DidUpdateGroup = 60, + DidUpdateGroupView = 60, + DidUpdateGroup = 61, } impl std::default::Default for GridNotification { diff --git a/frontend/rust-lib/flowy-grid/src/entities/block_entities.rs b/frontend/rust-lib/flowy-grid/src/entities/block_entities.rs index bb7eec9032..e691ed1830 100644 --- a/frontend/rust-lib/flowy-grid/src/entities/block_entities.rs +++ b/frontend/rust-lib/flowy-grid/src/entities/block_entities.rs @@ -30,7 +30,7 @@ impl BlockPB { } /// [RowPB] Describes a row. Has the id of the parent Block. Has the metadata of the row. -#[derive(Debug, Default, Clone, ProtoBuf)] +#[derive(Debug, Default, Clone, ProtoBuf, Eq, PartialEq)] pub struct RowPB { #[pb(index = 1)] pub block_id: String, diff --git a/frontend/rust-lib/flowy-grid/src/entities/field_entities.rs b/frontend/rust-lib/flowy-grid/src/entities/field_entities.rs index 8875b3fc26..271cbcf424 100644 --- a/frontend/rust-lib/flowy-grid/src/entities/field_entities.rs +++ b/frontend/rust-lib/flowy-grid/src/entities/field_entities.rs @@ -2,7 +2,6 @@ use flowy_derive::{ProtoBuf, ProtoBuf_Enum}; use flowy_error::ErrorCode; use flowy_grid_data_model::parser::NotEmptyStr; use flowy_grid_data_model::revision::{FieldRevision, FieldTypeRevision}; -use flowy_sync::entities::grid::FieldChangesetParams; use serde_repr::*; use std::sync::Arc; @@ -491,6 +490,27 @@ impl TryInto for FieldChangesetPayloadPB { } } +#[derive(Debug, Clone, Default)] +pub struct FieldChangesetParams { + pub field_id: String, + + pub grid_id: String, + + pub name: Option, + + pub desc: Option, + + pub field_type: Option, + + pub frozen: Option, + + pub visibility: Option, + + pub width: Option, + + pub type_option_data: Option>, +} + #[derive( Debug, Clone, diff --git a/frontend/rust-lib/flowy-grid/src/entities/filter_entities/util.rs b/frontend/rust-lib/flowy-grid/src/entities/filter_entities/util.rs index 079b6fd6dc..7dff00bf56 100644 --- a/frontend/rust-lib/flowy-grid/src/entities/filter_entities/util.rs +++ b/frontend/rust-lib/flowy-grid/src/entities/filter_entities/util.rs @@ -5,8 +5,7 @@ use crate::entities::{ use flowy_derive::ProtoBuf; use flowy_error::ErrorCode; use flowy_grid_data_model::parser::NotEmptyStr; -use flowy_grid_data_model::revision::{FieldRevision, FilterConfigurationRevision}; -use flowy_sync::entities::grid::{CreateGridFilterParams, DeleteFilterParams}; +use flowy_grid_data_model::revision::{FieldRevision, FieldTypeRevision, FilterConfigurationRevision}; use std::convert::TryInto; use std::sync::Arc; @@ -72,6 +71,12 @@ impl TryInto for DeleteFilterPayloadPB { } } +pub struct DeleteFilterParams { + pub field_id: String, + pub filter_id: String, + pub field_type_rev: FieldTypeRevision, +} + #[derive(ProtoBuf, Debug, Default, Clone)] pub struct CreateGridFilterPayloadPB { #[pb(index = 1)] @@ -99,10 +104,10 @@ impl CreateGridFilterPayloadPB { } } -impl TryInto for CreateGridFilterPayloadPB { +impl TryInto for CreateGridFilterPayloadPB { type Error = ErrorCode; - fn try_into(self) -> Result { + fn try_into(self) -> Result { let field_id = NotEmptyStr::parse(self.field_id) .map_err(|_| ErrorCode::FieldIdIsEmpty)? .0; @@ -125,7 +130,7 @@ impl TryInto for CreateGridFilterPayloadPB { } } - Ok(CreateGridFilterParams { + Ok(CreateFilterParams { field_id, field_type_rev: self.field_type.into(), condition, @@ -133,3 +138,10 @@ impl TryInto for CreateGridFilterPayloadPB { }) } } + +pub struct CreateFilterParams { + pub field_id: String, + pub field_type_rev: FieldTypeRevision, + pub condition: u8, + pub content: Option, +} diff --git a/frontend/rust-lib/flowy-grid/src/entities/grid_entities.rs b/frontend/rust-lib/flowy-grid/src/entities/grid_entities.rs index be8cfdeae1..c012376f55 100644 --- a/frontend/rust-lib/flowy-grid/src/entities/grid_entities.rs +++ b/frontend/rust-lib/flowy-grid/src/entities/grid_entities.rs @@ -123,3 +123,46 @@ impl TryInto for MoveRowPayloadPB { }) } } +#[derive(Debug, Clone, Default, ProtoBuf)] +pub struct MoveGroupRowPayloadPB { + #[pb(index = 1)] + pub view_id: String, + + #[pb(index = 2)] + pub from_row_id: String, + + #[pb(index = 3)] + pub to_group_id: String, + + #[pb(index = 4, one_of)] + pub to_row_id: Option, +} + +pub struct MoveGroupRowParams { + pub view_id: String, + pub from_row_id: String, + pub to_group_id: String, + pub to_row_id: Option, +} + +impl TryInto for MoveGroupRowPayloadPB { + type Error = ErrorCode; + + fn try_into(self) -> Result { + let view_id = NotEmptyStr::parse(self.view_id).map_err(|_| ErrorCode::GridViewIdIsEmpty)?; + let from_row_id = NotEmptyStr::parse(self.from_row_id).map_err(|_| ErrorCode::RowIdIsEmpty)?; + let to_group_id = NotEmptyStr::parse(self.to_group_id).map_err(|_| ErrorCode::GroupIdIsEmpty)?; + + let to_row_id = match self.to_row_id { + None => None, + Some(to_row_id) => Some(NotEmptyStr::parse(to_row_id).map_err(|_| ErrorCode::RowIdIsEmpty)?.0), + }; + + Ok(MoveGroupRowParams { + view_id: view_id.0, + from_row_id: from_row_id.0, + to_group_id: to_group_id.0, + to_row_id, + }) + } +} diff --git a/frontend/rust-lib/flowy-grid/src/entities/group_entities/board_card.rs b/frontend/rust-lib/flowy-grid/src/entities/group_entities/board_card.rs deleted file mode 100644 index 1ba3991f96..0000000000 --- a/frontend/rust-lib/flowy-grid/src/entities/group_entities/board_card.rs +++ /dev/null @@ -1,28 +0,0 @@ -use crate::entities::{CreateRowParams, GridLayout}; -use flowy_derive::ProtoBuf; -use flowy_error::ErrorCode; -use flowy_grid_data_model::parser::NotEmptyStr; - -#[derive(ProtoBuf, Debug, Default, Clone)] -pub struct CreateBoardCardPayloadPB { - #[pb(index = 1)] - pub grid_id: String, - - #[pb(index = 2)] - pub group_id: String, -} - -impl TryInto for CreateBoardCardPayloadPB { - type Error = ErrorCode; - - fn try_into(self) -> Result { - let grid_id = NotEmptyStr::parse(self.grid_id).map_err(|_| ErrorCode::GridIdIsEmpty)?; - let group_id = NotEmptyStr::parse(self.group_id).map_err(|_| ErrorCode::GroupIdIsEmpty)?; - Ok(CreateRowParams { - grid_id: grid_id.0, - start_row_id: None, - group_id: Some(group_id.0), - layout: GridLayout::Board, - }) - } -} diff --git a/frontend/rust-lib/flowy-grid/src/entities/group_entities/configuration.rs b/frontend/rust-lib/flowy-grid/src/entities/group_entities/configuration.rs index baa39d91a2..19f5b27a9b 100644 --- a/frontend/rust-lib/flowy-grid/src/entities/group_entities/configuration.rs +++ b/frontend/rust-lib/flowy-grid/src/entities/group_entities/configuration.rs @@ -1,4 +1,5 @@ use flowy_derive::{ProtoBuf, ProtoBuf_Enum}; +use flowy_grid_data_model::revision::{GroupRevision, SelectOptionGroupConfigurationRevision}; #[derive(Eq, PartialEq, ProtoBuf, Debug, Default, Clone)] pub struct UrlGroupConfigurationPB { @@ -18,6 +19,32 @@ pub struct SelectOptionGroupConfigurationPB { hide_empty: bool, } +impl std::convert::From for SelectOptionGroupConfigurationPB { + fn from(rev: SelectOptionGroupConfigurationRevision) -> Self { + Self { + hide_empty: rev.hide_empty, + } + } +} + +#[derive(Eq, PartialEq, ProtoBuf, Debug, Default, Clone)] +pub struct GroupRecordPB { + #[pb(index = 1)] + group_id: String, + + #[pb(index = 2)] + visible: bool, +} + +impl std::convert::From for GroupRecordPB { + fn from(rev: GroupRevision) -> Self { + Self { + group_id: rev.id, + visible: rev.visible, + } + } +} + #[derive(Eq, PartialEq, ProtoBuf, Debug, Default, Clone)] pub struct NumberGroupConfigurationPB { #[pb(index = 1)] diff --git a/frontend/rust-lib/flowy-grid/src/entities/group_entities/group.rs b/frontend/rust-lib/flowy-grid/src/entities/group_entities/group.rs index 32f7c4543a..9cc138bc0f 100644 --- a/frontend/rust-lib/flowy-grid/src/entities/group_entities/group.rs +++ b/frontend/rust-lib/flowy-grid/src/entities/group_entities/group.rs @@ -1,12 +1,36 @@ -use crate::entities::{FieldType, RowPB}; +use crate::entities::{CreateRowParams, FieldType, GridLayout, RowPB}; +use crate::services::group::Group; use flowy_derive::ProtoBuf; use flowy_error::ErrorCode; use flowy_grid_data_model::parser::NotEmptyStr; -use flowy_grid_data_model::revision::GroupConfigurationRevision; -use flowy_sync::entities::grid::{CreateGridGroupParams, DeleteGroupParams}; +use flowy_grid_data_model::revision::{FieldTypeRevision, GroupConfigurationRevision}; use std::convert::TryInto; use std::sync::Arc; +#[derive(ProtoBuf, Debug, Default, Clone)] +pub struct CreateBoardCardPayloadPB { + #[pb(index = 1)] + pub grid_id: String, + + #[pb(index = 2)] + pub group_id: String, +} + +impl TryInto for CreateBoardCardPayloadPB { + type Error = ErrorCode; + + fn try_into(self) -> Result { + let grid_id = NotEmptyStr::parse(self.grid_id).map_err(|_| ErrorCode::GridIdIsEmpty)?; + let group_id = NotEmptyStr::parse(self.group_id).map_err(|_| ErrorCode::GroupIdIsEmpty)?; + Ok(CreateRowParams { + grid_id: grid_id.0, + start_row_id: None, + group_id: Some(group_id.0), + layout: GridLayout::Board, + }) + } +} + #[derive(Eq, PartialEq, ProtoBuf, Debug, Default, Clone)] pub struct GridGroupConfigurationPB { #[pb(index = 1)] @@ -59,6 +83,17 @@ pub struct GroupPB { pub rows: Vec, } +impl std::convert::From for GroupPB { + fn from(group: Group) -> Self { + Self { + field_id: group.field_id, + group_id: group.id, + desc: group.name, + rows: group.rows, + } + } +} + #[derive(Eq, PartialEq, ProtoBuf, Debug, Default, Clone)] pub struct RepeatedGridGroupConfigurationPB { #[pb(index = 1)] @@ -86,27 +121,28 @@ pub struct CreateGridGroupPayloadPB { #[pb(index = 2)] pub field_type: FieldType, - - #[pb(index = 3, one_of)] - pub content: Option>, } -impl TryInto for CreateGridGroupPayloadPB { +impl TryInto for CreateGridGroupPayloadPB { type Error = ErrorCode; - fn try_into(self) -> Result { + fn try_into(self) -> Result { let field_id = NotEmptyStr::parse(self.field_id) .map_err(|_| ErrorCode::FieldIdIsEmpty)? .0; - Ok(CreateGridGroupParams { + Ok(CreatGroupParams { field_id, field_type_rev: self.field_type.into(), - content: self.content, }) } } +pub struct CreatGroupParams { + pub field_id: String, + pub field_type_rev: FieldTypeRevision, +} + #[derive(ProtoBuf, Debug, Default, Clone)] pub struct DeleteGroupPayloadPB { #[pb(index = 1)] @@ -137,3 +173,9 @@ impl TryInto for DeleteGroupPayloadPB { }) } } + +pub struct DeleteGroupParams { + pub field_id: String, + pub group_id: String, + pub field_type_rev: FieldTypeRevision, +} diff --git a/frontend/rust-lib/flowy-grid/src/entities/group_entities/group_changeset.rs b/frontend/rust-lib/flowy-grid/src/entities/group_entities/group_changeset.rs index 743da70444..21f39775f6 100644 --- a/frontend/rust-lib/flowy-grid/src/entities/group_entities/group_changeset.rs +++ b/frontend/rust-lib/flowy-grid/src/entities/group_entities/group_changeset.rs @@ -1,23 +1,28 @@ -use crate::entities::{InsertedRowPB, RowPB}; +use crate::entities::{GroupPB, InsertedRowPB, RowPB}; use flowy_derive::ProtoBuf; +use flowy_error::ErrorCode; +use flowy_grid_data_model::parser::NotEmptyStr; use std::fmt::Formatter; #[derive(Debug, Default, ProtoBuf)] -pub struct GroupRowsChangesetPB { +pub struct GroupChangesetPB { #[pb(index = 1)] pub group_id: String, - #[pb(index = 2)] - pub inserted_rows: Vec, + #[pb(index = 2, one_of)] + pub group_name: Option, #[pb(index = 3)] - pub deleted_rows: Vec, + pub inserted_rows: Vec, #[pb(index = 4)] + pub deleted_rows: Vec, + + #[pb(index = 5)] pub updated_rows: Vec, } -impl std::fmt::Display for GroupRowsChangesetPB { +impl std::fmt::Display for GroupChangesetPB { fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { for inserted_row in &self.inserted_rows { let _ = f.write_fmt(format_args!( @@ -34,10 +39,29 @@ impl std::fmt::Display for GroupRowsChangesetPB { } } -impl GroupRowsChangesetPB { +impl GroupChangesetPB { pub fn is_empty(&self) -> bool { - self.inserted_rows.is_empty() && self.deleted_rows.is_empty() && self.updated_rows.is_empty() + self.group_name.is_none() + && self.inserted_rows.is_empty() + && self.deleted_rows.is_empty() + && self.updated_rows.is_empty() } + + pub fn new(group_id: String) -> Self { + Self { + group_id, + ..Default::default() + } + } + + pub fn name(group_id: String, name: &str) -> Self { + Self { + group_id, + group_name: Some(name.to_owned()), + ..Default::default() + } + } + pub fn insert(group_id: String, inserted_rows: Vec) -> Self { Self { group_id, @@ -62,3 +86,71 @@ impl GroupRowsChangesetPB { } } } +#[derive(Debug, Default, ProtoBuf)] +pub struct MoveGroupPayloadPB { + #[pb(index = 1)] + pub view_id: String, + + #[pb(index = 2)] + pub from_group_id: String, + + #[pb(index = 3)] + pub to_group_id: String, +} + +pub struct MoveGroupParams { + pub view_id: String, + pub from_group_id: String, + pub to_group_id: String, +} + +impl TryInto for MoveGroupPayloadPB { + type Error = ErrorCode; + + fn try_into(self) -> Result { + let view_id = NotEmptyStr::parse(self.view_id) + .map_err(|_| ErrorCode::GridViewIdIsEmpty)? + .0; + let from_group_id = NotEmptyStr::parse(self.from_group_id) + .map_err(|_| ErrorCode::GroupIdIsEmpty)? + .0; + let to_group_id = NotEmptyStr::parse(self.to_group_id) + .map_err(|_| ErrorCode::GroupIdIsEmpty)? + .0; + Ok(MoveGroupParams { + view_id, + from_group_id, + to_group_id, + }) + } +} + +#[derive(Debug, Default, ProtoBuf)] +pub struct GroupViewChangesetPB { + #[pb(index = 1)] + pub view_id: String, + + #[pb(index = 2)] + pub inserted_groups: Vec, + + #[pb(index = 3)] + pub deleted_groups: Vec, + + #[pb(index = 4)] + pub update_groups: Vec, +} + +impl GroupViewChangesetPB { + pub fn is_empty(&self) -> bool { + self.inserted_groups.is_empty() && self.deleted_groups.is_empty() && self.update_groups.is_empty() + } +} + +#[derive(Debug, Default, ProtoBuf)] +pub struct InsertedGroupPB { + #[pb(index = 1)] + pub group: GroupPB, + + #[pb(index = 2)] + pub index: i32, +} diff --git a/frontend/rust-lib/flowy-grid/src/entities/group_entities/mod.rs b/frontend/rust-lib/flowy-grid/src/entities/group_entities/mod.rs index f5daa803bc..778eff4cc9 100644 --- a/frontend/rust-lib/flowy-grid/src/entities/group_entities/mod.rs +++ b/frontend/rust-lib/flowy-grid/src/entities/group_entities/mod.rs @@ -1,9 +1,7 @@ -mod board_card; mod configuration; mod group; mod group_changeset; -pub use board_card::*; pub use configuration::*; pub use group::*; pub use group_changeset::*; diff --git a/frontend/rust-lib/flowy-grid/src/entities/mod.rs b/frontend/rust-lib/flowy-grid/src/entities/mod.rs index 96c7a9ba60..eb11d982a4 100644 --- a/frontend/rust-lib/flowy-grid/src/entities/mod.rs +++ b/frontend/rust-lib/flowy-grid/src/entities/mod.rs @@ -6,7 +6,6 @@ mod grid_entities; mod group_entities; mod row_entities; mod setting_entities; -mod sort_entities; pub use block_entities::*; pub use cell_entities::*; @@ -16,4 +15,3 @@ pub use grid_entities::*; pub use group_entities::*; pub use row_entities::*; pub use setting_entities::*; -pub use sort_entities::*; diff --git a/frontend/rust-lib/flowy-grid/src/entities/setting_entities.rs b/frontend/rust-lib/flowy-grid/src/entities/setting_entities.rs index 89f66dd433..9c02a2c692 100644 --- a/frontend/rust-lib/flowy-grid/src/entities/setting_entities.rs +++ b/frontend/rust-lib/flowy-grid/src/entities/setting_entities.rs @@ -1,12 +1,12 @@ use crate::entities::{ - CreateGridFilterPayloadPB, CreateGridGroupPayloadPB, CreateGridSortPayloadPB, DeleteFilterPayloadPB, - DeleteGroupPayloadPB, RepeatedGridConfigurationFilterPB, RepeatedGridGroupConfigurationPB, RepeatedGridSortPB, + CreatGroupParams, CreateFilterParams, CreateGridFilterPayloadPB, CreateGridGroupPayloadPB, DeleteFilterParams, + DeleteFilterPayloadPB, DeleteGroupParams, DeleteGroupPayloadPB, RepeatedGridConfigurationFilterPB, + RepeatedGridGroupConfigurationPB, }; use flowy_derive::{ProtoBuf, ProtoBuf_Enum}; use flowy_error::ErrorCode; use flowy_grid_data_model::parser::NotEmptyStr; use flowy_grid_data_model::revision::LayoutRevision; -use flowy_sync::entities::grid::GridSettingChangesetParams; use std::collections::HashMap; use std::convert::TryInto; use strum::IntoEnumIterator; @@ -26,9 +26,6 @@ pub struct GridSettingPB { #[pb(index = 4)] pub group_configuration_by_field_id: HashMap, - - #[pb(index = 5)] - pub sorts_by_field_id: HashMap, } #[derive(Eq, PartialEq, ProtoBuf, Debug, Default, Clone)] @@ -98,12 +95,6 @@ pub struct GridSettingChangesetPayloadPB { #[pb(index = 6, one_of)] pub delete_group: Option, - - #[pb(index = 7, one_of)] - pub insert_sort: Option, - - #[pb(index = 8, one_of)] - pub delete_sort: Option, } impl TryInto for GridSettingChangesetPayloadPB { @@ -134,16 +125,6 @@ impl TryInto for GridSettingChangesetPayloadPB { None => None, }; - let insert_sort = match self.insert_sort { - None => None, - Some(payload) => Some(payload.try_into()?), - }; - - let delete_sort = match self.delete_sort { - None => None, - Some(filter_id) => Some(NotEmptyStr::parse(filter_id).map_err(|_| ErrorCode::FieldIdIsEmpty)?.0), - }; - Ok(GridSettingChangesetParams { grid_id: view_id, layout_type: self.layout_type.into(), @@ -151,8 +132,21 @@ impl TryInto for GridSettingChangesetPayloadPB { delete_filter, insert_group, delete_group, - insert_sort, - delete_sort, }) } } + +pub struct GridSettingChangesetParams { + pub grid_id: String, + pub layout_type: LayoutRevision, + pub insert_filter: Option, + pub delete_filter: Option, + pub insert_group: Option, + pub delete_group: Option, +} + +impl GridSettingChangesetParams { + pub fn is_filter_changed(&self) -> bool { + self.insert_filter.is_some() || self.delete_filter.is_some() + } +} diff --git a/frontend/rust-lib/flowy-grid/src/entities/sort_entities.rs b/frontend/rust-lib/flowy-grid/src/entities/sort_entities.rs deleted file mode 100644 index f844b75066..0000000000 --- a/frontend/rust-lib/flowy-grid/src/entities/sort_entities.rs +++ /dev/null @@ -1,65 +0,0 @@ -use flowy_derive::ProtoBuf; -use flowy_error::ErrorCode; -use flowy_grid_data_model::parser::NotEmptyStr; -use flowy_grid_data_model::revision::SortConfigurationRevision; -use flowy_sync::entities::grid::CreateGridSortParams; -use std::convert::TryInto; -use std::sync::Arc; - -#[derive(Eq, PartialEq, ProtoBuf, Debug, Default, Clone)] -pub struct GridSort { - #[pb(index = 1)] - pub id: String, - - #[pb(index = 2, one_of)] - pub field_id: Option, -} - -impl std::convert::From<&SortConfigurationRevision> for GridSort { - fn from(rev: &SortConfigurationRevision) -> Self { - GridSort { - id: rev.id.clone(), - - field_id: rev.field_id.clone(), - } - } -} - -#[derive(Eq, PartialEq, ProtoBuf, Debug, Default, Clone)] -pub struct RepeatedGridSortPB { - #[pb(index = 1)] - pub items: Vec, -} - -impl std::convert::From>> for RepeatedGridSortPB { - fn from(revs: Vec>) -> Self { - RepeatedGridSortPB { - items: revs.into_iter().map(|rev| rev.as_ref().into()).collect(), - } - } -} - -impl std::convert::From> for RepeatedGridSortPB { - fn from(items: Vec) -> Self { - Self { items } - } -} - -#[derive(ProtoBuf, Debug, Default, Clone)] -pub struct CreateGridSortPayloadPB { - #[pb(index = 1, one_of)] - pub field_id: Option, -} - -impl TryInto for CreateGridSortPayloadPB { - type Error = ErrorCode; - - fn try_into(self) -> Result { - let field_id = match self.field_id { - None => None, - Some(field_id) => Some(NotEmptyStr::parse(field_id).map_err(|_| ErrorCode::FieldIdIsEmpty)?.0), - }; - - Ok(CreateGridSortParams { field_id }) - } -} diff --git a/frontend/rust-lib/flowy-grid/src/event_handler.rs b/frontend/rust-lib/flowy-grid/src/event_handler.rs index 3108acd977..4b525c233f 100644 --- a/frontend/rust-lib/flowy-grid/src/event_handler.rs +++ b/frontend/rust-lib/flowy-grid/src/event_handler.rs @@ -10,7 +10,6 @@ use crate::services::field::{ use crate::services::row::make_row_from_row_rev; use flowy_error::{ErrorCode, FlowyError, FlowyResult}; use flowy_grid_data_model::revision::FieldRevision; -use flowy_sync::entities::grid::{FieldChangesetParams, GridSettingChangesetParams}; use lib_dispatch::prelude::{data_result, AppData, Data, DataResult}; use std::sync::Arc; @@ -36,17 +35,6 @@ pub(crate) async fn get_grid_setting_handler( data_result(grid_setting) } -#[tracing::instrument(level = "trace", skip(data, manager), err)] -pub(crate) async fn update_grid_setting_handler( - data: Data, - manager: AppData>, -) -> Result<(), FlowyError> { - let params: GridSettingChangesetParams = data.into_inner().try_into()?; - let editor = manager.open_grid(¶ms.grid_id).await?; - let _ = editor.update_grid_setting(params).await?; - Ok(()) -} - #[tracing::instrument(level = "debug", skip(data, manager), err)] pub(crate) async fn get_grid_blocks_handler( data: Data, @@ -281,7 +269,7 @@ pub(crate) async fn create_table_row_handler( data_result(row) } -// #[tracing::instrument(level = "debug", skip_all, err)] +#[tracing::instrument(level = "trace", skip_all, err)] pub(crate) async fn get_cell_handler( data: Data, manager: AppData>, @@ -437,3 +425,25 @@ pub(crate) async fn create_board_card_handler( let row = editor.create_row(params).await?; data_result(row) } + +#[tracing::instrument(level = "debug", skip(data, manager), err)] +pub(crate) async fn move_group_handler( + data: Data, + manager: AppData>, +) -> FlowyResult<()> { + let params: MoveGroupParams = data.into_inner().try_into()?; + let editor = manager.get_grid_editor(params.view_id.as_ref())?; + let _ = editor.move_group(params).await?; + Ok(()) +} + +#[tracing::instrument(level = "debug", skip(data, manager), err)] +pub(crate) async fn move_group_row_handler( + data: Data, + manager: AppData>, +) -> FlowyResult<()> { + let params: MoveGroupRowParams = data.into_inner().try_into()?; + let editor = manager.get_grid_editor(params.view_id.as_ref())?; + let _ = editor.move_group_row(params).await?; + Ok(()) +} diff --git a/frontend/rust-lib/flowy-grid/src/event_map.rs b/frontend/rust-lib/flowy-grid/src/event_map.rs index 55ef3ff4db..a78bcb5ed3 100644 --- a/frontend/rust-lib/flowy-grid/src/event_map.rs +++ b/frontend/rust-lib/flowy-grid/src/event_map.rs @@ -11,7 +11,7 @@ pub fn create(grid_manager: Arc) -> Module { .event(GridEvent::GetGrid, get_grid_handler) .event(GridEvent::GetGridBlocks, get_grid_blocks_handler) .event(GridEvent::GetGridSetting, get_grid_setting_handler) - .event(GridEvent::UpdateGridSetting, update_grid_setting_handler) + // .event(GridEvent::UpdateGridSetting, update_grid_setting_handler) // Field .event(GridEvent::GetFields, get_fields_handler) .event(GridEvent::UpdateField, update_field_handler) @@ -41,6 +41,8 @@ pub fn create(grid_manager: Arc) -> Module { .event(GridEvent::UpdateDateCell, update_date_cell_handler) // Group .event(GridEvent::CreateBoardCard, create_board_card_handler) + .event(GridEvent::MoveGroup, move_group_handler) + .event(GridEvent::MoveGroupRow, move_group_row_handler) .event(GridEvent::GetGroup, get_groups_handler); module @@ -217,4 +219,10 @@ pub enum GridEvent { #[event(input = "CreateBoardCardPayloadPB", output = "RowPB")] CreateBoardCard = 110, + + #[event(input = "MoveGroupPayloadPB")] + MoveGroup = 111, + + #[event(input = "MoveGroupRowPayloadPB")] + MoveGroupRow = 112, } diff --git a/frontend/rust-lib/flowy-grid/src/manager.rs b/frontend/rust-lib/flowy-grid/src/manager.rs index 9e4556b793..12b94ff8db 100644 --- a/frontend/rust-lib/flowy-grid/src/manager.rs +++ b/frontend/rust-lib/flowy-grid/src/manager.rs @@ -131,7 +131,6 @@ impl GridManager { async fn get_or_create_grid_editor(&self, grid_id: &str) -> FlowyResult> { match self.grid_editors.get(grid_id) { None => { - tracing::trace!("Create grid editor with id: {}", grid_id); let db_pool = self.grid_user.db_pool()?; let editor = self.make_grid_rev_editor(grid_id, db_pool).await?; diff --git a/frontend/rust-lib/flowy-grid/src/services/field/type_options/selection_type_option/select_option.rs b/frontend/rust-lib/flowy-grid/src/services/field/type_options/selection_type_option/select_option.rs index 13da2e8359..9270f73684 100644 --- a/frontend/rust-lib/flowy-grid/src/services/field/type_options/selection_type_option/select_option.rs +++ b/frontend/rust-lib/flowy-grid/src/services/field/type_options/selection_type_option/select_option.rs @@ -157,6 +157,9 @@ pub fn select_option_color_from_index(index: usize) -> SelectOptionColorPB { pub struct SelectOptionIds(Vec); impl SelectOptionIds { + pub fn new() -> Self { + Self(vec![]) + } pub fn into_inner(self) -> Vec { self.0 } @@ -181,6 +184,12 @@ impl std::convert::From for SelectOptionIds { } } +impl ToString for SelectOptionIds { + fn to_string(&self) -> String { + self.0.join(SELECTION_IDS_SEPARATOR) + } +} + impl std::convert::From> for SelectOptionIds { fn from(s: Option) -> Self { match s { diff --git a/frontend/rust-lib/flowy-grid/src/services/filter/filter_service.rs b/frontend/rust-lib/flowy-grid/src/services/filter/filter_service.rs index a2831c0ad9..8335a36fb2 100644 --- a/frontend/rust-lib/flowy-grid/src/services/filter/filter_service.rs +++ b/frontend/rust-lib/flowy-grid/src/services/filter/filter_service.rs @@ -4,7 +4,7 @@ #![allow(unused_imports)] #![allow(unused_results)] use crate::dart_notification::{send_dart_notification, GridNotification}; -use crate::entities::{FieldType, GridBlockChangesetPB}; +use crate::entities::{FieldType, GridBlockChangesetPB, GridSettingChangesetParams}; use crate::services::block_manager::GridBlockManager; use crate::services::cell::{AnyCellData, CellFilterOperation}; use crate::services::field::{ @@ -20,7 +20,6 @@ use crate::services::tasks::{FilterTaskContext, Task, TaskContent}; use flowy_error::FlowyResult; use flowy_grid_data_model::revision::{CellRevision, FieldId, FieldRevision, RowRevision}; use flowy_sync::client_grid::GridRevisionPad; -use flowy_sync::entities::grid::GridSettingChangesetParams; use rayon::prelude::*; use std::collections::HashMap; use std::sync::Arc; diff --git a/frontend/rust-lib/flowy-grid/src/services/grid_editor.rs b/frontend/rust-lib/flowy-grid/src/services/grid_editor.rs index 92cf9da550..cdc6cf6e6b 100644 --- a/frontend/rust-lib/flowy-grid/src/services/grid_editor.rs +++ b/frontend/rust-lib/flowy-grid/src/services/grid_editor.rs @@ -15,7 +15,6 @@ use flowy_error::{ErrorCode, FlowyError, FlowyResult}; use flowy_grid_data_model::revision::*; use flowy_revision::{RevisionCloudService, RevisionCompactor, RevisionManager, RevisionObjectBuilder}; use flowy_sync::client_grid::{GridRevisionChangeset, GridRevisionPad, JsonDeserializer}; -use flowy_sync::entities::grid::{FieldChangesetParams, GridSettingChangesetParams}; use flowy_sync::entities::revision::Revision; use flowy_sync::errors::CollaborateResult; use flowy_sync::util::make_text_delta_from_revisions; @@ -96,23 +95,19 @@ impl GridRevisionEditor { } = params; let field_id = field.id.clone(); if self.contain_field(&field_id).await { - let _ = self - .modify(|grid| { - let deserializer = TypeOptionJsonDeserializer(field.field_type.clone()); - let changeset = FieldChangesetParams { - field_id: field.id, - grid_id, - name: Some(field.name), - desc: Some(field.desc), - field_type: Some(field.field_type.into()), - frozen: Some(field.frozen), - visibility: Some(field.visibility), - width: Some(field.width), - type_option_data: Some(type_option_data), - }; - Ok(grid.update_field_rev(changeset, deserializer)?) - }) - .await?; + let changeset = FieldChangesetParams { + field_id: field.id, + grid_id, + name: Some(field.name), + desc: Some(field.desc), + field_type: Some(field.field_type.clone().into()), + frozen: Some(field.frozen), + visibility: Some(field.visibility), + width: Some(field.width), + type_option_data: Some(type_option_data), + }; + + let _ = self.update_field_rev(changeset, field.field_type).await?; let _ = self.notify_did_update_grid_field(&field_id).await?; } else { let _ = self @@ -140,19 +135,13 @@ impl GridRevisionEditor { return Ok(()); } let field_rev = result.unwrap(); - let _ = self - .modify(|grid| { - let field_type = field_rev.ty.into(); - let deserializer = TypeOptionJsonDeserializer(field_type); - let changeset = FieldChangesetParams { - field_id: field_id.to_owned(), - grid_id: grid_id.to_owned(), - type_option_data: Some(type_option_data), - ..Default::default() - }; - Ok(grid.update_field_rev(changeset, deserializer)?) - }) - .await?; + let changeset = FieldChangesetParams { + field_id: field_id.to_owned(), + grid_id: grid_id.to_owned(), + type_option_data: Some(type_option_data), + ..Default::default() + }; + let _ = self.update_field_rev(changeset, field_rev.ty.into()).await?; let _ = self.notify_did_update_grid_field(field_id).await?; Ok(()) } @@ -179,24 +168,33 @@ impl GridRevisionEditor { pub async fn update_field(&self, params: FieldChangesetParams) -> FlowyResult<()> { let field_id = params.field_id.clone(); - let json_deserializer = match self.grid_pad.read().await.get_field_rev(params.field_id.as_str()) { - None => return Err(ErrorCode::FieldDoesNotExist.into()), - Some((_, field_rev)) => TypeOptionJsonDeserializer(field_rev.ty.into()), - }; + let field_type: Option = self + .grid_pad + .read() + .await + .get_field_rev(params.field_id.as_str()) + .map(|(_, field_rev)| field_rev.ty.into()); - let _ = self - .modify(|grid| Ok(grid.update_field_rev(params, json_deserializer)?)) - .await?; - - let _ = self.notify_did_update_grid_field(&field_id).await?; - Ok(()) + match field_type { + None => Err(ErrorCode::FieldDoesNotExist.into()), + Some(field_type) => { + let _ = self.update_field_rev(params, field_type).await?; + let _ = self.notify_did_update_grid_field(&field_id).await?; + Ok(()) + } + } } pub async fn replace_field(&self, field_rev: Arc) -> FlowyResult<()> { let field_id = field_rev.id.clone(); let _ = self - .modify(|grid_pad| Ok(grid_pad.replace_field_rev(field_rev)?)) + .modify(|grid_pad| Ok(grid_pad.replace_field_rev(field_rev.clone())?)) .await?; + + match self.view_manager.did_update_field(&field_rev.id).await { + Ok(_) => {} + Err(e) => tracing::error!("View manager update field failed: {:?}", e), + } let _ = self.notify_did_update_grid_field(&field_id).await?; Ok(()) } @@ -269,6 +267,68 @@ impl GridRevisionEditor { Ok(field_revs) } + async fn update_field_rev(&self, params: FieldChangesetParams, field_type: FieldType) -> FlowyResult<()> { + let _ = self + .modify(|grid| { + let deserializer = TypeOptionJsonDeserializer(field_type); + let changeset = grid.modify_field(¶ms.field_id, |field| { + let mut is_changed = None; + if let Some(name) = params.name { + field.name = name; + is_changed = Some(()) + } + + if let Some(desc) = params.desc { + field.desc = desc; + is_changed = Some(()) + } + + if let Some(field_type) = params.field_type { + field.ty = field_type; + is_changed = Some(()) + } + + if let Some(frozen) = params.frozen { + field.frozen = frozen; + is_changed = Some(()) + } + + if let Some(visibility) = params.visibility { + field.visibility = visibility; + is_changed = Some(()) + } + + if let Some(width) = params.width { + field.width = width; + is_changed = Some(()) + } + + if let Some(type_option_data) = params.type_option_data { + match deserializer.deserialize(type_option_data) { + Ok(json_str) => { + let field_type = field.ty; + field.insert_type_option_str(&field_type, json_str); + is_changed = Some(()) + } + Err(err) => { + tracing::error!("Deserialize data to type option json failed: {}", err); + } + } + } + + Ok(is_changed) + })?; + Ok(changeset) + }) + .await?; + + match self.view_manager.did_update_field(¶ms.field_id).await { + Ok(_) => {} + Err(e) => tracing::error!("View manager update field failed: {:?}", e), + } + Ok(()) + } + pub async fn create_block(&self, block_meta_rev: GridBlockMetaRevision) -> FlowyResult<()> { let _ = self .modify(|grid_pad| Ok(grid_pad.create_block_meta_rev(block_meta_rev)?)) @@ -294,6 +354,11 @@ impl GridRevisionEditor { Ok(row_pb) } + pub async fn move_group(&self, params: MoveGroupParams) -> FlowyResult<()> { + let _ = self.view_manager.move_group(params).await?; + Ok(()) + } + pub async fn insert_rows(&self, row_revs: Vec) -> FlowyResult> { let block_id = self.block_id().await?; let mut rows_by_block_id: HashMap> = HashMap::new(); @@ -460,8 +525,13 @@ impl GridRevisionEditor { self.view_manager.get_filters().await } - pub async fn update_grid_setting(&self, params: GridSettingChangesetParams) -> FlowyResult<()> { - let _ = self.view_manager.update_setting(params).await?; + pub async fn update_filter(&self, params: CreateFilterParams) -> FlowyResult<()> { + let _ = self.view_manager.update_filter(params).await?; + Ok(()) + } + + pub async fn delete_filter(&self, params: DeleteFilterParams) -> FlowyResult<()> { + let _ = self.view_manager.delete_filter(params).await?; Ok(()) } @@ -501,16 +571,6 @@ impl GridRevisionEditor { .block_manager .move_row(row_rev.clone(), from_index, to_index) .await?; - - if let Some(row_changeset) = self.view_manager.move_row(row_rev, to_row_id.clone()).await { - tracing::trace!("Receive row changeset after moving the row"); - match self.block_manager.update_row(row_changeset).await { - Ok(_) => {} - Err(e) => { - tracing::error!("Apply row changeset error:{:?}", e); - } - } - } } (_, None) => tracing::warn!("Can not find the from row id: {}", from_row_id), (None, _) => tracing::warn!("Can not find the to row id: {}", to_row_id), @@ -520,6 +580,48 @@ impl GridRevisionEditor { Ok(()) } + pub async fn move_group_row(&self, params: MoveGroupRowParams) -> FlowyResult<()> { + let MoveGroupRowParams { + view_id, + from_row_id, + to_group_id, + to_row_id, + } = params; + + match self.block_manager.get_row_rev(&from_row_id).await? { + None => tracing::warn!("Move row failed, can not find the row:{}", from_row_id), + Some(row_rev) => { + if let Some(row_changeset) = self + .view_manager + .move_group_row(row_rev, to_group_id, to_row_id.clone()) + .await + { + tracing::trace!("Move group row cause row data changed: {:?}", row_changeset); + + let cell_changesets = row_changeset + .cell_by_field_id + .into_iter() + .map(|(field_id, cell_rev)| CellChangesetPB { + grid_id: view_id.clone(), + row_id: row_changeset.row_id.clone(), + field_id, + content: cell_rev.data, + }) + .collect::>(); + + for cell_changeset in cell_changesets { + match self.block_manager.update_cell(cell_changeset).await { + Ok(_) => {} + Err(e) => tracing::error!("Apply cell changeset error:{:?}", e), + } + } + } + } + } + + Ok(()) + } + pub async fn move_field(&self, params: MoveFieldParams) -> FlowyResult<()> { let MoveFieldParams { grid_id: _, diff --git a/frontend/rust-lib/flowy-grid/src/services/grid_view_editor.rs b/frontend/rust-lib/flowy-grid/src/services/grid_view_editor.rs index da3ea1be2d..6a04e18815 100644 --- a/frontend/rust-lib/flowy-grid/src/services/grid_view_editor.rs +++ b/frontend/rust-lib/flowy-grid/src/services/grid_view_editor.rs @@ -1,18 +1,23 @@ use crate::dart_notification::{send_dart_notification, GridNotification}; use crate::entities::{ - CreateRowParams, GridFilterConfiguration, GridSettingPB, GroupPB, GroupRowsChangesetPB, InsertedRowPB, RowPB, + CreateFilterParams, CreateRowParams, DeleteFilterParams, GridFilterConfiguration, GridLayout, GridLayoutPB, + GridSettingPB, GroupChangesetPB, GroupPB, GroupViewChangesetPB, InsertedGroupPB, InsertedRowPB, MoveGroupParams, + RepeatedGridConfigurationFilterPB, RepeatedGridGroupConfigurationPB, RowPB, }; use crate::services::grid_editor_task::GridServiceTaskScheduler; use crate::services::grid_view_manager::{GridViewFieldDelegate, GridViewRowDelegate}; -use crate::services::group::{default_group_configuration, GroupConfigurationDelegate, GroupService}; -use crate::services::setting::make_grid_setting; +use crate::services::group::{GroupConfigurationReader, GroupConfigurationWriter, GroupService}; use flowy_error::{FlowyError, FlowyResult}; -use flowy_grid_data_model::revision::{FieldRevision, GroupConfigurationRevision, RowChangeset, RowRevision}; +use flowy_grid_data_model::revision::{ + gen_grid_filter_id, FieldRevision, FieldTypeRevision, FilterConfigurationRevision, GroupConfigurationRevision, + RowChangeset, RowRevision, +}; use flowy_revision::{RevisionCloudService, RevisionManager, RevisionObjectBuilder}; use flowy_sync::client_grid::{GridViewRevisionChangeset, GridViewRevisionPad}; -use flowy_sync::entities::grid::GridSettingChangesetParams; use flowy_sync::entities::revision::Revision; use lib_infra::future::{wrap_future, AFFuture, FutureResult}; +use std::collections::HashMap; + use std::sync::atomic::{AtomicBool, Ordering}; use std::sync::Arc; use tokio::sync::RwLock; @@ -31,6 +36,7 @@ pub struct GridViewRevisionEditor { } impl GridViewRevisionEditor { + #[tracing::instrument(level = "trace", skip_all, err)] pub(crate) async fn new( user_id: &str, token: &str, @@ -46,7 +52,14 @@ impl GridViewRevisionEditor { let view_revision_pad = rev_manager.load::(Some(cloud)).await?; let pad = Arc::new(RwLock::new(view_revision_pad)); let rev_manager = Arc::new(rev_manager); - let group_service = GroupService::new(Box::new(pad.clone())).await; + + let configuration_reader = GroupConfigurationReaderImpl(pad.clone()); + let configuration_writer = GroupConfigurationWriterImpl { + user_id: user_id.to_owned(), + rev_manager: rev_manager.clone(), + view_pad: pad.clone(), + }; + let group_service = GroupService::new(view_id.clone(), configuration_reader, configuration_writer).await; let user_id = user_id.to_owned(); let did_load_group = AtomicBool::new(false); Ok(Self { @@ -67,7 +80,7 @@ impl GridViewRevisionEditor { None => {} Some(group_id) => { self.group_service - .read() + .write() .await .will_create_row(row_rev, group_id, |field_id| { self.field_delegate.get_field_rev(&field_id) @@ -86,7 +99,7 @@ impl GridViewRevisionEditor { row: row_pb.clone(), index: None, }; - let changeset = GroupRowsChangesetPB::insert(group_id.clone(), vec![inserted_row]); + let changeset = GroupChangesetPB::insert(group_id.clone(), vec![inserted_row]); self.notify_did_update_group(changeset).await; } } @@ -121,33 +134,35 @@ impl GridViewRevisionEditor { } } - pub(crate) async fn did_move_row( + pub(crate) async fn move_group_row( &self, row_rev: &RowRevision, row_changeset: &mut RowChangeset, - upper_row_id: &str, + to_group_id: &str, + to_row_id: Option, ) { if let Some(changesets) = self .group_service .write() .await - .did_move_row(row_rev, row_changeset, upper_row_id, |field_id| { + .move_group_row(row_rev, row_changeset, to_group_id, to_row_id, |field_id| { self.field_delegate.get_field_rev(&field_id) }) .await { for changeset in changesets { - tracing::trace!("Group: {} changeset: {}", changeset.group_id, changeset); self.notify_did_update_group(changeset).await; } } } - + /// Only call once after grid view editor initialized + #[tracing::instrument(level = "trace", skip(self))] pub(crate) async fn load_groups(&self) -> FlowyResult> { let groups = if !self.did_load_group.load(Ordering::SeqCst) { self.did_load_group.store(true, Ordering::SeqCst); let field_revs = self.field_delegate.get_field_revs().await; let row_revs = self.row_delegate.gv_row_revs().await; + match self .group_service .write() @@ -162,23 +177,48 @@ impl GridViewRevisionEditor { self.group_service.read().await.groups().await }; + tracing::trace!("Number of groups: {}", groups.len()); Ok(groups.into_iter().map(GroupPB::from).collect()) } + pub(crate) async fn move_group(&self, params: MoveGroupParams) -> FlowyResult<()> { + let _ = self + .group_service + .write() + .await + .move_group(¶ms.from_group_id, ¶ms.to_group_id) + .await?; + + match self.group_service.read().await.get_group(¶ms.from_group_id).await { + None => {} + Some((index, group)) => { + let inserted_group = InsertedGroupPB { + group: GroupPB::from(group), + index: index as i32, + }; + + let changeset = GroupViewChangesetPB { + view_id: self.view_id.clone(), + inserted_groups: vec![inserted_group], + deleted_groups: vec![params.from_group_id.clone()], + update_groups: vec![], + }; + + self.notify_did_update_view(changeset).await; + } + } + Ok(()) + } + pub(crate) async fn get_setting(&self) -> GridSettingPB { let field_revs = self.field_delegate.get_field_revs().await; - let grid_setting = make_grid_setting(self.pad.read().await.get_setting_rev(), &field_revs); + let grid_setting = make_grid_setting(&*self.pad.read().await, &field_revs); grid_setting } - pub(crate) async fn update_setting(&self, changeset: GridSettingChangesetParams) -> FlowyResult<()> { - let _ = self.modify(|pad| Ok(pad.update_setting(changeset)?)).await; - Ok(()) - } - pub(crate) async fn get_filters(&self) -> Vec { let field_revs = self.field_delegate.get_field_revs().await; - match self.pad.read().await.get_setting_rev().get_all_filters(&field_revs) { + match self.pad.read().await.get_all_filters(&field_revs) { None => vec![], Some(filters) => filters .into_values() @@ -188,12 +228,56 @@ impl GridViewRevisionEditor { } } - async fn notify_did_update_group(&self, changeset: GroupRowsChangesetPB) { + pub(crate) async fn insert_filter(&self, insert_filter: CreateFilterParams) -> FlowyResult<()> { + self.modify(|pad| { + let filter_rev = FilterConfigurationRevision { + id: gen_grid_filter_id(), + field_id: insert_filter.field_id.clone(), + condition: insert_filter.condition, + content: insert_filter.content, + }; + let changeset = pad.insert_filter(&insert_filter.field_id, &insert_filter.field_type_rev, filter_rev)?; + Ok(changeset) + }) + .await + } + + pub(crate) async fn delete_filter(&self, delete_filter: DeleteFilterParams) -> FlowyResult<()> { + self.modify(|pad| { + let changeset = pad.delete_filter( + &delete_filter.field_id, + &delete_filter.field_type_rev, + &delete_filter.filter_id, + )?; + Ok(changeset) + }) + .await + } + #[tracing::instrument(level = "trace", skip_all, err)] + pub(crate) async fn did_update_field(&self, field_id: &str) -> FlowyResult<()> { + if let Some(field_rev) = self.field_delegate.get_field_rev(field_id).await { + match self.group_service.write().await.did_update_field(&field_rev).await? { + None => {} + Some(changeset) => { + self.notify_did_update_view(changeset).await; + } + } + } + Ok(()) + } + + async fn notify_did_update_group(&self, changeset: GroupChangesetPB) { send_dart_notification(&changeset.group_id, GridNotification::DidUpdateGroup) .payload(changeset) .send(); } + async fn notify_did_update_view(&self, changeset: GroupViewChangesetPB) { + send_dart_notification(&self.view_id, GridNotification::DidUpdateGroupView) + .payload(changeset) + .send(); + } + async fn modify(&self, f: F) -> FlowyResult<()> where F: for<'a> FnOnce(&'a mut GridViewRevisionPad) -> FlowyResult>, @@ -202,28 +286,24 @@ impl GridViewRevisionEditor { match f(&mut *write_guard)? { None => {} Some(change) => { - let _ = self.apply_change(change).await?; + let _ = apply_change(&self.user_id, self.rev_manager.clone(), change).await?; } } Ok(()) } +} - async fn apply_change(&self, change: GridViewRevisionChangeset) -> FlowyResult<()> { - let GridViewRevisionChangeset { delta, md5 } = change; - let user_id = self.user_id.clone(); - let (base_rev_id, rev_id) = self.rev_manager.next_rev_id_pair(); - let delta_data = delta.json_bytes(); - let revision = Revision::new( - &self.rev_manager.object_id, - base_rev_id, - rev_id, - delta_data, - &user_id, - md5, - ); - let _ = self.rev_manager.add_local_revision(&revision).await?; - Ok(()) - } +async fn apply_change( + user_id: &str, + rev_manager: Arc, + change: GridViewRevisionChangeset, +) -> FlowyResult<()> { + let GridViewRevisionChangeset { delta, md5 } = change; + let (base_rev_id, rev_id) = rev_manager.next_rev_id_pair(); + let delta_data = delta.json_bytes(); + let revision = Revision::new(&rev_manager.object_id, base_rev_id, rev_id, delta_data, user_id, md5); + let _ = rev_manager.add_local_revision(&revision).await?; + Ok(()) } struct GridViewRevisionCloudService { @@ -248,19 +328,97 @@ impl RevisionObjectBuilder for GridViewRevisionPadBuilder { } } -impl GroupConfigurationDelegate for Arc> { - fn get_group_configuration(&self, field_rev: Arc) -> AFFuture { - let view_pad = self.clone(); +struct GroupConfigurationReaderImpl(Arc>); + +impl GroupConfigurationReader for GroupConfigurationReaderImpl { + fn get_group_configuration( + &self, + field_rev: Arc, + ) -> AFFuture>> { + let view_pad = self.0.clone(); wrap_future(async move { - let grid_pad = view_pad.read().await; - let configurations = grid_pad.get_groups(&field_rev.id, &field_rev.ty); - match configurations { - None => default_group_configuration(&field_rev), - Some(mut configurations) => { - assert_eq!(configurations.len(), 1); - (&*configurations.pop().unwrap()).clone() - } + let mut groups = view_pad.read().await.groups.get_objects(&field_rev.id, &field_rev.ty)?; + if groups.is_empty() { + None + } else { + debug_assert_eq!(groups.len(), 1); + Some(groups.pop().unwrap()) } }) } } + +struct GroupConfigurationWriterImpl { + user_id: String, + rev_manager: Arc, + view_pad: Arc>, +} + +impl GroupConfigurationWriter for GroupConfigurationWriterImpl { + fn save_group_configuration( + &self, + field_id: &str, + field_type: FieldTypeRevision, + group_configuration: GroupConfigurationRevision, + ) -> AFFuture> { + let user_id = self.user_id.clone(); + let rev_manager = self.rev_manager.clone(); + let view_pad = self.view_pad.clone(); + let field_id = field_id.to_owned(); + + wrap_future(async move { + let changeset = view_pad + .write() + .await + .insert_group(&field_id, &field_type, group_configuration)?; + + if let Some(changeset) = changeset { + let _ = apply_change(&user_id, rev_manager, changeset).await?; + } + Ok(()) + }) + } +} + +pub fn make_grid_setting(view_pad: &GridViewRevisionPad, field_revs: &[Arc]) -> GridSettingPB { + let current_layout_type: GridLayout = view_pad.layout.clone().into(); + let filters_by_field_id = view_pad + .get_all_filters(field_revs) + .map(|filters_by_field_id| { + filters_by_field_id + .into_iter() + .map(|(k, v)| (k, v.into())) + .collect::>() + }) + .unwrap_or_default(); + let groups_by_field_id = view_pad + .get_all_groups(field_revs) + .map(|groups_by_field_id| { + groups_by_field_id + .into_iter() + .map(|(k, v)| (k, v.into())) + .collect::>() + }) + .unwrap_or_default(); + + GridSettingPB { + layouts: GridLayoutPB::all(), + current_layout_type, + filter_configuration_by_field_id: filters_by_field_id, + group_configuration_by_field_id: groups_by_field_id, + } +} + +#[cfg(test)] +mod tests { + use lib_ot::core::TextDelta; + + #[test] + fn test() { + let s1 = r#"[{"insert":"{\"view_id\":\"fTURELffPr\",\"grid_id\":\"fTURELffPr\",\"layout\":0,\"filters\":[],\"groups\":[]}"}]"#; + let _delta_1 = TextDelta::from_json(s1).unwrap(); + + let s2 = r#"[{"retain":195},{"insert":"{\\\"group_id\\\":\\\"wD9i\\\",\\\"visible\\\":true},{\\\"group_id\\\":\\\"xZtv\\\",\\\"visible\\\":true},{\\\"group_id\\\":\\\"tFV2\\\",\\\"visible\\\":true}"},{"retain":10}]"#; + let _delta_2 = TextDelta::from_json(s2).unwrap(); + } +} diff --git a/frontend/rust-lib/flowy-grid/src/services/grid_view_manager.rs b/frontend/rust-lib/flowy-grid/src/services/grid_view_manager.rs index 5a8faad6a0..657058b31f 100644 --- a/frontend/rust-lib/flowy-grid/src/services/grid_view_manager.rs +++ b/frontend/rust-lib/flowy-grid/src/services/grid_view_manager.rs @@ -1,4 +1,7 @@ -use crate::entities::{CreateRowParams, GridFilterConfiguration, GridSettingPB, RepeatedGridGroupPB, RowPB}; +use crate::entities::{ + CreateFilterParams, CreateRowParams, DeleteFilterParams, GridFilterConfiguration, GridSettingPB, MoveGroupParams, + RepeatedGridGroupPB, RowPB, +}; use crate::manager::GridUser; use crate::services::grid_editor_task::GridServiceTaskScheduler; use crate::services::grid_view_editor::GridViewRevisionEditor; @@ -8,7 +11,6 @@ use flowy_error::FlowyResult; use flowy_grid_data_model::revision::{FieldRevision, RowChangeset, RowRevision}; use flowy_revision::disk::SQLiteGridViewRevisionPersistence; use flowy_revision::{RevisionCompactor, RevisionManager, RevisionPersistence, SQLiteRevisionSnapshotPersistence}; -use flowy_sync::entities::grid::GridSettingChangesetParams; use flowy_sync::entities::revision::Revision; use flowy_sync::util::make_text_delta_from_revisions; use lib_infra::future::AFFuture; @@ -97,39 +99,62 @@ impl GridViewManager { Ok(view_editor.get_setting().await) } - pub(crate) async fn update_setting(&self, params: GridSettingChangesetParams) -> FlowyResult<()> { - let view_editor = self.get_default_view_editor().await?; - let _ = view_editor.update_setting(params).await?; - Ok(()) - } - pub(crate) async fn get_filters(&self) -> FlowyResult> { let view_editor = self.get_default_view_editor().await?; Ok(view_editor.get_filters().await) } + pub(crate) async fn update_filter(&self, insert_filter: CreateFilterParams) -> FlowyResult<()> { + let view_editor = self.get_default_view_editor().await?; + view_editor.insert_filter(insert_filter).await + } + + pub(crate) async fn delete_filter(&self, delete_filter: DeleteFilterParams) -> FlowyResult<()> { + let view_editor = self.get_default_view_editor().await?; + view_editor.delete_filter(delete_filter).await + } + pub(crate) async fn load_groups(&self) -> FlowyResult { let view_editor = self.get_default_view_editor().await?; let groups = view_editor.load_groups().await?; Ok(RepeatedGridGroupPB { items: groups }) } + pub(crate) async fn move_group(&self, params: MoveGroupParams) -> FlowyResult<()> { + let view_editor = self.get_default_view_editor().await?; + let _ = view_editor.move_group(params).await?; + Ok(()) + } + /// It may generate a RowChangeset when the Row was moved from one group to another. /// The return value, [RowChangeset], contains the changes made by the groups. /// - pub(crate) async fn move_row(&self, row_rev: Arc, to_row_id: String) -> Option { + pub(crate) async fn move_group_row( + &self, + row_rev: Arc, + to_group_id: String, + to_row_id: Option, + ) -> Option { let mut row_changeset = RowChangeset::new(row_rev.id.clone()); for view_editor in self.view_editors.iter() { - view_editor.did_move_row(&row_rev, &mut row_changeset, &to_row_id).await; + view_editor + .move_group_row(&row_rev, &mut row_changeset, &to_group_id, to_row_id.clone()) + .await; } - if row_changeset.has_changed() { - Some(row_changeset) - } else { + if row_changeset.is_empty() { None + } else { + Some(row_changeset) } } + pub(crate) async fn did_update_field(&self, field_id: &str) -> FlowyResult<()> { + let view_editor = self.get_default_view_editor().await?; + let _ = view_editor.did_update_field(field_id).await?; + Ok(()) + } + pub(crate) async fn get_view_editor(&self, view_id: &str) -> FlowyResult> { debug_assert!(!view_id.is_empty()); match self.view_editors.get(view_id) { @@ -163,12 +188,11 @@ async fn make_view_editor( row_delegate: Arc, scheduler: Arc, ) -> FlowyResult { - tracing::trace!("Open view:{} editor", view_id); - let rev_manager = make_grid_view_rev_manager(user, view_id).await?; let user_id = user.user_id()?; let token = user.token()?; let view_id = view_id.to_owned(); + GridViewRevisionEditor::new( &user_id, &token, @@ -182,7 +206,6 @@ async fn make_view_editor( } pub async fn make_grid_view_rev_manager(user: &Arc, view_id: &str) -> FlowyResult { - tracing::trace!("Open view:{} editor", view_id); let user_id = user.user_id()?; let pool = user.db_pool()?; diff --git a/frontend/rust-lib/flowy-grid/src/services/group/action.rs b/frontend/rust-lib/flowy-grid/src/services/group/action.rs new file mode 100644 index 0000000000..d19be8395e --- /dev/null +++ b/frontend/rust-lib/flowy-grid/src/services/group/action.rs @@ -0,0 +1,13 @@ +use crate::entities::GroupChangesetPB; + +use crate::services::group::controller::MoveGroupRowContext; +use flowy_grid_data_model::revision::RowRevision; + +pub trait GroupAction: Send + Sync { + type CellDataType; + fn can_group(&self, content: &str, cell_data: &Self::CellDataType) -> bool; + fn add_row_if_match(&mut self, row_rev: &RowRevision, cell_data: &Self::CellDataType) -> Vec; + fn remove_row_if_match(&mut self, row_rev: &RowRevision, cell_data: &Self::CellDataType) -> Vec; + + fn move_row(&mut self, cell_data: &Self::CellDataType, context: MoveGroupRowContext) -> Vec; +} diff --git a/frontend/rust-lib/flowy-grid/src/services/group/configuration.rs b/frontend/rust-lib/flowy-grid/src/services/group/configuration.rs new file mode 100644 index 0000000000..546afb8a32 --- /dev/null +++ b/frontend/rust-lib/flowy-grid/src/services/group/configuration.rs @@ -0,0 +1,319 @@ +use crate::entities::{GroupPB, GroupViewChangesetPB, InsertedGroupPB}; +use crate::services::group::{default_group_configuration, Group}; +use flowy_error::{FlowyError, FlowyResult}; +use flowy_grid_data_model::revision::{ + FieldRevision, FieldTypeRevision, GroupConfigurationContentSerde, GroupConfigurationRevision, GroupRevision, +}; +use indexmap::IndexMap; +use lib_infra::future::AFFuture; +use std::fmt::Formatter; +use std::marker::PhantomData; +use std::sync::Arc; + +pub trait GroupConfigurationReader: Send + Sync + 'static { + fn get_group_configuration( + &self, + field_rev: Arc, + ) -> AFFuture>>; +} + +pub trait GroupConfigurationWriter: Send + Sync + 'static { + fn save_group_configuration( + &self, + field_id: &str, + field_type: FieldTypeRevision, + group_configuration: GroupConfigurationRevision, + ) -> AFFuture>; +} + +impl std::fmt::Display for GenericGroupConfiguration { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + self.groups_map.iter().for_each(|(_, group)| { + let _ = f.write_fmt(format_args!("Group:{} has {} rows \n", group.id, group.rows.len())); + }); + Ok(()) + } +} + +pub struct GenericGroupConfiguration { + view_id: String, + pub configuration: Arc, + configuration_content: PhantomData, + field_rev: Arc, + groups_map: IndexMap, + writer: Arc, +} + +impl GenericGroupConfiguration +where + C: GroupConfigurationContentSerde, +{ + #[tracing::instrument(level = "trace", skip_all, err)] + pub async fn new( + view_id: String, + field_rev: Arc, + reader: Arc, + writer: Arc, + ) -> FlowyResult { + let configuration = match reader.get_group_configuration(field_rev.clone()).await { + None => { + let default_group_configuration = default_group_configuration(&field_rev); + writer + .save_group_configuration(&field_rev.id, field_rev.ty, default_group_configuration.clone()) + .await?; + Arc::new(default_group_configuration) + } + Some(configuration) => configuration, + }; + + // let configuration = C::from_configuration_content(&configuration_rev.content)?; + Ok(Self { + view_id, + field_rev, + groups_map: IndexMap::new(), + writer, + configuration, + configuration_content: PhantomData, + }) + } + + pub(crate) fn groups(&self) -> Vec<&Group> { + self.groups_map.values().collect() + } + + pub(crate) fn clone_groups(&self) -> Vec { + self.groups_map.values().cloned().collect() + } + + pub(crate) fn merge_groups(&mut self, groups: Vec) -> FlowyResult> { + let MergeGroupResult { + groups, + inserted_groups, + updated_groups, + } = merge_groups(&self.configuration.groups, groups); + + let group_revs = groups + .iter() + .map(|group| GroupRevision::new(group.id.clone(), group.name.clone())) + .collect::>(); + + self.mut_configuration(move |configuration| { + let mut is_changed = false; + for new_group_rev in group_revs { + match configuration + .groups + .iter() + .position(|group_rev| group_rev.id == new_group_rev.id) + { + None => { + configuration.groups.push(new_group_rev); + is_changed = true; + } + Some(pos) => { + let removed_group = configuration.groups.remove(pos); + if removed_group != new_group_rev { + is_changed = true; + } + configuration.groups.insert(pos, new_group_rev); + } + } + } + is_changed + })?; + + groups.into_iter().for_each(|group| { + self.groups_map.insert(group.id.clone(), group); + }); + + let changeset = make_group_view_changeset(self.view_id.clone(), inserted_groups, updated_groups); + tracing::trace!("Group changeset: {:?}", changeset); + if changeset.is_empty() { + Ok(None) + } else { + Ok(Some(changeset)) + } + } + + #[allow(dead_code)] + pub(crate) async fn hide_group(&mut self, group_id: &str) -> FlowyResult<()> { + self.mut_configuration_group(group_id, |group_rev| { + group_rev.visible = false; + })?; + Ok(()) + } + + #[allow(dead_code)] + pub(crate) async fn show_group(&mut self, group_id: &str) -> FlowyResult<()> { + self.mut_configuration_group(group_id, |group_rev| { + group_rev.visible = true; + })?; + Ok(()) + } + + pub(crate) fn iter_mut_groups(&mut self, mut each: impl FnMut(&mut Group)) { + self.groups_map.iter_mut().for_each(|(_, group)| { + each(group); + }) + } + + pub(crate) fn get_mut_group(&mut self, group_id: &str) -> Option<&mut Group> { + self.groups_map.get_mut(group_id) + } + + pub(crate) fn move_group(&mut self, from_id: &str, to_id: &str) -> FlowyResult<()> { + let from_index = self.groups_map.get_index_of(from_id); + let to_index = self.groups_map.get_index_of(to_id); + match (from_index, to_index) { + (Some(from_index), Some(to_index)) => { + self.groups_map.swap_indices(from_index, to_index); + + self.mut_configuration(|configuration| { + let from_index = configuration.groups.iter().position(|group| group.id == from_id); + let to_index = configuration.groups.iter().position(|group| group.id == to_id); + if let (Some(from), Some(to)) = (from_index, to_index) { + configuration.groups.swap(from, to); + } + true + })?; + Ok(()) + } + _ => Err(FlowyError::out_of_bounds()), + } + } + + // Returns the index and group specified by the group_id + pub(crate) fn get_group(&self, group_id: &str) -> Option<(usize, &Group)> { + match (self.groups_map.get_index_of(group_id), self.groups_map.get(group_id)) { + (Some(index), Some(group)) => Some((index, group)), + _ => None, + } + } + + pub fn save_configuration(&self) -> FlowyResult<()> { + let configuration = (&*self.configuration).clone(); + let writer = self.writer.clone(); + let field_id = self.field_rev.id.clone(); + let field_type = self.field_rev.ty; + tokio::spawn(async move { + match writer + .save_group_configuration(&field_id, field_type, configuration) + .await + { + Ok(_) => {} + Err(e) => { + tracing::error!("Save group configuration failed: {}", e); + } + } + }); + + Ok(()) + } + + fn mut_configuration_group( + &mut self, + group_id: &str, + mut_groups_fn: impl Fn(&mut GroupRevision), + ) -> FlowyResult<()> { + self.mut_configuration(|configuration| { + match configuration.groups.iter_mut().find(|group| group.id == group_id) { + None => false, + Some(group_rev) => { + mut_groups_fn(group_rev); + true + } + } + }) + } + + fn mut_configuration( + &mut self, + mut_configuration_fn: impl FnOnce(&mut GroupConfigurationRevision) -> bool, + ) -> FlowyResult<()> { + let configuration = Arc::make_mut(&mut self.configuration); + let is_changed = mut_configuration_fn(configuration); + if is_changed { + let _ = self.save_configuration()?; + } + Ok(()) + } +} + +fn merge_groups(old_groups: &[GroupRevision], groups: Vec) -> MergeGroupResult { + let mut merge_result = MergeGroupResult::new(); + if old_groups.is_empty() { + merge_result.groups = groups; + return merge_result; + } + + // group_map is a helper map is used to filter out the new groups. + let mut group_map: IndexMap = IndexMap::new(); + groups.into_iter().for_each(|group| { + group_map.insert(group.id.clone(), group); + }); + + // The group is ordered in old groups. Add them before adding the new groups + for group_rev in old_groups { + if let Some(group) = group_map.remove(&group_rev.id) { + if group.name == group_rev.name { + merge_result.add_group(group); + } else { + merge_result.add_updated_group(group); + } + } + } + + // Find out the new groups + let new_groups = group_map.into_values().collect::>(); + for (index, group) in new_groups.into_iter().enumerate() { + merge_result.add_insert_group(index, group); + } + merge_result +} + +struct MergeGroupResult { + groups: Vec, + inserted_groups: Vec, + updated_groups: Vec, +} + +impl MergeGroupResult { + fn new() -> Self { + Self { + groups: vec![], + inserted_groups: vec![], + updated_groups: vec![], + } + } + + fn add_updated_group(&mut self, group: Group) { + self.groups.push(group.clone()); + self.updated_groups.push(group); + } + + fn add_group(&mut self, group: Group) { + self.groups.push(group.clone()); + } + + fn add_insert_group(&mut self, index: usize, group: Group) { + self.groups.push(group.clone()); + let inserted_group = InsertedGroupPB { + group: GroupPB::from(group), + index: index as i32, + }; + self.inserted_groups.push(inserted_group); + } +} + +fn make_group_view_changeset( + view_id: String, + inserted_groups: Vec, + updated_group: Vec, +) -> GroupViewChangesetPB { + let changeset = GroupViewChangesetPB { + view_id, + inserted_groups, + deleted_groups: vec![], + update_groups: updated_group.into_iter().map(GroupPB::from).collect(), + }; + changeset +} diff --git a/frontend/rust-lib/flowy-grid/src/services/group/controller.rs b/frontend/rust-lib/flowy-grid/src/services/group/controller.rs new file mode 100644 index 0000000000..fac034f6f5 --- /dev/null +++ b/frontend/rust-lib/flowy-grid/src/services/group/controller.rs @@ -0,0 +1,249 @@ +use crate::entities::{GroupChangesetPB, GroupViewChangesetPB, RowPB}; +use crate::services::cell::{decode_any_cell_data, CellBytesParser}; +use crate::services::group::action::GroupAction; +use crate::services::group::configuration::GenericGroupConfiguration; +use crate::services::group::entities::Group; +use flowy_error::FlowyResult; +use flowy_grid_data_model::revision::{ + FieldRevision, GroupConfigurationContentSerde, RowChangeset, RowRevision, TypeOptionDataDeserializer, +}; + +use std::marker::PhantomData; +use std::sync::Arc; + +const DEFAULT_GROUP_ID: &str = "default_group"; + +// Each kind of group must implement this trait to provide custom group +// operations. For example, insert cell data to the row_rev when creating +// a new row. +pub trait GroupController: GroupControllerSharedOperation + Send + Sync { + fn will_create_row(&mut self, row_rev: &mut RowRevision, field_rev: &FieldRevision, group_id: &str); +} + +pub trait GroupGenerator { + type ConfigurationType; + type TypeOptionType; + + fn generate_groups( + field_id: &str, + configuration: &Self::ConfigurationType, + type_option: &Option, + ) -> Vec; +} + +pub struct MoveGroupRowContext<'a> { + pub row_rev: &'a RowRevision, + pub row_changeset: &'a mut RowChangeset, + pub field_rev: &'a FieldRevision, + pub to_group_id: &'a str, + pub to_row_id: Option, +} + +// Defines the shared actions each group controller can perform. +pub trait GroupControllerSharedOperation: Send + Sync { + // The field that is used for grouping the rows + fn field_id(&self) -> &str; + fn groups(&self) -> Vec; + fn get_group(&self, group_id: &str) -> Option<(usize, Group)>; + fn fill_groups(&mut self, row_revs: &[Arc], field_rev: &FieldRevision) -> FlowyResult>; + fn move_group(&mut self, from_group_id: &str, to_group_id: &str) -> FlowyResult<()>; + fn did_update_row( + &mut self, + row_rev: &RowRevision, + field_rev: &FieldRevision, + ) -> FlowyResult>; + + fn did_delete_row( + &mut self, + row_rev: &RowRevision, + field_rev: &FieldRevision, + ) -> FlowyResult>; + + fn move_group_row(&mut self, context: MoveGroupRowContext) -> FlowyResult>; + + fn did_update_field(&mut self, field_rev: &FieldRevision) -> FlowyResult>; +} + +/// C: represents the group configuration that impl [GroupConfigurationSerde] +/// T: the type option data deserializer that impl [TypeOptionDataDeserializer] +/// G: the group generator, [GroupGenerator] +/// P: the parser that impl [CellBytesParser] for the CellBytes +pub struct GenericGroupController { + pub field_id: String, + pub type_option: Option, + pub configuration: GenericGroupConfiguration, + /// default_group is used to store the rows that don't belong to any groups. + default_group: Group, + group_action_phantom: PhantomData, + cell_parser_phantom: PhantomData

, +} + +impl GenericGroupController +where + C: GroupConfigurationContentSerde, + T: TypeOptionDataDeserializer, + G: GroupGenerator, TypeOptionType = T>, +{ + pub async fn new( + field_rev: &Arc, + mut configuration: GenericGroupConfiguration, + ) -> FlowyResult { + let field_type_rev = field_rev.ty; + let type_option = field_rev.get_type_option_entry::(field_type_rev); + let groups = G::generate_groups(&field_rev.id, &configuration, &type_option); + let _ = configuration.merge_groups(groups)?; + let default_group = Group::new( + DEFAULT_GROUP_ID.to_owned(), + field_rev.id.clone(), + format!("No {}", field_rev.name), + "".to_string(), + ); + + Ok(Self { + field_id: field_rev.id.clone(), + default_group, + type_option, + configuration, + group_action_phantom: PhantomData, + cell_parser_phantom: PhantomData, + }) + } +} + +impl GroupControllerSharedOperation for GenericGroupController +where + P: CellBytesParser, + C: GroupConfigurationContentSerde, + T: TypeOptionDataDeserializer, + G: GroupGenerator, TypeOptionType = T>, + + Self: GroupAction, +{ + fn field_id(&self) -> &str { + &self.field_id + } + + fn groups(&self) -> Vec { + let mut groups = self.configuration.clone_groups(); + if self.default_group.is_empty() == false { + groups.insert(0, self.default_group.clone()); + } + groups + } + + fn get_group(&self, group_id: &str) -> Option<(usize, Group)> { + let group = self.configuration.get_group(group_id)?; + Some((group.0, group.1.clone())) + } + + #[tracing::instrument(level = "trace", skip_all, fields(row_count=%row_revs.len(), group_result))] + fn fill_groups(&mut self, row_revs: &[Arc], field_rev: &FieldRevision) -> FlowyResult> { + // let mut ungrouped_rows = vec![]; + for row_rev in row_revs { + if let Some(cell_rev) = row_rev.cells.get(&self.field_id) { + let mut grouped_rows: Vec = vec![]; + let cell_bytes = decode_any_cell_data(cell_rev.data.clone(), field_rev); + let cell_data = cell_bytes.parser::

()?; + for group in self.configuration.groups() { + if self.can_group(&group.content, &cell_data) { + grouped_rows.push(GroupedRow { + row: row_rev.into(), + group_id: group.id.clone(), + }); + } + } + + if grouped_rows.is_empty() { + // ungrouped_rows.push(RowPB::from(row_rev)); + self.default_group.add_row(row_rev.into()); + } else { + for group_row in grouped_rows { + if let Some(group) = self.configuration.get_mut_group(&group_row.group_id) { + group.add_row(group_row.row); + } + } + } + } else { + self.default_group.add_row(row_rev.into()); + } + } + + // if !ungrouped_rows.is_empty() { + // let default_group_rev = GroupRevision::default_group(gen_grid_group_id(), format!("No {}", field_rev.name)); + // let default_group = Group::new( + // default_group_rev.id.clone(), + // field_rev.id.clone(), + // default_group_rev.name.clone(), + // "".to_owned(), + // ); + // } + + tracing::Span::current().record( + "group_result", + &format!( + "{}, default_group has {} rows", + self.configuration, + self.default_group.rows.len() + ) + .as_str(), + ); + + Ok(self.groups()) + } + + fn move_group(&mut self, from_group_id: &str, to_group_id: &str) -> FlowyResult<()> { + self.configuration.move_group(from_group_id, to_group_id) + } + + fn did_update_row( + &mut self, + row_rev: &RowRevision, + field_rev: &FieldRevision, + ) -> FlowyResult> { + if let Some(cell_rev) = row_rev.cells.get(&self.field_id) { + let cell_bytes = decode_any_cell_data(cell_rev.data.clone(), field_rev); + let cell_data = cell_bytes.parser::

()?; + let changesets = self.add_row_if_match(row_rev, &cell_data); + Ok(changesets) + } else { + Ok(vec![]) + } + } + + fn did_delete_row( + &mut self, + row_rev: &RowRevision, + field_rev: &FieldRevision, + ) -> FlowyResult> { + if let Some(cell_rev) = row_rev.cells.get(&self.field_id) { + let cell_bytes = decode_any_cell_data(cell_rev.data.clone(), field_rev); + let cell_data = cell_bytes.parser::

()?; + Ok(self.remove_row_if_match(row_rev, &cell_data)) + } else { + Ok(vec![]) + } + } + + fn move_group_row(&mut self, context: MoveGroupRowContext) -> FlowyResult> { + if let Some(cell_rev) = context.row_rev.cells.get(&self.field_id) { + let cell_bytes = decode_any_cell_data(cell_rev.data.clone(), context.field_rev); + let cell_data = cell_bytes.parser::

()?; + Ok(self.move_row(&cell_data, context)) + } else { + Ok(vec![]) + } + } + + fn did_update_field(&mut self, field_rev: &FieldRevision) -> FlowyResult> { + let field_type_rev = field_rev.ty; + let type_option = field_rev.get_type_option_entry::(field_type_rev); + let groups = G::generate_groups(&field_rev.id, &self.configuration, &type_option); + let changeset = self.configuration.merge_groups(groups)?; + Ok(changeset) + } +} + +struct GroupedRow { + row: RowPB, + group_id: String, +} diff --git a/frontend/rust-lib/flowy-grid/src/services/group/group_generator/checkbox_group.rs b/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/checkbox_controller.rs similarity index 59% rename from frontend/rust-lib/flowy-grid/src/services/group/group_generator/checkbox_group.rs rename to frontend/rust-lib/flowy-grid/src/services/group/controller_impls/checkbox_controller.rs index c1284dd659..4c06ba63ce 100644 --- a/frontend/rust-lib/flowy-grid/src/services/group/group_generator/checkbox_group.rs +++ b/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/checkbox_controller.rs @@ -1,29 +1,30 @@ -use crate::entities::{CheckboxGroupConfigurationPB, GroupRowsChangesetPB}; - -use flowy_grid_data_model::revision::{FieldRevision, RowChangeset, RowRevision}; - +use crate::entities::GroupChangesetPB; use crate::services::field::{CheckboxCellData, CheckboxCellDataParser, CheckboxTypeOptionPB, CHECK, UNCHECK}; -use crate::services::group::{GenericGroupController, Group, GroupController, GroupGenerator, Groupable}; +use crate::services::group::action::GroupAction; +use crate::services::group::configuration::GenericGroupConfiguration; +use crate::services::group::controller::{ + GenericGroupController, GroupController, GroupGenerator, MoveGroupRowContext, +}; +use crate::services::group::entities::Group; + +use flowy_grid_data_model::revision::{CheckboxGroupConfigurationRevision, FieldRevision, RowRevision}; pub type CheckboxGroupController = GenericGroupController< - CheckboxGroupConfigurationPB, + CheckboxGroupConfigurationRevision, CheckboxTypeOptionPB, CheckboxGroupGenerator, CheckboxCellDataParser, >; -impl Groupable for CheckboxGroupController { - type CellDataType = CheckboxCellData; +pub type CheckboxGroupConfiguration = GenericGroupConfiguration; +impl GroupAction for CheckboxGroupController { + type CellDataType = CheckboxCellData; fn can_group(&self, _content: &str, _cell_data: &Self::CellDataType) -> bool { false } - fn add_row_if_match( - &mut self, - _row_rev: &RowRevision, - _cell_data: &Self::CellDataType, - ) -> Vec { + fn add_row_if_match(&mut self, _row_rev: &RowRevision, _cell_data: &Self::CellDataType) -> Vec { todo!() } @@ -31,18 +32,11 @@ impl Groupable for CheckboxGroupController { &mut self, _row_rev: &RowRevision, _cell_data: &Self::CellDataType, - ) -> Vec { + ) -> Vec { todo!() } - fn move_row_if_match( - &mut self, - _field_rev: &FieldRevision, - _row_rev: &RowRevision, - _row_changeset: &mut RowChangeset, - _cell_data: &Self::CellDataType, - _to_row_id: &str, - ) -> Vec { + fn move_row(&mut self, _cell_data: &Self::CellDataType, _context: MoveGroupRowContext) -> Vec { todo!() } } @@ -55,12 +49,12 @@ impl GroupController for CheckboxGroupController { pub struct CheckboxGroupGenerator(); impl GroupGenerator for CheckboxGroupGenerator { - type ConfigurationType = CheckboxGroupConfigurationPB; + type ConfigurationType = CheckboxGroupConfiguration; type TypeOptionType = CheckboxTypeOptionPB; fn generate_groups( field_id: &str, - _configuration: &Option, + _configuration: &Self::ConfigurationType, _type_option: &Option, ) -> Vec { let check_group = Group::new( diff --git a/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/mod.rs b/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/mod.rs new file mode 100644 index 0000000000..974f311a48 --- /dev/null +++ b/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/mod.rs @@ -0,0 +1,5 @@ +mod checkbox_controller; +mod select_option_controller; + +pub use checkbox_controller::*; +pub use select_option_controller::*; diff --git a/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/select_option_controller/mod.rs b/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/select_option_controller/mod.rs new file mode 100644 index 0000000000..0d7b8fa03e --- /dev/null +++ b/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/select_option_controller/mod.rs @@ -0,0 +1,7 @@ +mod multi_select_controller; +mod single_select_controller; +mod util; + +pub use multi_select_controller::*; +pub use single_select_controller::*; +pub use util::*; diff --git a/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/select_option_controller/multi_select_controller.rs b/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/select_option_controller/multi_select_controller.rs new file mode 100644 index 0000000000..fe90e1b462 --- /dev/null +++ b/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/select_option_controller/multi_select_controller.rs @@ -0,0 +1,96 @@ +use crate::entities::GroupChangesetPB; +use crate::services::cell::insert_select_option_cell; +use crate::services::field::{MultiSelectTypeOptionPB, SelectOptionCellDataPB, SelectOptionCellDataParser}; +use crate::services::group::action::GroupAction; + +use crate::services::group::controller::{ + GenericGroupController, GroupController, GroupGenerator, MoveGroupRowContext, +}; +use crate::services::group::controller_impls::select_option_controller::util::*; +use crate::services::group::entities::Group; +use flowy_grid_data_model::revision::{FieldRevision, RowRevision, SelectOptionGroupConfigurationRevision}; + +// MultiSelect +pub type MultiSelectGroupController = GenericGroupController< + SelectOptionGroupConfigurationRevision, + MultiSelectTypeOptionPB, + MultiSelectGroupGenerator, + SelectOptionCellDataParser, +>; + +impl GroupAction for MultiSelectGroupController { + type CellDataType = SelectOptionCellDataPB; + + fn can_group(&self, content: &str, cell_data: &SelectOptionCellDataPB) -> bool { + cell_data.select_options.iter().any(|option| option.id == content) + } + + fn add_row_if_match(&mut self, row_rev: &RowRevision, cell_data: &Self::CellDataType) -> Vec { + let mut changesets = vec![]; + self.configuration.iter_mut_groups(|group| { + if let Some(changeset) = add_row(group, cell_data, row_rev) { + changesets.push(changeset); + } + }); + changesets + } + + fn remove_row_if_match(&mut self, row_rev: &RowRevision, cell_data: &Self::CellDataType) -> Vec { + let mut changesets = vec![]; + self.configuration.iter_mut_groups(|group| { + if let Some(changeset) = remove_row(group, cell_data, row_rev) { + changesets.push(changeset); + } + }); + changesets + } + + fn move_row(&mut self, cell_data: &Self::CellDataType, mut context: MoveGroupRowContext) -> Vec { + let mut group_changeset = vec![]; + self.configuration.iter_mut_groups(|group| { + if let Some(changeset) = move_select_option_row(group, cell_data, &mut context) { + group_changeset.push(changeset); + } + }); + group_changeset + } +} + +impl GroupController for MultiSelectGroupController { + fn will_create_row(&mut self, row_rev: &mut RowRevision, field_rev: &FieldRevision, group_id: &str) { + match self.configuration.get_group(group_id) { + None => tracing::warn!("Can not find the group: {}", group_id), + Some((_, group)) => { + let cell_rev = insert_select_option_cell(group.id.clone(), field_rev); + row_rev.cells.insert(field_rev.id.clone(), cell_rev); + } + } + } +} + +pub struct MultiSelectGroupGenerator(); +impl GroupGenerator for MultiSelectGroupGenerator { + type ConfigurationType = SelectOptionGroupConfiguration; + type TypeOptionType = MultiSelectTypeOptionPB; + fn generate_groups( + field_id: &str, + _configuration: &Self::ConfigurationType, + type_option: &Option, + ) -> Vec { + match type_option { + None => vec![], + Some(type_option) => type_option + .options + .iter() + .map(|option| { + Group::new( + option.id.clone(), + field_id.to_owned(), + option.name.clone(), + option.id.clone(), + ) + }) + .collect(), + } + } +} diff --git a/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/select_option_controller/single_select_controller.rs b/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/select_option_controller/single_select_controller.rs new file mode 100644 index 0000000000..d774ab083f --- /dev/null +++ b/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/select_option_controller/single_select_controller.rs @@ -0,0 +1,98 @@ +use crate::entities::{GroupChangesetPB, RowPB}; +use crate::services::cell::insert_select_option_cell; +use crate::services::field::{SelectOptionCellDataPB, SelectOptionCellDataParser, SingleSelectTypeOptionPB}; +use crate::services::group::action::GroupAction; + +use crate::services::group::controller::{ + GenericGroupController, GroupController, GroupGenerator, MoveGroupRowContext, +}; +use crate::services::group::controller_impls::select_option_controller::util::*; +use crate::services::group::entities::Group; + +use flowy_grid_data_model::revision::{FieldRevision, RowRevision, SelectOptionGroupConfigurationRevision}; + +// SingleSelect +pub type SingleSelectGroupController = GenericGroupController< + SelectOptionGroupConfigurationRevision, + SingleSelectTypeOptionPB, + SingleSelectGroupGenerator, + SelectOptionCellDataParser, +>; + +impl GroupAction for SingleSelectGroupController { + type CellDataType = SelectOptionCellDataPB; + fn can_group(&self, content: &str, cell_data: &SelectOptionCellDataPB) -> bool { + cell_data.select_options.iter().any(|option| option.id == content) + } + + fn add_row_if_match(&mut self, row_rev: &RowRevision, cell_data: &Self::CellDataType) -> Vec { + let mut changesets = vec![]; + self.configuration.iter_mut_groups(|group| { + if let Some(changeset) = add_row(group, cell_data, row_rev) { + changesets.push(changeset); + } + }); + changesets + } + + fn remove_row_if_match(&mut self, row_rev: &RowRevision, cell_data: &Self::CellDataType) -> Vec { + let mut changesets = vec![]; + self.configuration.iter_mut_groups(|group| { + if let Some(changeset) = remove_row(group, cell_data, row_rev) { + changesets.push(changeset); + } + }); + changesets + } + + fn move_row(&mut self, cell_data: &Self::CellDataType, mut context: MoveGroupRowContext) -> Vec { + let mut group_changeset = vec![]; + self.configuration.iter_mut_groups(|group| { + if let Some(changeset) = move_select_option_row(group, cell_data, &mut context) { + group_changeset.push(changeset); + } + }); + group_changeset + } +} + +impl GroupController for SingleSelectGroupController { + fn will_create_row(&mut self, row_rev: &mut RowRevision, field_rev: &FieldRevision, group_id: &str) { + let group: Option<&mut Group> = self.configuration.get_mut_group(group_id); + match group { + None => {} + Some(group) => { + let cell_rev = insert_select_option_cell(group.id.clone(), field_rev); + row_rev.cells.insert(field_rev.id.clone(), cell_rev); + group.add_row(RowPB::from(row_rev)); + } + } + } +} + +pub struct SingleSelectGroupGenerator(); +impl GroupGenerator for SingleSelectGroupGenerator { + type ConfigurationType = SelectOptionGroupConfiguration; + type TypeOptionType = SingleSelectTypeOptionPB; + fn generate_groups( + field_id: &str, + _configuration: &Self::ConfigurationType, + type_option: &Option, + ) -> Vec { + match type_option { + None => vec![], + Some(type_option) => type_option + .options + .iter() + .map(|option| { + Group::new( + option.id.clone(), + field_id.to_owned(), + option.name.clone(), + option.id.clone(), + ) + }) + .collect(), + } + } +} diff --git a/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/select_option_controller/util.rs b/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/select_option_controller/util.rs new file mode 100644 index 0000000000..349f7391a6 --- /dev/null +++ b/frontend/rust-lib/flowy-grid/src/services/group/controller_impls/select_option_controller/util.rs @@ -0,0 +1,120 @@ +use crate::entities::{GroupChangesetPB, InsertedRowPB, RowPB}; +use crate::services::cell::insert_select_option_cell; +use crate::services::field::SelectOptionCellDataPB; +use crate::services::group::configuration::GenericGroupConfiguration; +use crate::services::group::Group; + +use crate::services::group::controller::MoveGroupRowContext; +use flowy_grid_data_model::revision::{RowRevision, SelectOptionGroupConfigurationRevision}; + +pub type SelectOptionGroupConfiguration = GenericGroupConfiguration; + +pub fn add_row( + group: &mut Group, + cell_data: &SelectOptionCellDataPB, + row_rev: &RowRevision, +) -> Option { + let mut changeset = GroupChangesetPB::new(group.id.clone()); + cell_data.select_options.iter().for_each(|option| { + if option.id == group.id { + if !group.contains_row(&row_rev.id) { + let row_pb = RowPB::from(row_rev); + changeset.inserted_rows.push(InsertedRowPB::new(row_pb.clone())); + group.add_row(row_pb); + } + } else if group.contains_row(&row_rev.id) { + changeset.deleted_rows.push(row_rev.id.clone()); + group.remove_row(&row_rev.id); + } + }); + + if changeset.is_empty() { + None + } else { + Some(changeset) + } +} + +pub fn remove_row( + group: &mut Group, + cell_data: &SelectOptionCellDataPB, + row_rev: &RowRevision, +) -> Option { + let mut changeset = GroupChangesetPB::new(group.id.clone()); + cell_data.select_options.iter().for_each(|option| { + if option.id == group.id && group.contains_row(&row_rev.id) { + changeset.deleted_rows.push(row_rev.id.clone()); + group.remove_row(&row_rev.id); + } + }); + + if changeset.is_empty() { + None + } else { + Some(changeset) + } +} + +pub fn move_select_option_row( + group: &mut Group, + _cell_data: &SelectOptionCellDataPB, + context: &mut MoveGroupRowContext, +) -> Option { + let mut changeset = GroupChangesetPB::new(group.id.clone()); + let MoveGroupRowContext { + row_rev, + row_changeset, + field_rev, + to_group_id, + to_row_id, + } = context; + + let from_index = group.index_of_row(&row_rev.id); + let to_index = match to_row_id { + None => None, + Some(to_row_id) => group.index_of_row(to_row_id), + }; + + // Remove the row in which group contains it + if from_index.is_some() { + changeset.deleted_rows.push(row_rev.id.clone()); + tracing::debug!("Group:{} remove row:{}", group.id, row_rev.id); + group.remove_row(&row_rev.id); + } + + if group.id == *to_group_id { + let row_pb = RowPB::from(*row_rev); + let mut inserted_row = InsertedRowPB::new(row_pb.clone()); + match to_index { + None => { + changeset.inserted_rows.push(inserted_row); + tracing::debug!("Group:{} append row:{}", group.id, row_rev.id); + group.add_row(row_pb); + } + Some(to_index) => { + if to_index < group.number_of_row() { + tracing::debug!("Group:{} insert row:{} at {} ", group.id, row_rev.id, to_index); + inserted_row.index = Some(to_index as i32); + group.insert_row(to_index, row_pb); + } else { + tracing::debug!("Group:{} append row:{}", group.id, row_rev.id); + group.add_row(row_pb); + } + changeset.inserted_rows.push(inserted_row); + } + } + + // Update the corresponding row's cell content. + if from_index.is_none() { + tracing::debug!("Mark row:{} belong to group:{}", row_rev.id, group.id); + let cell_rev = insert_select_option_cell(group.id.clone(), field_rev); + row_changeset.cell_by_field_id.insert(field_rev.id.clone(), cell_rev); + changeset.updated_rows.push(RowPB::from(*row_rev)); + } + } + if changeset.is_empty() { + None + } else { + Some(changeset) + } +} diff --git a/frontend/rust-lib/flowy-grid/src/services/group/entities.rs b/frontend/rust-lib/flowy-grid/src/services/group/entities.rs new file mode 100644 index 0000000000..f4d0ee1652 --- /dev/null +++ b/frontend/rust-lib/flowy-grid/src/services/group/entities.rs @@ -0,0 +1,66 @@ +use crate::entities::RowPB; + +#[derive(Clone, PartialEq, Eq)] +pub struct Group { + pub id: String, + pub field_id: String, + pub name: String, + pub(crate) rows: Vec, + + /// [content] is used to determine which group the cell belongs to. + pub content: String, +} + +impl Group { + pub fn new(id: String, field_id: String, name: String, content: String) -> Self { + Self { + id, + field_id, + name, + rows: vec![], + content, + } + } + + pub fn contains_row(&self, row_id: &str) -> bool { + self.rows.iter().any(|row| row.id == row_id) + } + + pub fn remove_row(&mut self, row_id: &str) { + match self.rows.iter().position(|row| row.id == row_id) { + None => {} + Some(pos) => { + self.rows.remove(pos); + } + } + } + + pub fn add_row(&mut self, row_pb: RowPB) { + match self.rows.iter().find(|row| row.id == row_pb.id) { + None => { + self.rows.push(row_pb); + } + Some(_) => {} + } + } + + pub fn insert_row(&mut self, index: usize, row_pb: RowPB) { + if index < self.rows.len() { + self.rows.insert(index, row_pb); + } else { + tracing::error!("Insert row index:{} beyond the bounds:{},", index, self.rows.len()); + } + } + + pub fn index_of_row(&self, row_id: &str) -> Option { + self.rows.iter().position(|row| row.id == row_id) + } + + pub fn number_of_row(&self) -> usize { + self.rows.len() + } + + pub fn is_empty(&self) -> bool { + self.rows.is_empty() + } +} diff --git a/frontend/rust-lib/flowy-grid/src/services/group/group_generator/group_controller.rs b/frontend/rust-lib/flowy-grid/src/services/group/group_generator/group_controller.rs deleted file mode 100644 index a1d5df2154..0000000000 --- a/frontend/rust-lib/flowy-grid/src/services/group/group_generator/group_controller.rs +++ /dev/null @@ -1,296 +0,0 @@ -use crate::entities::{GroupPB, GroupRowsChangesetPB, RowPB}; -use crate::services::cell::{decode_any_cell_data, CellBytesParser}; -use bytes::Bytes; -use flowy_error::FlowyResult; -use flowy_grid_data_model::revision::{ - FieldRevision, GroupConfigurationRevision, RowChangeset, RowRevision, TypeOptionDataDeserializer, -}; -use indexmap::IndexMap; -use std::marker::PhantomData; -use std::sync::Arc; - -pub trait GroupGenerator { - type ConfigurationType; - type TypeOptionType; - - fn generate_groups( - field_id: &str, - configuration: &Option, - type_option: &Option, - ) -> Vec; -} - -pub trait Groupable: Send + Sync { - type CellDataType; - fn can_group(&self, content: &str, cell_data: &Self::CellDataType) -> bool; - fn add_row_if_match(&mut self, row_rev: &RowRevision, cell_data: &Self::CellDataType) -> Vec; - fn remove_row_if_match( - &mut self, - row_rev: &RowRevision, - cell_data: &Self::CellDataType, - ) -> Vec; - - fn move_row_if_match( - &mut self, - field_rev: &FieldRevision, - row_rev: &RowRevision, - row_changeset: &mut RowChangeset, - cell_data: &Self::CellDataType, - to_row_id: &str, - ) -> Vec; -} - -pub trait GroupController: GroupControllerSharedAction + Send + Sync { - fn will_create_row(&mut self, row_rev: &mut RowRevision, field_rev: &FieldRevision, group_id: &str); -} - -pub trait GroupControllerSharedAction: Send + Sync { - // The field that is used for grouping the rows - fn field_id(&self) -> &str; - fn groups(&self) -> Vec; - fn group_rows(&mut self, row_revs: &[Arc], field_rev: &FieldRevision) -> FlowyResult<()>; - fn did_update_row( - &mut self, - row_rev: &RowRevision, - field_rev: &FieldRevision, - ) -> FlowyResult>; - - fn did_delete_row( - &mut self, - row_rev: &RowRevision, - field_rev: &FieldRevision, - ) -> FlowyResult>; - - fn did_move_row( - &mut self, - row_rev: &RowRevision, - row_changeset: &mut RowChangeset, - field_rev: &FieldRevision, - to_row_id: &str, - ) -> FlowyResult>; -} - -const DEFAULT_GROUP_ID: &str = "default_group"; - -/// C: represents the group configuration structure -/// T: the type option data deserializer that impl [TypeOptionDataDeserializer] -/// G: the group generator, [GroupGenerator] -/// P: the parser that impl [CellBytesParser] for the CellBytes -pub struct GenericGroupController { - pub field_id: String, - pub groups_map: IndexMap, - default_group: Group, - pub type_option: Option, - pub configuration: Option, - group_action_phantom: PhantomData, - cell_parser_phantom: PhantomData

, -} - -#[derive(Clone)] -pub struct Group { - pub id: String, - pub field_id: String, - pub desc: String, - rows: Vec, - pub content: String, -} - -impl std::convert::From for GroupPB { - fn from(group: Group) -> Self { - Self { - field_id: group.field_id, - group_id: group.id, - desc: group.desc, - rows: group.rows, - } - } -} - -impl Group { - pub fn new(id: String, field_id: String, desc: String, content: String) -> Self { - Self { - id, - field_id, - desc, - rows: vec![], - content, - } - } - - pub fn contains_row(&self, row_id: &str) -> bool { - self.rows.iter().any(|row| row.id == row_id) - } - - pub fn remove_row(&mut self, row_id: &str) { - match self.rows.iter().position(|row| row.id == row_id) { - None => {} - Some(pos) => { - self.rows.remove(pos); - } - } - } - - pub fn add_row(&mut self, row_pb: RowPB) { - match self.rows.iter().find(|row| row.id == row_pb.id) { - None => { - self.rows.push(row_pb); - } - Some(_) => {} - } - } - - pub fn insert_row(&mut self, index: usize, row_pb: RowPB) { - if index < self.rows.len() { - self.rows.insert(index, row_pb); - } else { - tracing::error!("Insert row index:{} beyond the bounds:{},", index, self.rows.len()); - } - } - - pub fn index_of_row(&self, row_id: &str) -> Option { - self.rows.iter().position(|row| row.id == row_id) - } - - pub fn number_of_row(&self) -> usize { - self.rows.len() - } -} - -impl GenericGroupController -where - C: TryFrom, - T: TypeOptionDataDeserializer, - G: GroupGenerator, -{ - pub fn new(field_rev: &Arc, configuration: GroupConfigurationRevision) -> FlowyResult { - let configuration = match configuration.content { - None => None, - Some(content) => Some(C::try_from(Bytes::from(content))?), - }; - let field_type_rev = field_rev.ty; - let type_option = field_rev.get_type_option_entry::(field_type_rev); - let groups = G::generate_groups(&field_rev.id, &configuration, &type_option); - - let default_group = Group::new( - DEFAULT_GROUP_ID.to_owned(), - field_rev.id.clone(), - format!("No {}", field_rev.name), - "".to_string(), - ); - - Ok(Self { - field_id: field_rev.id.clone(), - groups_map: groups.into_iter().map(|group| (group.id.clone(), group)).collect(), - default_group, - type_option, - configuration, - group_action_phantom: PhantomData, - cell_parser_phantom: PhantomData, - }) - } -} - -impl GroupControllerSharedAction for GenericGroupController -where - P: CellBytesParser, - Self: Groupable, -{ - fn field_id(&self) -> &str { - &self.field_id - } - - fn groups(&self) -> Vec { - let default_group = self.default_group.clone(); - let mut groups: Vec = self.groups_map.values().cloned().collect(); - if !default_group.rows.is_empty() { - groups.push(default_group); - } - groups - } - - fn group_rows(&mut self, row_revs: &[Arc], field_rev: &FieldRevision) -> FlowyResult<()> { - if self.configuration.is_none() { - return Ok(()); - } - - for row_rev in row_revs { - if let Some(cell_rev) = row_rev.cells.get(&self.field_id) { - let mut records: Vec = vec![]; - let cell_bytes = decode_any_cell_data(cell_rev.data.clone(), field_rev); - let cell_data = cell_bytes.parser::

()?; - for group in self.groups_map.values() { - if self.can_group(&group.content, &cell_data) { - records.push(GroupRecord { - row: row_rev.into(), - group_id: group.id.clone(), - }); - } - } - - if records.is_empty() { - self.default_group.rows.push(row_rev.into()); - } else { - for record in records { - if let Some(group) = self.groups_map.get_mut(&record.group_id) { - group.rows.push(record.row); - } - } - } - } else { - self.default_group.rows.push(row_rev.into()); - } - } - - Ok(()) - } - - fn did_update_row( - &mut self, - row_rev: &RowRevision, - field_rev: &FieldRevision, - ) -> FlowyResult> { - if let Some(cell_rev) = row_rev.cells.get(&self.field_id) { - let cell_bytes = decode_any_cell_data(cell_rev.data.clone(), field_rev); - let cell_data = cell_bytes.parser::

()?; - Ok(self.add_row_if_match(row_rev, &cell_data)) - } else { - Ok(vec![]) - } - } - - fn did_delete_row( - &mut self, - row_rev: &RowRevision, - field_rev: &FieldRevision, - ) -> FlowyResult> { - if let Some(cell_rev) = row_rev.cells.get(&self.field_id) { - let cell_bytes = decode_any_cell_data(cell_rev.data.clone(), field_rev); - let cell_data = cell_bytes.parser::

()?; - Ok(self.remove_row_if_match(row_rev, &cell_data)) - } else { - Ok(vec![]) - } - } - - fn did_move_row( - &mut self, - row_rev: &RowRevision, - row_changeset: &mut RowChangeset, - field_rev: &FieldRevision, - to_row_id: &str, - ) -> FlowyResult> { - if let Some(cell_rev) = row_rev.cells.get(&self.field_id) { - let cell_bytes = decode_any_cell_data(cell_rev.data.clone(), field_rev); - let cell_data = cell_bytes.parser::

()?; - tracing::trace!("Move row:{} to row:{}", row_rev.id, to_row_id); - Ok(self.move_row_if_match(field_rev, row_rev, row_changeset, &cell_data, to_row_id)) - } else { - Ok(vec![]) - } - } -} - -struct GroupRecord { - row: RowPB, - group_id: String, -} diff --git a/frontend/rust-lib/flowy-grid/src/services/group/group_generator/mod.rs b/frontend/rust-lib/flowy-grid/src/services/group/group_generator/mod.rs deleted file mode 100644 index 08e691a75e..0000000000 --- a/frontend/rust-lib/flowy-grid/src/services/group/group_generator/mod.rs +++ /dev/null @@ -1,7 +0,0 @@ -mod checkbox_group; -mod group_controller; -mod select_option_group; - -pub use checkbox_group::*; -pub use group_controller::*; -pub use select_option_group::*; diff --git a/frontend/rust-lib/flowy-grid/src/services/group/group_generator/select_option_group.rs b/frontend/rust-lib/flowy-grid/src/services/group/group_generator/select_option_group.rs deleted file mode 100644 index 6e569a7b54..0000000000 --- a/frontend/rust-lib/flowy-grid/src/services/group/group_generator/select_option_group.rs +++ /dev/null @@ -1,287 +0,0 @@ -use crate::entities::{GroupRowsChangesetPB, InsertedRowPB, RowPB, SelectOptionGroupConfigurationPB}; -use crate::services::cell::insert_select_option_cell; -use crate::services::field::{ - MultiSelectTypeOptionPB, SelectOptionCellDataPB, SelectOptionCellDataParser, SingleSelectTypeOptionPB, -}; -use crate::services::group::{GenericGroupController, Group, GroupController, GroupGenerator, Groupable}; - -use flowy_grid_data_model::revision::{FieldRevision, RowChangeset, RowRevision}; - -// SingleSelect -pub type SingleSelectGroupController = GenericGroupController< - SelectOptionGroupConfigurationPB, - SingleSelectTypeOptionPB, - SingleSelectGroupGenerator, - SelectOptionCellDataParser, ->; - -impl Groupable for SingleSelectGroupController { - type CellDataType = SelectOptionCellDataPB; - fn can_group(&self, content: &str, cell_data: &SelectOptionCellDataPB) -> bool { - cell_data.select_options.iter().any(|option| option.id == content) - } - - fn add_row_if_match(&mut self, row_rev: &RowRevision, cell_data: &Self::CellDataType) -> Vec { - let mut changesets = vec![]; - self.groups_map.iter_mut().for_each(|(_, group): (_, &mut Group)| { - add_row(group, &mut changesets, cell_data, row_rev); - }); - changesets - } - - fn remove_row_if_match( - &mut self, - row_rev: &RowRevision, - cell_data: &Self::CellDataType, - ) -> Vec { - let mut changesets = vec![]; - self.groups_map.iter_mut().for_each(|(_, group): (_, &mut Group)| { - remove_row(group, &mut changesets, cell_data, row_rev); - }); - changesets - } - - fn move_row_if_match( - &mut self, - field_rev: &FieldRevision, - row_rev: &RowRevision, - row_changeset: &mut RowChangeset, - cell_data: &Self::CellDataType, - to_row_id: &str, - ) -> Vec { - let mut group_changeset = vec![]; - self.groups_map.iter_mut().for_each(|(_, group): (_, &mut Group)| { - move_row( - group, - &mut group_changeset, - field_rev, - row_rev, - row_changeset, - cell_data, - to_row_id, - ); - }); - group_changeset - } -} - -impl GroupController for SingleSelectGroupController { - fn will_create_row(&mut self, row_rev: &mut RowRevision, field_rev: &FieldRevision, group_id: &str) { - let group: Option<&mut Group> = self.groups_map.get_mut(group_id); - match group { - None => {} - Some(group) => { - let cell_rev = insert_select_option_cell(group.id.clone(), field_rev); - row_rev.cells.insert(field_rev.id.clone(), cell_rev); - group.add_row(RowPB::from(row_rev)); - } - } - } -} - -pub struct SingleSelectGroupGenerator(); -impl GroupGenerator for SingleSelectGroupGenerator { - type ConfigurationType = SelectOptionGroupConfigurationPB; - type TypeOptionType = SingleSelectTypeOptionPB; - fn generate_groups( - field_id: &str, - _configuration: &Option, - type_option: &Option, - ) -> Vec { - match type_option { - None => vec![], - Some(type_option) => type_option - .options - .iter() - .map(|option| { - Group::new( - option.id.clone(), - field_id.to_owned(), - option.name.clone(), - option.id.clone(), - ) - }) - .collect(), - } - } -} - -// MultiSelect -pub type MultiSelectGroupController = GenericGroupController< - SelectOptionGroupConfigurationPB, - MultiSelectTypeOptionPB, - MultiSelectGroupGenerator, - SelectOptionCellDataParser, ->; - -impl Groupable for MultiSelectGroupController { - type CellDataType = SelectOptionCellDataPB; - - fn can_group(&self, content: &str, cell_data: &SelectOptionCellDataPB) -> bool { - cell_data.select_options.iter().any(|option| option.id == content) - } - - fn add_row_if_match(&mut self, row_rev: &RowRevision, cell_data: &Self::CellDataType) -> Vec { - let mut changesets = vec![]; - self.groups_map.iter_mut().for_each(|(_, group): (_, &mut Group)| { - add_row(group, &mut changesets, cell_data, row_rev); - }); - changesets - } - - fn remove_row_if_match( - &mut self, - row_rev: &RowRevision, - cell_data: &Self::CellDataType, - ) -> Vec { - let mut changesets = vec![]; - self.groups_map.iter_mut().for_each(|(_, group): (_, &mut Group)| { - remove_row(group, &mut changesets, cell_data, row_rev); - }); - changesets - } - - fn move_row_if_match( - &mut self, - field_rev: &FieldRevision, - row_rev: &RowRevision, - row_changeset: &mut RowChangeset, - cell_data: &Self::CellDataType, - to_row_id: &str, - ) -> Vec { - let mut group_changeset = vec![]; - self.groups_map.iter_mut().for_each(|(_, group): (_, &mut Group)| { - move_row( - group, - &mut group_changeset, - field_rev, - row_rev, - row_changeset, - cell_data, - to_row_id, - ); - }); - group_changeset - } -} - -impl GroupController for MultiSelectGroupController { - fn will_create_row(&mut self, row_rev: &mut RowRevision, field_rev: &FieldRevision, group_id: &str) { - let group: Option<&Group> = self.groups_map.get(group_id); - match group { - None => tracing::warn!("Can not find the group: {}", group_id), - Some(group) => { - let cell_rev = insert_select_option_cell(group.id.clone(), field_rev); - row_rev.cells.insert(field_rev.id.clone(), cell_rev); - } - } - } -} - -pub struct MultiSelectGroupGenerator(); -impl GroupGenerator for MultiSelectGroupGenerator { - type ConfigurationType = SelectOptionGroupConfigurationPB; - type TypeOptionType = MultiSelectTypeOptionPB; - - fn generate_groups( - field_id: &str, - _configuration: &Option, - type_option: &Option, - ) -> Vec { - match type_option { - None => vec![], - Some(type_option) => type_option - .options - .iter() - .map(|option| { - Group::new( - option.id.clone(), - field_id.to_owned(), - option.name.clone(), - option.id.clone(), - ) - }) - .collect(), - } - } -} - -fn add_row( - group: &mut Group, - changesets: &mut Vec, - cell_data: &SelectOptionCellDataPB, - row_rev: &RowRevision, -) { - cell_data.select_options.iter().for_each(|option| { - if option.id == group.id { - if !group.contains_row(&row_rev.id) { - let row_pb = RowPB::from(row_rev); - changesets.push(GroupRowsChangesetPB::insert( - group.id.clone(), - vec![InsertedRowPB::new(row_pb.clone())], - )); - group.add_row(row_pb); - } - } else if group.contains_row(&row_rev.id) { - changesets.push(GroupRowsChangesetPB::delete(group.id.clone(), vec![row_rev.id.clone()])); - group.remove_row(&row_rev.id); - } - }); -} - -fn remove_row( - group: &mut Group, - changesets: &mut Vec, - cell_data: &SelectOptionCellDataPB, - row_rev: &RowRevision, -) { - cell_data.select_options.iter().for_each(|option| { - if option.id == group.id && group.contains_row(&row_rev.id) { - changesets.push(GroupRowsChangesetPB::delete(group.id.clone(), vec![row_rev.id.clone()])); - group.remove_row(&row_rev.id); - } - }); -} - -fn move_row( - group: &mut Group, - group_changeset: &mut Vec, - field_rev: &FieldRevision, - row_rev: &RowRevision, - row_changeset: &mut RowChangeset, - cell_data: &SelectOptionCellDataPB, - to_row_id: &str, -) { - cell_data.select_options.iter().for_each(|option| { - // Remove the row in which group contains the row - let is_group_contains = group.contains_row(&row_rev.id); - let to_index = group.index_of_row(to_row_id); - - if option.id == group.id && is_group_contains { - group_changeset.push(GroupRowsChangesetPB::delete(group.id.clone(), vec![row_rev.id.clone()])); - group.remove_row(&row_rev.id); - } - - // Find the inserted group - if let Some(to_index) = to_index { - let row_pb = RowPB::from(row_rev); - let inserted_row = InsertedRowPB { - row: row_pb.clone(), - index: Some(to_index as i32), - }; - group_changeset.push(GroupRowsChangesetPB::insert(group.id.clone(), vec![inserted_row])); - if group.number_of_row() == to_index { - group.add_row(row_pb); - } else { - group.insert_row(to_index, row_pb); - } - } - - // If the inserted row comes from other group, it needs to update the corresponding cell content. - if to_index.is_some() && option.id != group.id { - // Update the corresponding row's cell content. - let cell_rev = insert_select_option_cell(group.id.clone(), field_rev); - row_changeset.cell_by_field_id.insert(field_rev.id.clone(), cell_rev); - } - }); -} diff --git a/frontend/rust-lib/flowy-grid/src/services/group/group_service.rs b/frontend/rust-lib/flowy-grid/src/services/group/group_service.rs index 0e152bf27c..c7d67f65d6 100644 --- a/frontend/rust-lib/flowy-grid/src/services/group/group_service.rs +++ b/frontend/rust-lib/flowy-grid/src/services/group/group_service.rs @@ -1,43 +1,51 @@ -use crate::entities::{ - CheckboxGroupConfigurationPB, DateGroupConfigurationPB, FieldType, GroupRowsChangesetPB, - NumberGroupConfigurationPB, SelectOptionGroupConfigurationPB, TextGroupConfigurationPB, UrlGroupConfigurationPB, -}; +use crate::entities::{FieldType, GroupChangesetPB, GroupViewChangesetPB}; +use crate::services::group::configuration::GroupConfigurationReader; +use crate::services::group::controller::{GroupController, MoveGroupRowContext}; use crate::services::group::{ - CheckboxGroupController, Group, GroupController, MultiSelectGroupController, SingleSelectGroupController, + CheckboxGroupConfiguration, CheckboxGroupController, Group, GroupConfigurationWriter, MultiSelectGroupController, + SelectOptionGroupConfiguration, SingleSelectGroupController, }; -use bytes::Bytes; use flowy_error::FlowyResult; use flowy_grid_data_model::revision::{ - gen_grid_group_id, FieldRevision, GroupConfigurationRevision, RowChangeset, RowRevision, + CheckboxGroupConfigurationRevision, DateGroupConfigurationRevision, FieldRevision, GroupConfigurationRevision, + NumberGroupConfigurationRevision, RowChangeset, RowRevision, SelectOptionGroupConfigurationRevision, + TextGroupConfigurationRevision, UrlGroupConfigurationRevision, }; -use lib_infra::future::AFFuture; use std::future::Future; use std::sync::Arc; -use tokio::sync::RwLock; - -pub trait GroupConfigurationDelegate: Send + Sync + 'static { - fn get_group_configuration(&self, field_rev: Arc) -> AFFuture; -} pub(crate) struct GroupService { - delegate: Box, - group_controller: Option>>, + view_id: String, + configuration_reader: Arc, + configuration_writer: Arc, + group_controller: Option>, } impl GroupService { - pub(crate) async fn new(delegate: Box) -> Self { + pub(crate) async fn new(view_id: String, configuration_reader: R, configuration_writer: W) -> Self + where + R: GroupConfigurationReader, + W: GroupConfigurationWriter, + { Self { - delegate, + view_id, + configuration_reader: Arc::new(configuration_reader), + configuration_writer: Arc::new(configuration_writer), group_controller: None, } } pub(crate) async fn groups(&self) -> Vec { - if let Some(group_action_handler) = self.group_controller.as_ref() { - group_action_handler.read().await.groups() - } else { - vec![] - } + self.group_controller + .as_ref() + .map(|group_controller| group_controller.groups()) + .unwrap_or_default() + } + + pub(crate) async fn get_group(&self, group_id: &str) -> Option<(usize, Group)> { + self.group_controller + .as_ref() + .and_then(|group_controller| group_controller.get_group(group_id)) } pub(crate) async fn load_groups( @@ -47,49 +55,49 @@ impl GroupService { ) -> Option> { let field_rev = find_group_field(field_revs)?; let field_type: FieldType = field_rev.ty.into(); - let configuration = self.delegate.get_group_configuration(field_rev.clone()).await; - match self - .build_groups(&field_type, &field_rev, row_revs, configuration) - .await - { - Ok(groups) => Some(groups), - Err(_) => None, - } + + let mut group_controller = self.make_group_controller(&field_type, &field_rev).await.ok()??; + let groups = match group_controller.fill_groups(&row_revs, &field_rev) { + Ok(groups) => groups, + Err(e) => { + tracing::error!("Fill groups failed:{:?}", e); + vec![] + } + }; + self.group_controller = Some(group_controller); + Some(groups) } - pub(crate) async fn will_create_row(&self, row_rev: &mut RowRevision, group_id: &str, get_field_fn: F) + pub(crate) async fn will_create_row(&mut self, row_rev: &mut RowRevision, group_id: &str, get_field_fn: F) where F: FnOnce(String) -> O, O: Future>> + Send + Sync + 'static, { - if let Some(group_controller) = self.group_controller.as_ref() { - let field_id = group_controller.read().await.field_id().to_owned(); + if let Some(group_controller) = self.group_controller.as_mut() { + let field_id = group_controller.field_id().to_owned(); match get_field_fn(field_id).await { None => {} Some(field_rev) => { - group_controller - .write() - .await - .will_create_row(row_rev, &field_rev, group_id); + group_controller.will_create_row(row_rev, &field_rev, group_id); } } } } pub(crate) async fn did_delete_row( - &self, + &mut self, row_rev: &RowRevision, get_field_fn: F, - ) -> Option> + ) -> Option> where F: FnOnce(String) -> O, O: Future>> + Send + Sync + 'static, { - let group_controller = self.group_controller.as_ref()?; - let field_id = group_controller.read().await.field_id().to_owned(); + let group_controller = self.group_controller.as_mut()?; + let field_id = group_controller.field_id().to_owned(); let field_rev = get_field_fn(field_id).await?; - match group_controller.write().await.did_delete_row(row_rev, &field_rev) { + match group_controller.did_delete_row(row_rev, &field_rev) { Ok(changesets) => Some(changesets), Err(e) => { tracing::error!("Delete group data failed, {:?}", e); @@ -98,26 +106,30 @@ impl GroupService { } } - pub(crate) async fn did_move_row( - &self, + pub(crate) async fn move_group_row( + &mut self, row_rev: &RowRevision, row_changeset: &mut RowChangeset, - upper_row_id: &str, + to_group_id: &str, + to_row_id: Option, get_field_fn: F, - ) -> Option> + ) -> Option> where F: FnOnce(String) -> O, O: Future>> + Send + Sync + 'static, { - let group_controller = self.group_controller.as_ref()?; - let field_id = group_controller.read().await.field_id().to_owned(); + let group_controller = self.group_controller.as_mut()?; + let field_id = group_controller.field_id().to_owned(); let field_rev = get_field_fn(field_id).await?; + let move_row_context = MoveGroupRowContext { + row_rev, + row_changeset, + field_rev: field_rev.as_ref(), + to_group_id, + to_row_id, + }; - match group_controller - .write() - .await - .did_move_row(row_rev, row_changeset, &field_rev, upper_row_id) - { + match group_controller.move_group_row(move_row_context) { Ok(changesets) => Some(changesets), Err(e) => { tracing::error!("Move group data failed, {:?}", e); @@ -128,19 +140,19 @@ impl GroupService { #[tracing::instrument(level = "trace", skip_all)] pub(crate) async fn did_update_row( - &self, + &mut self, row_rev: &RowRevision, get_field_fn: F, - ) -> Option> + ) -> Option> where F: FnOnce(String) -> O, O: Future>> + Send + Sync + 'static, { - let group_controller = self.group_controller.as_ref()?; - let field_id = group_controller.read().await.field_id().to_owned(); + let group_controller = self.group_controller.as_mut()?; + let field_id = group_controller.field_id().to_owned(); let field_rev = get_field_fn(field_id).await?; - match group_controller.write().await.did_update_row(row_rev, &field_rev) { + match group_controller.did_update_row(row_rev, &field_rev) { Ok(changeset) => Some(changeset), Err(e) => { tracing::error!("Update group data failed, {:?}", e); @@ -149,14 +161,35 @@ impl GroupService { } } - #[tracing::instrument(level = "trace", skip_all, err)] - async fn build_groups( + #[tracing::instrument(level = "trace", skip_all)] + pub(crate) async fn move_group(&mut self, from_group_id: &str, to_group_id: &str) -> FlowyResult<()> { + match self.group_controller.as_mut() { + None => Ok(()), + Some(group_controller) => { + let _ = group_controller.move_group(from_group_id, to_group_id)?; + Ok(()) + } + } + } + + #[tracing::instrument(level = "trace", name = "group_did_update_field", skip(self, field_rev), err)] + pub(crate) async fn did_update_field( &mut self, + field_rev: &FieldRevision, + ) -> FlowyResult> { + match self.group_controller.as_mut() { + None => Ok(None), + Some(group_controller) => group_controller.did_update_field(field_rev), + } + } + + #[tracing::instrument(level = "trace", skip(self, field_rev), err)] + async fn make_group_controller( + &self, field_type: &FieldType, field_rev: &Arc, - row_revs: Vec>, - configuration: GroupConfigurationRevision, - ) -> FlowyResult> { + ) -> FlowyResult>> { + let mut group_controller: Option> = None; match field_type { FieldType::RichText => { // let generator = GroupGenerator::::from_configuration(configuration); @@ -168,31 +201,43 @@ impl GroupService { // let generator = GroupGenerator::::from_configuration(configuration); } FieldType::SingleSelect => { - let controller = SingleSelectGroupController::new(field_rev, configuration)?; - self.group_controller = Some(Arc::new(RwLock::new(controller))); + let configuration = SelectOptionGroupConfiguration::new( + self.view_id.clone(), + field_rev.clone(), + self.configuration_reader.clone(), + self.configuration_writer.clone(), + ) + .await?; + let controller = SingleSelectGroupController::new(field_rev, configuration).await?; + group_controller = Some(Box::new(controller)); } FieldType::MultiSelect => { - let controller = MultiSelectGroupController::new(field_rev, configuration)?; - self.group_controller = Some(Arc::new(RwLock::new(controller))); + let configuration = SelectOptionGroupConfiguration::new( + self.view_id.clone(), + field_rev.clone(), + self.configuration_reader.clone(), + self.configuration_writer.clone(), + ) + .await?; + let controller = MultiSelectGroupController::new(field_rev, configuration).await?; + group_controller = Some(Box::new(controller)); } FieldType::Checkbox => { - let controller = CheckboxGroupController::new(field_rev, configuration)?; - self.group_controller = Some(Arc::new(RwLock::new(controller))); + let configuration = CheckboxGroupConfiguration::new( + self.view_id.clone(), + field_rev.clone(), + self.configuration_reader.clone(), + self.configuration_writer.clone(), + ) + .await?; + let controller = CheckboxGroupController::new(field_rev, configuration).await?; + group_controller = Some(Box::new(controller)); } FieldType::URL => { // let generator = GroupGenerator::::from_configuration(configuration); } - }; - - let mut groups = vec![]; - if let Some(group_action_handler) = self.group_controller.as_ref() { - let mut write_guard = group_action_handler.write().await; - let _ = write_guard.group_rows(&row_revs, field_rev)?; - groups = write_guard.groups(); - drop(write_guard); } - - Ok(groups) + Ok(group_controller) } } @@ -208,20 +253,41 @@ fn find_group_field(field_revs: &[Arc]) -> Option GroupConfigurationRevision { + let field_id = field_rev.id.clone(); + let field_type_rev = field_rev.ty; let field_type: FieldType = field_rev.ty.into(); - let bytes: Bytes = match field_type { - FieldType::RichText => TextGroupConfigurationPB::default().try_into().unwrap(), - FieldType::Number => NumberGroupConfigurationPB::default().try_into().unwrap(), - FieldType::DateTime => DateGroupConfigurationPB::default().try_into().unwrap(), - FieldType::SingleSelect => SelectOptionGroupConfigurationPB::default().try_into().unwrap(), - FieldType::MultiSelect => SelectOptionGroupConfigurationPB::default().try_into().unwrap(), - FieldType::Checkbox => CheckboxGroupConfigurationPB::default().try_into().unwrap(), - FieldType::URL => UrlGroupConfigurationPB::default().try_into().unwrap(), - }; - GroupConfigurationRevision { - id: gen_grid_group_id(), - field_id: field_rev.id.clone(), - field_type_rev: field_rev.ty, - content: Some(bytes.to_vec()), + match field_type { + FieldType::RichText => { + GroupConfigurationRevision::new(field_id, field_type_rev, TextGroupConfigurationRevision::default()) + .unwrap() + } + FieldType::Number => { + GroupConfigurationRevision::new(field_id, field_type_rev, NumberGroupConfigurationRevision::default()) + .unwrap() + } + FieldType::DateTime => { + GroupConfigurationRevision::new(field_id, field_type_rev, DateGroupConfigurationRevision::default()) + .unwrap() + } + + FieldType::SingleSelect => GroupConfigurationRevision::new( + field_id, + field_type_rev, + SelectOptionGroupConfigurationRevision::default(), + ) + .unwrap(), + FieldType::MultiSelect => GroupConfigurationRevision::new( + field_id, + field_type_rev, + SelectOptionGroupConfigurationRevision::default(), + ) + .unwrap(), + FieldType::Checkbox => { + GroupConfigurationRevision::new(field_id, field_type_rev, CheckboxGroupConfigurationRevision::default()) + .unwrap() + } + FieldType::URL => { + GroupConfigurationRevision::new(field_id, field_type_rev, UrlGroupConfigurationRevision::default()).unwrap() + } } } diff --git a/frontend/rust-lib/flowy-grid/src/services/group/mod.rs b/frontend/rust-lib/flowy-grid/src/services/group/mod.rs index 15b401f4c0..2bc979c28d 100644 --- a/frontend/rust-lib/flowy-grid/src/services/group/mod.rs +++ b/frontend/rust-lib/flowy-grid/src/services/group/mod.rs @@ -1,5 +1,11 @@ -mod group_generator; +mod action; +mod configuration; +mod controller; +mod controller_impls; +mod entities; mod group_service; -pub(crate) use group_generator::*; +pub(crate) use configuration::*; +pub(crate) use controller_impls::*; +pub(crate) use entities::*; pub(crate) use group_service::*; diff --git a/frontend/rust-lib/flowy-grid/src/services/setting/setting_builder.rs b/frontend/rust-lib/flowy-grid/src/services/setting/setting_builder.rs index 7d285fbe2b..16ee630cc7 100644 --- a/frontend/rust-lib/flowy-grid/src/services/setting/setting_builder.rs +++ b/frontend/rust-lib/flowy-grid/src/services/setting/setting_builder.rs @@ -1,11 +1,4 @@ -use crate::entities::{ - GridLayout, GridLayoutPB, GridSettingPB, RepeatedGridConfigurationFilterPB, RepeatedGridGroupConfigurationPB, - RepeatedGridSortPB, -}; -use flowy_grid_data_model::revision::{FieldRevision, SettingRevision}; -use flowy_sync::entities::grid::{CreateGridFilterParams, DeleteFilterParams, GridSettingChangesetParams}; -use std::collections::HashMap; -use std::sync::Arc; +use crate::entities::{CreateFilterParams, DeleteFilterParams, GridLayout, GridSettingChangesetParams}; pub struct GridSettingChangesetBuilder { params: GridSettingChangesetParams, @@ -20,13 +13,11 @@ impl GridSettingChangesetBuilder { delete_filter: None, insert_group: None, delete_group: None, - insert_sort: None, - delete_sort: None, }; Self { params } } - pub fn insert_filter(mut self, params: CreateGridFilterParams) -> Self { + pub fn insert_filter(mut self, params: CreateFilterParams) -> Self { self.params.insert_filter = Some(params); self } @@ -40,42 +31,3 @@ impl GridSettingChangesetBuilder { self.params } } - -pub fn make_grid_setting(grid_setting_rev: &SettingRevision, field_revs: &[Arc]) -> GridSettingPB { - let current_layout_type: GridLayout = grid_setting_rev.layout.clone().into(); - let filters_by_field_id = grid_setting_rev - .get_all_filters(field_revs) - .map(|filters_by_field_id| { - filters_by_field_id - .into_iter() - .map(|(k, v)| (k, v.into())) - .collect::>() - }) - .unwrap_or_default(); - let groups_by_field_id = grid_setting_rev - .get_all_groups(field_revs) - .map(|groups_by_field_id| { - groups_by_field_id - .into_iter() - .map(|(k, v)| (k, v.into())) - .collect::>() - }) - .unwrap_or_default(); - let sorts_by_field_id = grid_setting_rev - .get_all_sort() - .map(|sorts_by_field_id| { - sorts_by_field_id - .into_iter() - .map(|(k, v)| (k, v.into())) - .collect::>() - }) - .unwrap_or_default(); - - GridSettingPB { - layouts: GridLayoutPB::all(), - current_layout_type, - filter_configuration_by_field_id: filters_by_field_id, - group_configuration_by_field_id: groups_by_field_id, - sorts_by_field_id, - } -} diff --git a/frontend/rust-lib/flowy-grid/src/util.rs b/frontend/rust-lib/flowy-grid/src/util.rs index 90bf2f2a26..65f6440c1f 100644 --- a/frontend/rust-lib/flowy-grid/src/util.rs +++ b/frontend/rust-lib/flowy-grid/src/util.rs @@ -34,6 +34,127 @@ pub fn make_default_grid() -> BuildGridContext { } pub fn make_default_board() -> BuildGridContext { + let mut grid_builder = GridBuilder::new(); + // text + let text_field = FieldBuilder::new(RichTextTypeOptionBuilder::default()) + .name("Description") + .visibility(true) + .primary(true) + .build(); + let text_field_id = text_field.id.clone(); + grid_builder.add_field(text_field); + + // single select + let to_do_option = SelectOptionPB::with_color("To Do", SelectOptionColorPB::Purple); + let doing_option = SelectOptionPB::with_color("Doing", SelectOptionColorPB::Orange); + let done_option = SelectOptionPB::with_color("Done", SelectOptionColorPB::Yellow); + let single_select_type_option = SingleSelectTypeOptionBuilder::default() + .add_option(to_do_option.clone()) + .add_option(doing_option.clone()) + .add_option(done_option.clone()); + let single_select_field = FieldBuilder::new(single_select_type_option) + .name("Status") + .visibility(true) + .build(); + let single_select_field_id = single_select_field.id.clone(); + grid_builder.add_field(single_select_field); + + // MultiSelect + let work_option = SelectOptionPB::with_color("Work", SelectOptionColorPB::Aqua); + let travel_option = SelectOptionPB::with_color("Travel", SelectOptionColorPB::Green); + let fun_option = SelectOptionPB::with_color("Fun", SelectOptionColorPB::Lime); + let health_option = SelectOptionPB::with_color("Health", SelectOptionColorPB::Pink); + let multi_select_type_option = MultiSelectTypeOptionBuilder::default() + .add_option(travel_option.clone()) + .add_option(work_option.clone()) + .add_option(fun_option.clone()) + .add_option(health_option.clone()); + let multi_select_field = FieldBuilder::new(multi_select_type_option) + .name("Tags") + .visibility(true) + .build(); + let multi_select_field_id = multi_select_field.id.clone(); + grid_builder.add_field(multi_select_field); + + for i in 0..3 { + let mut row_builder = RowRevisionBuilder::new(grid_builder.block_id(), grid_builder.field_revs()); + row_builder.insert_select_option_cell(&single_select_field_id, to_do_option.id.clone()); + match i { + 0 => { + row_builder.insert_text_cell(&text_field_id, "Update AppFlowy Website".to_string()); + row_builder.insert_select_option_cell(&multi_select_field_id, work_option.id.clone()); + } + 1 => { + row_builder.insert_text_cell(&text_field_id, "Learn French".to_string()); + let mut options = SelectOptionIds::new(); + options.push(fun_option.id.clone()); + options.push(travel_option.id.clone()); + row_builder.insert_select_option_cell(&multi_select_field_id, options.to_string()); + } + + 2 => { + row_builder.insert_text_cell(&text_field_id, "Exercise 4x/week".to_string()); + row_builder.insert_select_option_cell(&multi_select_field_id, fun_option.id.clone()); + } + _ => {} + } + let row = row_builder.build(); + grid_builder.add_row(row); + } + + for i in 0..3 { + let mut row_builder = RowRevisionBuilder::new(grid_builder.block_id(), grid_builder.field_revs()); + row_builder.insert_select_option_cell(&single_select_field_id, doing_option.id.clone()); + match i { + 0 => { + row_builder.insert_text_cell(&text_field_id, "Learn how to swim".to_string()); + row_builder.insert_select_option_cell(&multi_select_field_id, fun_option.id.clone()); + } + 1 => { + row_builder.insert_text_cell(&text_field_id, "Meditate 10 mins each day".to_string()); + row_builder.insert_select_option_cell(&multi_select_field_id, health_option.id.clone()); + } + + 2 => { + row_builder.insert_text_cell(&text_field_id, "Write atomic essays ".to_string()); + let mut options = SelectOptionIds::new(); + options.push(fun_option.id.clone()); + options.push(work_option.id.clone()); + row_builder.insert_select_option_cell(&multi_select_field_id, options.to_string()); + } + _ => {} + } + let row = row_builder.build(); + grid_builder.add_row(row); + } + + for i in 0..2 { + let mut row_builder = RowRevisionBuilder::new(grid_builder.block_id(), grid_builder.field_revs()); + row_builder.insert_select_option_cell(&single_select_field_id, done_option.id.clone()); + match i { + 0 => { + row_builder.insert_text_cell(&text_field_id, "Publish an article".to_string()); + row_builder.insert_select_option_cell(&multi_select_field_id, work_option.id.clone()); + } + 1 => { + row_builder.insert_text_cell(&text_field_id, "Visit Chicago".to_string()); + let mut options = SelectOptionIds::new(); + options.push(travel_option.id.clone()); + options.push(fun_option.id.clone()); + row_builder.insert_select_option_cell(&multi_select_field_id, options.to_string()); + } + + _ => {} + } + let row = row_builder.build(); + grid_builder.add_row(row); + } + + grid_builder.build() +} + +#[allow(dead_code)] +pub fn make_default_board2() -> BuildGridContext { let mut grid_builder = GridBuilder::new(); // text let text_field = FieldBuilder::new(RichTextTypeOptionBuilder::default()) diff --git a/frontend/rust-lib/flowy-grid/tests/grid/field_test/script.rs b/frontend/rust-lib/flowy-grid/tests/grid/field_test/script.rs index ebe3d3adf2..c790285fb1 100644 --- a/frontend/rust-lib/flowy-grid/tests/grid/field_test/script.rs +++ b/frontend/rust-lib/flowy-grid/tests/grid/field_test/script.rs @@ -1,7 +1,6 @@ use crate::grid::grid_editor::GridEditorTest; -use flowy_grid::entities::InsertFieldParams; +use flowy_grid::entities::{FieldChangesetParams, InsertFieldParams}; use flowy_grid_data_model::revision::FieldRevision; -use flowy_sync::entities::grid::FieldChangesetParams; pub enum FieldScript { CreateField { diff --git a/frontend/rust-lib/flowy-grid/tests/grid/field_test/test.rs b/frontend/rust-lib/flowy-grid/tests/grid/field_test/test.rs index 98cb3d0324..3e255d3662 100644 --- a/frontend/rust-lib/flowy-grid/tests/grid/field_test/test.rs +++ b/frontend/rust-lib/flowy-grid/tests/grid/field_test/test.rs @@ -1,10 +1,10 @@ use crate::grid::field_test::script::FieldScript::*; use crate::grid::field_test::script::GridFieldTest; use crate::grid::field_test::util::*; +use flowy_grid::entities::FieldChangesetParams; use flowy_grid::services::field::selection_type_option::SelectOptionPB; use flowy_grid::services::field::SingleSelectTypeOptionPB; use flowy_grid_data_model::revision::TypeOptionDataEntry; -use flowy_sync::entities::grid::FieldChangesetParams; #[tokio::test] async fn grid_create_field() { diff --git a/frontend/rust-lib/flowy-grid/tests/grid/filter_test/script.rs b/frontend/rust-lib/flowy-grid/tests/grid/filter_test/script.rs index 650564d8d5..a1f0b8a0c6 100644 --- a/frontend/rust-lib/flowy-grid/tests/grid/filter_test/script.rs +++ b/frontend/rust-lib/flowy-grid/tests/grid/filter_test/script.rs @@ -3,17 +3,12 @@ #![allow(dead_code)] #![allow(unused_imports)] -use flowy_grid::entities::{CreateGridFilterPayloadPB, GridLayout, GridSettingPB}; +use flowy_grid::entities::{CreateFilterParams, CreateGridFilterPayloadPB, DeleteFilterParams, GridLayout, GridSettingChangesetParams, GridSettingPB}; use flowy_grid::services::setting::GridSettingChangesetBuilder; use flowy_grid_data_model::revision::{FieldRevision, FieldTypeRevision}; -use flowy_sync::entities::grid::{CreateGridFilterParams, DeleteFilterParams, GridSettingChangesetParams}; use crate::grid::grid_editor::GridEditorTest; pub enum FilterScript { - #[allow(dead_code)] - UpdateGridSetting { - params: GridSettingChangesetParams, - }, InsertGridTableFilter { payload: CreateGridFilterPayloadPB, }, @@ -50,27 +45,18 @@ impl GridFilterTest { pub async fn run_script(&mut self, script: FilterScript) { match script { - FilterScript::UpdateGridSetting { params } => { - let _ = self.editor.update_grid_setting(params).await.unwrap(); - } + FilterScript::InsertGridTableFilter { payload } => { - let params: CreateGridFilterParams = payload.try_into().unwrap(); - let layout_type = GridLayout::Table; - let params = GridSettingChangesetBuilder::new(&self.grid_id, &layout_type) - .insert_filter(params) - .build(); - let _ = self.editor.update_grid_setting(params).await.unwrap(); + let params: CreateFilterParams = payload.try_into().unwrap(); + let _ = self.editor.update_filter(params).await.unwrap(); } FilterScript::AssertTableFilterCount { count } => { let filters = self.editor.get_grid_filter().await.unwrap(); assert_eq!(count as usize, filters.len()); } FilterScript::DeleteGridTableFilter { filter_id, field_rev} => { - let layout_type = GridLayout::Table; - let params = GridSettingChangesetBuilder::new(&self.grid_id, &layout_type) - .delete_filter(DeleteFilterParams { field_id: field_rev.id, filter_id, field_type_rev: field_rev.ty }) - .build(); - let _ = self.editor.update_grid_setting(params).await.unwrap(); + let params = DeleteFilterParams { field_id: field_rev.id, filter_id, field_type_rev: field_rev.ty }; + let _ = self.editor.delete_filter(params).await.unwrap(); } FilterScript::AssertGridSetting { expected_setting } => { let setting = self.editor.get_grid_setting().await.unwrap(); diff --git a/frontend/rust-lib/flowy-grid/tests/grid/grid_editor.rs b/frontend/rust-lib/flowy-grid/tests/grid/grid_editor.rs index dbd5df1484..78cfc17b26 100644 --- a/frontend/rust-lib/flowy-grid/tests/grid/grid_editor.rs +++ b/frontend/rust-lib/flowy-grid/tests/grid/grid_editor.rs @@ -12,9 +12,6 @@ use flowy_grid::services::setting::GridSettingChangesetBuilder; use flowy_grid_data_model::revision::*; use flowy_revision::REVISION_WRITE_INTERVAL_IN_MILLIS; use flowy_sync::client_grid::GridBuilder; -use flowy_sync::entities::grid::{ - CreateGridFilterParams, DeleteFilterParams, FieldChangesetParams, GridSettingChangesetParams, -}; use flowy_test::helper::ViewTest; use flowy_test::FlowySDKTest; use std::collections::HashMap; diff --git a/frontend/rust-lib/flowy-grid/tests/grid/group_test/script.rs b/frontend/rust-lib/flowy-grid/tests/grid/group_test/script.rs index 1900e89bff..3a5ae9455b 100644 --- a/frontend/rust-lib/flowy-grid/tests/grid/group_test/script.rs +++ b/frontend/rust-lib/flowy-grid/tests/grid/group_test/script.rs @@ -1,14 +1,22 @@ use crate::grid::grid_editor::GridEditorTest; -use flowy_grid::entities::{CreateRowParams, FieldType, GridLayout, GroupPB, MoveRowParams, RowPB}; +use flowy_grid::entities::{ + CreateRowParams, FieldChangesetParams, FieldType, GridLayout, GroupPB, MoveGroupParams, MoveGroupRowParams, RowPB, +}; use flowy_grid::services::cell::insert_select_option_cell; use flowy_grid_data_model::revision::RowChangeset; +use std::time::Duration; +use tokio::time::interval; pub enum GroupScript { - AssertGroup { + AssertGroupRowCount { group_index: usize, row_count: usize, }, AssertGroupCount(usize), + AssertGroup { + group_index: usize, + expected_group: GroupPB, + }, AssertRow { group_index: usize, row_index: usize, @@ -32,6 +40,13 @@ pub enum GroupScript { row_index: usize, to_group_index: usize, }, + MoveGroup { + from_group_index: usize, + to_group_index: usize, + }, + UpdateField { + changeset: FieldChangesetParams, + }, } pub struct GridGroupTest { @@ -52,7 +67,7 @@ impl GridGroupTest { pub async fn run_script(&mut self, script: GroupScript) { match script { - GroupScript::AssertGroup { group_index, row_count } => { + GroupScript::AssertGroupRowCount { group_index, row_count } => { assert_eq!(row_count, self.group_at_index(group_index).await.rows.len()); } GroupScript::AssertGroupCount(count) => { @@ -67,14 +82,16 @@ impl GridGroupTest { } => { let groups: Vec = self.editor.load_groups().await.unwrap().items; let from_row = groups.get(from_group_index).unwrap().rows.get(from_row_index).unwrap(); - let to_row = groups.get(to_group_index).unwrap().rows.get(to_row_index).unwrap(); - let params = MoveRowParams { + let to_group = groups.get(to_group_index).unwrap(); + let to_row = to_group.rows.get(to_row_index).unwrap(); + let params = MoveGroupRowParams { view_id: self.inner.grid_id.clone(), from_row_id: from_row.id.clone(), - to_row_id: to_row.id.clone(), + to_group_id: to_group.group_id.clone(), + to_row_id: Some(to_row.id.clone()), }; - self.editor.move_row(params).await.unwrap(); + self.editor.move_group_row(params).await.unwrap(); } GroupScript::AssertRow { group_index, @@ -84,7 +101,6 @@ impl GridGroupTest { // let group = self.group_at_index(group_index).await; let compare_row = group.rows.get(row_index).unwrap().clone(); - assert_eq!(row.id, compare_row.id); } GroupScript::CreateRow { group_index } => { @@ -125,6 +141,33 @@ impl GridGroupTest { row_changeset.cell_by_field_id.insert(field_id, cell_rev); self.editor.update_row(row_changeset).await.unwrap(); } + GroupScript::MoveGroup { + from_group_index, + to_group_index, + } => { + let from_group = self.group_at_index(from_group_index).await; + let to_group = self.group_at_index(to_group_index).await; + let params = MoveGroupParams { + view_id: self.editor.grid_id.clone(), + from_group_id: from_group.group_id, + to_group_id: to_group.group_id, + }; + self.editor.move_group(params).await.unwrap(); + // + } + GroupScript::AssertGroup { + group_index, + expected_group: group_pb, + } => { + let group = self.group_at_index(group_index).await; + assert_eq!(group.group_id, group_pb.group_id); + assert_eq!(group.desc, group_pb.desc); + } + GroupScript::UpdateField { changeset } => { + self.editor.update_field(changeset).await.unwrap(); + let mut interval = interval(Duration::from_millis(130)); + interval.tick().await; + } } } diff --git a/frontend/rust-lib/flowy-grid/tests/grid/group_test/test.rs b/frontend/rust-lib/flowy-grid/tests/grid/group_test/test.rs index 798f478439..4a4d45f952 100644 --- a/frontend/rust-lib/flowy-grid/tests/grid/group_test/test.rs +++ b/frontend/rust-lib/flowy-grid/tests/grid/group_test/test.rs @@ -1,20 +1,21 @@ use crate::grid::group_test::script::GridGroupTest; use crate::grid::group_test::script::GroupScript::*; +use flowy_grid::entities::FieldChangesetParams; #[tokio::test] -async fn board_init_test() { +async fn group_init_test() { let mut test = GridGroupTest::new().await; let scripts = vec![ AssertGroupCount(3), - AssertGroup { + AssertGroupRowCount { group_index: 0, row_count: 2, }, - AssertGroup { + AssertGroupRowCount { group_index: 1, row_count: 2, }, - AssertGroup { + AssertGroupRowCount { group_index: 2, row_count: 1, }, @@ -23,7 +24,7 @@ async fn board_init_test() { } #[tokio::test] -async fn board_move_row_test() { +async fn group_move_row_test() { let mut test = GridGroupTest::new().await; let group = test.group_at_index(0).await; let scripts = vec![ @@ -34,7 +35,7 @@ async fn board_move_row_test() { to_group_index: 0, to_row_index: 1, }, - AssertGroup { + AssertGroupRowCount { group_index: 0, row_count: 2, }, @@ -48,7 +49,7 @@ async fn board_move_row_test() { } #[tokio::test] -async fn board_move_row_to_other_group_test() { +async fn group_move_row_to_other_group_test() { let mut test = GridGroupTest::new().await; let group = test.group_at_index(0).await; let scripts = vec![ @@ -58,11 +59,11 @@ async fn board_move_row_to_other_group_test() { to_group_index: 1, to_row_index: 1, }, - AssertGroup { + AssertGroupRowCount { group_index: 0, row_count: 1, }, - AssertGroup { + AssertGroupRowCount { group_index: 1, row_count: 3, }, @@ -76,7 +77,7 @@ async fn board_move_row_to_other_group_test() { } #[tokio::test] -async fn board_move_row_to_other_group_and_reorder_test() { +async fn group_move_two_row_to_other_group_test() { let mut test = GridGroupTest::new().await; let group = test.group_at_index(0).await; let scripts = vec![ @@ -86,15 +87,41 @@ async fn board_move_row_to_other_group_and_reorder_test() { to_group_index: 1, to_row_index: 1, }, - MoveRow { - from_group_index: 1, - from_row_index: 1, - to_group_index: 1, - to_row_index: 2, + AssertGroupRowCount { + group_index: 0, + row_count: 1, + }, + AssertGroupRowCount { + group_index: 1, + row_count: 3, }, AssertRow { group_index: 1, - row_index: 2, + row_index: 1, + row: group.rows.get(0).unwrap().clone(), + }, + ]; + test.run_scripts(scripts).await; + + let group = test.group_at_index(0).await; + let scripts = vec![ + MoveRow { + from_group_index: 0, + from_row_index: 0, + to_group_index: 1, + to_row_index: 1, + }, + AssertGroupRowCount { + group_index: 0, + row_count: 0, + }, + AssertGroupRowCount { + group_index: 1, + row_count: 4, + }, + AssertRow { + group_index: 1, + row_index: 1, row: group.rows.get(0).unwrap().clone(), }, ]; @@ -102,17 +129,84 @@ async fn board_move_row_to_other_group_and_reorder_test() { } #[tokio::test] -async fn board_create_row_test() { +async fn group_move_row_to_other_group_and_reorder_from_up_to_down_test() { + let mut test = GridGroupTest::new().await; + let group_0 = test.group_at_index(0).await; + let group_1 = test.group_at_index(1).await; + let scripts = vec![ + MoveRow { + from_group_index: 0, + from_row_index: 0, + to_group_index: 1, + to_row_index: 1, + }, + AssertRow { + group_index: 1, + row_index: 1, + row: group_0.rows.get(0).unwrap().clone(), + }, + ]; + test.run_scripts(scripts).await; + + let scripts = vec![ + MoveRow { + from_group_index: 1, + from_row_index: 0, + to_group_index: 1, + to_row_index: 2, + }, + AssertRow { + group_index: 1, + row_index: 2, + row: group_1.rows.get(0).unwrap().clone(), + }, + ]; + test.run_scripts(scripts).await; +} + +#[tokio::test] +async fn group_move_row_to_other_group_and_reorder_from_bottom_to_up_test() { + let mut test = GridGroupTest::new().await; + let scripts = vec![MoveRow { + from_group_index: 0, + from_row_index: 0, + to_group_index: 1, + to_row_index: 1, + }]; + test.run_scripts(scripts).await; + + let group = test.group_at_index(1).await; + let scripts = vec![ + AssertGroupRowCount { + group_index: 1, + row_count: 3, + }, + MoveRow { + from_group_index: 1, + from_row_index: 2, + to_group_index: 1, + to_row_index: 0, + }, + AssertRow { + group_index: 1, + row_index: 0, + row: group.rows.get(2).unwrap().clone(), + }, + ]; + test.run_scripts(scripts).await; +} +#[tokio::test] +async fn group_create_row_test() { let mut test = GridGroupTest::new().await; let scripts = vec![ CreateRow { group_index: 0 }, - AssertGroup { + AssertGroupRowCount { group_index: 0, row_count: 3, }, CreateRow { group_index: 1 }, CreateRow { group_index: 1 }, - AssertGroup { + AssertGroupRowCount { group_index: 1, row_count: 4, }, @@ -121,14 +215,14 @@ async fn board_create_row_test() { } #[tokio::test] -async fn board_delete_row_test() { +async fn group_delete_row_test() { let mut test = GridGroupTest::new().await; let scripts = vec![ DeleteRow { group_index: 0, row_index: 0, }, - AssertGroup { + AssertGroupRowCount { group_index: 0, row_count: 1, }, @@ -137,7 +231,7 @@ async fn board_delete_row_test() { } #[tokio::test] -async fn board_delete_all_row_test() { +async fn group_delete_all_row_test() { let mut test = GridGroupTest::new().await; let scripts = vec![ DeleteRow { @@ -148,7 +242,7 @@ async fn board_delete_all_row_test() { group_index: 0, row_index: 0, }, - AssertGroup { + AssertGroupRowCount { group_index: 0, row_count: 0, }, @@ -157,7 +251,7 @@ async fn board_delete_all_row_test() { } #[tokio::test] -async fn board_update_row_test() { +async fn group_update_row_test() { let mut test = GridGroupTest::new().await; let scripts = vec![ // Update the row at 0 in group0 by setting the row's group field data @@ -166,11 +260,11 @@ async fn board_update_row_test() { row_index: 0, to_group_index: 1, }, - AssertGroup { + AssertGroupRowCount { group_index: 0, row_count: 1, }, - AssertGroup { + AssertGroupRowCount { group_index: 1, row_count: 3, }, @@ -179,7 +273,7 @@ async fn board_update_row_test() { } #[tokio::test] -async fn board_reorder_group_test() { +async fn group_reorder_group_test() { let mut test = GridGroupTest::new().await; let scripts = vec![ // Update the row at 0 in group0 by setting the row's group field data @@ -188,14 +282,58 @@ async fn board_reorder_group_test() { row_index: 0, to_group_index: 1, }, - AssertGroup { + AssertGroupRowCount { group_index: 0, row_count: 1, }, - AssertGroup { + AssertGroupRowCount { group_index: 1, row_count: 3, }, ]; test.run_scripts(scripts).await; } + +#[tokio::test] +async fn group_move_group_test() { + let mut test = GridGroupTest::new().await; + let group_0 = test.group_at_index(0).await; + let group_1 = test.group_at_index(1).await; + let scripts = vec![ + MoveGroup { + from_group_index: 0, + to_group_index: 1, + }, + AssertGroup { + group_index: 0, + expected_group: group_1, + }, + AssertGroup { + group_index: 1, + expected_group: group_0, + }, + ]; + test.run_scripts(scripts).await; +} + +#[tokio::test] +async fn group_update_field_test() { + let mut test = GridGroupTest::new().await; + let group = test.group_at_index(0).await; + let changeset = FieldChangesetParams { + field_id: group.field_id.clone(), + grid_id: test.grid_id.clone(), + name: Some("ABC".to_string()), + ..Default::default() + }; + + // group.desc = "ABC".to_string(); + let scripts = vec![ + UpdateField { changeset }, + AssertGroup { + group_index: 0, + expected_group: group, + }, + ]; + test.run_scripts(scripts).await; +} diff --git a/frontend/rust-lib/flowy-sdk/src/lib.rs b/frontend/rust-lib/flowy-sdk/src/lib.rs index ce5920e532..e0bd601987 100644 --- a/frontend/rust-lib/flowy-sdk/src/lib.rs +++ b/frontend/rust-lib/flowy-sdk/src/lib.rs @@ -74,7 +74,7 @@ fn crate_log_filter(level: String) -> String { filters.push(format!("lib_ot={}", level)); filters.push(format!("lib_ws={}", level)); filters.push(format!("lib_infra={}", level)); - // filters.push(format!("flowy_sync={}", level)); + filters.push(format!("flowy_sync={}", level)); // filters.push(format!("flowy_revision={}", level)); // filters.push(format!("lib_dispatch={}", level)); diff --git a/shared-lib/Cargo.lock b/shared-lib/Cargo.lock index da8bc0ff1c..596f1fe694 100644 --- a/shared-lib/Cargo.lock +++ b/shared-lib/Cargo.lock @@ -741,6 +741,12 @@ dependencies = [ "serde", ] +[[package]] +name = "indextree" +version = "4.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42b4b46b3311ebd8e5cd44f6b03b36e0f48a70552cf6b036afcebc5626794066" + [[package]] name = "instant" version = "0.1.12" @@ -809,6 +815,7 @@ dependencies = [ "bytes", "dashmap", "derive_more", + "indextree", "lazy_static", "log", "md5", diff --git a/shared-lib/flowy-error-code/src/code.rs b/shared-lib/flowy-error-code/src/code.rs index 63f7ac7749..c5e89a99f3 100644 --- a/shared-lib/flowy-error-code/src/code.rs +++ b/shared-lib/flowy-error-code/src/code.rs @@ -125,6 +125,9 @@ pub enum ErrorCode { #[display(fmt = "Invalid data")] InvalidData = 1000, + + #[display(fmt = "Out of bounds")] + OutOfBounds = 10001, } impl ErrorCode { diff --git a/shared-lib/flowy-grid-data-model/src/revision/filter_rev.rs b/shared-lib/flowy-grid-data-model/src/revision/filter_rev.rs new file mode 100644 index 0000000000..7079b52229 --- /dev/null +++ b/shared-lib/flowy-grid-data-model/src/revision/filter_rev.rs @@ -0,0 +1,9 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq, Eq, Hash)] +pub struct FilterConfigurationRevision { + pub id: String, + pub field_id: String, + pub condition: u8, + pub content: Option, +} diff --git a/shared-lib/flowy-grid-data-model/src/revision/grid_block.rs b/shared-lib/flowy-grid-data-model/src/revision/grid_block.rs index 5464d83877..ba113810f6 100644 --- a/shared-lib/flowy-grid-data-model/src/revision/grid_block.rs +++ b/shared-lib/flowy-grid-data-model/src/revision/grid_block.rs @@ -59,8 +59,8 @@ impl RowChangeset { } } - pub fn has_changed(&self) -> bool { - self.height.is_some() || self.visibility.is_some() || !self.cell_by_field_id.is_empty() + pub fn is_empty(&self) -> bool { + self.height.is_none() && self.visibility.is_none() && self.cell_by_field_id.is_empty() } } diff --git a/shared-lib/flowy-grid-data-model/src/revision/grid_setting_rev.rs b/shared-lib/flowy-grid-data-model/src/revision/grid_setting_rev.rs index da366f39ab..1f52ae93e2 100644 --- a/shared-lib/flowy-grid-data-model/src/revision/grid_setting_rev.rs +++ b/shared-lib/flowy-grid-data-model/src/revision/grid_setting_rev.rs @@ -1,8 +1,7 @@ -use crate::revision::{FieldRevision, FieldTypeRevision}; +use crate::revision::{FieldRevision, FieldTypeRevision, FilterConfigurationRevision, GroupConfigurationRevision}; use indexmap::IndexMap; use nanoid::nanoid; use serde::{Deserialize, Serialize}; -use serde_repr::*; use std::collections::HashMap; use std::fmt::Debug; use std::sync::Arc; @@ -15,6 +14,7 @@ pub fn gen_grid_group_id() -> String { nanoid!(6) } +#[allow(dead_code)] pub fn gen_grid_sort_id() -> String { nanoid!(6) } @@ -24,120 +24,12 @@ pub type FilterConfigurationsByFieldId = HashMap; pub type GroupConfigurationsByFieldId = HashMap>>; -// -pub type SortConfiguration = Configuration; -pub type SortConfigurationsByFieldId = HashMap>>; -#[derive(Debug, Clone, Serialize, Deserialize, Default, Eq, PartialEq)] -pub struct SettingRevision { - pub layout: LayoutRevision, - - pub filters: FilterConfiguration, - - #[serde(default)] - pub groups: GroupConfiguration, - - #[serde(skip)] - pub sorts: SortConfiguration, -} - -#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize_repr, Deserialize_repr)] -#[repr(u8)] -pub enum LayoutRevision { - Table = 0, - Board = 1, -} - -impl ToString for LayoutRevision { - fn to_string(&self) -> String { - let layout_rev = self.clone() as u8; - layout_rev.to_string() - } -} - -impl std::default::Default for LayoutRevision { - fn default() -> Self { - LayoutRevision::Table - } -} - -impl SettingRevision { - pub fn get_all_groups(&self, field_revs: &[Arc]) -> Option { - self.groups.get_all_objects(field_revs) - } - - pub fn get_groups( - &self, - field_id: &str, - field_type_rev: &FieldTypeRevision, - ) -> Option>> { - self.groups.get_objects(field_id, field_type_rev) - } - - pub fn get_mut_groups( - &mut self, - field_id: &str, - field_type: &FieldTypeRevision, - ) -> Option<&mut Vec>> { - self.groups.get_mut_objects(field_id, field_type) - } - - pub fn insert_group( - &mut self, - field_id: &str, - field_type: &FieldTypeRevision, - group_rev: GroupConfigurationRevision, - ) { - // only one group can be set - self.groups.remove_all(); - self.groups.insert_object(field_id, field_type, group_rev); - } - - pub fn get_all_filters(&self, field_revs: &[Arc]) -> Option { - self.filters.get_all_objects(field_revs) - } - - pub fn get_filters( - &self, - field_id: &str, - field_type_rev: &FieldTypeRevision, - ) -> Option>> { - self.filters.get_objects(field_id, field_type_rev) - } - - pub fn get_mut_filters( - &mut self, - field_id: &str, - field_type: &FieldTypeRevision, - ) -> Option<&mut Vec>> { - self.filters.get_mut_objects(field_id, field_type) - } - - pub fn insert_filter( - &mut self, - field_id: &str, - field_type: &FieldTypeRevision, - filter_rev: FilterConfigurationRevision, - ) { - self.filters.insert_object(field_id, field_type, filter_rev); - } - - pub fn get_all_sort(&self) -> Option { - None - } -} - -#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq, Eq)] -pub struct SortConfigurationRevision { - pub id: String, - pub field_id: Option, -} - -#[derive(Debug, Clone, Serialize, Deserialize, Default, Eq, PartialEq)] +#[derive(Debug, Clone, Serialize, Deserialize, Default)] #[serde(transparent)] pub struct Configuration where - T: Debug + Clone + Default + Eq + PartialEq + serde::Serialize + serde::de::DeserializeOwned + 'static, + T: Debug + Clone + Default + serde::Serialize + serde::de::DeserializeOwned + 'static, { /// Key: field_id /// Value: this value contains key/value. @@ -149,7 +41,7 @@ where impl Configuration where - T: Debug + Clone + Default + Eq + PartialEq + serde::Serialize + serde::de::DeserializeOwned + 'static, + T: Debug + Clone + Default + serde::Serialize + serde::de::DeserializeOwned + 'static, { pub fn get_mut_objects(&mut self, field_id: &str, field_type: &FieldTypeRevision) -> Option<&mut Vec>> { let value = self @@ -157,7 +49,7 @@ where .get_mut(field_id) .and_then(|object_rev_map| object_rev_map.get_mut(field_type)); if value.is_none() { - tracing::warn!("Can't find the {:?} with", std::any::type_name::()); + tracing::warn!("[Configuration] Can't find the {:?} with", std::any::type_name::()); } value } @@ -184,7 +76,8 @@ where Some(objects_by_field_id) } - pub fn insert_object(&mut self, field_id: &str, field_type: &FieldTypeRevision, object: T) { + /// add object to the end of the list + pub fn add_object(&mut self, field_id: &str, field_type: &FieldTypeRevision, object: T) { let object_rev_map = self .inner .entry(field_id.to_string()) @@ -196,16 +89,16 @@ where .push(Arc::new(object)) } - pub fn remove_all(&mut self) { + pub fn clear(&mut self) { self.inner.clear() } } -#[derive(Debug, Clone, Serialize, Deserialize, Default, Eq, PartialEq)] +#[derive(Debug, Clone, Serialize, Deserialize, Default)] #[serde(transparent)] pub struct ObjectIndexMap where - T: Debug + Clone + Default + Eq + PartialEq + serde::Serialize + serde::de::DeserializeOwned + 'static, + T: Debug + Clone + Default + serde::Serialize + serde::de::DeserializeOwned + 'static, { #[serde(with = "indexmap::serde_seq")] pub object_by_field_type: IndexMap>>, @@ -213,7 +106,7 @@ where impl ObjectIndexMap where - T: Debug + Clone + Default + Eq + PartialEq + serde::Serialize + serde::de::DeserializeOwned + 'static, + T: Debug + Clone + Default + serde::Serialize + serde::de::DeserializeOwned + 'static, { pub fn new() -> Self { ObjectIndexMap::default() @@ -222,7 +115,7 @@ where impl std::ops::Deref for ObjectIndexMap where - T: Debug + Clone + Default + Eq + PartialEq + serde::Serialize + serde::de::DeserializeOwned + 'static, + T: Debug + Clone + Default + serde::Serialize + serde::de::DeserializeOwned + 'static, { type Target = IndexMap>>; @@ -233,25 +126,9 @@ where impl std::ops::DerefMut for ObjectIndexMap where - T: Debug + Clone + Default + Eq + PartialEq + serde::Serialize + serde::de::DeserializeOwned + 'static, + T: Debug + Clone + Default + serde::Serialize + serde::de::DeserializeOwned + 'static, { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.object_by_field_type } } - -#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq, Eq)] -pub struct GroupConfigurationRevision { - pub id: String, - pub field_id: String, - pub field_type_rev: FieldTypeRevision, - pub content: Option>, -} - -#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq, Eq, Hash)] -pub struct FilterConfigurationRevision { - pub id: String, - pub field_id: String, - pub condition: u8, - pub content: Option, -} diff --git a/shared-lib/flowy-grid-data-model/src/revision/grid_view.rs b/shared-lib/flowy-grid-data-model/src/revision/grid_view.rs index 2fcc2fc4eb..74c3c72511 100644 --- a/shared-lib/flowy-grid-data-model/src/revision/grid_view.rs +++ b/shared-lib/flowy-grid-data-model/src/revision/grid_view.rs @@ -1,24 +1,50 @@ -use crate::revision::SettingRevision; +use crate::revision::{FilterConfiguration, GroupConfiguration}; use nanoid::nanoid; use serde::{Deserialize, Serialize}; +use serde_repr::*; #[allow(dead_code)] pub fn gen_grid_view_id() -> String { nanoid!(6) } +#[derive(Debug, PartialEq, Eq, Hash, Clone, Serialize_repr, Deserialize_repr)] +#[repr(u8)] +pub enum LayoutRevision { + Table = 0, + Board = 1, +} + +impl ToString for LayoutRevision { + fn to_string(&self) -> String { + let layout_rev = self.clone() as u8; + layout_rev.to_string() + } +} + +impl std::default::Default for LayoutRevision { + fn default() -> Self { + LayoutRevision::Table + } +} + #[derive(Debug, Clone, Default, Serialize, Deserialize)] pub struct GridViewRevision { pub view_id: String, pub grid_id: String, - pub setting: SettingRevision, + pub layout: LayoutRevision, - // For the moment, we just use the order returned from the GridRevision - #[allow(dead_code)] - #[serde(skip, rename = "row")] - pub row_orders: Vec, + #[serde(default)] + pub filters: FilterConfiguration, + + #[serde(default)] + pub groups: GroupConfiguration, + // // For the moment, we just use the order returned from the GridRevision + // #[allow(dead_code)] + // #[serde(skip, rename = "rows")] + // pub row_orders: Vec, } impl GridViewRevision { @@ -26,8 +52,10 @@ impl GridViewRevision { GridViewRevision { view_id, grid_id, - setting: Default::default(), - row_orders: vec![], + layout: Default::default(), + filters: Default::default(), + groups: Default::default(), + // row_orders: vec![], } } } @@ -36,3 +64,24 @@ impl GridViewRevision { pub struct RowOrderRevision { pub row_id: String, } + +#[cfg(test)] +mod tests { + use crate::revision::GridViewRevision; + + #[test] + fn grid_view_revision_serde_test() { + let grid_view_revision = GridViewRevision { + view_id: "1".to_string(), + grid_id: "1".to_string(), + layout: Default::default(), + filters: Default::default(), + groups: Default::default(), + }; + let s = serde_json::to_string(&grid_view_revision).unwrap(); + assert_eq!( + s, + r#"{"view_id":"1","grid_id":"1","layout":0,"filters":[],"groups":[]}"# + ); + } +} diff --git a/shared-lib/flowy-grid-data-model/src/revision/group_rev.rs b/shared-lib/flowy-grid-data-model/src/revision/group_rev.rs new file mode 100644 index 0000000000..04b571fd76 --- /dev/null +++ b/shared-lib/flowy-grid-data-model/src/revision/group_rev.rs @@ -0,0 +1,199 @@ +use crate::revision::{gen_grid_group_id, FieldTypeRevision}; +use serde::{Deserialize, Serialize}; +use serde_json::Error; +use serde_repr::*; + +pub trait GroupConfigurationContentSerde: Sized + Send + Sync { + fn from_configuration_content(s: &str) -> Result; + + fn to_configuration_content(&self) -> Result; +} + +#[derive(Debug, Clone, Serialize, Deserialize, Default)] +pub struct GroupConfigurationRevision { + pub id: String, + pub field_id: String, + pub field_type_rev: FieldTypeRevision, + pub groups: Vec, + pub content: String, +} + +impl GroupConfigurationRevision { + pub fn new(field_id: String, field_type: FieldTypeRevision, content: T) -> Result + where + T: GroupConfigurationContentSerde, + { + let content = content.to_configuration_content()?; + Ok(Self { + id: gen_grid_group_id(), + field_id, + field_type_rev: field_type, + groups: vec![], + content, + }) + } +} + +#[derive(Default, Serialize, Deserialize)] +pub struct TextGroupConfigurationRevision { + pub hide_empty: bool, +} + +impl GroupConfigurationContentSerde for TextGroupConfigurationRevision { + fn from_configuration_content(s: &str) -> Result { + serde_json::from_str(s) + } + fn to_configuration_content(&self) -> Result { + serde_json::to_string(self) + } +} + +#[derive(Default, Serialize, Deserialize)] +pub struct NumberGroupConfigurationRevision { + pub hide_empty: bool, +} + +impl GroupConfigurationContentSerde for NumberGroupConfigurationRevision { + fn from_configuration_content(s: &str) -> Result { + serde_json::from_str(s) + } + fn to_configuration_content(&self) -> Result { + serde_json::to_string(self) + } +} + +#[derive(Default, Serialize, Deserialize)] +pub struct UrlGroupConfigurationRevision { + pub hide_empty: bool, +} + +impl GroupConfigurationContentSerde for UrlGroupConfigurationRevision { + fn from_configuration_content(s: &str) -> Result { + serde_json::from_str(s) + } + fn to_configuration_content(&self) -> Result { + serde_json::to_string(self) + } +} + +#[derive(Default, Serialize, Deserialize)] +pub struct CheckboxGroupConfigurationRevision { + pub hide_empty: bool, +} + +impl GroupConfigurationContentSerde for CheckboxGroupConfigurationRevision { + fn from_configuration_content(s: &str) -> Result { + serde_json::from_str(s) + } + + fn to_configuration_content(&self) -> Result { + serde_json::to_string(self) + } +} + +#[derive(Default, Serialize, Deserialize)] +pub struct SelectOptionGroupConfigurationRevision { + pub hide_empty: bool, +} + +impl GroupConfigurationContentSerde for SelectOptionGroupConfigurationRevision { + fn from_configuration_content(s: &str) -> Result { + serde_json::from_str(s) + } + + fn to_configuration_content(&self) -> Result { + serde_json::to_string(self) + } +} + +#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq)] +pub struct GroupRevision { + pub id: String, + + #[serde(default)] + pub name: String, + + #[serde(skip, default = "IS_DEFAULT_GROUP")] + pub is_default: bool, + + #[serde(default = "GROUP_REV_VISIBILITY")] + pub visible: bool, +} + +const GROUP_REV_VISIBILITY: fn() -> bool = || true; +const IS_DEFAULT_GROUP: fn() -> bool = || false; + +impl GroupRevision { + pub fn new(id: String, group_name: String) -> Self { + Self { + id, + name: group_name, + is_default: false, + visible: true, + } + } + + pub fn default_group(id: String, group_name: String) -> Self { + Self { + id, + name: group_name, + is_default: true, + visible: true, + } + } +} + +#[derive(Default, Serialize, Deserialize)] +pub struct DateGroupConfigurationRevision { + pub hide_empty: bool, + pub condition: DateCondition, +} + +impl GroupConfigurationContentSerde for DateGroupConfigurationRevision { + fn from_configuration_content(s: &str) -> Result { + serde_json::from_str(s) + } + fn to_configuration_content(&self) -> Result { + serde_json::to_string(self) + } +} + +#[derive(Serialize_repr, Deserialize_repr)] +#[repr(u8)] +pub enum DateCondition { + Relative = 0, + Day = 1, + Week = 2, + Month = 3, + Year = 4, +} + +impl std::default::Default for DateCondition { + fn default() -> Self { + DateCondition::Relative + } +} + +#[cfg(test)] +mod tests { + use crate::revision::{GroupConfigurationRevision, SelectOptionGroupConfigurationRevision}; + + #[test] + fn group_configuration_serde_test() { + let content = SelectOptionGroupConfigurationRevision { hide_empty: false }; + let rev = GroupConfigurationRevision::new("1".to_owned(), 2, content).unwrap(); + let json = serde_json::to_string(&rev).unwrap(); + + let rev: GroupConfigurationRevision = serde_json::from_str(&json).unwrap(); + let _content: SelectOptionGroupConfigurationRevision = serde_json::from_str(&rev.content).unwrap(); + } + + #[test] + fn group_configuration_serde_test2() { + let content = SelectOptionGroupConfigurationRevision { hide_empty: false }; + let content_json = serde_json::to_string(&content).unwrap(); + let rev = GroupConfigurationRevision::new("1".to_owned(), 2, content).unwrap(); + + assert_eq!(rev.content, content_json); + } +} diff --git a/shared-lib/flowy-grid-data-model/src/revision/mod.rs b/shared-lib/flowy-grid-data-model/src/revision/mod.rs index 7ea98d78e3..460370b86b 100644 --- a/shared-lib/flowy-grid-data-model/src/revision/mod.rs +++ b/shared-lib/flowy-grid-data-model/src/revision/mod.rs @@ -1,9 +1,13 @@ +mod filter_rev; mod grid_block; mod grid_rev; mod grid_setting_rev; mod grid_view; +mod group_rev; +pub use filter_rev::*; pub use grid_block::*; pub use grid_rev::*; pub use grid_setting_rev::*; pub use grid_view::*; +pub use group_rev::*; diff --git a/shared-lib/flowy-sync/src/client_grid/grid_revision_pad.rs b/shared-lib/flowy-sync/src/client_grid/grid_revision_pad.rs index aad9c8b5f3..e079929aee 100644 --- a/shared-lib/flowy-sync/src/client_grid/grid_revision_pad.rs +++ b/shared-lib/flowy-sync/src/client_grid/grid_revision_pad.rs @@ -1,4 +1,3 @@ -use crate::entities::grid::FieldChangesetParams; use crate::entities::revision::{md5, RepeatedRevision, Revision}; use crate::errors::{internal_error, CollaborateError, CollaborateResult}; use crate::util::{cal_diff, make_text_delta_from_revisions}; @@ -162,61 +161,6 @@ impl GridRevisionPad { }) } - pub fn update_field_rev( - &mut self, - changeset: FieldChangesetParams, - deserializer: T, - ) -> CollaborateResult> { - let field_id = changeset.field_id.clone(); - self.modify_field(&field_id, |field| { - let mut is_changed = None; - if let Some(name) = changeset.name { - field.name = name; - is_changed = Some(()) - } - - if let Some(desc) = changeset.desc { - field.desc = desc; - is_changed = Some(()) - } - - if let Some(field_type) = changeset.field_type { - field.ty = field_type; - is_changed = Some(()) - } - - if let Some(frozen) = changeset.frozen { - field.frozen = frozen; - is_changed = Some(()) - } - - if let Some(visibility) = changeset.visibility { - field.visibility = visibility; - is_changed = Some(()) - } - - if let Some(width) = changeset.width { - field.width = width; - is_changed = Some(()) - } - - if let Some(type_option_data) = changeset.type_option_data { - match deserializer.deserialize(type_option_data) { - Ok(json_str) => { - let field_type = field.ty; - field.insert_type_option_str(&field_type, json_str); - is_changed = Some(()) - } - Err(err) => { - tracing::error!("Deserialize data to type option json failed: {}", err); - } - } - } - - Ok(is_changed) - }) - } - pub fn get_field_rev(&self, field_id: &str) -> Option<(usize, &Arc)> { self.grid_rev .fields @@ -399,7 +343,7 @@ impl GridRevisionPad { ) } - fn modify_field(&mut self, field_id: &str, f: F) -> CollaborateResult> + pub fn modify_field(&mut self, field_id: &str, f: F) -> CollaborateResult> where F: FnOnce(&mut FieldRevision) -> CollaborateResult>, { diff --git a/shared-lib/flowy-sync/src/client_grid/view_revision_pad.rs b/shared-lib/flowy-sync/src/client_grid/view_revision_pad.rs index dd6cc6f977..ddc9c6e05a 100644 --- a/shared-lib/flowy-sync/src/client_grid/view_revision_pad.rs +++ b/shared-lib/flowy-sync/src/client_grid/view_revision_pad.rs @@ -1,11 +1,9 @@ -use crate::entities::grid::{CreateGridFilterParams, CreateGridGroupParams, GridSettingChangesetParams}; use crate::entities::revision::{md5, Revision}; use crate::errors::{internal_error, CollaborateError, CollaborateResult}; use crate::util::{cal_diff, make_text_delta_from_revisions}; use flowy_grid_data_model::revision::{ - gen_grid_filter_id, gen_grid_group_id, FieldRevision, FieldTypeRevision, FilterConfigurationRevision, - FilterConfigurationsByFieldId, GridViewRevision, GroupConfigurationRevision, GroupConfigurationsByFieldId, - SettingRevision, SortConfigurationsByFieldId, + FieldRevision, FieldTypeRevision, FilterConfigurationRevision, FilterConfigurationsByFieldId, GridViewRevision, + GroupConfigurationRevision, GroupConfigurationsByFieldId, }; use lib_ot::core::{OperationTransform, PhantomAttributes, TextDelta, TextDeltaBuilder}; use std::sync::Arc; @@ -50,71 +48,11 @@ impl GridViewRevisionPad { Self::from_delta(delta) } - pub fn get_setting_rev(&self) -> &SettingRevision { - &self.view.setting - } - - pub fn update_setting( - &mut self, - changeset: GridSettingChangesetParams, - ) -> CollaborateResult> { - self.modify(|view| { - let mut is_changed = None; - if let Some(params) = changeset.insert_filter { - view.setting.filters.insert_object( - ¶ms.field_id, - ¶ms.field_type_rev, - make_filter_revision(¶ms), - ); - is_changed = Some(()) - } - if let Some(params) = changeset.delete_filter { - if let Some(filters) = view - .setting - .filters - .get_mut_objects(¶ms.field_id, ¶ms.field_type_rev) - { - filters.retain(|filter| filter.id != params.filter_id); - is_changed = Some(()) - } - } - if let Some(params) = changeset.insert_group { - view.setting.groups.remove_all(); - view.setting.groups.insert_object( - ¶ms.field_id, - ¶ms.field_type_rev, - make_group_revision(¶ms), - ); - - is_changed = Some(()); - } - if let Some(params) = changeset.delete_group { - if let Some(groups) = view - .setting - .groups - .get_mut_objects(¶ms.field_id, ¶ms.field_type_rev) - { - groups.retain(|group| group.id != params.group_id); - is_changed = Some(()); - } - } - - Ok(is_changed) - }) - } - pub fn get_all_groups(&self, field_revs: &[Arc]) -> Option { - self.setting.groups.get_all_objects(field_revs) - } - - pub fn get_groups( - &self, - field_id: &str, - field_type_rev: &FieldTypeRevision, - ) -> Option>> { - self.setting.groups.get_objects(field_id, field_type_rev) + self.groups.get_all_objects(field_revs) } + #[tracing::instrument(level = "trace", skip_all, err)] pub fn insert_group( &mut self, field_id: &str, @@ -122,13 +60,40 @@ impl GridViewRevisionPad { group_rev: GroupConfigurationRevision, ) -> CollaborateResult> { self.modify(|view| { - // only one group can be set - view.setting.groups.remove_all(); - view.setting.groups.insert_object(field_id, field_type, group_rev); + // Only save one group + view.groups.clear(); + view.groups.add_object(field_id, field_type, group_rev); Ok(Some(())) }) } + #[tracing::instrument(level = "trace", skip_all)] + pub fn contains_group(&self, field_id: &str, field_type: &FieldTypeRevision) -> bool { + self.view.groups.get_objects(field_id, field_type).is_some() + } + + #[tracing::instrument(level = "trace", skip_all, err)] + pub fn with_mut_group( + &mut self, + field_id: &str, + field_type: &FieldTypeRevision, + configuration_id: &str, + mut_configuration_fn: F, + ) -> CollaborateResult> { + self.modify(|view| match view.groups.get_mut_objects(field_id, field_type) { + None => Ok(None), + Some(configurations_revs) => { + for configuration_rev in configurations_revs { + if configuration_rev.id == configuration_id { + mut_configuration_fn(Arc::make_mut(configuration_rev)); + return Ok(Some(())); + } + } + Ok(None) + } + }) + } + pub fn delete_group( &mut self, field_id: &str, @@ -136,7 +101,7 @@ impl GridViewRevisionPad { group_id: &str, ) -> CollaborateResult> { self.modify(|view| { - if let Some(groups) = view.setting.groups.get_mut_objects(field_id, field_type) { + if let Some(groups) = view.groups.get_mut_objects(field_id, field_type) { groups.retain(|group| group.id != group_id); Ok(Some(())) } else { @@ -146,7 +111,7 @@ impl GridViewRevisionPad { } pub fn get_all_filters(&self, field_revs: &[Arc]) -> Option { - self.setting.filters.get_all_objects(field_revs) + self.filters.get_all_objects(field_revs) } pub fn get_filters( @@ -154,7 +119,7 @@ impl GridViewRevisionPad { field_id: &str, field_type_rev: &FieldTypeRevision, ) -> Option>> { - self.setting.filters.get_objects(field_id, field_type_rev) + self.filters.get_objects(field_id, field_type_rev) } pub fn insert_filter( @@ -164,7 +129,7 @@ impl GridViewRevisionPad { filter_rev: FilterConfigurationRevision, ) -> CollaborateResult> { self.modify(|view| { - view.setting.filters.insert_object(field_id, field_type, filter_rev); + view.filters.add_object(field_id, field_type, filter_rev); Ok(Some(())) }) } @@ -176,7 +141,7 @@ impl GridViewRevisionPad { filter_id: &str, ) -> CollaborateResult> { self.modify(|view| { - if let Some(filters) = view.setting.filters.get_mut_objects(field_id, field_type) { + if let Some(filters) = view.filters.get_mut_objects(field_id, field_type) { filters.retain(|filter| filter.id != filter_id); Ok(Some(())) } else { @@ -185,10 +150,6 @@ impl GridViewRevisionPad { }) } - pub fn get_all_sort(&self) -> Option { - None - } - pub fn json_str(&self) -> CollaborateResult { make_grid_view_rev_json_str(&self.view) } @@ -216,24 +177,7 @@ impl GridViewRevisionPad { } } -fn make_filter_revision(params: &CreateGridFilterParams) -> FilterConfigurationRevision { - FilterConfigurationRevision { - id: gen_grid_filter_id(), - field_id: params.field_id.clone(), - condition: params.condition, - content: params.content.clone(), - } -} - -fn make_group_revision(params: &CreateGridGroupParams) -> GroupConfigurationRevision { - GroupConfigurationRevision { - id: gen_grid_group_id(), - field_id: params.field_id.clone(), - field_type_rev: params.field_type_rev, - content: params.content.clone(), - } -} - +#[derive(Debug)] pub struct GridViewRevisionChangeset { pub delta: TextDelta, pub md5: String, diff --git a/shared-lib/flowy-sync/src/entities/grid.rs b/shared-lib/flowy-sync/src/entities/grid.rs deleted file mode 100644 index 3be3d98267..0000000000 --- a/shared-lib/flowy-sync/src/entities/grid.rs +++ /dev/null @@ -1,67 +0,0 @@ -use flowy_grid_data_model::revision::{FieldTypeRevision, LayoutRevision}; - -pub struct GridSettingChangesetParams { - pub grid_id: String, - pub layout_type: LayoutRevision, - pub insert_filter: Option, - pub delete_filter: Option, - pub insert_group: Option, - pub delete_group: Option, - pub insert_sort: Option, - pub delete_sort: Option, -} - -impl GridSettingChangesetParams { - pub fn is_filter_changed(&self) -> bool { - self.insert_filter.is_some() || self.delete_filter.is_some() - } -} -pub struct CreateGridFilterParams { - pub field_id: String, - pub field_type_rev: FieldTypeRevision, - pub condition: u8, - pub content: Option, -} - -pub struct DeleteFilterParams { - pub field_id: String, - pub filter_id: String, - pub field_type_rev: FieldTypeRevision, -} - -pub struct CreateGridGroupParams { - pub field_id: String, - pub field_type_rev: FieldTypeRevision, - pub content: Option>, -} - -pub struct DeleteGroupParams { - pub field_id: String, - pub group_id: String, - pub field_type_rev: FieldTypeRevision, -} - -pub struct CreateGridSortParams { - pub field_id: Option, -} - -#[derive(Debug, Clone, Default)] -pub struct FieldChangesetParams { - pub field_id: String, - - pub grid_id: String, - - pub name: Option, - - pub desc: Option, - - pub field_type: Option, - - pub frozen: Option, - - pub visibility: Option, - - pub width: Option, - - pub type_option_data: Option>, -} diff --git a/shared-lib/flowy-sync/src/entities/mod.rs b/shared-lib/flowy-sync/src/entities/mod.rs index 768640454b..1c357df94c 100644 --- a/shared-lib/flowy-sync/src/entities/mod.rs +++ b/shared-lib/flowy-sync/src/entities/mod.rs @@ -1,5 +1,4 @@ pub mod folder; -pub mod grid; pub mod parser; pub mod revision; pub mod text_block; diff --git a/shared-lib/lib-ot/Cargo.toml b/shared-lib/lib-ot/Cargo.toml index a1a577132e..d47968dcfe 100644 --- a/shared-lib/lib-ot/Cargo.toml +++ b/shared-lib/lib-ot/Cargo.toml @@ -24,6 +24,7 @@ lazy_static = "1.4.0" strum = "0.21" strum_macros = "0.21" bytes = "1.0" +indextree = "4.4.0" [features] diff --git a/shared-lib/lib-ot/src/core/document/attributes.rs b/shared-lib/lib-ot/src/core/document/attributes.rs new file mode 100644 index 0000000000..52b33dce08 --- /dev/null +++ b/shared-lib/lib-ot/src/core/document/attributes.rs @@ -0,0 +1,22 @@ +use std::collections::HashMap; + +#[derive(Clone, serde::Serialize, serde::Deserialize)] +pub struct NodeAttributes(pub HashMap>); + +impl NodeAttributes { + pub fn new() -> NodeAttributes { + NodeAttributes(HashMap::new()) + } + + pub fn compose(a: &NodeAttributes, b: &NodeAttributes) -> NodeAttributes { + let mut new_map: HashMap> = b.0.clone(); + + for (key, value) in &a.0 { + if b.0.contains_key(key.as_str()) { + new_map.insert(key.into(), value.clone()); + } + } + + NodeAttributes(new_map) + } +} diff --git a/shared-lib/lib-ot/src/core/document/document.rs b/shared-lib/lib-ot/src/core/document/document.rs new file mode 100644 index 0000000000..73ff03fe64 --- /dev/null +++ b/shared-lib/lib-ot/src/core/document/document.rs @@ -0,0 +1,211 @@ +use crate::core::document::position::Position; +use crate::core::{ + DocumentOperation, NodeAttributes, NodeData, NodeSubTree, OperationTransform, TextDelta, Transaction, +}; +use crate::errors::{ErrorBuilder, OTError, OTErrorCode}; +use indextree::{Arena, NodeId}; + +pub struct DocumentTree { + pub arena: Arena, + pub root: NodeId, +} + +impl DocumentTree { + pub fn new() -> DocumentTree { + let mut arena = Arena::new(); + let root = arena.new_node(NodeData::new("root".into())); + DocumentTree { arena, root } + } + + pub fn node_at_path(&self, position: &Position) -> Option { + if position.is_empty() { + return Some(self.root); + } + + let mut iterate_node = self.root; + + for id in &position.0 { + let child = self.child_at_index_of_path(iterate_node, id.clone()); + iterate_node = match child { + Some(node) => node, + None => return None, + }; + } + + Some(iterate_node) + } + + pub fn path_of_node(&self, node_id: NodeId) -> Position { + let mut path: Vec = Vec::new(); + + let mut ancestors = node_id.ancestors(&self.arena); + let mut current_node = node_id; + let mut parent = ancestors.next(); + + while parent.is_some() { + let parent_node = parent.unwrap(); + let counter = self.index_of_node(parent_node, current_node); + path.push(counter); + current_node = parent_node; + parent = ancestors.next(); + } + + Position(path) + } + + fn index_of_node(&self, parent_node: NodeId, child_node: NodeId) -> usize { + let mut counter: usize = 0; + + let mut children_iterator = parent_node.children(&self.arena); + let mut node = children_iterator.next(); + + while node.is_some() { + if node.unwrap() == child_node { + return counter; + } + + node = children_iterator.next(); + counter += 1; + } + + counter + } + + fn child_at_index_of_path(&self, at_node: NodeId, index: usize) -> Option { + let children = at_node.children(&self.arena); + + let mut counter = 0; + for child in children { + if counter == index { + return Some(child); + } + + counter += 1; + } + + None + } + + pub fn apply(&mut self, transaction: Transaction) -> Result<(), OTError> { + for op in &transaction.operations { + self.apply_op(op)?; + } + Ok(()) + } + + fn apply_op(&mut self, op: &DocumentOperation) -> Result<(), OTError> { + match op { + DocumentOperation::Insert { path, nodes } => self.apply_insert(path, nodes), + DocumentOperation::Update { path, attributes, .. } => self.apply_update(path, attributes), + DocumentOperation::Delete { path, nodes } => self.apply_delete(path, nodes.len()), + DocumentOperation::TextEdit { path, delta, .. } => self.apply_text_edit(path, delta), + } + } + + fn apply_insert(&mut self, path: &Position, nodes: &[Box]) -> Result<(), OTError> { + let parent_path = &path.0[0..(path.0.len() - 1)]; + let last_index = path.0[path.0.len() - 1]; + let parent_node = self + .node_at_path(&Position(parent_path.to_vec())) + .ok_or(ErrorBuilder::new(OTErrorCode::PathNotFound).build())?; + + self.insert_child_at_index(parent_node, last_index, nodes.as_ref()) + } + + fn insert_child_at_index( + &mut self, + parent: NodeId, + index: usize, + insert_children: &[Box], + ) -> Result<(), OTError> { + if index == 0 && parent.children(&self.arena).next().is_none() { + self.append_subtree(&parent, insert_children); + return Ok(()); + } + + let children_length = parent.children(&self.arena).fold(0, |counter, _| counter + 1); + + if index == children_length { + self.append_subtree(&parent, insert_children); + return Ok(()); + } + + let node_to_insert = self + .child_at_index_of_path(parent, index) + .ok_or(ErrorBuilder::new(OTErrorCode::PathNotFound).build())?; + + self.insert_subtree_before(&node_to_insert, insert_children); + Ok(()) + } + + // recursive append the subtrees to the node + fn append_subtree(&mut self, parent: &NodeId, insert_children: &[Box]) { + for child in insert_children { + let child_id = self.arena.new_node(child.to_node_data()); + parent.append(child_id, &mut self.arena); + + self.append_subtree(&child_id, child.children.as_ref()); + } + } + + fn insert_subtree_before(&mut self, before: &NodeId, insert_children: &[Box]) { + for child in insert_children { + let child_id = self.arena.new_node(child.to_node_data()); + before.insert_before(child_id, &mut self.arena); + + self.append_subtree(&child_id, child.children.as_ref()); + } + } + + fn apply_update(&mut self, path: &Position, attributes: &NodeAttributes) -> Result<(), OTError> { + let update_node = self + .node_at_path(path) + .ok_or(ErrorBuilder::new(OTErrorCode::PathNotFound).build())?; + let node_data = self.arena.get_mut(update_node).unwrap(); + let new_node = { + let old_attributes = &node_data.get().attributes; + let new_attributes = NodeAttributes::compose(&old_attributes, attributes); + NodeData { + attributes: new_attributes, + ..node_data.get().clone() + } + }; + *node_data.get_mut() = new_node; + Ok(()) + } + + fn apply_delete(&mut self, path: &Position, len: usize) -> Result<(), OTError> { + let mut update_node = self + .node_at_path(path) + .ok_or(ErrorBuilder::new(OTErrorCode::PathNotFound).build())?; + for _ in 0..len { + let next = update_node.following_siblings(&self.arena).next(); + update_node.remove_subtree(&mut self.arena); + if let Some(next_id) = next { + update_node = next_id; + } else { + break; + } + } + Ok(()) + } + + fn apply_text_edit(&mut self, path: &Position, delta: &TextDelta) -> Result<(), OTError> { + let edit_node = self + .node_at_path(path) + .ok_or(ErrorBuilder::new(OTErrorCode::PathNotFound).build())?; + let node_data = self.arena.get_mut(edit_node).unwrap(); + let new_delta = if let Some(old_delta) = &node_data.get().delta { + Some(old_delta.compose(delta)?) + } else { + None + }; + if let Some(new_delta) = new_delta { + *node_data.get_mut() = NodeData { + delta: Some(new_delta), + ..node_data.get().clone() + }; + }; + Ok(()) + } +} diff --git a/shared-lib/lib-ot/src/core/document/document_operation.rs b/shared-lib/lib-ot/src/core/document/document_operation.rs new file mode 100644 index 0000000000..4d9d3617eb --- /dev/null +++ b/shared-lib/lib-ot/src/core/document/document_operation.rs @@ -0,0 +1,215 @@ +use crate::core::document::position::Position; +use crate::core::{NodeAttributes, NodeSubTree, TextDelta}; + +#[derive(Clone, serde::Serialize, serde::Deserialize)] +#[serde(tag = "op")] +pub enum DocumentOperation { + #[serde(rename = "insert")] + Insert { + path: Position, + nodes: Vec>, + }, + #[serde(rename = "update")] + Update { + path: Position, + attributes: NodeAttributes, + #[serde(rename = "oldAttributes")] + old_attributes: NodeAttributes, + }, + #[serde(rename = "delete")] + Delete { + path: Position, + nodes: Vec>, + }, + #[serde(rename = "text-edit")] + TextEdit { + path: Position, + delta: TextDelta, + inverted: TextDelta, + }, +} + +impl DocumentOperation { + pub fn path(&self) -> &Position { + match self { + DocumentOperation::Insert { path, .. } => path, + DocumentOperation::Update { path, .. } => path, + DocumentOperation::Delete { path, .. } => path, + DocumentOperation::TextEdit { path, .. } => path, + } + } + pub fn invert(&self) -> DocumentOperation { + match self { + DocumentOperation::Insert { path, nodes } => DocumentOperation::Delete { + path: path.clone(), + nodes: nodes.clone(), + }, + DocumentOperation::Update { + path, + attributes, + old_attributes, + } => DocumentOperation::Update { + path: path.clone(), + attributes: old_attributes.clone(), + old_attributes: attributes.clone(), + }, + DocumentOperation::Delete { path, nodes } => DocumentOperation::Insert { + path: path.clone(), + nodes: nodes.clone(), + }, + DocumentOperation::TextEdit { path, delta, inverted } => DocumentOperation::TextEdit { + path: path.clone(), + delta: inverted.clone(), + inverted: delta.clone(), + }, + } + } + pub fn clone_with_new_path(&self, path: Position) -> DocumentOperation { + match self { + DocumentOperation::Insert { nodes, .. } => DocumentOperation::Insert { + path, + nodes: nodes.clone(), + }, + DocumentOperation::Update { + attributes, + old_attributes, + .. + } => DocumentOperation::Update { + path, + attributes: attributes.clone(), + old_attributes: old_attributes.clone(), + }, + DocumentOperation::Delete { nodes, .. } => DocumentOperation::Delete { + path, + nodes: nodes.clone(), + }, + DocumentOperation::TextEdit { delta, inverted, .. } => DocumentOperation::TextEdit { + path, + delta: delta.clone(), + inverted: inverted.clone(), + }, + } + } + pub fn transform(a: &DocumentOperation, b: &DocumentOperation) -> DocumentOperation { + match a { + DocumentOperation::Insert { path: a_path, nodes } => { + let new_path = Position::transform(a_path, b.path(), nodes.len() as i64); + b.clone_with_new_path(new_path) + } + DocumentOperation::Delete { path: a_path, nodes } => { + let new_path = Position::transform(a_path, b.path(), nodes.len() as i64); + b.clone_with_new_path(new_path) + } + _ => b.clone(), + } + } +} + +#[cfg(test)] +mod tests { + use crate::core::{Delta, DocumentOperation, NodeAttributes, NodeSubTree, Position}; + + #[test] + fn test_transform_path_1() { + assert_eq!( + { Position::transform(&Position(vec![0, 1]), &Position(vec![0, 1]), 1) }.0, + vec![0, 2] + ); + } + + #[test] + fn test_transform_path_2() { + assert_eq!( + { Position::transform(&Position(vec![0, 1]), &Position(vec![0, 2]), 1) }.0, + vec![0, 3] + ); + } + + #[test] + fn test_transform_path_3() { + assert_eq!( + { Position::transform(&Position(vec![0, 1]), &Position(vec![0, 2, 7, 8, 9]), 1) }.0, + vec![0, 3, 7, 8, 9] + ); + } + + #[test] + fn test_transform_path_not_changed() { + assert_eq!( + { Position::transform(&Position(vec![0, 1, 2]), &Position(vec![0, 0, 7, 8, 9]), 1) }.0, + vec![0, 0, 7, 8, 9] + ); + assert_eq!( + { Position::transform(&Position(vec![0, 1, 2]), &Position(vec![0, 1]), 1) }.0, + vec![0, 1] + ); + assert_eq!( + { Position::transform(&Position(vec![1, 1]), &Position(vec![1, 0]), 1) }.0, + vec![1, 0] + ); + } + + #[test] + fn test_transform_delta() { + assert_eq!( + { Position::transform(&Position(vec![0, 1]), &Position(vec![0, 1]), 5) }.0, + vec![0, 6] + ); + } + + #[test] + fn test_serialize_insert_operation() { + let insert = DocumentOperation::Insert { + path: Position(vec![0, 1]), + nodes: vec![Box::new(NodeSubTree::new("text"))], + }; + let result = serde_json::to_string(&insert).unwrap(); + assert_eq!( + result, + r#"{"op":"insert","path":[0,1],"nodes":[{"type":"text","attributes":{}}]}"# + ); + } + + #[test] + fn test_serialize_insert_sub_trees() { + let insert = DocumentOperation::Insert { + path: Position(vec![0, 1]), + nodes: vec![Box::new(NodeSubTree { + node_type: "text".into(), + attributes: NodeAttributes::new(), + delta: None, + children: vec![Box::new(NodeSubTree::new("text".into()))], + })], + }; + let result = serde_json::to_string(&insert).unwrap(); + assert_eq!( + result, + r#"{"op":"insert","path":[0,1],"nodes":[{"type":"text","attributes":{},"children":[{"type":"text","attributes":{}}]}]}"# + ); + } + + #[test] + fn test_serialize_update_operation() { + let insert = DocumentOperation::Update { + path: Position(vec![0, 1]), + attributes: NodeAttributes::new(), + old_attributes: NodeAttributes::new(), + }; + let result = serde_json::to_string(&insert).unwrap(); + assert_eq!( + result, + r#"{"op":"update","path":[0,1],"attributes":{},"oldAttributes":{}}"# + ); + } + + #[test] + fn test_serialize_text_edit_operation() { + let insert = DocumentOperation::TextEdit { + path: Position(vec![0, 1]), + delta: Delta::new(), + inverted: Delta::new(), + }; + let result = serde_json::to_string(&insert).unwrap(); + assert_eq!(result, r#"{"op":"text-edit","path":[0,1],"delta":[],"inverted":[]}"#); + } +} diff --git a/shared-lib/lib-ot/src/core/document/mod.rs b/shared-lib/lib-ot/src/core/document/mod.rs new file mode 100644 index 0000000000..b019cb0f71 --- /dev/null +++ b/shared-lib/lib-ot/src/core/document/mod.rs @@ -0,0 +1,13 @@ +mod attributes; +mod document; +mod document_operation; +mod node; +mod position; +mod transaction; + +pub use attributes::*; +pub use document::*; +pub use document_operation::*; +pub use node::*; +pub use position::*; +pub use transaction::*; diff --git a/shared-lib/lib-ot/src/core/document/node.rs b/shared-lib/lib-ot/src/core/document/node.rs new file mode 100644 index 0000000000..e74c7d4918 --- /dev/null +++ b/shared-lib/lib-ot/src/core/document/node.rs @@ -0,0 +1,48 @@ +use crate::core::{NodeAttributes, TextDelta}; + +#[derive(Clone)] +pub struct NodeData { + pub node_type: String, + pub attributes: NodeAttributes, + pub delta: Option, +} + +impl NodeData { + pub fn new(node_type: &str) -> NodeData { + NodeData { + node_type: node_type.into(), + attributes: NodeAttributes::new(), + delta: None, + } + } +} + +#[derive(Clone, serde::Serialize, serde::Deserialize)] +pub struct NodeSubTree { + #[serde(rename = "type")] + pub node_type: String, + pub attributes: NodeAttributes, + #[serde(skip_serializing_if = "Option::is_none")] + pub delta: Option, + #[serde(skip_serializing_if = "Vec::is_empty")] + pub children: Vec>, +} + +impl NodeSubTree { + pub fn new(node_type: &str) -> NodeSubTree { + NodeSubTree { + node_type: node_type.into(), + attributes: NodeAttributes::new(), + delta: None, + children: Vec::new(), + } + } + + pub fn to_node_data(&self) -> NodeData { + NodeData { + node_type: self.node_type.clone(), + attributes: self.attributes.clone(), + delta: self.delta.clone(), + } + } +} diff --git a/shared-lib/lib-ot/src/core/document/position.rs b/shared-lib/lib-ot/src/core/document/position.rs new file mode 100644 index 0000000000..b98edd97f4 --- /dev/null +++ b/shared-lib/lib-ot/src/core/document/position.rs @@ -0,0 +1,46 @@ +#[derive(Clone, serde::Serialize, serde::Deserialize)] +pub struct Position(pub Vec); + +impl Position { + pub fn is_empty(&self) -> bool { + self.0.is_empty() + } + pub fn len(&self) -> usize { + self.0.len() + } +} + +impl Position { + // delta is default to be 1 + pub fn transform(pre_insert_path: &Position, b: &Position, offset: i64) -> Position { + if pre_insert_path.len() > b.len() { + return b.clone(); + } + if pre_insert_path.is_empty() || b.is_empty() { + return b.clone(); + } + // check the prefix + for i in 0..(pre_insert_path.len() - 1) { + if pre_insert_path.0[i] != b.0[i] { + return b.clone(); + } + } + let mut prefix: Vec = pre_insert_path.0[0..(pre_insert_path.len() - 1)].into(); + let mut suffix: Vec = b.0[pre_insert_path.0.len()..].into(); + let prev_insert_last: usize = *pre_insert_path.0.last().unwrap(); + let b_at_index = b.0[pre_insert_path.0.len() - 1]; + if prev_insert_last <= b_at_index { + prefix.push(((b_at_index as i64) + offset) as usize); + } else { + prefix.push(b_at_index); + } + prefix.append(&mut suffix); + return Position(prefix); + } +} + +impl From> for Position { + fn from(v: Vec) -> Self { + Position(v) + } +} diff --git a/shared-lib/lib-ot/src/core/document/transaction.rs b/shared-lib/lib-ot/src/core/document/transaction.rs new file mode 100644 index 0000000000..73fce7d8ad --- /dev/null +++ b/shared-lib/lib-ot/src/core/document/transaction.rs @@ -0,0 +1,106 @@ +use crate::core::document::position::Position; +use crate::core::{DocumentOperation, DocumentTree, NodeAttributes, NodeSubTree}; +use indextree::NodeId; +use std::collections::HashMap; + +pub struct Transaction { + pub operations: Vec, +} + +impl Transaction { + fn new(operations: Vec) -> Transaction { + Transaction { operations } + } +} + +pub struct TransactionBuilder<'a> { + document: &'a DocumentTree, + operations: Vec, +} + +impl<'a> TransactionBuilder<'a> { + pub fn new(document: &'a DocumentTree) -> TransactionBuilder { + TransactionBuilder { + document, + operations: Vec::new(), + } + } + + pub fn insert_nodes_at_path(&mut self, path: &Position, nodes: &[Box]) { + self.push(DocumentOperation::Insert { + path: path.clone(), + nodes: nodes.to_vec(), + }); + } + + pub fn update_attributes_at_path(&mut self, path: &Position, attributes: HashMap>) { + let mut old_attributes: HashMap> = HashMap::new(); + let node = self.document.node_at_path(path).unwrap(); + let node_data = self.document.arena.get(node).unwrap().get(); + + for key in attributes.keys() { + let old_attrs = &node_data.attributes; + let old_value = match old_attrs.0.get(key.as_str()) { + Some(value) => value.clone(), + None => None, + }; + old_attributes.insert(key.clone(), old_value); + } + + self.push(DocumentOperation::Update { + path: path.clone(), + attributes: NodeAttributes(attributes), + old_attributes: NodeAttributes(old_attributes), + }) + } + + pub fn delete_node_at_path(&mut self, path: &Position) { + self.delete_nodes_at_path(path, 1); + } + + pub fn delete_nodes_at_path(&mut self, path: &Position, length: usize) { + let mut node = self.document.node_at_path(path).unwrap(); + let mut deleted_nodes: Vec> = Vec::new(); + + for _ in 0..length { + deleted_nodes.push(self.get_deleted_nodes(node.clone())); + node = node.following_siblings(&self.document.arena).next().unwrap(); + } + + self.operations.push(DocumentOperation::Delete { + path: path.clone(), + nodes: deleted_nodes, + }) + } + + fn get_deleted_nodes(&self, node_id: NodeId) -> Box { + let node = self.document.arena.get(node_id.clone()).unwrap(); + let node_data = node.get(); + let mut children: Vec> = vec![]; + + let mut children_iterators = node_id.children(&self.document.arena); + loop { + let next_child = children_iterators.next(); + if let Some(child_id) = next_child { + children.push(self.get_deleted_nodes(child_id)); + } else { + break; + } + } + + Box::new(NodeSubTree { + node_type: node_data.node_type.clone(), + attributes: node_data.attributes.clone(), + delta: node_data.delta.clone(), + children, + }) + } + + pub fn push(&mut self, op: DocumentOperation) { + self.operations.push(op); + } + + pub fn finalize(self) -> Transaction { + Transaction::new(self.operations) + } +} diff --git a/shared-lib/lib-ot/src/core/mod.rs b/shared-lib/lib-ot/src/core/mod.rs index 7c1ed3f2ef..262233c85a 100644 --- a/shared-lib/lib-ot/src/core/mod.rs +++ b/shared-lib/lib-ot/src/core/mod.rs @@ -1,9 +1,11 @@ mod delta; +mod document; mod interval; mod operation; mod ot_str; pub use delta::*; +pub use document::*; pub use interval::*; pub use operation::*; pub use ot_str::*; diff --git a/shared-lib/lib-ot/src/errors.rs b/shared-lib/lib-ot/src/errors.rs index e7aea28bcf..eb313c784f 100644 --- a/shared-lib/lib-ot/src/errors.rs +++ b/shared-lib/lib-ot/src/errors.rs @@ -60,7 +60,7 @@ impl std::convert::From for OTError { } } -#[derive(Debug, Clone)] +#[derive(Debug, Clone, Eq, PartialEq)] pub enum OTErrorCode { IncompatibleLength, ApplyInsertFail, @@ -74,6 +74,7 @@ pub enum OTErrorCode { DuplicatedRevision, RevisionIDConflict, Internal, + PathNotFound, } pub struct ErrorBuilder { diff --git a/shared-lib/lib-ot/tests/main.rs b/shared-lib/lib-ot/tests/main.rs index 8b13789179..31e7748b3a 100644 --- a/shared-lib/lib-ot/tests/main.rs +++ b/shared-lib/lib-ot/tests/main.rs @@ -1 +1,147 @@ +use lib_ot::core::{DocumentTree, NodeAttributes, NodeSubTree, Position, TransactionBuilder}; +use lib_ot::errors::OTErrorCode; +use std::collections::HashMap; +#[test] +fn main() { + // Create a new arena + let _document = DocumentTree::new(); +} + +#[test] +fn test_documents() { + let mut document = DocumentTree::new(); + let transaction = { + let mut tb = TransactionBuilder::new(&document); + tb.insert_nodes_at_path(&vec![0].into(), &vec![Box::new(NodeSubTree::new("text"))]); + tb.finalize() + }; + document.apply(transaction).unwrap(); + + assert!(document.node_at_path(&vec![0].into()).is_some()); + let node = document.node_at_path(&vec![0].into()).unwrap(); + let node_data = document.arena.get(node).unwrap().get(); + assert_eq!(node_data.node_type, "text"); + + let transaction = { + let mut tb = TransactionBuilder::new(&document); + tb.update_attributes_at_path( + &vec![0].into(), + HashMap::from([("subtype".into(), Some("bullet-list".into()))]), + ); + tb.finalize() + }; + document.apply(transaction).unwrap(); + + let transaction = { + let mut tb = TransactionBuilder::new(&document); + tb.delete_node_at_path(&vec![0].into()); + tb.finalize() + }; + document.apply(transaction).unwrap(); + assert!(document.node_at_path(&vec![0].into()).is_none()); +} + +#[test] +fn test_inserts_nodes() { + let mut document = DocumentTree::new(); + let transaction = { + let mut tb = TransactionBuilder::new(&document); + tb.insert_nodes_at_path(&vec![0].into(), &vec![Box::new(NodeSubTree::new("text"))]); + tb.insert_nodes_at_path(&vec![1].into(), &vec![Box::new(NodeSubTree::new("text"))]); + tb.insert_nodes_at_path(&vec![2].into(), &vec![Box::new(NodeSubTree::new("text"))]); + tb.finalize() + }; + document.apply(transaction).unwrap(); + + let transaction = { + let mut tb = TransactionBuilder::new(&document); + tb.insert_nodes_at_path(&vec![1].into(), &vec![Box::new(NodeSubTree::new("text"))]); + tb.finalize() + }; + document.apply(transaction).unwrap(); +} + +#[test] +fn test_inserts_subtrees() { + let mut document = DocumentTree::new(); + let transaction = { + let mut tb = TransactionBuilder::new(&document); + tb.insert_nodes_at_path( + &vec![0].into(), + &vec![Box::new(NodeSubTree { + node_type: "text".into(), + attributes: NodeAttributes::new(), + delta: None, + children: vec![Box::new(NodeSubTree::new("image".into()))], + })], + ); + tb.finalize() + }; + document.apply(transaction).unwrap(); + + let node = document.node_at_path(&Position(vec![0, 0])).unwrap(); + let data = document.arena.get(node).unwrap().get(); + assert_eq!(data.node_type, "image"); +} + +#[test] +fn test_update_nodes() { + let mut document = DocumentTree::new(); + let transaction = { + let mut tb = TransactionBuilder::new(&document); + tb.insert_nodes_at_path(&vec![0].into(), &vec![Box::new(NodeSubTree::new("text"))]); + tb.insert_nodes_at_path(&vec![1].into(), &vec![Box::new(NodeSubTree::new("text"))]); + tb.insert_nodes_at_path(&vec![2].into(), &vec![Box::new(NodeSubTree::new("text"))]); + tb.finalize() + }; + document.apply(transaction).unwrap(); + + let transaction = { + let mut tb = TransactionBuilder::new(&document); + tb.update_attributes_at_path(&vec![1].into(), HashMap::from([("bolded".into(), Some("true".into()))])); + tb.finalize() + }; + document.apply(transaction).unwrap(); + + let node = document.node_at_path(&Position(vec![1])).unwrap(); + let node_data = document.arena.get(node).unwrap().get(); + let is_bold = node_data.attributes.0.get("bolded").unwrap().clone(); + assert_eq!(is_bold.unwrap(), "true"); +} + +#[test] +fn test_delete_nodes() { + let mut document = DocumentTree::new(); + let transaction = { + let mut tb = TransactionBuilder::new(&document); + tb.insert_nodes_at_path(&vec![0].into(), &vec![Box::new(NodeSubTree::new("text"))]); + tb.insert_nodes_at_path(&vec![1].into(), &vec![Box::new(NodeSubTree::new("text"))]); + tb.insert_nodes_at_path(&vec![2].into(), &vec![Box::new(NodeSubTree::new("text"))]); + tb.finalize() + }; + document.apply(transaction).unwrap(); + + let transaction = { + let mut tb = TransactionBuilder::new(&document); + tb.delete_node_at_path(&Position(vec![1])); + tb.finalize() + }; + document.apply(transaction).unwrap(); + + let len = document.root.children(&document.arena).fold(0, |count, _| count + 1); + assert_eq!(len, 2); +} + +#[test] +fn test_errors() { + let mut document = DocumentTree::new(); + let transaction = { + let mut tb = TransactionBuilder::new(&document); + tb.insert_nodes_at_path(&vec![0].into(), &vec![Box::new(NodeSubTree::new("text"))]); + tb.insert_nodes_at_path(&vec![100].into(), &vec![Box::new(NodeSubTree::new("text"))]); + tb.finalize() + }; + let result = document.apply(transaction); + assert_eq!(result.err().unwrap().code, OTErrorCode::PathNotFound); +}