From 03d48eac40316b08f4445bcb914c6ab86e6a1200 Mon Sep 17 00:00:00 2001 From: Erick Date: Fri, 11 Mar 2022 17:39:59 -0300 Subject: [PATCH] feat: adding bonus letters to board (#35) * feat: adding ball spawming upon click on debug mode * PR suggestions * fix: rebase * feat: adding bonus letter component * feat: bonus letter callback * feat: removing flip * feat: adding bonus letters to board * Apply suggestions from code review Co-authored-by: Allison Ryan <77211884+allisonryan0002@users.noreply.github.com> * feat: improving bonus letters grouping * feat: removing not needed pump * feat: rebase fix * fix: re adding wrongly removed code during rebase * fix: lint * fix: flaky test * Apply suggestions from code review Co-authored-by: Allison Ryan <77211884+allisonryan0002@users.noreply.github.com> Co-authored-by: Allison Ryan <77211884+allisonryan0002@users.noreply.github.com> --- lib/game/bloc/game_state.dart | 4 + lib/game/components/bonus_word.dart | 134 +++++++++++ lib/game/components/components.dart | 1 + lib/game/pinball_game.dart | 20 ++ lib/game/view/pinball_game_page.dart | 2 + pubspec.lock | 6 +- pubspec.yaml | 8 +- test/game/bloc/game_state_test.dart | 28 +++ test/game/components/ball_test.dart | 7 +- test/game/components/bonus_word_test.dart | 244 +++++++++++++++++++++ test/game/components/plunger_test.dart | 2 +- test/game/view/pinball_game_page_test.dart | 2 +- test/helpers/builders.dart | 4 +- test/helpers/mocks.dart | 2 + 14 files changed, 450 insertions(+), 14 deletions(-) create mode 100644 lib/game/components/bonus_word.dart create mode 100644 test/game/components/bonus_word_test.dart diff --git a/lib/game/bloc/game_state.dart b/lib/game/bloc/game_state.dart index 2812a049..e2c39d1f 100644 --- a/lib/game/bloc/game_state.dart +++ b/lib/game/bloc/game_state.dart @@ -49,6 +49,10 @@ class GameState extends Equatable { /// Determines when the player has only one ball left. bool get isLastBall => balls == 1; + /// Shortcut method to check if the given [i] + /// is activated. + bool isLetterActivated(int i) => activatedBonusLetters.contains(i); + GameState copyWith({ int? score, int? balls, diff --git a/lib/game/components/bonus_word.dart b/lib/game/components/bonus_word.dart new file mode 100644 index 00000000..35412ecf --- /dev/null +++ b/lib/game/components/bonus_word.dart @@ -0,0 +1,134 @@ +// ignore_for_file: avoid_renaming_method_parameters + +import 'dart:async'; + +import 'package:flame/components.dart'; +import 'package:flame/effects.dart'; +import 'package:flame_bloc/flame_bloc.dart'; +import 'package:flame_forge2d/flame_forge2d.dart'; +import 'package:flutter/material.dart'; +import 'package:pinball/game/game.dart'; + +/// {@template bonus_word} +/// Loads all [BonusLetter]s to compose a [BonusWord]. +/// {@endtemplate} +class BonusWord extends Component { + /// {@macro bonus_word} + BonusWord({required Vector2 position}) : _position = position; + + final Vector2 _position; + + @override + Future onLoad() async { + await super.onLoad(); + final letters = GameBloc.bonusWord.split(''); + + for (var i = 0; i < letters.length; i++) { + unawaited( + add( + BonusLetter( + position: _position - Vector2(16 - (i * 6), -30), + letter: letters[i], + index: i, + ), + ), + ); + } + } +} + +/// {@template bonus_letter} +/// [BodyType.static] sensor component, part of a word bonus, +/// which will activate its letter after contact with a [Ball]. +/// {@endtemplate} +class BonusLetter extends BodyComponent + with BlocComponent { + /// {@macro bonus_letter} + BonusLetter({ + required Vector2 position, + required String letter, + required int index, + }) : _position = position, + _letter = letter, + _index = index { + paint = Paint()..color = _disableColor; + } + + /// The area size of this [BonusLetter]. + static final areaSize = Vector2.all(4); + + static const _activeColor = Colors.green; + static const _disableColor = Colors.red; + + final Vector2 _position; + final String _letter; + final int _index; + + @override + Future onLoad() async { + await super.onLoad(); + + await add( + TextComponent( + position: Vector2(-1, -1), + text: _letter, + textRenderer: TextPaint( + style: const TextStyle(fontSize: 2, color: Colors.white), + ), + ), + ); + } + + @override + Body createBody() { + final shape = CircleShape()..radius = areaSize.x / 2; + + final fixtureDef = FixtureDef(shape)..isSensor = true; + + final bodyDef = BodyDef() + ..userData = this + ..position = _position + ..type = BodyType.static; + + return world.createBody(bodyDef)..createFixture(fixtureDef); + } + + @override + bool listenWhen(GameState? previousState, GameState newState) { + final wasActive = previousState?.isLetterActivated(_index) ?? false; + final isActive = newState.isLetterActivated(_index); + + return wasActive != isActive; + } + + @override + void onNewState(GameState state) { + final isActive = state.isLetterActivated(_index); + + add( + ColorEffect( + isActive ? _activeColor : _disableColor, + const Offset(0, 1), + EffectController(duration: 0.25), + ), + ); + } + + /// Activates this [BonusLetter], if it's not already activated. + void activate() { + final isActive = state?.isLetterActivated(_index) ?? false; + if (!isActive) { + gameRef.read().add(BonusLetterActivated(_index)); + } + } +} + +/// Triggers [BonusLetter.activate] method when a [BonusLetter] and a [Ball] +/// come in contact. +class BonusLetterBallContactCallback + extends ContactCallback { + @override + void begin(Ball ball, BonusLetter bonusLetter, Contact contact) { + bonusLetter.activate(); + } +} diff --git a/lib/game/components/components.dart b/lib/game/components/components.dart index bcf9a92d..6e663c26 100644 --- a/lib/game/components/components.dart +++ b/lib/game/components/components.dart @@ -2,6 +2,7 @@ export 'anchor.dart'; export 'ball.dart'; export 'baseboard.dart'; export 'board_side.dart'; +export 'bonus_word.dart'; export 'flipper.dart'; export 'pathway.dart'; export 'plunger.dart'; diff --git a/lib/game/pinball_game.dart b/lib/game/pinball_game.dart index c6b23dae..633c2351 100644 --- a/lib/game/pinball_game.dart +++ b/lib/game/pinball_game.dart @@ -48,6 +48,25 @@ class PinballGame extends Forge2DGame ), ); + unawaited(_addFlippers()); + + unawaited(_addBonusWord()); + } + + Future _addBonusWord() async { + await add( + BonusWord( + position: screenToWorld( + Vector2( + camera.viewport.effectiveSize.x / 2, + camera.viewport.effectiveSize.y - 50, + ), + ), + ), + ); + } + + Future _addFlippers() async { final flippersPosition = screenToWorld( Vector2( camera.viewport.effectiveSize.x / 2, @@ -73,6 +92,7 @@ class PinballGame extends Forge2DGame void _addContactCallbacks() { addContactCallback(BallScorePointsCallback()); addContactCallback(BottomWallBallContactCallback()); + addContactCallback(BonusLetterBallContactCallback()); } Future _addGameBoundaries() async { diff --git a/lib/game/view/pinball_game_page.dart b/lib/game/view/pinball_game_page.dart index 4af2168e..21bd4074 100644 --- a/lib/game/view/pinball_game_page.dart +++ b/lib/game/view/pinball_game_page.dart @@ -63,6 +63,8 @@ class _PinballGameViewState extends State { @override Widget build(BuildContext context) { return BlocListener( + listenWhen: (previous, current) => + previous.isGameOver != current.isGameOver, listener: (context, state) { if (state.isGameOver) { showDialog( diff --git a/pubspec.lock b/pubspec.lock index 4b375ff7..8ff31de7 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -140,21 +140,21 @@ packages: name: flame url: "https://pub.dartlang.org" source: hosted - version: "1.1.0-releasecandidate.2" + version: "1.1.0-releasecandidate.4" flame_bloc: dependency: "direct main" description: name: flame_bloc url: "https://pub.dartlang.org" source: hosted - version: "1.2.0-releasecandidate.2" + version: "1.2.0-releasecandidate.4" flame_forge2d: dependency: "direct main" description: name: flame_forge2d url: "https://pub.dartlang.org" source: hosted - version: "0.9.0-releasecandidate.2" + version: "0.9.0-releasecandidate.4" flame_test: dependency: "direct dev" description: diff --git a/pubspec.yaml b/pubspec.yaml index 41b0d081..39b93fe7 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -9,15 +9,15 @@ environment: dependencies: bloc: ^8.0.2 equatable: ^2.0.3 - flame: ^1.1.0-releasecandidate.2 - flame_bloc: ^1.2.0-releasecandidate.2 - flame_forge2d: ^0.9.0-releasecandidate.2 + flame: ^1.1.0-releasecandidate.4 + flame_bloc: ^1.2.0-releasecandidate.4 + flame_forge2d: ^0.9.0-releasecandidate.4 flutter: sdk: flutter flutter_bloc: ^8.0.1 flutter_localizations: sdk: flutter - geometry: + geometry: path: packages/geometry intl: ^0.17.0 pinball_theme: diff --git a/test/game/bloc/game_state_test.dart b/test/game/bloc/game_state_test.dart index 7b060984..8ab72e6c 100644 --- a/test/game/bloc/game_state_test.dart +++ b/test/game/bloc/game_state_test.dart @@ -126,6 +126,34 @@ void main() { ); }); + group('isLetterActivated', () { + test( + 'is true when the letter is activated', + () { + const gameState = GameState( + balls: 3, + score: 0, + activatedBonusLetters: [1], + bonusHistory: [], + ); + expect(gameState.isLetterActivated(1), isTrue); + }, + ); + + test( + 'is false when the letter is not activated', + () { + const gameState = GameState( + balls: 3, + score: 0, + activatedBonusLetters: [1], + bonusHistory: [], + ); + expect(gameState.isLetterActivated(0), isFalse); + }, + ); + }); + group('copyWith', () { test( 'throws AssertionError ' diff --git a/test/game/components/ball_test.dart b/test/game/components/ball_test.dart index 9f473e42..8ac32212 100644 --- a/test/game/components/ball_test.dart +++ b/test/game/components/ball_test.dart @@ -89,9 +89,10 @@ void main() { }); group('resetting a ball', () { - final gameBloc = MockGameBloc(); + late GameBloc gameBloc; setUp(() { + gameBloc = MockGameBloc(); whenListen( gameBloc, const Stream.empty(), @@ -99,7 +100,7 @@ void main() { ); }); - final tester = flameBlocTester(gameBloc: gameBloc); + final tester = flameBlocTester(gameBloc: () => gameBloc); tester.widgetTest( 'adds BallLost to GameBloc', @@ -118,7 +119,7 @@ void main() { (game, tester) async { await game.ready(); - game.children.whereType().first.removeFromParent(); + game.children.whereType().first.lost(); await game.ready(); // Making sure that all additions are done expect( diff --git a/test/game/components/bonus_word_test.dart b/test/game/components/bonus_word_test.dart new file mode 100644 index 00000000..129f68d1 --- /dev/null +++ b/test/game/components/bonus_word_test.dart @@ -0,0 +1,244 @@ +// ignore_for_file: cascade_invocations + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame/effects.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/game/game.dart'; + +import '../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + + group('BonusWord', () { + final flameTester = FlameTester(PinballGameTest.create); + + flameTester.test( + 'loads the letters correctly', + (game) async { + await game.ready(); + + final bonusWord = game.children.whereType().first; + final letters = bonusWord.children.whereType(); + expect(letters.length, equals(GameBloc.bonusWord.length)); + }, + ); + }); + + group('BonusLetter', () { + final flameTester = FlameTester(PinballGameTest.create); + + flameTester.test( + 'loads correctly', + (game) async { + final bonusLetter = BonusLetter( + position: Vector2.zero(), + letter: 'G', + index: 0, + ); + await game.ensureAdd(bonusLetter); + await game.ready(); + + expect(game.contains(bonusLetter), isTrue); + }, + ); + + group('body', () { + flameTester.test( + 'positions correctly', + (game) async { + final position = Vector2.all(10); + final bonusLetter = BonusLetter( + position: position, + letter: 'G', + index: 0, + ); + await game.ensureAdd(bonusLetter); + game.contains(bonusLetter); + + expect(bonusLetter.body.position, position); + }, + ); + + flameTester.test( + 'is static', + (game) async { + final bonusLetter = BonusLetter( + position: Vector2.zero(), + letter: 'G', + index: 0, + ); + await game.ensureAdd(bonusLetter); + + expect(bonusLetter.body.bodyType, equals(BodyType.static)); + }, + ); + }); + + group('fixture', () { + flameTester.test( + 'exists', + (game) async { + final bonusLetter = BonusLetter( + position: Vector2.zero(), + letter: 'G', + index: 0, + ); + await game.ensureAdd(bonusLetter); + + expect(bonusLetter.body.fixtures[0], isA()); + }, + ); + + flameTester.test( + 'is sensor', + (game) async { + final bonusLetter = BonusLetter( + position: Vector2.zero(), + letter: 'G', + index: 0, + ); + await game.ensureAdd(bonusLetter); + + final fixture = bonusLetter.body.fixtures[0]; + expect(fixture.isSensor, isTrue); + }, + ); + + flameTester.test( + 'shape is circular', + (game) async { + final bonusLetter = BonusLetter( + position: Vector2.zero(), + letter: 'G', + index: 0, + ); + await game.ensureAdd(bonusLetter); + + final fixture = bonusLetter.body.fixtures[0]; + expect(fixture.shape.shapeType, equals(ShapeType.circle)); + expect(fixture.shape.radius, equals(2)); + }, + ); + }); + + group('bonus letter activation', () { + final gameBloc = MockGameBloc(); + + BonusLetter _getBonusLetter(PinballGame game) { + return game.children + .whereType() + .first + .children + .whereType() + .first; + } + + setUp(() { + whenListen( + gameBloc, + const Stream.empty(), + initialState: const GameState.initial(), + ); + }); + + final tester = flameBlocTester(gameBloc: () => gameBloc); + + tester.widgetTest( + 'adds BonusLetterActivated to GameBloc when not activated', + (game, tester) async { + await game.ready(); + + _getBonusLetter(game).activate(); + + await tester.pump(); + + verify(() => gameBloc.add(const BonusLetterActivated(0))).called(1); + }, + ); + + tester.widgetTest( + "doesn't add BonusLetterActivated to GameBloc when already activated", + (game, tester) async { + const state = GameState( + score: 0, + balls: 2, + activatedBonusLetters: [0], + bonusHistory: [], + ); + whenListen( + gameBloc, + Stream.value(state), + initialState: state, + ); + await game.ready(); + + _getBonusLetter(game).activate(); + await game.ready(); // Making sure that all additions are done + + verifyNever(() => gameBloc.add(const BonusLetterActivated(0))); + }, + ); + + tester.widgetTest( + 'adds a ColorEffect', + (game, tester) async { + await game.ready(); + + const state = GameState( + score: 0, + balls: 2, + activatedBonusLetters: [0], + bonusHistory: [], + ); + + final bonusLetter = _getBonusLetter(game); + + bonusLetter.onNewState(state); + await tester.pump(); + + expect( + bonusLetter.children.whereType().length, + equals(1), + ); + }, + ); + + tester.widgetTest( + 'only listens when there is a change on the letter status', + (game, tester) async { + await game.ready(); + + const state = GameState( + score: 0, + balls: 2, + activatedBonusLetters: [0], + bonusHistory: [], + ); + + final bonusLetter = _getBonusLetter(game); + + expect( + bonusLetter.listenWhen(const GameState.initial(), state), + isTrue, + ); + }, + ); + }); + + group('BonusLetterBallContactCallback', () { + test('calls ball.activate', () { + final ball = MockBall(); + final bonusLetter = MockBonusLetter(); + + final contactCallback = BonusLetterBallContactCallback(); + contactCallback.begin(ball, bonusLetter, MockContact()); + + verify(bonusLetter.activate).called(1); + }); + }); + }); +} diff --git a/test/game/components/plunger_test.dart b/test/game/components/plunger_test.dart index 02330b31..1ca29e85 100644 --- a/test/game/components/plunger_test.dart +++ b/test/game/components/plunger_test.dart @@ -227,7 +227,7 @@ void main() { ); }); - final flameTester = flameBlocTester(gameBloc: gameBloc); + final flameTester = flameBlocTester(gameBloc: () => gameBloc); group('initializes with', () { flameTester.test( diff --git a/test/game/view/pinball_game_page_test.dart b/test/game/view/pinball_game_page_test.dart index 9de36cde..dcf0c001 100644 --- a/test/game/view/pinball_game_page_test.dart +++ b/test/game/view/pinball_game_page_test.dart @@ -94,7 +94,7 @@ void main() { whenListen( gameBloc, Stream.value(state), - initialState: state, + initialState: GameState.initial(), ); await tester.pumpApp( diff --git a/test/helpers/builders.dart b/test/helpers/builders.dart index c77e55c5..d8ffd715 100644 --- a/test/helpers/builders.dart +++ b/test/helpers/builders.dart @@ -5,14 +5,14 @@ import 'package:pinball/game/game.dart'; import 'helpers.dart'; FlameTester flameBlocTester({ - required GameBloc gameBloc, + required GameBloc Function() gameBloc, }) { return FlameTester( PinballGameTest.create, pumpWidget: (gameWidget, tester) async { await tester.pumpWidget( BlocProvider.value( - value: gameBloc, + value: gameBloc(), child: gameWidget, ), ); diff --git a/test/helpers/mocks.dart b/test/helpers/mocks.dart index 46886752..c1c59377 100644 --- a/test/helpers/mocks.dart +++ b/test/helpers/mocks.dart @@ -37,3 +37,5 @@ class MockRawKeyUpEvent extends Mock implements RawKeyUpEvent { class MockTapUpInfo extends Mock implements TapUpInfo {} class MockEventPosition extends Mock implements EventPosition {} + +class MockBonusLetter extends Mock implements BonusLetter {}