feat: flipper sfx (#449)

* feat: flipper sfx

* lint

* Apply suggestions from code review

Co-authored-by: Allison Ryan <77211884+allisonryan0002@users.noreply.github.com>

* pr

* lint

* Update packages/pinball_audio/lib/src/pinball_audio.dart

Co-authored-by: Alejandro Santiago <dev@alestiago.com>

Co-authored-by: Allison Ryan <77211884+allisonryan0002@users.noreply.github.com>
Co-authored-by: Alejandro Santiago <dev@alestiago.com>

packages/pinball_audio/lib/gen/assets.gen.dart

@@ -20,6 +20,7 @@ class $AssetsSfxGen {
   String get cowMoo => 'assets/sfx/cow_moo.mp3';
   String get dash => 'assets/sfx/dash.mp3';
   String get dino => 'assets/sfx/dino.mp3';
+  String get flipper => 'assets/sfx/flipper.mp3';
   String get gameOverVoiceOver => 'assets/sfx/game_over_voice_over.mp3';
   String get google => 'assets/sfx/google.mp3';
   String get ioPinballVoiceOver => 'assets/sfx/io_pinball_voice_over.mp3';

packages/pinball_audio/lib/src/pinball_audio.dart

@@ -39,14 +39,17 @@ enum PinballAudio {
   /// Sparky.
   sparky,
 
-  /// Android
+  /// Android.
   android,
 
-  /// Dino
+  /// Dino.
   dino,
 
-  /// Dash
+  /// Dash.
   dash,
+
+  /// Flipper.
+  flipper,
 }
 
 /// Defines the contract of the creation of an [AudioPool].
@@ -147,6 +150,31 @@ class _SingleLoopAudio extends _LoopAudio {
   }
 }
 
+class _SingleAudioPool extends _Audio {
+  _SingleAudioPool({
+    required this.path,
+    required this.createAudioPool,
+    required this.maxPlayers,
+  });
+
+  final String path;
+  final CreateAudioPool createAudioPool;
+  final int maxPlayers;
+  late AudioPool pool;
+
+  @override
+  Future<void> load() async {
+    pool = await createAudioPool(
+      prefixFile(path),
+      maxPlayers: maxPlayers,
+      prefix: '',
+    );
+  }
+
+  @override
+  void play() => pool.start();
+}
+
 class _RandomABAudio extends _Audio {
   _RandomABAudio({
     required this.createAudioPool,
@@ -277,6 +305,11 @@ class PinballAudioPlayer {
         path: Assets.sfx.rollover,
         volume: 0.3,
       ),
+      PinballAudio.flipper: _SingleAudioPool(
+        path: Assets.sfx.flipper,
+        createAudioPool: _createAudioPool,
+        maxPlayers: 2,
+      ),
       PinballAudio.ioPinballVoiceOver: _SimplePlayAudio(
         preCacheSingleAudio: _preCacheSingleAudio,
         playSingleAudio: _playSingleAudio,

packages/pinball_audio/test/src/pinball_audio_test.dart

@@ -145,6 +145,20 @@ void main() {
         ).called(1);
       });
 
+      test('creates the flipper pool', () async {
+        await Future.wait(
+          audioPlayer.load().map((loadableBuilder) => loadableBuilder()),
+        );
+
+        verify(
+          () => createAudioPool.onCall(
+            'packages/pinball_audio/${Assets.sfx.flipper}',
+            maxPlayers: 2,
+            prefix: '',
+          ),
+        ).called(1);
+      });
+
       test('configures the audio cache instance', () async {
         await Future.wait(
           audioPlayer.load().map((loadableBuilder) => loadableBuilder()),
@@ -327,6 +341,33 @@ void main() {
       });
     });
 
+    group('flipper', () {
+      late AudioPool pool;
+
+      setUp(() {
+        pool = _MockAudioPool();
+        when(() => pool.start(volume: any(named: 'volume')))
+            .thenAnswer((_) async => () {});
+        when(
+          () => createAudioPool.onCall(
+            'packages/pinball_audio/${Assets.sfx.flipper}',
+            maxPlayers: any(named: 'maxPlayers'),
+            prefix: any(named: 'prefix'),
+          ),
+        ).thenAnswer((_) async => pool);
+      });
+
+      test('plays the flipper sound pool', () async {
+        when(seed.nextBool).thenReturn(true);
+        await Future.wait(
+          audioPlayer.load().map((loadableBuilder) => loadableBuilder()),
+        );
+        audioPlayer.play(PinballAudio.flipper);
+
+        verify(() => pool.start()).called(1);
+      });
+    });
+
     group('cow moo', () {
       test('plays the correct file', () async {
         await Future.wait(

packages/pinball_components/lib/src/components/flipper/behaviors/behaviors.dart

@@ -1,3 +1,4 @@
 export 'flipper_jointing_behavior.dart';
 export 'flipper_key_controlling_behavior.dart';
 export 'flipper_moving_behavior.dart';
+export 'flipper_noise_behavior.dart';

packages/pinball_components/lib/src/components/flipper/behaviors/flipper_moving_behavior.dart

@@ -15,7 +15,9 @@ class FlipperMovingBehavior extends Component
 
   late final Flipper _flipper;
 
-  void _moveUp() => _flipper.body.linearVelocity = Vector2(0, -_strength);
+  void _moveUp() {
+    _flipper.body.linearVelocity = Vector2(0, -_strength);
+  }
 
   void _moveDown() => _flipper.body.linearVelocity = Vector2(0, _strength);
 

packages/pinball_components/lib/src/components/flipper/behaviors/flipper_noise_behavior.dart

@@ -0,0 +1,18 @@
+import 'package:flame/components.dart';
+import 'package:flame_bloc/flame_bloc.dart';
+import 'package:pinball_audio/pinball_audio.dart';
+import 'package:pinball_components/pinball_components.dart';
+import 'package:pinball_flame/pinball_flame.dart';
+
+class FlipperNoiseBehavior extends Component
+    with
+        FlameBlocListenable<FlipperCubit, FlipperState>,
+        FlameBlocReader<FlipperCubit, FlipperState> {
+  @override
+  void onNewState(FlipperState state) {
+    super.onNewState(state);
+    if (bloc.state.isMovingUp) {
+      readProvider<PinballAudioPlayer>().play(PinballAudio.flipper);
+    }
+  }
+}

packages/pinball_components/lib/src/components/flipper/flipper.dart

@@ -25,7 +25,10 @@ class Flipper extends BodyComponent with KeyboardHandler, InitialPosition {
             FlipperJointingBehavior(),
             FlameBlocProvider<FlipperCubit, FlipperState>(
               create: FlipperCubit.new,
-              children: [FlipperMovingBehavior(strength: 90)],
+              children: [
+                FlipperMovingBehavior(strength: 90),
+                FlipperNoiseBehavior(),
+              ],
             ),
           ],
         );

packages/pinball_components/test/src/components/flipper/behaviors/flipper_moving_behavior_test.dart

@@ -8,12 +8,14 @@ import 'package:flame_forge2d/flame_forge2d.dart';
 import 'package:flame_test/flame_test.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:mocktail/mocktail.dart';
+import 'package:pinball_audio/pinball_audio.dart';
 import 'package:pinball_components/pinball_components.dart';
 
 class _TestGame extends Forge2DGame {
   Future<void> pump(
     FlipperMovingBehavior behavior, {
     FlipperCubit? flipperBloc,
+    PinballAudioPlayer? audioPlayer,
   }) async {
     final flipper = Flipper.test(side: BoardSide.left);
     await ensureAdd(flipper);

packages/pinball_components/test/src/components/flipper/behaviors/flipper_noise_behavior_test.dart

@@ -0,0 +1,79 @@
+// ignore_for_file: avoid_dynamic_calls, cascade_invocations
+
+import 'dart:async';
+
+import 'package:bloc_test/bloc_test.dart';
+import 'package:flame_bloc/flame_bloc.dart';
+import 'package:flame_forge2d/flame_forge2d.dart';
+import 'package:flame_test/flame_test.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:mocktail/mocktail.dart';
+import 'package:pinball_audio/pinball_audio.dart';
+import 'package:pinball_components/pinball_components.dart';
+import 'package:pinball_flame/pinball_flame.dart';
+
+class _TestGame extends Forge2DGame {
+  Future<void> pump(
+    FlipperNoiseBehavior behavior, {
+    FlipperCubit? flipperBloc,
+    PinballAudioPlayer? audioPlayer,
+  }) async {
+    final flipper = Flipper.test(side: BoardSide.left);
+    await ensureAdd(
+      FlameProvider<PinballAudioPlayer>.value(
+        audioPlayer ?? _MockPinballAudioPlayer(),
+        children: [
+          flipper,
+        ],
+      ),
+    );
+    await flipper.ensureAdd(
+      FlameBlocProvider<FlipperCubit, FlipperState>.value(
+        value: flipperBloc ?? FlipperCubit(),
+        children: [behavior],
+      ),
+    );
+  }
+}
+
+class _MockPinballAudioPlayer extends Mock implements PinballAudioPlayer {}
+
+class _MockFlipperCubit extends Mock implements FlipperCubit {}
+
+void main() {
+  TestWidgetsFlutterBinding.ensureInitialized();
+  final flameTester = FlameTester(_TestGame.new);
+
+  group('FlipperNoiseBehavior', () {
+    test('can be instantiated', () {
+      expect(
+        FlipperNoiseBehavior(),
+        isA<FlipperNoiseBehavior>(),
+      );
+    });
+
+    flameTester.test(
+      'plays the flipper sound when moving up',
+      (game) async {
+        final audioPlayer = _MockPinballAudioPlayer();
+        final bloc = _MockFlipperCubit();
+        whenListen(
+          bloc,
+          Stream.fromIterable([FlipperState.movingUp]),
+          initialState: FlipperState.movingUp,
+        );
+
+        final behavior = FlipperNoiseBehavior();
+        await game.pump(
+          behavior,
+          flipperBloc: bloc,
+          audioPlayer: audioPlayer,
+        );
+        behavior.onNewState(FlipperState.movingUp);
+        game.update(0);
+
+        verify(() => audioPlayer.play(PinballAudio.flipper)).called(1);
+      },
+    );
+  });
+}