refactor: rename Mascots enum to Mascot

VGVentures · Jun 5, 2024 · 55a90c9 · 55a90c9
1 parent 7133427
commit 55a90c9
Show file tree

Hide file tree

Showing 56 changed files with 317 additions and 320 deletions.
diff --git a/api/packages/crossword_repository/lib/src/crossword_repository.dart b/api/packages/crossword_repository/lib/src/crossword_repository.dart
@@ -82,7 +82,7 @@ class CrosswordRepository {
   /// The second value returns true if the answer was previously answered.
   Future<(bool, bool)> answerWord(
     String wordId,
-    Mascots mascot,
+    Mascot mascot,
     String userAnswer,
   ) async {
     final correctAnswer = await findAnswerById(wordId);

diff --git a/api/packages/crossword_repository/test/src/crossword_repository_test.dart b/api/packages/crossword_repository/test/src/crossword_repository_test.dart
@@ -164,7 +164,7 @@ void main() {
         answer: 'solved',
         clue: '',
         solvedTimestamp: 12343,
-        mascot: Mascots.sparky,
+        mascot: Mascot.sparky,
       );
 
       setUp(() {
@@ -296,8 +296,7 @@ void main() {
         final time = DateTime.now();
         final clock = Clock.fixed(time);
         await withClock(clock, () async {
-          final valid =
-              await repository.answerWord('4', Mascots.dino, 'solved');
+          final valid = await repository.answerWord('4', Mascot.dino, 'solved');
           expect(valid, (true, true));
         });
       });
@@ -308,7 +307,7 @@ void main() {
         final clock = Clock.fixed(time);
         await withClock(clock, () async {
           final valid =
-              await repository.answerWord('1', Mascots.dino, 'flutter');
+              await repository.answerWord('1', Mascot.dino, 'flutter');
           expect(valid, (true, false));
 
           verify(
@@ -338,7 +337,7 @@ void main() {
                     word
                         .copyWith(
                           solvedTimestamp: time.millisecondsSinceEpoch,
-                          mascot: Mascots.dino,
+                          mascot: Mascot.dino,
                           answer: 'flutter',
                         )
                         .toJson(),
@@ -352,7 +351,7 @@ void main() {
       });
 
       test('returns (false, false) if answer is incorrect', () async {
-        final valid = await repository.answerWord('1', Mascots.dino, 'android');
+        final valid = await repository.answerWord('1', Mascot.dino, 'android');
         expect(valid, (false, false));
       });
 
@@ -363,7 +362,7 @@ void main() {
             () => dbClient.getById(answersCollection, 'fake'),
           ).thenAnswer((_) async => null);
           expect(
-            () => repository.answerWord('fake', Mascots.dino, 'flutter'),
+            () => repository.answerWord('fake', Mascot.dino, 'flutter'),
             throwsA(isA<CrosswordRepositoryException>()),
           );
         },
@@ -396,7 +395,7 @@ void main() {
           ).thenAnswer((_) async => answersRecord);
 
           expect(
-            () => repository.answerWord('3', Mascots.sparky, 'happy'),
+            () => repository.answerWord('3', Mascot.sparky, 'happy'),
             throwsA(isA<CrosswordRepositoryException>()),
           );
         },
@@ -413,7 +412,7 @@ void main() {
           ).thenAnswer((_) async => []);
 
           expect(
-            () => repository.answerWord('1', Mascots.dino, 'flutter'),
+            () => repository.answerWord('1', Mascot.dino, 'flutter'),
             throwsA(isA<CrosswordRepositoryException>()),
           );
         },
@@ -435,7 +434,7 @@ void main() {
             () => dbClient.getById(answersCollection, 'fake'),
           ).thenAnswer((_) async => answersRecord);
           expect(
-            () => repository.answerWord('fake', Mascots.dino, 'flutter'),
+            () => repository.answerWord('fake', Mascot.dino, 'flutter'),
             throwsA(isA<CrosswordRepositoryException>()),
           );
         },

diff --git a/api/packages/game_domain/lib/src/models/mascots.dart b/api/packages/game_domain/lib/src/models/mascots.dart
@@ -1,7 +1,7 @@
 /// {@template mascots}
 /// Google Mascots enum.
 /// {@endtemplate}
-enum Mascots {
+enum Mascot {
   /// Flutter Dash mascot.
   dash,
 

diff --git a/api/packages/game_domain/lib/src/models/player.dart b/api/packages/game_domain/lib/src/models/player.dart
@@ -25,7 +25,7 @@ class Player extends Equatable {
   static const empty = Player(
     id: '',
     initials: '',
-    mascot: Mascots.dash,
+    mascot: Mascot.dash,
   );
 
   /// Unique identifier of the leaderboard player object
@@ -47,14 +47,14 @@ class Player extends Equatable {
 
   /// The player mascot.
   @JsonKey()
-  final Mascots mascot;
+  final Mascot mascot;
 
   /// Returns a copy of [Player] this instance with the
   /// provided fields.
   Player copyWith({
     String? id,
     String? initials,
-    Mascots? mascot,
+    Mascot? mascot,
     int? score,
     int? streak,
   }) {

diff --git a/api/packages/game_domain/lib/src/models/player.g.dart b/api/packages/game_domain/lib/src/models/player.g.dart
diff --git a/api/packages/game_domain/lib/src/models/word.dart b/api/packages/game_domain/lib/src/models/word.dart
@@ -66,7 +66,7 @@ class Word extends Equatable {
   /// The mascot of the user that first solved the word.
   /// If the word is not solved, this value is null.
   @JsonKey()
-  final Mascots? mascot;
+  final Mascot? mascot;
 
   /// Returns the solved characters with the index position and character
   /// solved.
@@ -95,7 +95,7 @@ class Word extends Equatable {
     String? clue,
     String? answer,
     int? solvedTimestamp,
-    Mascots? mascot,
+    Mascot? mascot,
   }) {
     return Word(
       id: id ?? this.id,

diff --git a/api/packages/game_domain/lib/src/models/word.g.dart b/api/packages/game_domain/lib/src/models/word.g.dart
diff --git a/api/packages/game_domain/test/src/models/board_section_test.dart b/api/packages/game_domain/test/src/models/board_section_test.dart
@@ -18,7 +18,7 @@ void main() {
             answer: 'answer',
             clue: 'clue',
             solvedTimestamp: 1234,
-            mascot: Mascots.android,
+            mascot: Mascot.android,
           ),
         ],
       );
@@ -74,7 +74,7 @@ void main() {
                 answer: 'answer',
                 clue: 'clue',
                 solvedTimestamp: 1234,
-                mascot: Mascots.android,
+                mascot: Mascot.android,
               ),
             ],
           ),

diff --git a/api/packages/game_domain/test/src/models/player_test.dart b/api/packages/game_domain/test/src/models/player_test.dart
@@ -12,7 +12,7 @@ void main() {
           Player(
             id: '',
             initials: '',
-            mascot: Mascots.dash,
+            mascot: Mascot.dash,
           ),
         ),
       );
@@ -24,7 +24,7 @@ void main() {
           id: 'id',
           initials: 'TST',
           score: 10,
-          mascot: Mascots.android,
+          mascot: Mascot.android,
           streak: 2,
         ),
         isNotNull,
@@ -35,7 +35,7 @@ void main() {
       id: 'id',
       initials: 'TST',
       score: 20,
-      mascot: Mascots.android,
+      mascot: Mascot.android,
       streak: 2,
     );
 
@@ -45,7 +45,7 @@ void main() {
         equals({
           'initials': 'TST',
           'score': 20,
-          'mascot': Mascots.android.name,
+          'mascot': Mascot.android.name,
           'streak': 2,
         }),
       );
@@ -57,7 +57,7 @@ void main() {
           'id': 'id',
           'initials': 'TST',
           'score': 20,
-          'mascot': Mascots.android.name,
+          'mascot': Mascot.android.name,
           'streak': 2,
         }),
         equals(leaderboardPlayer),
@@ -70,15 +70,15 @@ void main() {
           id: '',
           initials: 'TST',
           score: 20,
-          mascot: Mascots.android,
+          mascot: Mascot.android,
           streak: 2,
         ),
         equals(
           Player(
             id: '',
             initials: 'TST',
             score: 20,
-            mascot: Mascots.android,
+            mascot: Mascot.android,
             streak: 2,
           ),
         ),
@@ -89,7 +89,7 @@ void main() {
           id: '',
           initials: 'TST',
           score: 20,
-          mascot: Mascots.android,
+          mascot: Mascot.android,
           streak: 2,
         ),
         isNot(
@@ -102,7 +102,7 @@ void main() {
           id: 'id',
           initials: 'WOW',
           score: 20,
-          mascot: Mascots.android,
+          mascot: Mascot.android,
           streak: 2,
         ),
         isNot(
@@ -115,7 +115,7 @@ void main() {
           id: 'id',
           initials: 'TST',
           score: 20,
-          mascot: Mascots.dash,
+          mascot: Mascot.dash,
           streak: 2,
         ),
         isNot(
@@ -128,7 +128,7 @@ void main() {
           id: 'id',
           initials: 'TST',
           score: 20,
-          mascot: Mascots.android,
+          mascot: Mascot.android,
           streak: 3,
         ),
         isNot(
@@ -142,19 +142,19 @@ void main() {
         Player(
           id: 'id',
           initials: 'AAA',
-          mascot: Mascots.android,
+          mascot: Mascot.android,
           streak: 10,
           score: 500,
         ).copyWith(),
         equals(
           Player(
             id: '',
             initials: '',
-            mascot: Mascots.dash,
+            mascot: Mascot.dash,
           ).copyWith(
             id: 'id',
             initials: 'AAA',
-            mascot: Mascots.android,
+            mascot: Mascot.android,
             streak: 10,
             score: 500,
           ),

diff --git a/api/packages/game_domain/test/src/models/word_test.dart b/api/packages/game_domain/test/src/models/word_test.dart
@@ -13,7 +13,7 @@ void main() {
         answer: 'test',
         clue: 'clue',
         solvedTimestamp: 0,
-        mascot: Mascots.sparky,
+        mascot: Mascot.sparky,
       );
       final json = word.toJson();
 
@@ -50,7 +50,7 @@ void main() {
             axis: WordAxis.horizontal,
             answer: 'test',
             clue: 'clue',
-            mascot: Mascots.sparky,
+            mascot: Mascot.sparky,
           ),
         ),
       );

diff --git a/api/packages/leaderboard_repository/test/src/leaderboard_repository_test.dart b/api/packages/leaderboard_repository/test/src/leaderboard_repository_test.dart
@@ -120,7 +120,7 @@ void main() {
             id: 'userId',
             score: 10,
             streak: 1,
-            mascot: Mascots.dash,
+            mascot: Mascot.dash,
             initials: 'ABC',
           ),
         );
@@ -136,7 +136,7 @@ void main() {
             id: 'userId',
             score: 20,
             streak: 1,
-            mascot: Mascots.dash,
+            mascot: Mascot.dash,
             initials: 'ABC',
           ),
           30,
@@ -208,7 +208,7 @@ void main() {
               id: 'userId',
               score: 20,
               streak: 3,
-              mascot: Mascots.dash,
+              mascot: Mascot.dash,
               initials: 'ABC',
             ),
           ),