Merge pull request #1877 from nextcloud/feat/nextcloud/rich-object-pa…

…rameters
nextcloud · Jul 17, 2024 · 4ced44c · 4ced44c
2 parents 64bca57 + c624c39
commit 4ced44c
Show file tree

Hide file tree

Showing 18 changed files with 753 additions and 514 deletions.
diff --git a/.cspell/nextcloud.txt b/.cspell/nextcloud.txt
@@ -1,3 +1,4 @@
+addressbook
 apirequest
 apppassword
 bigfilechunking

diff --git a/packages/neon/neon_talk/lib/src/widgets/message.dart b/packages/neon/neon_talk/lib/src/widgets/message.dart
@@ -163,40 +163,35 @@ InlineSpan buildRichObjectParameter({
   required TextStyle? textStyle,
   required bool isPreview,
 }) {
-  Widget child;
-
-  if (isPreview) {
-    child = Text(
-      parameter.name,
-      style: textStyle,
-    );
-  } else {
-    switch (parameter.type) {
-      case 'user' || 'call' || 'guest' || 'user-group' || 'group':
-        child = TalkRichObjectMention(
-          parameter: parameter,
-          textStyle: textStyle,
-        );
-      case 'file':
-        child = TalkRichObjectFile(
-          parameter: parameter,
-          textStyle: textStyle,
-        );
-      case 'deck-card':
-        child = TalkRichObjectDeckCard(
-          parameter: parameter,
-        );
-      default:
-        child = TalkRichObjectFallback(
-          parameter: parameter,
-          textStyle: textStyle,
-        );
-    }
-  }
-
   return WidgetSpan(
     alignment: PlaceholderAlignment.middle,
-    child: child,
+    child: isPreview
+        ? Text(
+            parameter.name,
+            style: textStyle,
+          )
+        : switch (parameter.type) {
+            spreed.RichObjectParameter_Type.user ||
+            spreed.RichObjectParameter_Type.call ||
+            spreed.RichObjectParameter_Type.guest ||
+            spreed.RichObjectParameter_Type.userGroup ||
+            spreed.RichObjectParameter_Type.group =>
+              TalkRichObjectMention(
+                parameter: parameter,
+                textStyle: textStyle,
+              ),
+            spreed.RichObjectParameter_Type.file => TalkRichObjectFile(
+                parameter: parameter,
+                textStyle: textStyle,
+              ),
+            spreed.RichObjectParameter_Type.deckCard => TalkRichObjectDeckCard(
+                parameter: parameter,
+              ),
+            _ => TalkRichObjectFallback(
+                parameter: parameter,
+                textStyle: textStyle,
+              ),
+          },
   );
 }
 

diff --git a/packages/neon/neon_talk/lib/src/widgets/rich_object/file.dart b/packages/neon/neon_talk/lib/src/widgets/rich_object/file.dart
@@ -24,7 +24,7 @@ class TalkRichObjectFile extends StatelessWidget {
   Widget build(BuildContext context) {
     Widget child;
 
-    if (parameter.previewAvailable == spreed.RichObjectParameter_PreviewAvailable.yes) {
+    if (parameter.previewAvailable == 'yes') {
       child = TalkRichObjectFilePreview(
         parameter: parameter,
       );

diff --git a/packages/neon/neon_talk/lib/src/widgets/rich_object/mention.dart b/packages/neon/neon_talk/lib/src/widgets/rich_object/mention.dart
@@ -28,7 +28,7 @@ class TalkRichObjectMention extends StatelessWidget {
     final bool highlight;
 
     switch (parameter.type) {
-      case 'user':
+      case spreed.RichObjectParameter_Type.user:
         final account = NeonProvider.of<Account>(context);
 
         highlight = account.username == parameter.id;
@@ -37,7 +37,7 @@ class TalkRichObjectMention extends StatelessWidget {
           account: NeonProvider.of<Account>(context),
           userStatusBloc: null,
         );
-      case 'call':
+      case spreed.RichObjectParameter_Type.call:
         highlight = true;
         child = CircleAvatar(
           child: ClipOval(
@@ -47,13 +47,13 @@ class TalkRichObjectMention extends StatelessWidget {
             ),
           ),
         );
-      case 'guest':
+      case spreed.RichObjectParameter_Type.guest:
         // TODO: Add highlighting when the mention is about the current guest user.
         highlight = false;
         child = CircleAvatar(
           child: Icon(AdaptiveIcons.person),
         );
-      case 'user-group' || 'group':
+      case spreed.RichObjectParameter_Type.userGroup || spreed.RichObjectParameter_Type.group:
         final userDetailsBloc = NeonProvider.of<UserDetailsBloc>(context);
         final groups = userDetailsBloc.userDetails.valueOrNull?.data?.groups ?? BuiltList();
 

diff --git a/packages/neon/neon_talk/test/message_test.dart b/packages/neon/neon_talk/test/message_test.dart
@@ -1173,8 +1173,14 @@ void main() {
     for (final isPreview in [true, false]) {
       group(isPreview ? 'As preview' : 'Complete', () {
         group('Mention', () {
-          for (final type in ['user', 'call', 'guest', 'user-group', 'group']) {
-            testWidgets(type, (tester) async {
+          for (final type in [
+            spreed.RichObjectParameter_Type.user,
+            spreed.RichObjectParameter_Type.call,
+            spreed.RichObjectParameter_Type.guest,
+            spreed.RichObjectParameter_Type.userGroup,
+            spreed.RichObjectParameter_Type.group,
+          ]) {
+            testWidgets(type.value, (tester) async {
               final userDetails = MockUserDetails();
               when(() => userDetails.groups).thenReturn(BuiltList());
 
@@ -1221,7 +1227,7 @@ void main() {
                 text: buildRichObjectParameter(
                   parameter: spreed.RichObjectParameter(
                     (b) => b
-                      ..type = 'file'
+                      ..type = spreed.RichObjectParameter_Type.file
                       ..id = ''
                       ..name = 'name',
                   ),
@@ -1243,7 +1249,7 @@ void main() {
                 text: buildRichObjectParameter(
                   parameter: spreed.RichObjectParameter(
                     (b) => b
-                      ..type = 'deck-card'
+                      ..type = spreed.RichObjectParameter_Type.deckCard
                       ..id = ''
                       ..name = 'name'
                       ..boardname = 'boardname'
@@ -1267,7 +1273,7 @@ void main() {
                 text: buildRichObjectParameter(
                   parameter: spreed.RichObjectParameter(
                     (b) => b
-                      ..type = 'unknown'
+                      ..type = spreed.RichObjectParameter_Type.addressbook
                       ..id = ''
                       ..name = 'name',
                   ),
@@ -1319,7 +1325,7 @@ void main() {
               BuiltMap({
                 type: spreed.RichObjectParameter(
                   (b) => b
-                    ..type = ''
+                    ..type = spreed.RichObjectParameter_Type.user
                     ..id = ''
                     ..name = '',
                 ),
@@ -1344,7 +1350,7 @@ void main() {
           BuiltMap({
             'file': spreed.RichObjectParameter(
               (b) => b
-                ..type = 'file'
+                ..type = spreed.RichObjectParameter_Type.file
                 ..id = ''
                 ..name = '',
             ),
@@ -1371,13 +1377,13 @@ void main() {
         BuiltMap({
           'actor1': spreed.RichObjectParameter(
             (b) => b
-              ..type = 'user'
+              ..type = spreed.RichObjectParameter_Type.user
               ..id = ''
               ..name = '',
           ),
           'actor2': spreed.RichObjectParameter(
             (b) => b
-              ..type = 'user'
+              ..type = spreed.RichObjectParameter_Type.user
               ..id = ''
               ..name = '',
           ),

diff --git a/packages/neon/neon_talk/test/rich_object_test.dart b/packages/neon/neon_talk/test/rich_object_test.dart
@@ -50,7 +50,7 @@ void main() {
         child: TalkRichObjectDeckCard(
           parameter: spreed.RichObjectParameter(
             (b) => b
-              ..type = ''
+              ..type = spreed.RichObjectParameter_Type.deckCard
               ..id = ''
               ..name = 'name'
               ..boardname = 'boardname'
@@ -82,7 +82,7 @@ void main() {
             child: TalkRichObjectMention(
               parameter: spreed.RichObjectParameter(
                 (b) => b
-                  ..type = 'user'
+                  ..type = spreed.RichObjectParameter_Type.user
                   ..id = 'username'
                   ..name = 'name',
               ),
@@ -107,7 +107,7 @@ void main() {
             child: TalkRichObjectMention(
               parameter: spreed.RichObjectParameter(
                 (b) => b
-                  ..type = 'user'
+                  ..type = spreed.RichObjectParameter_Type.user
                   ..id = 'other'
                   ..name = 'name',
               ),
@@ -133,7 +133,7 @@ void main() {
           child: TalkRichObjectMention(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = 'call'
+                ..type = spreed.RichObjectParameter_Type.call
                 ..id = ''
                 ..name = 'name'
                 ..iconUrl = '',
@@ -156,7 +156,7 @@ void main() {
           child: TalkRichObjectMention(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = 'guest'
+                ..type = spreed.RichObjectParameter_Type.guest
                 ..id = ''
                 ..name = 'name',
             ),
@@ -172,8 +172,11 @@ void main() {
       );
     });
 
-    for (final type in ['user-group', 'group']) {
-      testWidgets(type, (tester) async {
+    for (final type in [
+      spreed.RichObjectParameter_Type.userGroup,
+      spreed.RichObjectParameter_Type.group,
+    ]) {
+      testWidgets(type.value, (tester) async {
         final userDetails = MockUserDetails();
         when(() => userDetails.groups).thenReturn(BuiltList(['group']));
 
@@ -200,7 +203,7 @@ void main() {
         expect(find.text('name'), findsOne);
         await expectLater(
           find.byType(TalkRichObjectMention),
-          matchesGoldenFile('goldens/rich_object_mention_${type}_highlight.png'),
+          matchesGoldenFile('goldens/rich_object_mention_${type.value}_highlight.png'),
         );
 
         await tester.pumpWidgetWithAccessibility(
@@ -223,7 +226,7 @@ void main() {
         expect(find.text('name'), findsOne);
         await expectLater(
           find.byType(TalkRichObjectMention),
-          matchesGoldenFile('goldens/rich_object_mention_${type}_other.png'),
+          matchesGoldenFile('goldens/rich_object_mention_${type.value}_other.png'),
         );
       });
     }
@@ -239,10 +242,10 @@ void main() {
           child: TalkRichObjectFile(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = ''
+                ..type = spreed.RichObjectParameter_Type.file
                 ..id = '0'
                 ..name = 'name'
-                ..previewAvailable = spreed.RichObjectParameter_PreviewAvailable.no
+                ..previewAvailable = 'no'
                 ..path = ''
                 ..link = '/link',
             ),
@@ -264,10 +267,10 @@ void main() {
           child: TalkRichObjectFile(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = ''
+                ..type = spreed.RichObjectParameter_Type.file
                 ..id = '0'
                 ..name = 'name'
-                ..previewAvailable = spreed.RichObjectParameter_PreviewAvailable.yes
+                ..previewAvailable = 'yes'
                 ..path = '',
             ),
             textStyle: null,
@@ -283,10 +286,10 @@ void main() {
           child: TalkRichObjectFile(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = ''
+                ..type = spreed.RichObjectParameter_Type.file
                 ..id = '0'
                 ..name = 'name'
-                ..previewAvailable = spreed.RichObjectParameter_PreviewAvailable.no
+                ..previewAvailable = 'no'
                 ..path = '',
             ),
             textStyle: null,
@@ -316,10 +319,10 @@ void main() {
           child: TalkRichObjectFile(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = ''
+                ..type = spreed.RichObjectParameter_Type.file
                 ..id = '0'
                 ..name = 'name'
-                ..previewAvailable = spreed.RichObjectParameter_PreviewAvailable.yes
+                ..previewAvailable = 'yes'
                 ..path = 'path',
             ),
             textStyle: null,
@@ -347,10 +350,10 @@ void main() {
           child: TalkRichObjectFile(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = ''
+                ..type = spreed.RichObjectParameter_Type.file
                 ..id = '0'
                 ..name = 'name'
-                ..previewAvailable = spreed.RichObjectParameter_PreviewAvailable.yes
+                ..previewAvailable = 'yes'
                 ..path = 'path'
                 ..width = ($int: width, string: null)
                 ..height = ($int: height, string: null),
@@ -380,10 +383,10 @@ void main() {
           child: TalkRichObjectFile(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = ''
+                ..type = spreed.RichObjectParameter_Type.file
                 ..id = '0'
                 ..name = 'name'
-                ..previewAvailable = spreed.RichObjectParameter_PreviewAvailable.yes
+                ..previewAvailable = 'yes'
                 ..path = 'path'
                 ..width = ($int: (maxWidth * widthFactor) * pixelRatio, string: null)
                 ..height = ($int: (maxHeight * heightFactor) * pixelRatio, string: null),
@@ -414,10 +417,10 @@ void main() {
           child: TalkRichObjectFile(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = ''
+                ..type = spreed.RichObjectParameter_Type.file
                 ..id = '0'
                 ..name = 'name'
-                ..previewAvailable = spreed.RichObjectParameter_PreviewAvailable.yes
+                ..previewAvailable = 'yes'
                 ..path = 'path'
                 ..mimetype = 'image/gif',
             ),
@@ -447,7 +450,7 @@ void main() {
           child: TalkRichObjectFallback(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = ''
+                ..type = spreed.RichObjectParameter_Type.calendarEvent
                 ..id = ''
                 ..name = 'name'
                 ..link = '/link',
@@ -467,7 +470,7 @@ void main() {
           child: TalkRichObjectFallback(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = ''
+                ..type = spreed.RichObjectParameter_Type.addressbook
                 ..id = ''
                 ..name = 'name',
             ),
@@ -492,7 +495,7 @@ void main() {
           child: TalkRichObjectFallback(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = ''
+                ..type = spreed.RichObjectParameter_Type.addressbook
                 ..id = ''
                 ..name = 'name'
                 ..iconUrl = '',