feat(tool,nextcloud)!: Generate rich object parameters

Signed-off-by: provokateurin <kate@provokateurin.de>
nextcloud · May 21, 2024 · be34dde · be34dde
1 parent d888526
commit be34dde
Show file tree

Hide file tree

Showing 15 changed files with 721 additions and 525 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
@@ -119,40 +119,34 @@ InlineSpan buildRichObjectParameter({
   required TextStyle? textStyle,
   required bool isPreview,
 }) {
-  Widget child;
-
-  const mentionTypes = ['user', 'call', 'guest', 'user-group', 'group'];
-  if (mentionTypes.contains(parameter.type)) {
-    child = TalkRichObjectMention(
-      parameter: parameter,
-      textStyle: textStyle,
-    );
-  } else {
-    if (isPreview) {
-      child = Text(parameter.name);
-    } else {
-      switch (parameter.type) {
-        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: 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,
+        ),
+      _ => isPreview
+          ? Text(parameter.name)
+          : switch (parameter.type) {
+              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
@@ -27,7 +27,7 @@ class TalkRichObjectFile extends StatelessWidget {
   Widget build(BuildContext context) {
     Widget child;
 
-    if (parameter.previewAvailable == spreed.RichObjectParameter_PreviewAvailable.yes) {
+    if (parameter.previewAvailable == 'yes') {
       final maxHeight = MediaQuery.sizeOf(context).height / 2;
 
       var width = _parseDimension(parameter.width);

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
@@ -27,7 +27,7 @@ class TalkRichObjectMention extends StatelessWidget {
     final bool highlight;
 
     switch (parameter.type) {
-      case 'user':
+      case spreed.RichObjectParameter_Type.user:
         final accountsBloc = NeonProvider.of<AccountsBloc>(context);
         final account = accountsBloc.activeAccount.value!;
 
@@ -36,7 +36,7 @@ class TalkRichObjectMention extends StatelessWidget {
           username: parameter.id,
           showStatus: false,
         );
-      case 'call':
+      case spreed.RichObjectParameter_Type.call:
         highlight = true;
         child = CircleAvatar(
           child: ClipOval(
@@ -45,13 +45,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 accountsBloc = NeonProvider.of<AccountsBloc>(context);
         final userDetailsBloc = accountsBloc.activeUserDetailsBloc;
         final groups = userDetailsBloc.userDetails.valueOrNull?.data?.groups ?? BuiltList();

diff --git a/packages/neon/neon_talk/test/goldens/rich_object_mention_user_other.png b/packages/neon/neon_talk/test/goldens/rich_object_mention_user_other.png
diff --git a/packages/neon/neon_talk/test/message_test.dart b/packages/neon/neon_talk/test/message_test.dart
@@ -696,8 +696,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());
 
@@ -749,7 +755,7 @@ void main() {
                 text: buildRichObjectParameter(
                   parameter: spreed.RichObjectParameter(
                     (b) => b
-                      ..type = 'file'
+                      ..type = spreed.RichObjectParameter_Type.file
                       ..id = ''
                       ..name = 'name',
                   ),
@@ -771,7 +777,7 @@ void main() {
                 text: buildRichObjectParameter(
                   parameter: spreed.RichObjectParameter(
                     (b) => b
-                      ..type = 'deck-card'
+                      ..type = spreed.RichObjectParameter_Type.deckCard
                       ..id = ''
                       ..name = 'name'
                       ..boardname = 'boardname'
@@ -795,7 +801,7 @@ void main() {
                 text: buildRichObjectParameter(
                   parameter: spreed.RichObjectParameter(
                     (b) => b
-                      ..type = 'unknown'
+                      ..type = spreed.RichObjectParameter_Type.addressbook
                       ..id = ''
                       ..name = 'name',
                   ),
@@ -836,7 +842,7 @@ void main() {
               BuiltMap({
                 type: spreed.RichObjectParameter(
                   (b) => b
-                    ..type = ''
+                    ..type = spreed.RichObjectParameter_Type.user
                     ..id = ''
                     ..name = '',
                 ),
@@ -856,7 +862,7 @@ void main() {
           BuiltMap({
             'file': spreed.RichObjectParameter(
               (b) => b
-                ..type = 'file'
+                ..type = spreed.RichObjectParameter_Type.file
                 ..id = ''
                 ..name = '',
             ),
@@ -878,13 +884,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
@@ -48,7 +48,7 @@ void main() {
         child: TalkRichObjectDeckCard(
           parameter: spreed.RichObjectParameter(
             (b) => b
-              ..type = ''
+              ..type = spreed.RichObjectParameter_Type.deckCard
               ..id = ''
               ..name = 'name'
               ..boardname = 'boardname'
@@ -75,7 +75,7 @@ void main() {
           child: TalkRichObjectMention(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = 'user'
+                ..type = spreed.RichObjectParameter_Type.user
                 ..id = 'username'
                 ..name = 'name',
             ),
@@ -95,14 +95,17 @@ void main() {
           providers: [
             NeonProvider<AccountsBloc>.value(value: accountsBloc),
           ],
-          child: TalkRichObjectMention(
-            parameter: spreed.RichObjectParameter(
-              (b) => b
-                ..type = 'user'
-                ..id = 'other'
-                ..name = 'name',
+          child: NeonProvider<AccountsBloc>.value(
+            value: accountsBloc,
+            child: TalkRichObjectMention(
+              parameter: spreed.RichObjectParameter(
+                (b) => b
+                  ..type = spreed.RichObjectParameter_Type.user
+                  ..id = 'other'
+                  ..name = 'name',
+              ),
+              textStyle: null,
             ),
-            textStyle: null,
           ),
         ),
       );
@@ -120,15 +123,18 @@ void main() {
           providers: [
             NeonProvider<AccountsBloc>.value(value: accountsBloc),
           ],
-          child: TalkRichObjectMention(
-            parameter: spreed.RichObjectParameter(
-              (b) => b
-                ..type = 'call'
-                ..id = ''
-                ..name = 'name'
-                ..iconUrl = '',
+          child: NeonProvider<AccountsBloc>.value(
+            value: accountsBloc,
+            child: TalkRichObjectMention(
+              parameter: spreed.RichObjectParameter(
+                (b) => b
+                  ..type = spreed.RichObjectParameter_Type.call
+                  ..id = ''
+                  ..name = 'name'
+                  ..iconUrl = '',
+              ),
+              textStyle: null,
             ),
-            textStyle: null,
           ),
         ),
       );
@@ -146,7 +152,7 @@ void main() {
           child: TalkRichObjectMention(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = 'guest'
+                ..type = spreed.RichObjectParameter_Type.guest
                 ..id = ''
                 ..name = 'name',
             ),
@@ -162,8 +168,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']));
 
@@ -192,7 +201,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.pumpWidget(
@@ -215,7 +224,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'),
         );
       });
     }
@@ -228,16 +237,19 @@ void main() {
           providers: [
             NeonProvider<AccountsBloc>.value(value: accountsBloc),
           ],
-          child: TalkRichObjectFile(
-            parameter: spreed.RichObjectParameter(
-              (b) => b
-                ..type = ''
-                ..id = '0'
-                ..name = 'name'
-                ..previewAvailable = spreed.RichObjectParameter_PreviewAvailable.yes
-                ..path = '',
+          child: NeonProvider<AccountsBloc>.value(
+            value: accountsBloc,
+            child: TalkRichObjectFile(
+              parameter: spreed.RichObjectParameter(
+                (b) => b
+                  ..type = spreed.RichObjectParameter_Type.file
+                  ..id = '0'
+                  ..name = 'name'
+                  ..previewAvailable = 'yes'
+                  ..path = '',
+              ),
+              textStyle: null,
             ),
-            textStyle: null,
           ),
         ),
       );
@@ -255,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.no
+                ..previewAvailable = 'no'
                 ..path = '',
             ),
             textStyle: null,
@@ -281,7 +293,7 @@ void main() {
           child: TalkRichObjectFallback(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = ''
+                ..type = spreed.RichObjectParameter_Type.addressbook
                 ..id = ''
                 ..name = 'name',
             ),
@@ -306,7 +318,7 @@ void main() {
           child: TalkRichObjectFallback(
             parameter: spreed.RichObjectParameter(
               (b) => b
-                ..type = ''
+                ..type = spreed.RichObjectParameter_Type.addressbook
                 ..id = ''
                 ..name = 'name'
                 ..iconUrl = '',