emoji: Add toString on EmojiCandidate and EmojiAutocompleteResult

Very useful when these objects appear in test failures.
gnprice · Dec 8, 2024 · 1b1a26b · 1b1a26b
1 parent d368126
commit 1b1a26b
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/lib/model/autocomplete.dart b/lib/model/autocomplete.dart
@@ -766,6 +766,11 @@ class EmojiAutocompleteResult extends ComposeAutocompleteResult {
   final int rank;
 
   final EmojiCandidate candidate;
+
+  @override
+  String toString() {
+    return 'EmojiAutocompleteResult(${candidate.description()})';
+  }
 }
 
 /// A result from an @-mention autocomplete interaction,

diff --git a/lib/model/emoji.dart b/lib/model/emoji.dart
@@ -87,6 +87,18 @@ final class EmojiCandidate {
     required List<String>? aliases,
     required this.emojiDisplay,
   }) : _aliases = aliases;
+
+  /// Used for implementing [toString] and [EmojiAutocompleteResult.toString].
+  String description() {
+    final typeLabel = emojiType.name.replaceFirst(RegExp(r'Emoji$'), '');
+    return '$typeLabel $emojiCode $emojiName'
+      '${aliases.isNotEmpty ? ' $aliases' : ''}';
+  }
+
+  @override
+  String toString() {
+    return 'EmojiCandidate(${description()})';
+  }
 }
 
 // Zulip's hand selected "popular" emojis, currently used as list of