fix: avoid random updates of hints readable response (#393)

* feat: update hint model to store the readable response * feat: save readable hint response to database * feat: update ui * fix: hint response test
VGVentures · Apr 25, 2024 · b3f466e · b3f466e
1 parent 53bfcb3
commit b3f466e
Show file tree

Hide file tree

Showing 17 changed files with 238 additions and 48 deletions.
diff --git a/api/packages/game_domain/lib/src/models/hint.dart b/api/packages/game_domain/lib/src/models/hint.dart
@@ -9,7 +9,11 @@ part 'hint.g.dart';
 @JsonSerializable(ignoreUnannotated: true)
 class Hint extends Equatable {
   /// {@macro hint}
-  const Hint({required this.question, required this.response});
+  const Hint({
+    required this.question,
+    required this.response,
+    required this.readableResponse,
+  });
 
   /// {@macro hint}
   factory Hint.fromJson(Map<String, dynamic> json) => _$HintFromJson(json);
@@ -22,11 +26,15 @@ class Hint extends Equatable {
   @JsonKey()
   final HintResponse response;
 
+  /// Readable `response`.
+  @JsonKey()
+  final String readableResponse;
+
   /// Returns a json representation from this instance.
   Map<String, dynamic> toJson() => _$HintToJson(this);
 
   @override
-  List<Object?> get props => [question, response];
+  List<Object?> get props => [question, response, readableResponse];
 }
 
 /// Enum representing the possible responses to a hint question.

diff --git a/api/packages/game_domain/lib/src/models/hint.g.dart b/api/packages/game_domain/lib/src/models/hint.g.dart
diff --git a/api/packages/game_domain/test/src/models/hint_test.dart b/api/packages/game_domain/test/src/models/hint_test.dart
@@ -6,14 +6,19 @@ import 'package:test/test.dart';
 void main() {
   group('Hint', () {
     test('creates correct json object from Hint object', () {
-      final hint = Hint(question: 'to be?', response: HintResponse.yes);
+      final hint = Hint(
+        question: 'to be?',
+        response: HintResponse.yes,
+        readableResponse: 'Yes, that is correct!',
+      );
       final json = hint.toJson();
 
       expect(
         json,
         equals({
           'question': 'to be?',
           'response': 'yes',
+          'readableResponse': 'Yes, that is correct!',
         }),
       );
     });
@@ -22,6 +27,7 @@ void main() {
       final json = {
         'question': 'or not to be?',
         'response': 'notApplicable',
+        'readableResponse': "I can't answer that.",
       };
       final hint = Hint.fromJson(json);
       expect(
@@ -30,6 +36,7 @@ void main() {
           Hint(
             question: 'or not to be?',
             response: HintResponse.notApplicable,
+            readableResponse: "I can't answer that.",
           ),
         ),
       );
@@ -39,10 +46,12 @@ void main() {
       final firstHint = Hint(
         question: 'to be?',
         response: HintResponse.no,
+        readableResponse: 'Nope!',
       );
       final secondHint = Hint(
         question: 'to be?',
         response: HintResponse.no,
+        readableResponse: 'Nope!',
       );
       expect(firstHint, equals(secondHint));
     });

diff --git a/api/packages/hint_repository/lib/src/hint_repository.dart b/api/packages/hint_repository/lib/src/hint_repository.dart
@@ -4,6 +4,7 @@ import 'package:db_client/db_client.dart';
 import 'package:dio/dio.dart';
 import 'package:game_domain/game_domain.dart';
 import 'package:hint_repository/hint_repository.dart';
+import 'package:hint_repository/src/hint_response_extension.dart';
 
 /// {@template hint_repository}
 /// A repository to handle the hints.
@@ -102,6 +103,7 @@ class HintRepository {
       final hint = Hint(
         question: question,
         response: hintResponse,
+        readableResponse: hintResponse.readable,
       );
       return hint;
     } catch (e, stackTrace) {

diff --git a/...t/extensions/hint_response_extension.dart → ...tory/lib/src/hint_response_extension.dart b/...t/extensions/hint_response_extension.dart → ...tory/lib/src/hint_response_extension.dart
@@ -1,9 +1,11 @@
 import 'dart:math';
 
-import 'package:flutter/foundation.dart';
 import 'package:game_domain/game_domain.dart';
+import 'package:meta/meta.dart';
 
+/// An extension on [HintResponse] to provide readable responses.
 extension HintResponseExtension on HintResponse {
+  /// Returns a readable response for the hint.
   String get readable {
     final random = Random();
 
@@ -19,6 +21,7 @@ extension HintResponseExtension on HintResponse {
   }
 }
 
+/// Response alternatives to [HintResponse.yes].
 @visibleForTesting
 const yesResponses = [
   'Yes, that is correct!',
@@ -33,6 +36,7 @@ const yesResponses = [
   'Yes!',
 ];
 
+/// Response alternatives to [HintResponse.no].
 @visibleForTesting
 const noResponses = [
   'No, unfortunately.',
@@ -47,6 +51,7 @@ const noResponses = [
   'Sorry, but no!',
 ];
 
+/// Response alternatives to [HintResponse.notApplicable].
 @visibleForTesting
 const notApplicableResponses = [
   "I can't answer that.",

diff --git a/api/packages/hint_repository/pubspec.yaml b/api/packages/hint_repository/pubspec.yaml
@@ -13,6 +13,7 @@ dependencies:
   game_domain:
     path: ../game_domain
   http: ^1.2.1
+  meta: ^1.14.0
 
 dev_dependencies:
   mocktail: ^1.0.3

diff --git a/api/packages/hint_repository/test/src/hint_repository_test.dart b/api/packages/hint_repository/test/src/hint_repository_test.dart
@@ -118,13 +118,34 @@ void main() {
         final hint = await hintRepository.generateHint(
           wordAnswer: 'answer',
           question: 'question',
-          previousHints: [Hint(question: 'is it?', response: HintResponse.no)],
+          previousHints: [
+            Hint(
+              question: 'is it?',
+              response: HintResponse.no,
+              readableResponse: 'Nope!',
+            ),
+          ],
           userToken: 'token',
         );
 
         expect(
           hint,
-          equals(Hint(question: 'question', response: HintResponse.yes)),
+          isA<Hint>()
+              .having(
+                (hint) => hint.question,
+                'the question field',
+                'question',
+              )
+              .having(
+                (hint) => hint.response,
+                'the response field',
+                HintResponse.yes,
+              )
+              .having(
+                (hint) => hint.readableResponse,
+                'the readableResponse field',
+                isA<String>(),
+              ),
         );
       });
 
@@ -155,12 +176,22 @@ void main() {
 
           expect(
             hint,
-            equals(
-              Hint(
-                question: 'question',
-                response: HintResponse.notApplicable,
-              ),
-            ),
+            isA<Hint>()
+                .having(
+                  (hint) => hint.question,
+                  'the question field',
+                  'question',
+                )
+                .having(
+                  (hint) => hint.response,
+                  'the response field',
+                  HintResponse.notApplicable,
+                )
+                .having(
+                  (hint) => hint.readableResponse,
+                  'the readableResponse field',
+                  isA<String>(),
+                ),
           );
         },
       );
@@ -244,7 +275,11 @@ void main() {
           userId: 'userId',
           wordId: 'wordId',
           hints: [
-            Hint(question: 'question', response: HintResponse.yes),
+            Hint(
+              question: 'question',
+              response: HintResponse.yes,
+              readableResponse: 'Yeah!',
+            ),
           ],
         );
 
@@ -258,6 +293,7 @@ void main() {
                   {
                     'question': 'question',
                     'response': 'yes',
+                    'readableResponse': 'Yeah!',
                   },
                 ],
               },
@@ -277,6 +313,7 @@ void main() {
               Hint(
                 question: 'question',
                 response: HintResponse.yes,
+                readableResponse: 'Yeah!',
               ),
             ],
           ),

diff --git a/...ensions/hint_response_extension_test.dart → ...est/src/hint_response_extension_test.dart b/...ensions/hint_response_extension_test.dart → ...est/src/hint_response_extension_test.dart
@@ -1,6 +1,6 @@
-import 'package:flutter_test/flutter_test.dart';
 import 'package:game_domain/game_domain.dart';
-import 'package:io_crossword/hint/hint.dart';
+import 'package:hint_repository/src/hint_response_extension.dart';
+import 'package:test/test.dart';
 
 void main() {
   group('HintResponseExtension', () {

diff --git a/api/test/routes/game/hint_test.dart b/api/test/routes/game/hint_test.dart
@@ -107,13 +107,23 @@ void main() {
               userToken: 'token',
             ),
           ).thenAnswer(
-            (_) async => Hint(question: 'question', response: HintResponse.no),
+            (_) async => Hint(
+              question: 'question',
+              response: HintResponse.no,
+              readableResponse: 'Nope!',
+            ),
           );
           when(
             () => hintRepository.saveHints(
               userId: 'userId',
               wordId: 'wordId',
-              hints: [Hint(question: 'question', response: HintResponse.no)],
+              hints: [
+                Hint(
+                  question: 'question',
+                  response: HintResponse.no,
+                  readableResponse: 'Nope!',
+                ),
+              ],
             ),
           ).thenAnswer((_) async {});
 
@@ -126,6 +136,7 @@ void main() {
               'hint': {
                 'question': 'question',
                 'response': 'no',
+                'readableResponse': 'Nope!',
               },
               'maxHints': 10,
             }),
@@ -134,7 +145,13 @@ void main() {
             () => hintRepository.saveHints(
               userId: 'userId',
               wordId: 'wordId',
-              hints: [Hint(question: 'question', response: HintResponse.no)],
+              hints: [
+                Hint(
+                  question: 'question',
+                  response: HintResponse.no,
+                  readableResponse: 'Nope!',
+                ),
+              ],
             ),
           ).called(1);
         },
@@ -201,7 +218,11 @@ void main() {
               );
             },
           );
-          final hint = Hint(question: 'question', response: HintResponse.yes);
+          final hint = Hint(
+            question: 'question',
+            response: HintResponse.yes,
+            readableResponse: 'Yes, that is correct!',
+          );
           when(
             () => hintRepository.getPreviousHints(
               userId: 'userId',
@@ -298,9 +319,21 @@ void main() {
         'returns Response with a list of hints',
         () async {
           final hintList = [
-            Hint(question: 'question1', response: HintResponse.yes),
-            Hint(question: 'question2', response: HintResponse.notApplicable),
-            Hint(question: 'question3', response: HintResponse.no),
+            Hint(
+              question: 'question1',
+              response: HintResponse.yes,
+              readableResponse: 'yes',
+            ),
+            Hint(
+              question: 'question2',
+              response: HintResponse.notApplicable,
+              readableResponse: 'nah',
+            ),
+            Hint(
+              question: 'question3',
+              response: HintResponse.no,
+              readableResponse: 'nope',
+            ),
           ];
           when(() => uri.queryParameters).thenReturn({'wordId': 'wordId'});
           when(() => hintRepository.isHintsEnabled())
@@ -320,9 +353,21 @@ void main() {
             await response.json(),
             equals({
               'hints': [
-                {'question': 'question1', 'response': 'yes'},
-                {'question': 'question2', 'response': 'notApplicable'},
-                {'question': 'question3', 'response': 'no'},
+                {
+                  'question': 'question1',
+                  'response': 'yes',
+                  'readableResponse': 'yes',
+                },
+                {
+                  'question': 'question2',
+                  'response': 'notApplicable',
+                  'readableResponse': 'nah',
+                },
+                {
+                  'question': 'question3',
+                  'response': 'no',
+                  'readableResponse': 'nope',
+                },
               ],
               'maxHints': 10,
             }),

diff --git a/lib/hint/extensions/extensions.dart b/lib/hint/extensions/extensions.dart
diff --git a/lib/hint/hint.dart b/lib/hint/hint.dart
@@ -1,3 +1,2 @@
 export 'bloc/hint_bloc.dart';
-export 'extensions/extensions.dart';
 export 'widgets/widgets.dart';
diff --git a/lib/hint/widgets/hints_section.dart b/lib/hint/widgets/hints_section.dart
@@ -96,7 +96,7 @@ class HintQuestionResponse extends StatelessWidget {
           textAlign: TextAlign.center,
         ),
         const SizedBox(height: 8),
-        HintText(text: hint.response.readable),
+        HintText(text: hint.readableResponse),
         const SizedBox(height: 8),
       ],
     );