diff --git a/.github/workflows/deploy.yaml b/.github/workflows/deploy.yaml new file mode 100644 index 00000000..c8a41a4b --- /dev/null +++ b/.github/workflows/deploy.yaml @@ -0,0 +1,25 @@ +name: deploy + +on: + push: + branches: + - main + +jobs: + deploy-dev: + runs-on: ubuntu-latest + name: Deploy Development + steps: + - uses: actions/checkout@v2 + - uses: subosito/flutter-action@v2 + with: + channel: stable + - run: flutter packages get + - run: flutter build web --target lib/main_development.dart --web-renderer canvaskit --release + - uses: FirebaseExtended/action-hosting-deploy@v0 + with: + repoToken: "${{ secrets.GITHUB_TOKEN }}" + firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_PINBALL_DEV }}" + channelId: live + projectId: pinball-dev + target: ashehwkdkdjruejdnensjsjdne \ No newline at end of file diff --git a/.github/workflows/platform_helper.yaml b/.github/workflows/platform_helper.yaml new file mode 100644 index 00000000..0c1c61e7 --- /dev/null +++ b/.github/workflows/platform_helper.yaml @@ -0,0 +1,23 @@ +name: platform_helper + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +on: + push: + paths: + - "packages/platform_helper/**" + - ".github/workflows/platform_helper.yaml" + + pull_request: + paths: + - "packages/platform_helper/**" + - ".github/workflows/platform_helper.yaml" + +jobs: + build: + uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/flutter_package.yml@v1 + with: + working_directory: packages/platform_helper + coverage_excludes: "lib/gen/*.dart" diff --git a/assets/images/components/key.png b/assets/images/components/key.png new file mode 100644 index 00000000..588c2b89 Binary files /dev/null and b/assets/images/components/key.png differ diff --git a/assets/images/components/space.png b/assets/images/components/space.png new file mode 100644 index 00000000..9949b383 Binary files /dev/null and b/assets/images/components/space.png differ diff --git a/lib/game/components/android_acres.dart b/lib/game/components/android_acres.dart index 314986ce..da8e4949 100644 --- a/lib/game/components/android_acres.dart +++ b/lib/game/components/android_acres.dart @@ -16,14 +16,19 @@ class AndroidAcres extends Blueprint { components: [ AndroidBumper.a( children: [ - ScoringBehavior(points: 20), + ScoringBehavior(points: 20000), ], - )..initialPosition = Vector2(-32.52, -9.1), + )..initialPosition = Vector2(-25, 1.3), AndroidBumper.b( + children: [ + ScoringBehavior(points: 20000), + ], + )..initialPosition = Vector2(-32.6, -9.2), + AndroidBumper.cow( children: [ ScoringBehavior(points: 20), ], - )..initialPosition = Vector2(-22.89, -17.35), + )..initialPosition = Vector2(-20.5, -13.8), ], blueprints: [ SpaceshipRamp(), diff --git a/lib/game/components/bottom_group.dart b/lib/game/components/bottom_group.dart index 92ba0ed0..921a8e58 100644 --- a/lib/game/components/bottom_group.dart +++ b/lib/game/components/bottom_group.dart @@ -48,6 +48,9 @@ class _BottomGroupSide extends Component { ); final kicker = Kicker( side: _side, + children: [ + ScoringBehavior(points: 5000), + ], )..initialPosition = Vector2( (22.4 * direction) + centerXAdjustment, 25, diff --git a/lib/game/components/components.dart b/lib/game/components/components.dart index 3fae6abd..afef04f0 100644 --- a/lib/game/components/components.dart +++ b/lib/game/components/components.dart @@ -10,5 +10,6 @@ export 'flutter_forest/flutter_forest.dart'; export 'game_flow_controller.dart'; export 'google_word/google_word.dart'; export 'launcher.dart'; +export 'multipliers/multipliers.dart'; export 'scoring_behavior.dart'; export 'sparky_fire_zone.dart'; diff --git a/lib/game/components/flutter_forest/flutter_forest.dart b/lib/game/components/flutter_forest/flutter_forest.dart index d7447543..7508d5c3 100644 --- a/lib/game/components/flutter_forest/flutter_forest.dart +++ b/lib/game/components/flutter_forest/flutter_forest.dart @@ -23,17 +23,17 @@ class FlutterForest extends Component { )..initialPosition = Vector2(8.35, -58.3), DashNestBumper.main( children: [ - ScoringBehavior(points: 20), + ScoringBehavior(points: 200000), ], )..initialPosition = Vector2(18.55, -59.35), DashNestBumper.a( children: [ - ScoringBehavior(points: 20), + ScoringBehavior(points: 20000), ], )..initialPosition = Vector2(8.95, -51.95), DashNestBumper.b( children: [ - ScoringBehavior(points: 20), + ScoringBehavior(points: 20000), ], )..initialPosition = Vector2(23.3, -46.75), DashAnimatronic()..position = Vector2(20, -66), diff --git a/lib/game/components/google_word/google_word.dart b/lib/game/components/google_word/google_word.dart index 9a9faa9a..63999fe1 100644 --- a/lib/game/components/google_word/google_word.dart +++ b/lib/game/components/google_word/google_word.dart @@ -1,6 +1,7 @@ import 'package:flame/components.dart'; import 'package:flutter/material.dart'; import 'package:pinball/game/components/google_word/behaviors/behaviors.dart'; +import 'package:pinball/game/game.dart'; import 'package:pinball_components/pinball_components.dart'; /// {@template google_word} @@ -12,12 +13,30 @@ class GoogleWord extends Component { required Vector2 position, }) : super( children: [ - GoogleLetter(0)..initialPosition = position + Vector2(-12.92, 1.82), - GoogleLetter(1)..initialPosition = position + Vector2(-8.33, -0.65), - GoogleLetter(2)..initialPosition = position + Vector2(-2.88, -1.75), - GoogleLetter(3)..initialPosition = position + Vector2(2.88, -1.75), - GoogleLetter(4)..initialPosition = position + Vector2(8.33, -0.65), - GoogleLetter(5)..initialPosition = position + Vector2(12.92, 1.82), + GoogleLetter( + 0, + children: [ScoringBehavior(points: 5000)], + )..initialPosition = position + Vector2(-12.92, 1.82), + GoogleLetter( + 1, + children: [ScoringBehavior(points: 5000)], + )..initialPosition = position + Vector2(-8.33, -0.65), + GoogleLetter( + 2, + children: [ScoringBehavior(points: 5000)], + )..initialPosition = position + Vector2(-2.88, -1.75), + GoogleLetter( + 3, + children: [ScoringBehavior(points: 5000)], + )..initialPosition = position + Vector2(2.88, -1.75), + GoogleLetter( + 4, + children: [ScoringBehavior(points: 5000)], + )..initialPosition = position + Vector2(8.33, -0.65), + GoogleLetter( + 5, + children: [ScoringBehavior(points: 5000)], + )..initialPosition = position + Vector2(12.92, 1.82), GoogleWordBonusBehavior(), ], ); diff --git a/lib/game/components/multipliers/behaviors/behaviors.dart b/lib/game/components/multipliers/behaviors/behaviors.dart new file mode 100644 index 00000000..70703bba --- /dev/null +++ b/lib/game/components/multipliers/behaviors/behaviors.dart @@ -0,0 +1 @@ +export 'multipliers_behavior.dart'; diff --git a/lib/game/components/multipliers/behaviors/multipliers_behavior.dart b/lib/game/components/multipliers/behaviors/multipliers_behavior.dart new file mode 100644 index 00000000..33a59a08 --- /dev/null +++ b/lib/game/components/multipliers/behaviors/multipliers_behavior.dart @@ -0,0 +1,25 @@ +import 'package:flame/components.dart'; +import 'package:flame_bloc/flame_bloc.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +/// Toggle each [Multiplier] when GameState.multiplier changes. +class MultipliersBehavior extends Component + with + HasGameRef, + ParentIsA, + BlocComponent { + @override + bool listenWhen(GameState? previousState, GameState newState) { + return previousState?.multiplier != newState.multiplier; + } + + @override + void onNewState(GameState state) { + final multipliers = parent.children.whereType(); + for (final multiplier in multipliers) { + multiplier.bloc.next(state.multiplier); + } + } +} diff --git a/lib/game/components/multipliers/multipliers.dart b/lib/game/components/multipliers/multipliers.dart new file mode 100644 index 00000000..6a6a1563 --- /dev/null +++ b/lib/game/components/multipliers/multipliers.dart @@ -0,0 +1,44 @@ +import 'dart:math' as math; +import 'package:flame/components.dart'; +import 'package:flutter/material.dart'; +import 'package:pinball/game/components/multipliers/behaviors/behaviors.dart'; +import 'package:pinball_components/pinball_components.dart'; + +/// {@template multipliers} +/// A group for the multipliers on the board. +/// {@endtemplate} +class Multipliers extends Component { + /// {@macro multipliers} + Multipliers() + : super( + children: [ + Multiplier.x2( + position: Vector2(-19.5, -2), + angle: -15 * math.pi / 180, + ), + Multiplier.x3( + position: Vector2(13, -9.4), + angle: 15 * math.pi / 180, + ), + Multiplier.x4( + position: Vector2(0, -21.2), + angle: 0, + ), + Multiplier.x5( + position: Vector2(-8.5, -28), + angle: -3 * math.pi / 180, + ), + Multiplier.x6( + position: Vector2(10, -30.7), + angle: 8 * math.pi / 180, + ), + MultipliersBehavior(), + ], + ); + + /// Creates [Multipliers] without any children. + /// + /// This can be used for testing [Multipliers]'s behaviors in isolation. + @visibleForTesting + Multipliers.test(); +} diff --git a/lib/game/components/sparky_fire_zone.dart b/lib/game/components/sparky_fire_zone.dart index 5c00e5c9..a37c2469 100644 --- a/lib/game/components/sparky_fire_zone.dart +++ b/lib/game/components/sparky_fire_zone.dart @@ -18,17 +18,17 @@ class SparkyFireZone extends Blueprint { components: [ SparkyBumper.a( children: [ - ScoringBehavior(points: 20), + ScoringBehavior(points: 20000), ], )..initialPosition = Vector2(-22.9, -41.65), SparkyBumper.b( children: [ - ScoringBehavior(points: 20), + ScoringBehavior(points: 20000), ], )..initialPosition = Vector2(-21.25, -57.9), SparkyBumper.c( children: [ - ScoringBehavior(points: 20), + ScoringBehavior(points: 20000), ], )..initialPosition = Vector2(-3.3, -52.55), SparkyComputerSensor()..initialPosition = Vector2(-13, -49.8), @@ -47,7 +47,13 @@ class SparkyFireZone extends Blueprint { class SparkyComputerSensor extends BodyComponent with InitialPosition, ContactCallbacks { /// {@macro sparky_computer_sensor} - SparkyComputerSensor() : super(renderBody: false); + SparkyComputerSensor() + : super( + renderBody: false, + children: [ + ScoringBehavior(points: 200000), + ], + ); @override Body createBody() { diff --git a/lib/game/game_assets.dart b/lib/game/game_assets.dart index 12bf4308..ab7a6169 100644 --- a/lib/game/game_assets.dart +++ b/lib/game/game_assets.dart @@ -84,6 +84,8 @@ extension PinballGameAssetsX on PinballGame { images.load(components.Assets.images.android.bumper.a.dimmed.keyName), images.load(components.Assets.images.android.bumper.b.lit.keyName), images.load(components.Assets.images.android.bumper.b.dimmed.keyName), + images.load(components.Assets.images.android.bumper.cow.lit.keyName), + images.load(components.Assets.images.android.bumper.cow.dimmed.keyName), images.load(components.Assets.images.sparky.computer.top.keyName), images.load(components.Assets.images.sparky.computer.base.keyName), images.load(components.Assets.images.sparky.animatronic.keyName), @@ -102,6 +104,16 @@ extension PinballGameAssetsX on PinballGame { images.load(components.Assets.images.googleWord.letter5.keyName), images.load(components.Assets.images.googleWord.letter6.keyName), images.load(components.Assets.images.backboard.display.keyName), + images.load(components.Assets.images.multiplier.x2.lit.keyName), + images.load(components.Assets.images.multiplier.x2.dimmed.keyName), + images.load(components.Assets.images.multiplier.x3.lit.keyName), + images.load(components.Assets.images.multiplier.x3.dimmed.keyName), + images.load(components.Assets.images.multiplier.x4.lit.keyName), + images.load(components.Assets.images.multiplier.x4.dimmed.keyName), + images.load(components.Assets.images.multiplier.x5.lit.keyName), + images.load(components.Assets.images.multiplier.x5.dimmed.keyName), + images.load(components.Assets.images.multiplier.x6.lit.keyName), + images.load(components.Assets.images.multiplier.x6.dimmed.keyName), images.load(dashTheme.leaderboardIcon.keyName), images.load(sparkyTheme.leaderboardIcon.keyName), images.load(androidTheme.leaderboardIcon.keyName), diff --git a/lib/game/pinball_game.dart b/lib/game/pinball_game.dart index bec0c9e1..6933e649 100644 --- a/lib/game/pinball_game.dart +++ b/lib/game/pinball_game.dart @@ -52,6 +52,7 @@ class PinballGame extends Forge2DGame final launcher = Launcher(); unawaited(addFromBlueprint(launcher)); + await add(Multipliers()); await add(FlutterForest()); await addFromBlueprint(SparkyFireZone()); await addFromBlueprint(AndroidAcres()); diff --git a/lib/game/view/widgets/round_count_display.dart b/lib/game/view/widgets/round_count_display.dart index 30135cd2..b8f67c26 100644 --- a/lib/game/view/widgets/round_count_display.dart +++ b/lib/game/view/widgets/round_count_display.dart @@ -21,7 +21,7 @@ class RoundCountDisplay extends StatelessWidget { Text( l10n.rounds, style: AppTextStyle.subtitle1.copyWith( - color: AppColors.orange, + color: AppColors.yellow, ), ), const SizedBox(width: 8), @@ -53,7 +53,7 @@ class RoundIndicator extends StatelessWidget { @override Widget build(BuildContext context) { - final color = isActive ? AppColors.orange : AppColors.orange.withAlpha(128); + final color = isActive ? AppColors.yellow : AppColors.yellow.withAlpha(128); const size = 8.0; return Padding( diff --git a/lib/game/view/widgets/score_view.dart b/lib/game/view/widgets/score_view.dart index 288ea05c..40b33c35 100644 --- a/lib/game/view/widgets/score_view.dart +++ b/lib/game/view/widgets/score_view.dart @@ -59,7 +59,7 @@ class _ScoreDisplay extends StatelessWidget { Text( l10n.score.toLowerCase(), style: AppTextStyle.subtitle1.copyWith( - color: AppColors.orange, + color: AppColors.yellow, ), ), const _ScoreText(), diff --git a/lib/gen/assets.gen.dart b/lib/gen/assets.gen.dart index f5b935a5..9559fd45 100644 --- a/lib/gen/assets.gen.dart +++ b/lib/gen/assets.gen.dart @@ -47,6 +47,14 @@ class $AssetsImagesComponentsGen { /// File path: assets/images/components/background.png AssetGenImage get background => const AssetGenImage('assets/images/components/background.png'); + + /// File path: assets/images/components/key.png + AssetGenImage get key => + const AssetGenImage('assets/images/components/key.png'); + + /// File path: assets/images/components/space.png + AssetGenImage get space => + const AssetGenImage('assets/images/components/space.png'); } class $AssetsImagesScoreGen { diff --git a/lib/l10n/arb/app_en.arb b/lib/l10n/arb/app_en.arb index 9655d8be..19b12296 100644 --- a/lib/l10n/arb/app_en.arb +++ b/lib/l10n/arb/app_en.arb @@ -8,6 +8,10 @@ "@howToPlay": { "description": "Text displayed on the landing page how to play button" }, + "tipsForFlips": "Tips for flips", + "@tipsForFlips": { + "description": "Text displayed on the landing page how to play button" + }, "launchControls": "Launch Controls", "@launchControls": { "description": "Text displayed on the how to play dialog with the launch controls" @@ -16,6 +20,26 @@ "@flipperControls": { "description": "Text displayed on the how to play dialog with the flipper controls" }, + "tapAndHoldRocket": "Tap & Hold Rocket", + "@tapAndHoldRocket": { + "description": "Text displayed on the how to launch on mobile" + }, + "to": "to", + "@to": { + "description": "Text displayed for the word to" + }, + "launch": "LAUNCH", + "@launch": { + "description": "Text displayed for the word launch" + }, + "tapLeftRightScreen": "Tap left/right screen", + "@tapLeftRightScreen": { + "description": "Text displayed on the how to flip on mobile" + }, + "flip": "FLIP", + "@flip": { + "description": "Text displayed for the word FLIP" + }, "start": "Start", "@start": { "description": "Text displayed on the character selection page start button" @@ -24,6 +48,10 @@ "@select": { "description": "Text displayed on the character selection page select button" }, + "space": "Space", + "@space": { + "description": "Text displayed on space control button" + }, "characterSelectionTitle": "Choose your character!", "@characterSelectionTitle": { "description": "Title text displayed on the character selection page" @@ -80,4 +108,4 @@ "@rounds": { "description": "Text displayed on the scoreboard widget to indicate rounds left" } -} +} \ No newline at end of file diff --git a/lib/leaderboard/bloc/leaderboard_bloc.dart b/lib/leaderboard/bloc/leaderboard_bloc.dart deleted file mode 100644 index 49a35474..00000000 --- a/lib/leaderboard/bloc/leaderboard_bloc.dart +++ /dev/null @@ -1,71 +0,0 @@ -import 'dart:async'; - -import 'package:bloc/bloc.dart'; -import 'package:equatable/equatable.dart'; -import 'package:leaderboard_repository/leaderboard_repository.dart'; -import 'package:pinball/leaderboard/leaderboard.dart'; - -part 'leaderboard_event.dart'; -part 'leaderboard_state.dart'; - -/// {@template leaderboard_bloc} -/// Manages leaderboard events. -/// -/// Uses a [LeaderboardRepository] to request and update players participations. -/// {@endtemplate} -class LeaderboardBloc extends Bloc { - /// {@macro leaderboard_bloc} - LeaderboardBloc(this._leaderboardRepository) - : super(const LeaderboardState.initial()) { - on(_onTop10Fetched); - on(_onLeaderboardEntryAdded); - } - - final LeaderboardRepository _leaderboardRepository; - - Future _onTop10Fetched( - Top10Fetched event, - Emitter emit, - ) async { - emit(state.copyWith(status: LeaderboardStatus.loading)); - try { - final top10Leaderboard = - await _leaderboardRepository.fetchTop10Leaderboard(); - - final leaderboardEntries = []; - top10Leaderboard.asMap().forEach( - (index, value) => leaderboardEntries.add(value.toEntry(index + 1)), - ); - - emit( - state.copyWith( - status: LeaderboardStatus.success, - leaderboard: leaderboardEntries, - ), - ); - } catch (error) { - emit(state.copyWith(status: LeaderboardStatus.error)); - addError(error); - } - } - - Future _onLeaderboardEntryAdded( - LeaderboardEntryAdded event, - Emitter emit, - ) async { - emit(state.copyWith(status: LeaderboardStatus.loading)); - try { - final ranking = - await _leaderboardRepository.addLeaderboardEntry(event.entry); - emit( - state.copyWith( - status: LeaderboardStatus.success, - ranking: ranking, - ), - ); - } catch (error) { - emit(state.copyWith(status: LeaderboardStatus.error)); - addError(error); - } - } -} diff --git a/lib/leaderboard/bloc/leaderboard_event.dart b/lib/leaderboard/bloc/leaderboard_event.dart deleted file mode 100644 index b9e6955a..00000000 --- a/lib/leaderboard/bloc/leaderboard_event.dart +++ /dev/null @@ -1,36 +0,0 @@ -part of 'leaderboard_bloc.dart'; - -/// {@template leaderboard_event} -/// Represents the events available for [LeaderboardBloc]. -/// {endtemplate} -abstract class LeaderboardEvent extends Equatable { - /// {@macro leaderboard_event} - const LeaderboardEvent(); -} - -/// {@template top_10_fetched} -/// Request the top 10 [LeaderboardEntryData]s. -/// {endtemplate} -class Top10Fetched extends LeaderboardEvent { - /// {@macro top_10_fetched} - const Top10Fetched(); - - @override - List get props => []; -} - -/// {@template leaderboard_entry_added} -/// Writes a new [LeaderboardEntryData]. -/// -/// Should be added when a player finishes a game. -/// {endtemplate} -class LeaderboardEntryAdded extends LeaderboardEvent { - /// {@macro leaderboard_entry_added} - const LeaderboardEntryAdded({required this.entry}); - - /// [LeaderboardEntryData] to be written to the remote storage. - final LeaderboardEntryData entry; - - @override - List get props => [entry]; -} diff --git a/lib/leaderboard/bloc/leaderboard_state.dart b/lib/leaderboard/bloc/leaderboard_state.dart deleted file mode 100644 index 20d68f0d..00000000 --- a/lib/leaderboard/bloc/leaderboard_state.dart +++ /dev/null @@ -1,59 +0,0 @@ -// ignore_for_file: public_member_api_docs - -part of 'leaderboard_bloc.dart'; - -/// Defines the request status. -enum LeaderboardStatus { - /// Request is being loaded. - loading, - - /// Request was processed successfully and received a valid response. - success, - - /// Request was processed unsuccessfully and received an error. - error, -} - -/// {@template leaderboard_state} -/// Represents the state of the leaderboard. -/// {@endtemplate} -class LeaderboardState extends Equatable { - /// {@macro leaderboard_state} - const LeaderboardState({ - required this.status, - required this.ranking, - required this.leaderboard, - }); - - const LeaderboardState.initial() - : status = LeaderboardStatus.loading, - ranking = const LeaderboardRanking( - ranking: 0, - outOf: 0, - ), - leaderboard = const []; - - /// The current [LeaderboardStatus] of the state. - final LeaderboardStatus status; - - /// Rank of the current player. - final LeaderboardRanking ranking; - - /// List of top-ranked players. - final List leaderboard; - - @override - List get props => [status, ranking, leaderboard]; - - LeaderboardState copyWith({ - LeaderboardStatus? status, - LeaderboardRanking? ranking, - List? leaderboard, - }) { - return LeaderboardState( - status: status ?? this.status, - ranking: ranking ?? this.ranking, - leaderboard: leaderboard ?? this.leaderboard, - ); - } -} diff --git a/lib/leaderboard/leaderboard.dart b/lib/leaderboard/leaderboard.dart deleted file mode 100644 index 08765743..00000000 --- a/lib/leaderboard/leaderboard.dart +++ /dev/null @@ -1,3 +0,0 @@ -export 'bloc/leaderboard_bloc.dart'; -export 'models/leader_board_entry.dart'; -export 'view/leaderboard_page.dart'; diff --git a/lib/leaderboard/view/leaderboard_page.dart b/lib/leaderboard/view/leaderboard_page.dart deleted file mode 100644 index b9866111..00000000 --- a/lib/leaderboard/view/leaderboard_page.dart +++ /dev/null @@ -1,306 +0,0 @@ -// ignore_for_file: public_member_api_docs - -import 'package:flutter/material.dart'; -import 'package:flutter_bloc/flutter_bloc.dart'; -import 'package:leaderboard_repository/leaderboard_repository.dart'; -import 'package:pinball/l10n/l10n.dart'; -import 'package:pinball/leaderboard/leaderboard.dart'; -import 'package:pinball/select_character/select_character.dart'; -import 'package:pinball_theme/pinball_theme.dart'; - -class LeaderboardPage extends StatelessWidget { - const LeaderboardPage({Key? key, required this.theme}) : super(key: key); - - final CharacterTheme theme; - - static Route route({required CharacterTheme theme}) { - return MaterialPageRoute( - builder: (_) => LeaderboardPage(theme: theme), - ); - } - - @override - Widget build(BuildContext context) { - return BlocProvider( - create: (context) => LeaderboardBloc( - context.read(), - )..add(const Top10Fetched()), - child: LeaderboardView(theme: theme), - ); - } -} - -class LeaderboardView extends StatelessWidget { - const LeaderboardView({Key? key, required this.theme}) : super(key: key); - - final CharacterTheme theme; - - @override - Widget build(BuildContext context) { - final l10n = context.l10n; - - return Scaffold( - body: Center( - child: SingleChildScrollView( - child: Column( - mainAxisAlignment: MainAxisAlignment.center, - children: [ - const SizedBox(height: 80), - Text( - l10n.leaderboard, - style: Theme.of(context).textTheme.headline3, - ), - const SizedBox(height: 80), - BlocBuilder( - builder: (context, state) { - switch (state.status) { - case LeaderboardStatus.loading: - return _LeaderboardLoading(theme: theme); - case LeaderboardStatus.success: - return _LeaderboardRanking( - ranking: state.leaderboard, - theme: theme, - ); - case LeaderboardStatus.error: - return _LeaderboardError(theme: theme); - } - }, - ), - const SizedBox(height: 20), - TextButton( - onPressed: () => Navigator.of(context).push( - CharacterSelectionDialog.route(), - ), - child: Text(l10n.retry), - ), - ], - ), - ), - ), - ); - } -} - -class _LeaderboardLoading extends StatelessWidget { - const _LeaderboardLoading({Key? key, required this.theme}) : super(key: key); - - final CharacterTheme theme; - - @override - Widget build(BuildContext context) { - return const Center( - child: CircularProgressIndicator(), - ); - } -} - -class _LeaderboardError extends StatelessWidget { - const _LeaderboardError({Key? key, required this.theme}) : super(key: key); - - final CharacterTheme theme; - - @override - Widget build(BuildContext context) { - return Padding( - padding: const EdgeInsets.all(20), - child: Text( - 'There was en error loading data!', - style: - Theme.of(context).textTheme.headline6?.copyWith(color: Colors.red), - ), - ); - } -} - -class _LeaderboardRanking extends StatelessWidget { - const _LeaderboardRanking({ - Key? key, - required this.ranking, - required this.theme, - }) : super(key: key); - - final List ranking; - final CharacterTheme theme; - - @override - Widget build(BuildContext context) { - return Padding( - padding: const EdgeInsets.all(20), - child: Column( - mainAxisAlignment: MainAxisAlignment.center, - children: [ - _LeaderboardHeaders(theme: theme), - _LeaderboardList( - ranking: ranking, - theme: theme, - ), - ], - ), - ); - } -} - -class _LeaderboardHeaders extends StatelessWidget { - const _LeaderboardHeaders({Key? key, required this.theme}) : super(key: key); - - final CharacterTheme theme; - - @override - Widget build(BuildContext context) { - final l10n = context.l10n; - - return Row( - mainAxisAlignment: MainAxisAlignment.center, - children: [ - _LeaderboardHeaderItem(title: l10n.rank, theme: theme), - _LeaderboardHeaderItem(title: l10n.character, theme: theme), - _LeaderboardHeaderItem(title: l10n.username, theme: theme), - _LeaderboardHeaderItem(title: l10n.score, theme: theme), - ], - ); - } -} - -class _LeaderboardHeaderItem extends StatelessWidget { - const _LeaderboardHeaderItem({ - Key? key, - required this.title, - required this.theme, - }) : super(key: key); - - final CharacterTheme theme; - final String title; - - @override - Widget build(BuildContext context) { - return Expanded( - child: DecoratedBox( - decoration: BoxDecoration( - color: theme.ballColor, - ), - child: Text( - title, - style: Theme.of(context).textTheme.headline5, - ), - ), - ); - } -} - -class _LeaderboardList extends StatelessWidget { - const _LeaderboardList({ - Key? key, - required this.ranking, - required this.theme, - }) : super(key: key); - - final List ranking; - final CharacterTheme theme; - - @override - Widget build(BuildContext context) { - return ListView.builder( - shrinkWrap: true, - itemBuilder: (_, index) => _LeaderBoardCompetitor( - entry: ranking[index], - theme: theme, - ), - itemCount: ranking.length, - ); - } -} - -class _LeaderBoardCompetitor extends StatelessWidget { - const _LeaderBoardCompetitor({ - Key? key, - required this.entry, - required this.theme, - }) : super(key: key); - - final CharacterTheme theme; - - final LeaderboardEntry entry; - - @override - Widget build(BuildContext context) { - return Row( - mainAxisAlignment: MainAxisAlignment.center, - children: [ - _LeaderboardCompetitorField( - text: entry.rank, - theme: theme, - ), - _LeaderboardCompetitorCharacter( - characterAsset: entry.character, - theme: theme, - ), - _LeaderboardCompetitorField( - text: entry.playerInitials, - theme: theme, - ), - _LeaderboardCompetitorField( - text: entry.score.toString(), - theme: theme, - ), - ], - ); - } -} - -class _LeaderboardCompetitorField extends StatelessWidget { - const _LeaderboardCompetitorField({ - Key? key, - required this.text, - required this.theme, - }) : super(key: key); - - final CharacterTheme theme; - final String text; - - @override - Widget build(BuildContext context) { - return Expanded( - child: DecoratedBox( - decoration: BoxDecoration( - border: Border.all( - color: theme.ballColor, - width: 2, - ), - ), - child: Padding( - padding: const EdgeInsets.all(8), - child: Text(text), - ), - ), - ); - } -} - -class _LeaderboardCompetitorCharacter extends StatelessWidget { - const _LeaderboardCompetitorCharacter({ - Key? key, - required this.characterAsset, - required this.theme, - }) : super(key: key); - - final CharacterTheme theme; - final AssetGenImage characterAsset; - - @override - Widget build(BuildContext context) { - return Expanded( - child: DecoratedBox( - decoration: BoxDecoration( - border: Border.all( - color: theme.ballColor, - width: 2, - ), - ), - child: SizedBox( - height: 30, - child: characterAsset.image(), - ), - ), - ); - } -} diff --git a/lib/select_character/view/character_selection_page.dart b/lib/select_character/view/character_selection_page.dart index 83dc6ee6..863722e6 100644 --- a/lib/select_character/view/character_selection_page.dart +++ b/lib/select_character/view/character_selection_page.dart @@ -49,14 +49,13 @@ class CharacterSelectionView extends StatelessWidget { Navigator.of(context).pop(); // TODO(arturplaczek): remove after merge StarBlocListener final height = MediaQuery.of(context).size.height * 0.5; - showDialog( context: context, builder: (_) => Center( child: SizedBox( height: height, width: height * 1.4, - child: const HowToPlayDialog(), + child: HowToPlayDialog(), ), ), ); diff --git a/lib/start_game/widgets/how_to_play_dialog.dart b/lib/start_game/widgets/how_to_play_dialog.dart index bc5166e4..1665d35d 100644 --- a/lib/start_game/widgets/how_to_play_dialog.dart +++ b/lib/start_game/widgets/how_to_play_dialog.dart @@ -1,33 +1,236 @@ // ignore_for_file: public_member_api_docs +import 'dart:async'; + import 'package:flutter/material.dart'; +import 'package:pinball/gen/gen.dart'; import 'package:pinball/l10n/l10n.dart'; +import 'package:pinball/theme/theme.dart'; import 'package:pinball_ui/pinball_ui.dart'; +import 'package:platform_helper/platform_helper.dart'; + +@visibleForTesting +enum Control { + left, + right, + down, + a, + d, + s, + space, +} + +extension on Control { + bool get isArrow => isDown || isRight || isLeft; + + bool get isDown => this == Control.down; + + bool get isRight => this == Control.right; + + bool get isLeft => this == Control.left; + + bool get isSpace => this == Control.space; + + String getCharacter(BuildContext context) { + switch (this) { + case Control.a: + return 'A'; + case Control.d: + return 'D'; + case Control.down: + return '>'; // Will be rotated + case Control.left: + return '<'; + case Control.right: + return '>'; + case Control.s: + return 'S'; + case Control.space: + return context.l10n.space; + } + } +} + +class HowToPlayDialog extends StatefulWidget { + HowToPlayDialog({ + Key? key, + @visibleForTesting PlatformHelper? platformHelper, + }) : platformHelper = platformHelper ?? PlatformHelper(), + super(key: key); + + final PlatformHelper platformHelper; + + @override + State createState() => _HowToPlayDialogState(); +} + +class _HowToPlayDialogState extends State { + late Timer closeTimer; + @override + void initState() { + super.initState(); + closeTimer = Timer(const Duration(seconds: 3), () { + if (mounted) { + Navigator.of(context).maybePop(); + } + }); + } + + @override + void dispose() { + closeTimer.cancel(); + super.dispose(); + } + + @override + Widget build(BuildContext context) { + final isMobile = widget.platformHelper.isMobile; + return PixelatedDecoration( + header: const _HowToPlayHeader(), + body: isMobile ? const _MobileBody() : const _DesktopBody(), + ); + } +} + +class _MobileBody extends StatelessWidget { + const _MobileBody({Key? key}) : super(key: key); + + @override + Widget build(BuildContext context) { + final paddingWidth = MediaQuery.of(context).size.width * 0.15; + final paddingHeight = MediaQuery.of(context).size.height * 0.075; + return FittedBox( + child: Padding( + padding: EdgeInsets.symmetric( + horizontal: paddingWidth, + ), + child: Column( + children: [ + const _MobileLaunchControls(), + SizedBox(height: paddingHeight), + const _MobileFlipperControls(), + ], + ), + ), + ); + } +} + +class _MobileLaunchControls extends StatelessWidget { + const _MobileLaunchControls({Key? key}) : super(key: key); -class HowToPlayDialog extends StatelessWidget { - const HowToPlayDialog({Key? key}) : super(key: key); + @override + Widget build(BuildContext context) { + final l10n = context.l10n; + const textStyle = AppTextStyle.subtitle3; + return Column( + children: [ + Text( + l10n.tapAndHoldRocket, + style: textStyle, + ), + Text.rich( + TextSpan( + children: [ + TextSpan( + text: '${l10n.to} ', + style: textStyle, + ), + TextSpan( + text: l10n.launch, + style: textStyle.copyWith( + color: AppColors.blue, + ), + ), + ], + ), + ), + ], + ); + } +} + +class _MobileFlipperControls extends StatelessWidget { + const _MobileFlipperControls({Key? key}) : super(key: key); @override Widget build(BuildContext context) { final l10n = context.l10n; + const textStyle = AppTextStyle.subtitle3; + return Column( + children: [ + Text( + l10n.tapLeftRightScreen, + style: textStyle, + ), + Text.rich( + TextSpan( + children: [ + TextSpan( + text: '${l10n.to} ', + style: textStyle, + ), + TextSpan( + text: l10n.flip, + style: textStyle.copyWith( + color: AppColors.orange, + ), + ), + ], + ), + ), + ], + ); + } +} + +class _DesktopBody extends StatelessWidget { + const _DesktopBody({Key? key}) : super(key: key); + + @override + Widget build(BuildContext context) { const spacing = SizedBox(height: 16); + return ListView( + children: const [ + spacing, + _DesktopLaunchControls(), + spacing, + _DesktopFlipperControls(), + ], + ); + } +} - return PixelatedDecoration( - header: Text(l10n.howToPlay), - body: ListView( - children: const [ - spacing, - _LaunchControls(), - spacing, - _FlipperControls(), +class _HowToPlayHeader extends StatelessWidget { + const _HowToPlayHeader({Key? key}) : super(key: key); + + @override + Widget build(BuildContext context) { + final l10n = context.l10n; + const headerTextStyle = AppTextStyle.title; + + return FittedBox( + child: Column( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + Text( + l10n.howToPlay, + style: headerTextStyle.copyWith( + fontWeight: FontWeight.bold, + ), + ), + Text( + l10n.tipsForFlips, + style: headerTextStyle, + ), ], ), ); } } -class _LaunchControls extends StatelessWidget { - const _LaunchControls({Key? key}) : super(key: key); +class _DesktopLaunchControls extends StatelessWidget { + const _DesktopLaunchControls({Key? key}) : super(key: key); @override Widget build(BuildContext context) { @@ -36,15 +239,18 @@ class _LaunchControls extends StatelessWidget { return Column( children: [ - Text(l10n.launchControls), + Text( + l10n.launchControls, + style: AppTextStyle.headline4, + ), const SizedBox(height: 10), Wrap( children: const [ - KeyIndicator.fromIcon(keyIcon: Icons.keyboard_arrow_down), + KeyButton(control: Control.down), spacing, - KeyIndicator.fromKeyName(keyName: 'SPACE'), + KeyButton(control: Control.space), spacing, - KeyIndicator.fromKeyName(keyName: 'S'), + KeyButton(control: Control.s), ], ) ], @@ -52,8 +258,8 @@ class _LaunchControls extends StatelessWidget { } } -class _FlipperControls extends StatelessWidget { - const _FlipperControls({Key? key}) : super(key: key); +class _DesktopFlipperControls extends StatelessWidget { + const _DesktopFlipperControls({Key? key}) : super(key: key); @override Widget build(BuildContext context) { @@ -62,7 +268,10 @@ class _FlipperControls extends StatelessWidget { return Column( children: [ - Text(l10n.flipperControls), + Text( + l10n.flipperControls, + style: AppTextStyle.subtitle2, + ), const SizedBox(height: 10), Column( children: [ @@ -70,17 +279,17 @@ class _FlipperControls extends StatelessWidget { mainAxisSize: MainAxisSize.min, mainAxisAlignment: MainAxisAlignment.center, children: const [ - KeyIndicator.fromIcon(keyIcon: Icons.keyboard_arrow_left), + KeyButton(control: Control.left), rowSpacing, - KeyIndicator.fromIcon(keyIcon: Icons.keyboard_arrow_right), + KeyButton(control: Control.right), ], ), const SizedBox(height: 8), Wrap( children: const [ - KeyIndicator.fromKeyName(keyName: 'A'), + KeyButton(control: Control.a), rowSpacing, - KeyIndicator.fromKeyName(keyName: 'D'), + KeyButton(control: Control.d), ], ) ], @@ -90,65 +299,46 @@ class _FlipperControls extends StatelessWidget { } } -// TODO(allisonryan0002): remove visibility when adding final UI. @visibleForTesting -class KeyIndicator extends StatelessWidget { - const KeyIndicator._({ +class KeyButton extends StatelessWidget { + const KeyButton({ Key? key, - required String keyName, - required IconData keyIcon, - required bool fromIcon, - }) : _keyName = keyName, - _keyIcon = keyIcon, - _fromIcon = fromIcon, + required Control control, + }) : _control = control, super(key: key); - const KeyIndicator.fromKeyName({Key? key, required String keyName}) - : this._( - key: key, - keyName: keyName, - keyIcon: Icons.keyboard_arrow_down, - fromIcon: false, - ); - - const KeyIndicator.fromIcon({Key? key, required IconData keyIcon}) - : this._( - key: key, - keyName: '', - keyIcon: keyIcon, - fromIcon: true, - ); - - final String _keyName; - - final IconData _keyIcon; - - final bool _fromIcon; + final Control _control; @override Widget build(BuildContext context) { - const iconPadding = EdgeInsets.all(15); - const textPadding = EdgeInsets.symmetric(vertical: 20, horizontal: 22); - final boarderColor = Colors.blue.withOpacity(0.5); - final color = Colors.blue.withOpacity(0.7); - + final textStyle = + _control.isArrow ? AppTextStyle.headline1 : AppTextStyle.headline3; + const height = 60.0; + final width = _control.isSpace ? height * 2.83 : height; return DecoratedBox( decoration: BoxDecoration( - borderRadius: BorderRadius.circular(5), - border: Border.all( - color: boarderColor, - width: 3, + image: DecorationImage( + fit: BoxFit.fill, + image: AssetImage( + _control.isSpace + ? Assets.images.components.space.keyName + : Assets.images.components.key.keyName, + ), ), ), - child: _fromIcon - ? Padding( - padding: iconPadding, - child: Icon(_keyIcon, color: color), - ) - : Padding( - padding: textPadding, - child: Text(_keyName, style: TextStyle(color: color)), + child: SizedBox( + width: width, + height: height, + child: Center( + child: RotatedBox( + quarterTurns: _control.isDown ? 1 : 0, + child: Text( + _control.getCharacter(context), + style: textStyle.copyWith(color: AppColors.white), ), + ), + ), + ), ); } } diff --git a/lib/theme/app_colors.dart b/lib/theme/app_colors.dart index 2d3899a6..a12d3edc 100644 --- a/lib/theme/app_colors.dart +++ b/lib/theme/app_colors.dart @@ -7,7 +7,9 @@ abstract class AppColors { static const Color darkBlue = Color(0xFF0C32A4); - static const Color orange = Color(0xFFFFEE02); + static const Color yellow = Color(0xFFFFEE02); + + static const Color orange = Color(0xFFE5AB05); static const Color blue = Color(0xFF4B94F6); diff --git a/lib/theme/app_text_style.dart b/lib/theme/app_text_style.dart index 8104ca11..084936e9 100644 --- a/lib/theme/app_text_style.dart +++ b/lib/theme/app_text_style.dart @@ -27,6 +27,35 @@ abstract class AppTextStyle { fontFamily: _primaryFontFamily, ); + static const headline4 = TextStyle( + color: AppColors.white, + fontSize: 16, + package: _fontPackage, + fontFamily: _primaryFontFamily, + ); + + static const title = TextStyle( + color: AppColors.darkBlue, + fontSize: 20, + package: _fontPackage, + fontFamily: _primaryFontFamily, + ); + + static const subtitle3 = TextStyle( + color: AppColors.white, + fontSize: 20, + fontWeight: FontWeight.bold, + package: _fontPackage, + fontFamily: _primaryFontFamily, + ); + + static const subtitle2 = TextStyle( + color: AppColors.white, + fontSize: 16, + package: _fontPackage, + fontFamily: _primaryFontFamily, + ); + static const subtitle1 = TextStyle( fontSize: 10, fontFamily: _primaryFontFamily, diff --git a/packages/leaderboard_repository/lib/src/leaderboard_repository.dart b/packages/leaderboard_repository/lib/src/leaderboard_repository.dart index 9d8b2434..c522584c 100644 --- a/packages/leaderboard_repository/lib/src/leaderboard_repository.dart +++ b/packages/leaderboard_repository/lib/src/leaderboard_repository.dart @@ -1,91 +1,6 @@ import 'package:cloud_firestore/cloud_firestore.dart'; import 'package:leaderboard_repository/leaderboard_repository.dart'; -/// {@template leaderboard_exception} -/// Base exception for leaderboard repository failures. -/// {@endtemplate} -abstract class LeaderboardException implements Exception { - /// {@macro leaderboard_exception} - const LeaderboardException(this.error, this.stackTrace); - - /// The error that was caught. - final Object error; - - /// The Stacktrace associated with the [error]. - final StackTrace stackTrace; -} - -/// {@template leaderboard_deserialization_exception} -/// Exception thrown when leaderboard data cannot be deserialized in the -/// expected way. -/// {@endtemplate} -class LeaderboardDeserializationException extends LeaderboardException { - /// {@macro leaderboard_deserialization_exception} - const LeaderboardDeserializationException( - Object error, - StackTrace stackTrace, - ) : super( - error, - stackTrace, - ); -} - -/// {@template fetch_top_10_leaderboard_exception} -/// Exception thrown when failure occurs while fetching top 10 leaderboard. -/// {@endtemplate} -class FetchTop10LeaderboardException extends LeaderboardException { - /// {@macro fetch_top_10_leaderboard_exception} - const FetchTop10LeaderboardException( - Object error, - StackTrace stackTrace, - ) : super( - error, - stackTrace, - ); -} - -/// {@template add_leaderboard_entry_exception} -/// Exception thrown when failure occurs while adding entry to leaderboard. -/// {@endtemplate} -class AddLeaderboardEntryException extends LeaderboardException { - /// {@macro add_leaderboard_entry_exception} - const AddLeaderboardEntryException( - Object error, - StackTrace stackTrace, - ) : super( - error, - stackTrace, - ); -} - -/// {@template fetch_player_ranking_exception} -/// Exception thrown when failure occurs while fetching player ranking. -/// {@endtemplate} -class FetchPlayerRankingException extends LeaderboardException { - /// {@macro fetch_player_ranking_exception} - const FetchPlayerRankingException( - Object error, - StackTrace stackTrace, - ) : super( - error, - stackTrace, - ); -} - -/// {@template fetch_prohibited_initials_exception} -/// Exception thrown when failure occurs while fetching prohibited initials. -/// {@endtemplate} -class FetchProhibitedInitialsException extends LeaderboardException { - /// {@macro fetch_prohibited_initials_exception} - const FetchProhibitedInitialsException( - Object error, - StackTrace stackTrace, - ) : super( - error, - stackTrace, - ); -} - /// {@template leaderboard_repository} /// Repository to access leaderboard data in Firebase Cloud Firestore. /// {@endtemplate} @@ -97,73 +12,40 @@ class LeaderboardRepository { final FirebaseFirestore _firebaseFirestore; + static const _leaderboardLimit = 10; + static const _leaderboardCollectionName = 'leaderboard'; + static const _scoreFieldName = 'score'; + /// Acquires top 10 [LeaderboardEntryData]s. Future> fetchTop10Leaderboard() async { - final leaderboardEntries = []; - late List documents; - try { final querySnapshot = await _firebaseFirestore - .collection('leaderboard') - .orderBy('score', descending: true) - .limit(10) + .collection(_leaderboardCollectionName) + .orderBy(_scoreFieldName, descending: true) + .limit(_leaderboardLimit) .get(); - documents = querySnapshot.docs; + final documents = querySnapshot.docs; + return documents.toLeaderboard(); + } on LeaderboardDeserializationException { + rethrow; } on Exception catch (error, stackTrace) { throw FetchTop10LeaderboardException(error, stackTrace); } - - for (final document in documents) { - final data = document.data() as Map?; - if (data != null) { - try { - leaderboardEntries.add(LeaderboardEntryData.fromJson(data)); - } catch (error, stackTrace) { - throw LeaderboardDeserializationException(error, stackTrace); - } - } - } - - return leaderboardEntries; } - /// Adds player's score entry to the leaderboard and gets their - /// [LeaderboardRanking]. - Future addLeaderboardEntry( + /// Adds player's score entry to the leaderboard if it is within the top-10 + Future addLeaderboardEntry( LeaderboardEntryData entry, ) async { - late DocumentReference entryReference; - try { - entryReference = await _firebaseFirestore - .collection('leaderboard') - .add(entry.toJson()); - } on Exception catch (error, stackTrace) { - throw AddLeaderboardEntryException(error, stackTrace); - } - - try { - final querySnapshot = await _firebaseFirestore - .collection('leaderboard') - .orderBy('score', descending: true) - .get(); - - // TODO(allisonryan0002): see if we can find a more performant solution. - final documents = querySnapshot.docs; - final ranking = documents.indexWhere( - (document) => document.id == entryReference.id, - ) + - 1; - - if (ranking > 0) { - return LeaderboardRanking(ranking: ranking, outOf: documents.length); - } else { - throw FetchPlayerRankingException( - 'Player score could not be found and ranking cannot be provided.', - StackTrace.current, - ); + final leaderboard = await _fetchLeaderboardSortedByScore(); + if (leaderboard.length < 10) { + await _saveScore(entry); + } else { + final tenthPositionScore = leaderboard[9].score; + if (entry.score > tenthPositionScore) { + await _saveScore(entry); + await _deleteScoresUnder(tenthPositionScore); } - } on Exception catch (error, stackTrace) { - throw FetchPlayerRankingException(error, stackTrace); } } @@ -174,7 +56,6 @@ class LeaderboardRepository { if (!initialsRegex.hasMatch(initials)) { return false; } - try { final document = await _firebaseFirestore .collection('prohibitedInitials') @@ -187,4 +68,61 @@ class LeaderboardRepository { throw FetchProhibitedInitialsException(error, stackTrace); } } + + Future> _fetchLeaderboardSortedByScore() async { + try { + final querySnapshot = await _firebaseFirestore + .collection(_leaderboardCollectionName) + .orderBy(_scoreFieldName, descending: true) + .get(); + final documents = querySnapshot.docs; + return documents.toLeaderboard(); + } on Exception catch (error, stackTrace) { + throw FetchLeaderboardException(error, stackTrace); + } + } + + Future _saveScore(LeaderboardEntryData entry) { + try { + return _firebaseFirestore + .collection(_leaderboardCollectionName) + .add(entry.toJson()); + } on Exception catch (error, stackTrace) { + throw AddLeaderboardEntryException(error, stackTrace); + } + } + + Future _deleteScoresUnder(int score) async { + try { + final querySnapshot = await _firebaseFirestore + .collection(_leaderboardCollectionName) + .where(_scoreFieldName, isLessThanOrEqualTo: score) + .get(); + final documents = querySnapshot.docs; + for (final document in documents) { + await document.reference.delete(); + } + } on LeaderboardDeserializationException { + rethrow; + } on Exception catch (error, stackTrace) { + throw DeleteLeaderboardException(error, stackTrace); + } + } +} + +extension on List { + List toLeaderboard() { + final leaderboardEntries = []; + for (final document in this) { + final data = document.data() as Map?; + if (data != null) { + try { + leaderboardEntries.add(LeaderboardEntryData.fromJson(data)); + } catch (error, stackTrace) { + throw LeaderboardDeserializationException(error, stackTrace); + } + } + } + return leaderboardEntries; + } } diff --git a/packages/leaderboard_repository/lib/src/models/exceptions.dart b/packages/leaderboard_repository/lib/src/models/exceptions.dart new file mode 100644 index 00000000..f709a27e --- /dev/null +++ b/packages/leaderboard_repository/lib/src/models/exceptions.dart @@ -0,0 +1,69 @@ +/// {@template leaderboard_exception} +/// Base exception for leaderboard repository failures. +/// {@endtemplate} +abstract class LeaderboardException implements Exception { + /// {@macro leaderboard_exception} + const LeaderboardException(this.error, this.stackTrace); + + /// The error that was caught. + final Object error; + + /// The Stacktrace associated with the [error]. + final StackTrace stackTrace; +} + +/// {@template leaderboard_deserialization_exception} +/// Exception thrown when leaderboard data cannot be deserialized in the +/// expected way. +/// {@endtemplate} +class LeaderboardDeserializationException extends LeaderboardException { + /// {@macro leaderboard_deserialization_exception} + const LeaderboardDeserializationException(Object error, StackTrace stackTrace) + : super(error, stackTrace); +} + +/// {@template fetch_top_10_leaderboard_exception} +/// Exception thrown when failure occurs while fetching top 10 leaderboard. +/// {@endtemplate} +class FetchTop10LeaderboardException extends LeaderboardException { + /// {@macro fetch_top_10_leaderboard_exception} + const FetchTop10LeaderboardException(Object error, StackTrace stackTrace) + : super(error, stackTrace); +} + +/// {@template fetch_leaderboard_exception} +/// Exception thrown when failure occurs while fetching the leaderboard. +/// {@endtemplate} +class FetchLeaderboardException extends LeaderboardException { + /// {@macro fetch_top_10_leaderboard_exception} + const FetchLeaderboardException(Object error, StackTrace stackTrace) + : super(error, stackTrace); +} + +/// {@template delete_leaderboard_exception} +/// Exception thrown when failure occurs while deleting the leaderboard under +/// the tenth position. +/// {@endtemplate} +class DeleteLeaderboardException extends LeaderboardException { + /// {@macro fetch_top_10_leaderboard_exception} + const DeleteLeaderboardException(Object error, StackTrace stackTrace) + : super(error, stackTrace); +} + +/// {@template add_leaderboard_entry_exception} +/// Exception thrown when failure occurs while adding entry to leaderboard. +/// {@endtemplate} +class AddLeaderboardEntryException extends LeaderboardException { + /// {@macro add_leaderboard_entry_exception} + const AddLeaderboardEntryException(Object error, StackTrace stackTrace) + : super(error, stackTrace); +} + +/// {@template fetch_prohibited_initials_exception} +/// Exception thrown when failure occurs while fetching prohibited initials. +/// {@endtemplate} +class FetchProhibitedInitialsException extends LeaderboardException { + /// {@macro fetch_prohibited_initials_exception} + const FetchProhibitedInitialsException(Object error, StackTrace stackTrace) + : super(error, stackTrace); +} diff --git a/packages/leaderboard_repository/lib/src/models/leaderboard_ranking.dart b/packages/leaderboard_repository/lib/src/models/leaderboard_ranking.dart deleted file mode 100644 index 4a322e00..00000000 --- a/packages/leaderboard_repository/lib/src/models/leaderboard_ranking.dart +++ /dev/null @@ -1,20 +0,0 @@ -import 'package:equatable/equatable.dart'; -import 'package:leaderboard_repository/leaderboard_repository.dart'; - -/// {@template leaderboard_ranking} -/// Contains [ranking] for a single [LeaderboardEntryData] and the number of -/// players the [ranking] is [outOf]. -/// {@endtemplate} -class LeaderboardRanking extends Equatable { - /// {@macro leaderboard_ranking} - const LeaderboardRanking({required this.ranking, required this.outOf}); - - /// Place ranking by score for a [LeaderboardEntryData]. - final int ranking; - - /// Number of [LeaderboardEntryData]s at the time of score entry. - final int outOf; - - @override - List get props => [ranking, outOf]; -} diff --git a/packages/leaderboard_repository/lib/src/models/models.dart b/packages/leaderboard_repository/lib/src/models/models.dart index e10a743b..a612f3ac 100644 --- a/packages/leaderboard_repository/lib/src/models/models.dart +++ b/packages/leaderboard_repository/lib/src/models/models.dart @@ -1,2 +1,2 @@ +export 'exceptions.dart'; export 'leaderboard_entry_data.dart'; -export 'leaderboard_ranking.dart'; diff --git a/packages/leaderboard_repository/test/src/leaderboard_repository_test.dart b/packages/leaderboard_repository/test/src/leaderboard_repository_test.dart index 9d31983f..af3c5fa3 100644 --- a/packages/leaderboard_repository/test/src/leaderboard_repository_test.dart +++ b/packages/leaderboard_repository/test/src/leaderboard_repository_test.dart @@ -153,7 +153,6 @@ void main() { character: CharacterType.dash, ); const entryDocumentId = 'id$entryScore'; - final ranking = LeaderboardRanking(ranking: 3, outOf: 4); setUp(() { leaderboardRepository = LeaderboardRepository(firestore); @@ -165,13 +164,12 @@ void main() { final queryDocumentSnapshot = MockQueryDocumentSnapshot(); when(queryDocumentSnapshot.data).thenReturn({ 'character': 'dash', - 'username': 'user$score', + 'playerInitials': 'AAA', 'score': score }); when(() => queryDocumentSnapshot.id).thenReturn('id$score'); return queryDocumentSnapshot; }).toList(); - when(() => firestore.collection('leaderboard')) .thenAnswer((_) => collectionReference); when(() => collectionReference.add(any())) @@ -184,19 +182,29 @@ void main() { }); test( - 'adds leaderboard entry and returns player ranking when ' - 'firestore operations succeed', () async { - final rankingResult = - await leaderboardRepository.addLeaderboardEntry(leaderboardEntry); - - expect(rankingResult, equals(ranking)); + 'throws FetchLeaderboardException ' + 'when querying the leaderboard fails', () { + when(() => firestore.collection('leaderboard')).thenThrow(Exception()); + expect( + () => leaderboardRepository.addLeaderboardEntry(leaderboardEntry), + throwsA(isA()), + ); }); test( - 'throws AddLeaderboardEntryException when Exception occurs ' - 'when trying to add entry to firestore', () async { - when(() => firestore.collection('leaderboard')).thenThrow(Exception()); + 'saves the new score if the existing leaderboard ' + 'has less than 10 scores', () async { + await leaderboardRepository.addLeaderboardEntry(leaderboardEntry); + verify( + () => collectionReference.add(leaderboardEntry.toJson()), + ).called(1); + }); + test( + 'throws AddLeaderboardEntryException ' + 'when adding a new entry fails', () async { + when(() => collectionReference.add(leaderboardEntry.toJson())) + .thenThrow(Exception('oops')); expect( () => leaderboardRepository.addLeaderboardEntry(leaderboardEntry), throwsA(isA()), @@ -204,26 +212,160 @@ void main() { }); test( - 'throws FetchPlayerRankingException when Exception occurs ' - 'when trying to retrieve information from firestore', () async { - when(() => collectionReference.orderBy('score', descending: true)) - .thenThrow(Exception()); + 'does nothing if there are more than 10 scores in the leaderboard ' + 'and the new score is smaller than the top 10', () async { + final leaderboardScores = [ + 10000, + 9500, + 9000, + 8500, + 8000, + 7500, + 7000, + 6500, + 6000, + 5500, + 5000 + ]; + final queryDocumentSnapshots = leaderboardScores.map((score) { + final queryDocumentSnapshot = MockQueryDocumentSnapshot(); + when(queryDocumentSnapshot.data).thenReturn({ + 'character': 'dash', + 'playerInitials': 'AAA', + 'score': score + }); + when(() => queryDocumentSnapshot.id).thenReturn('id$score'); + return queryDocumentSnapshot; + }).toList(); + when(() => querySnapshot.docs).thenReturn(queryDocumentSnapshots); - expect( - () => leaderboardRepository.addLeaderboardEntry(leaderboardEntry), - throwsA(isA()), + await leaderboardRepository.addLeaderboardEntry(leaderboardEntry); + verifyNever( + () => collectionReference.add(leaderboardEntry.toJson()), ); }); test( - 'throws FetchPlayerRankingException when score cannot be found ' - 'in firestore leaderboard data', () async { - when(() => documentReference.id).thenReturn('nonexistentDocumentId'); - + 'throws DeleteLeaderboardException ' + 'when deleting scores outside the top 10 fails', () async { + final deleteQuery = MockQuery(); + final deleteQuerySnapshot = MockQuerySnapshot(); + final newScore = LeaderboardEntryData( + playerInitials: 'ABC', + score: 15000, + character: CharacterType.android, + ); + final leaderboardScores = [ + 10000, + 9500, + 9000, + 8500, + 8000, + 7500, + 7000, + 6500, + 6000, + 5500, + 5000, + ]; + final deleteDocumentSnapshots = [5500, 5000].map((score) { + final queryDocumentSnapshot = MockQueryDocumentSnapshot(); + when(queryDocumentSnapshot.data).thenReturn({ + 'character': 'dash', + 'playerInitials': 'AAA', + 'score': score + }); + when(() => queryDocumentSnapshot.id).thenReturn('id$score'); + when(() => queryDocumentSnapshot.reference) + .thenReturn(documentReference); + return queryDocumentSnapshot; + }).toList(); + when(deleteQuery.get).thenAnswer((_) async => deleteQuerySnapshot); + when(() => deleteQuerySnapshot.docs) + .thenReturn(deleteDocumentSnapshots); + final queryDocumentSnapshots = leaderboardScores.map((score) { + final queryDocumentSnapshot = MockQueryDocumentSnapshot(); + when(queryDocumentSnapshot.data).thenReturn({ + 'character': 'dash', + 'playerInitials': 'AAA', + 'score': score + }); + when(() => queryDocumentSnapshot.id).thenReturn('id$score'); + when(() => queryDocumentSnapshot.reference) + .thenReturn(documentReference); + return queryDocumentSnapshot; + }).toList(); + when( + () => collectionReference.where('score', isLessThanOrEqualTo: 5500), + ).thenAnswer((_) => deleteQuery); + when(() => documentReference.delete()).thenThrow(Exception('oops')); + when(() => querySnapshot.docs).thenReturn(queryDocumentSnapshots); expect( - () => leaderboardRepository.addLeaderboardEntry(leaderboardEntry), - throwsA(isA()), + () => leaderboardRepository.addLeaderboardEntry(newScore), + throwsA(isA()), + ); + }); + + test( + 'saves the new score when there are more than 10 scores in the ' + 'leaderboard and the new score is higher than the lowest top 10, and ' + 'deletes the scores that are not in the top 10 anymore', () async { + final deleteQuery = MockQuery(); + final deleteQuerySnapshot = MockQuerySnapshot(); + final newScore = LeaderboardEntryData( + playerInitials: 'ABC', + score: 15000, + character: CharacterType.android, ); + final leaderboardScores = [ + 10000, + 9500, + 9000, + 8500, + 8000, + 7500, + 7000, + 6500, + 6000, + 5500, + 5000, + ]; + final deleteDocumentSnapshots = [5500, 5000].map((score) { + final queryDocumentSnapshot = MockQueryDocumentSnapshot(); + when(queryDocumentSnapshot.data).thenReturn({ + 'character': 'dash', + 'playerInitials': 'AAA', + 'score': score + }); + when(() => queryDocumentSnapshot.id).thenReturn('id$score'); + when(() => queryDocumentSnapshot.reference) + .thenReturn(documentReference); + return queryDocumentSnapshot; + }).toList(); + when(deleteQuery.get).thenAnswer((_) async => deleteQuerySnapshot); + when(() => deleteQuerySnapshot.docs) + .thenReturn(deleteDocumentSnapshots); + final queryDocumentSnapshots = leaderboardScores.map((score) { + final queryDocumentSnapshot = MockQueryDocumentSnapshot(); + when(queryDocumentSnapshot.data).thenReturn({ + 'character': 'dash', + 'playerInitials': 'AAA', + 'score': score + }); + when(() => queryDocumentSnapshot.id).thenReturn('id$score'); + when(() => queryDocumentSnapshot.reference) + .thenReturn(documentReference); + return queryDocumentSnapshot; + }).toList(); + when( + () => collectionReference.where('score', isLessThanOrEqualTo: 5500), + ).thenAnswer((_) => deleteQuery); + when(() => documentReference.delete()) + .thenAnswer((_) async => Future.value()); + when(() => querySnapshot.docs).thenReturn(queryDocumentSnapshots); + await leaderboardRepository.addLeaderboardEntry(newScore); + verify(() => collectionReference.add(newScore.toJson())).called(1); + verify(() => documentReference.delete()).called(2); }); }); diff --git a/packages/leaderboard_repository/test/src/models/leaderboard_ranking_test.dart b/packages/leaderboard_repository/test/src/models/leaderboard_ranking_test.dart deleted file mode 100644 index 577251e4..00000000 --- a/packages/leaderboard_repository/test/src/models/leaderboard_ranking_test.dart +++ /dev/null @@ -1,19 +0,0 @@ -import 'package:leaderboard_repository/leaderboard_repository.dart'; -import 'package:test/test.dart'; - -void main() { - group('LeaderboardRanking', () { - test('can be instantiated', () { - const leaderboardRanking = LeaderboardRanking(ranking: 1, outOf: 1); - - expect(leaderboardRanking, isNotNull); - }); - - test('supports value equality.', () { - const leaderboardRanking = LeaderboardRanking(ranking: 1, outOf: 1); - const leaderboardRanking2 = LeaderboardRanking(ranking: 1, outOf: 1); - - expect(leaderboardRanking, equals(leaderboardRanking2)); - }); - }); -} diff --git a/packages/pinball_components/assets/images/android/bumper/cow/dimmed.png b/packages/pinball_components/assets/images/android/bumper/cow/dimmed.png new file mode 100644 index 00000000..6a8bb146 Binary files /dev/null and b/packages/pinball_components/assets/images/android/bumper/cow/dimmed.png differ diff --git a/packages/pinball_components/assets/images/android/bumper/cow/lit.png b/packages/pinball_components/assets/images/android/bumper/cow/lit.png new file mode 100644 index 00000000..4909708b Binary files /dev/null and b/packages/pinball_components/assets/images/android/bumper/cow/lit.png differ diff --git a/packages/pinball_components/assets/images/multiplier/x2/dimmed.png b/packages/pinball_components/assets/images/multiplier/x2/dimmed.png new file mode 100644 index 00000000..7cc9fc4f Binary files /dev/null and b/packages/pinball_components/assets/images/multiplier/x2/dimmed.png differ diff --git a/packages/pinball_components/assets/images/multiplier/x2/lit.png b/packages/pinball_components/assets/images/multiplier/x2/lit.png new file mode 100644 index 00000000..be2b3f08 Binary files /dev/null and b/packages/pinball_components/assets/images/multiplier/x2/lit.png differ diff --git a/packages/pinball_components/assets/images/multiplier/x3/dimmed.png b/packages/pinball_components/assets/images/multiplier/x3/dimmed.png new file mode 100644 index 00000000..460b1a0e Binary files /dev/null and b/packages/pinball_components/assets/images/multiplier/x3/dimmed.png differ diff --git a/packages/pinball_components/assets/images/multiplier/x3/lit.png b/packages/pinball_components/assets/images/multiplier/x3/lit.png new file mode 100644 index 00000000..7fdedbbe Binary files /dev/null and b/packages/pinball_components/assets/images/multiplier/x3/lit.png differ diff --git a/packages/pinball_components/assets/images/multiplier/x4/dimmed.png b/packages/pinball_components/assets/images/multiplier/x4/dimmed.png new file mode 100644 index 00000000..e8a6256e Binary files /dev/null and b/packages/pinball_components/assets/images/multiplier/x4/dimmed.png differ diff --git a/packages/pinball_components/assets/images/multiplier/x4/lit.png b/packages/pinball_components/assets/images/multiplier/x4/lit.png new file mode 100644 index 00000000..5beceabb Binary files /dev/null and b/packages/pinball_components/assets/images/multiplier/x4/lit.png differ diff --git a/packages/pinball_components/assets/images/multiplier/x5/dimmed.png b/packages/pinball_components/assets/images/multiplier/x5/dimmed.png new file mode 100644 index 00000000..96e018e4 Binary files /dev/null and b/packages/pinball_components/assets/images/multiplier/x5/dimmed.png differ diff --git a/packages/pinball_components/assets/images/multiplier/x5/lit.png b/packages/pinball_components/assets/images/multiplier/x5/lit.png new file mode 100644 index 00000000..23fd3aab Binary files /dev/null and b/packages/pinball_components/assets/images/multiplier/x5/lit.png differ diff --git a/packages/pinball_components/assets/images/multiplier/x6/dimmed.png b/packages/pinball_components/assets/images/multiplier/x6/dimmed.png new file mode 100644 index 00000000..d518e1eb Binary files /dev/null and b/packages/pinball_components/assets/images/multiplier/x6/dimmed.png differ diff --git a/packages/pinball_components/assets/images/multiplier/x6/lit.png b/packages/pinball_components/assets/images/multiplier/x6/lit.png new file mode 100644 index 00000000..54244bab Binary files /dev/null and b/packages/pinball_components/assets/images/multiplier/x6/lit.png differ diff --git a/packages/pinball_components/lib/gen/assets.gen.dart b/packages/pinball_components/lib/gen/assets.gen.dart index 8ae254df..ec196221 100644 --- a/packages/pinball_components/lib/gen/assets.gen.dart +++ b/packages/pinball_components/lib/gen/assets.gen.dart @@ -23,6 +23,8 @@ class $AssetsImagesGen { $AssetsImagesKickerGen get kicker => const $AssetsImagesKickerGen(); $AssetsImagesLaunchRampGen get launchRamp => const $AssetsImagesLaunchRampGen(); + $AssetsImagesMultiplierGen get multiplier => + const $AssetsImagesMultiplierGen(); $AssetsImagesPlungerGen get plunger => const $AssetsImagesPlungerGen(); $AssetsImagesSignpostGen get signpost => const $AssetsImagesSignpostGen(); $AssetsImagesSlingshotGen get slingshot => const $AssetsImagesSlingshotGen(); @@ -188,6 +190,16 @@ class $AssetsImagesLaunchRampGen { const AssetGenImage('assets/images/launch_ramp/ramp.png'); } +class $AssetsImagesMultiplierGen { + const $AssetsImagesMultiplierGen(); + + $AssetsImagesMultiplierX2Gen get x2 => const $AssetsImagesMultiplierX2Gen(); + $AssetsImagesMultiplierX3Gen get x3 => const $AssetsImagesMultiplierX3Gen(); + $AssetsImagesMultiplierX4Gen get x4 => const $AssetsImagesMultiplierX4Gen(); + $AssetsImagesMultiplierX5Gen get x5 => const $AssetsImagesMultiplierX5Gen(); + $AssetsImagesMultiplierX6Gen get x6 => const $AssetsImagesMultiplierX6Gen(); +} + class $AssetsImagesPlungerGen { const $AssetsImagesPlungerGen(); @@ -252,6 +264,8 @@ class $AssetsImagesAndroidBumperGen { const $AssetsImagesAndroidBumperAGen(); $AssetsImagesAndroidBumperBGen get b => const $AssetsImagesAndroidBumperBGen(); + $AssetsImagesAndroidBumperCowGen get cow => + const $AssetsImagesAndroidBumperCowGen(); } class $AssetsImagesAndroidRailGen { @@ -326,6 +340,66 @@ class $AssetsImagesDinoAnimatronicGen { const AssetGenImage('assets/images/dino/animatronic/mouth.png'); } +class $AssetsImagesMultiplierX2Gen { + const $AssetsImagesMultiplierX2Gen(); + + /// File path: assets/images/multiplier/x2/dimmed.png + AssetGenImage get dimmed => + const AssetGenImage('assets/images/multiplier/x2/dimmed.png'); + + /// File path: assets/images/multiplier/x2/lit.png + AssetGenImage get lit => + const AssetGenImage('assets/images/multiplier/x2/lit.png'); +} + +class $AssetsImagesMultiplierX3Gen { + const $AssetsImagesMultiplierX3Gen(); + + /// File path: assets/images/multiplier/x3/dimmed.png + AssetGenImage get dimmed => + const AssetGenImage('assets/images/multiplier/x3/dimmed.png'); + + /// File path: assets/images/multiplier/x3/lit.png + AssetGenImage get lit => + const AssetGenImage('assets/images/multiplier/x3/lit.png'); +} + +class $AssetsImagesMultiplierX4Gen { + const $AssetsImagesMultiplierX4Gen(); + + /// File path: assets/images/multiplier/x4/dimmed.png + AssetGenImage get dimmed => + const AssetGenImage('assets/images/multiplier/x4/dimmed.png'); + + /// File path: assets/images/multiplier/x4/lit.png + AssetGenImage get lit => + const AssetGenImage('assets/images/multiplier/x4/lit.png'); +} + +class $AssetsImagesMultiplierX5Gen { + const $AssetsImagesMultiplierX5Gen(); + + /// File path: assets/images/multiplier/x5/dimmed.png + AssetGenImage get dimmed => + const AssetGenImage('assets/images/multiplier/x5/dimmed.png'); + + /// File path: assets/images/multiplier/x5/lit.png + AssetGenImage get lit => + const AssetGenImage('assets/images/multiplier/x5/lit.png'); +} + +class $AssetsImagesMultiplierX6Gen { + const $AssetsImagesMultiplierX6Gen(); + + /// File path: assets/images/multiplier/x6/dimmed.png + AssetGenImage get dimmed => + const AssetGenImage('assets/images/multiplier/x6/dimmed.png'); + + /// File path: assets/images/multiplier/x6/lit.png + AssetGenImage get lit => + const AssetGenImage('assets/images/multiplier/x6/lit.png');; +} + class $AssetsImagesSparkyBumperGen { const $AssetsImagesSparkyBumperGen(); @@ -370,6 +444,18 @@ class $AssetsImagesAndroidBumperBGen { const AssetGenImage('assets/images/android/bumper/b/lit.png'); } +class $AssetsImagesAndroidBumperCowGen { + const $AssetsImagesAndroidBumperCowGen(); + + /// File path: assets/images/android/bumper/cow/dimmed.png + AssetGenImage get dimmed => + const AssetGenImage('assets/images/android/bumper/cow/dimmed.png'); + + /// File path: assets/images/android/bumper/cow/lit.png + AssetGenImage get lit => + const AssetGenImage('assets/images/android/bumper/cow/lit.png'); +} + class $AssetsImagesAndroidRampArrowGen { const $AssetsImagesAndroidRampArrowGen(); diff --git a/packages/pinball_components/lib/src/components/android_bumper/android_bumper.dart b/packages/pinball_components/lib/src/components/android_bumper/android_bumper.dart index 3c6add60..e1a3857e 100644 --- a/packages/pinball_components/lib/src/components/android_bumper/android_bumper.dart +++ b/packages/pinball_components/lib/src/components/android_bumper/android_bumper.dart @@ -19,6 +19,7 @@ class AndroidBumper extends BodyComponent with InitialPosition { required double minorRadius, required String litAssetPath, required String dimmedAssetPath, + required Vector2 spritePosition, Iterable? children, required this.bloc, }) : _majorRadius = majorRadius, @@ -32,6 +33,7 @@ class AndroidBumper extends BodyComponent with InitialPosition { _AndroidBumperSpriteGroupComponent( dimmedAssetPath: dimmedAssetPath, litAssetPath: litAssetPath, + position: spritePosition, state: bloc.state, ), ...?children, @@ -46,6 +48,7 @@ class AndroidBumper extends BodyComponent with InitialPosition { minorRadius: 2.97, litAssetPath: Assets.images.android.bumper.a.lit.keyName, dimmedAssetPath: Assets.images.android.bumper.a.dimmed.keyName, + spritePosition: Vector2(0, -0.1), bloc: AndroidBumperCubit(), children: children, ); @@ -58,6 +61,20 @@ class AndroidBumper extends BodyComponent with InitialPosition { minorRadius: 2.79, litAssetPath: Assets.images.android.bumper.b.lit.keyName, dimmedAssetPath: Assets.images.android.bumper.b.dimmed.keyName, + spritePosition: Vector2(0, -0.1), + bloc: AndroidBumperCubit(), + children: children, + ); + + /// {@macro android_bumper} + AndroidBumper.cow({ + Iterable? children, + }) : this._( + majorRadius: 3.4, + minorRadius: 2.9, + litAssetPath: Assets.images.android.bumper.cow.lit.keyName, + dimmedAssetPath: Assets.images.android.bumper.cow.dimmed.keyName, + spritePosition: Vector2(0, -0.68), bloc: AndroidBumperCubit(), children: children, ); @@ -113,12 +130,13 @@ class _AndroidBumperSpriteGroupComponent _AndroidBumperSpriteGroupComponent({ required String litAssetPath, required String dimmedAssetPath, + required Vector2 position, required AndroidBumperState state, }) : _litAssetPath = litAssetPath, _dimmedAssetPath = dimmedAssetPath, super( anchor: Anchor.center, - position: Vector2(0, -0.1), + position: position, current: state, ); diff --git a/packages/pinball_components/lib/src/components/android_bumper/cubit/android_bumper_cubit.dart b/packages/pinball_components/lib/src/components/android_bumper/cubit/android_bumper_cubit.dart index 3d3fd4b1..3e75f890 100644 --- a/packages/pinball_components/lib/src/components/android_bumper/cubit/android_bumper_cubit.dart +++ b/packages/pinball_components/lib/src/components/android_bumper/cubit/android_bumper_cubit.dart @@ -5,7 +5,7 @@ import 'package:bloc/bloc.dart'; part 'android_bumper_state.dart'; class AndroidBumperCubit extends Cubit { - AndroidBumperCubit() : super(AndroidBumperState.dimmed); + AndroidBumperCubit() : super(AndroidBumperState.lit); void onBallContacted() { emit(AndroidBumperState.dimmed); diff --git a/packages/pinball_components/lib/src/components/bumping_behavior.dart b/packages/pinball_components/lib/src/components/bumping_behavior.dart index 654f96b4..af0d07c3 100644 --- a/packages/pinball_components/lib/src/components/bumping_behavior.dart +++ b/packages/pinball_components/lib/src/components/bumping_behavior.dart @@ -1,4 +1,5 @@ import 'package:flame_forge2d/flame_forge2d.dart'; +import 'package:flutter/material.dart'; import 'package:pinball_flame/pinball_flame.dart'; /// {@template bumping_behavior} @@ -11,15 +12,22 @@ class BumpingBehavior extends ContactBehavior { /// Determines how strong the bump is. final double _strength; + /// This is used to recoginze the current state of a contact manifold in world + /// coordinates. + @visibleForTesting + final WorldManifold worldManifold = WorldManifold(); + @override void postSolve(Object other, Contact contact, ContactImpulse impulse) { super.postSolve(other, contact, impulse); if (other is! BodyComponent) return; + contact.getWorldManifold(worldManifold); other.body.applyLinearImpulse( - contact.manifold.localPoint - ..normalize() - ..multiply(Vector2.all(other.body.mass * _strength)), + worldManifold.normal + ..multiply( + Vector2.all(other.body.mass * _strength), + ), ); } } diff --git a/packages/pinball_components/lib/src/components/components.dart b/packages/pinball_components/lib/src/components/components.dart index 77191142..2f0e4031 100644 --- a/packages/pinball_components/lib/src/components/components.dart +++ b/packages/pinball_components/lib/src/components/components.dart @@ -20,6 +20,7 @@ export 'kicker.dart'; export 'launch_ramp.dart'; export 'layer.dart'; export 'layer_sensor.dart'; +export 'multiplier/multiplier.dart'; export 'plunger.dart'; export 'render_priority.dart'; export 'rocket.dart'; diff --git a/packages/pinball_components/lib/src/components/google_letter/google_letter.dart b/packages/pinball_components/lib/src/components/google_letter/google_letter.dart index 63207e01..a865acf8 100644 --- a/packages/pinball_components/lib/src/components/google_letter/google_letter.dart +++ b/packages/pinball_components/lib/src/components/google_letter/google_letter.dart @@ -13,12 +13,14 @@ export 'cubit/google_letter_cubit.dart'; class GoogleLetter extends BodyComponent with InitialPosition { /// {@macro google_letter} GoogleLetter( - int index, - ) : bloc = GoogleLetterCubit(), + int index, { + Iterable? children, + }) : bloc = GoogleLetterCubit(), super( children: [ GoogleLetterBallContactBehavior(), - _GoogleLetterSprite(_GoogleLetterSprite.spritePaths[index]) + _GoogleLetterSprite(_GoogleLetterSprite.spritePaths[index]), + ...?children, ], ); diff --git a/packages/pinball_components/lib/src/components/kicker.dart b/packages/pinball_components/lib/src/components/kicker.dart index 12cd638d..527ffde4 100644 --- a/packages/pinball_components/lib/src/components/kicker.dart +++ b/packages/pinball_components/lib/src/components/kicker.dart @@ -16,9 +16,13 @@ class Kicker extends BodyComponent with InitialPosition { /// {@macro kicker} Kicker({ required BoardSide side, + Iterable? children, }) : _side = side, super( - children: [_KickerSpriteComponent(side: side)], + children: [ + _KickerSpriteComponent(side: side), + ...?children, + ], renderBody: false, ); diff --git a/packages/pinball_components/lib/src/components/multiplier/cubit/multiplier_cubit.dart b/packages/pinball_components/lib/src/components/multiplier/cubit/multiplier_cubit.dart new file mode 100644 index 00000000..1d265b2e --- /dev/null +++ b/packages/pinball_components/lib/src/components/multiplier/cubit/multiplier_cubit.dart @@ -0,0 +1,25 @@ +// ignore_for_file: public_member_api_docs + +import 'package:bloc/bloc.dart'; +import 'package:equatable/equatable.dart'; +import 'package:pinball_components/pinball_components.dart'; + +part 'multiplier_state.dart'; + +class MultiplierCubit extends Cubit { + MultiplierCubit(MultiplierValue multiplierValue) + : super(MultiplierState.initial(multiplierValue)); + + /// Event added when the game's current multiplier changes. + void next(int multiplier) { + if (state.value.equals(multiplier)) { + if (state.spriteState == MultiplierSpriteState.dimmed) { + emit(state.copyWith(spriteState: MultiplierSpriteState.lit)); + } + } else { + if (state.spriteState == MultiplierSpriteState.lit) { + emit(state.copyWith(spriteState: MultiplierSpriteState.dimmed)); + } + } + } +} diff --git a/packages/pinball_components/lib/src/components/multiplier/cubit/multiplier_state.dart b/packages/pinball_components/lib/src/components/multiplier/cubit/multiplier_state.dart new file mode 100644 index 00000000..e3adde70 --- /dev/null +++ b/packages/pinball_components/lib/src/components/multiplier/cubit/multiplier_state.dart @@ -0,0 +1,56 @@ +// ignore_for_file: public_member_api_docs + +part of 'multiplier_cubit.dart'; + +enum MultiplierSpriteState { + lit, + dimmed, +} + +class MultiplierState extends Equatable { + const MultiplierState({ + required this.value, + required this.spriteState, + }); + + const MultiplierState.initial(MultiplierValue multiplierValue) + : this( + value: multiplierValue, + spriteState: MultiplierSpriteState.dimmed, + ); + + /// Current value for the [Multiplier] + final MultiplierValue value; + + /// The [MultiplierSpriteGroupComponent] current sprite state + final MultiplierSpriteState spriteState; + + MultiplierState copyWith({ + MultiplierSpriteState? spriteState, + }) { + return MultiplierState( + value: value, + spriteState: spriteState ?? this.spriteState, + ); + } + + @override + List get props => [value, spriteState]; +} + +extension MultiplierValueX on MultiplierValue { + bool equals(int value) { + switch (this) { + case MultiplierValue.x2: + return value == 2; + case MultiplierValue.x3: + return value == 3; + case MultiplierValue.x4: + return value == 4; + case MultiplierValue.x5: + return value == 5; + case MultiplierValue.x6: + return value == 6; + } + } +} diff --git a/packages/pinball_components/lib/src/components/multiplier/multiplier.dart b/packages/pinball_components/lib/src/components/multiplier/multiplier.dart new file mode 100644 index 00000000..54d02857 --- /dev/null +++ b/packages/pinball_components/lib/src/components/multiplier/multiplier.dart @@ -0,0 +1,204 @@ +// ignore_for_file: public_member_api_docs + +import 'package:flame/components.dart'; +import 'package:flutter/material.dart'; +import 'package:pinball_components/gen/assets.gen.dart'; +import 'package:pinball_components/src/components/multiplier/cubit/multiplier_cubit.dart'; +import 'package:pinball_flame/pinball_flame.dart'; + +export 'cubit/multiplier_cubit.dart'; + +/// {@template multiplier} +/// Backlit multiplier decal displayed on the board. +/// {@endtemplate} +class Multiplier extends Component { + /// {@macro multiplier} + Multiplier._({ + required MultiplierValue value, + required Vector2 position, + required double angle, + required this.bloc, + }) : _value = value, + _position = position, + _angle = angle, + super(); + + /// {@macro multiplier} + Multiplier.x2({ + required Vector2 position, + required double angle, + }) : this._( + value: MultiplierValue.x2, + position: position, + angle: angle, + bloc: MultiplierCubit(MultiplierValue.x2), + ); + + /// {@macro multiplier} + Multiplier.x3({ + required Vector2 position, + required double angle, + }) : this._( + value: MultiplierValue.x3, + position: position, + angle: angle, + bloc: MultiplierCubit(MultiplierValue.x3), + ); + + /// {@macro multiplier} + Multiplier.x4({ + required Vector2 position, + required double angle, + }) : this._( + value: MultiplierValue.x4, + position: position, + angle: angle, + bloc: MultiplierCubit(MultiplierValue.x4), + ); + + /// {@macro multiplier} + Multiplier.x5({ + required Vector2 position, + required double angle, + }) : this._( + value: MultiplierValue.x5, + position: position, + angle: angle, + bloc: MultiplierCubit(MultiplierValue.x5), + ); + + /// {@macro multiplier} + Multiplier.x6({ + required Vector2 position, + required double angle, + }) : this._( + value: MultiplierValue.x6, + position: position, + angle: angle, + bloc: MultiplierCubit(MultiplierValue.x6), + ); + + /// Creates a [Multiplier] without any children. + /// + /// This can be used for testing [Multiplier]'s behaviors in isolation. + // TODO(alestiago): Refactor injecting bloc once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + @visibleForTesting + Multiplier.test({ + required MultiplierValue value, + required this.bloc, + }) : _value = value, + _position = Vector2.zero(), + _angle = 0; + +// TODO(ruimiguel): Consider refactoring once the following is merged: + // https://github.com/flame-engine/flame/pull/1538 + final MultiplierCubit bloc; + + final MultiplierValue _value; + final Vector2 _position; + final double _angle; + late final MultiplierSpriteGroupComponent _sprite; + + @override + void onRemove() { + bloc.close(); + super.onRemove(); + } + + @override + Future onLoad() async { + await super.onLoad(); + _sprite = MultiplierSpriteGroupComponent( + position: _position, + litAssetPath: _value.litAssetPath, + dimmedAssetPath: _value.dimmedAssetPath, + angle: _angle, + current: bloc.state, + ); + await add(_sprite); + } +} + +/// Available multiplier values. +enum MultiplierValue { + x2, + x3, + x4, + x5, + x6, +} + +extension on MultiplierValue { + String get litAssetPath { + switch (this) { + case MultiplierValue.x2: + return Assets.images.multiplier.x2.lit.keyName; + case MultiplierValue.x3: + return Assets.images.multiplier.x3.lit.keyName; + case MultiplierValue.x4: + return Assets.images.multiplier.x4.lit.keyName; + case MultiplierValue.x5: + return Assets.images.multiplier.x5.lit.keyName; + case MultiplierValue.x6: + return Assets.images.multiplier.x6.lit.keyName; + } + } + + String get dimmedAssetPath { + switch (this) { + case MultiplierValue.x2: + return Assets.images.multiplier.x2.dimmed.keyName; + case MultiplierValue.x3: + return Assets.images.multiplier.x3.dimmed.keyName; + case MultiplierValue.x4: + return Assets.images.multiplier.x4.dimmed.keyName; + case MultiplierValue.x5: + return Assets.images.multiplier.x5.dimmed.keyName; + case MultiplierValue.x6: + return Assets.images.multiplier.x6.dimmed.keyName; + } + } +} + +/// {@template multiplier_sprite_group_component} +/// A [SpriteGroupComponent] for a [Multiplier] with lit and dimmed states. +/// {@endtemplate} +@visibleForTesting +class MultiplierSpriteGroupComponent + extends SpriteGroupComponent + with HasGameRef, ParentIsA { + /// {@macro multiplier_sprite_group_component} + MultiplierSpriteGroupComponent({ + required Vector2 position, + required String litAssetPath, + required String dimmedAssetPath, + required double angle, + required MultiplierState current, + }) : _litAssetPath = litAssetPath, + _dimmedAssetPath = dimmedAssetPath, + super( + anchor: Anchor.center, + position: position, + angle: angle, + current: current.spriteState, + ); + + final String _litAssetPath; + final String _dimmedAssetPath; + + @override + Future onLoad() async { + await super.onLoad(); + parent.bloc.stream.listen((state) => current = state.spriteState); + + final sprites = { + MultiplierSpriteState.lit: + Sprite(gameRef.images.fromCache(_litAssetPath)), + MultiplierSpriteState.dimmed: + Sprite(gameRef.images.fromCache(_dimmedAssetPath)), + }; + this.sprites = sprites; + size = sprites[current]!.originalSize / 10; + } +} diff --git a/packages/pinball_components/pubspec.yaml b/packages/pinball_components/pubspec.yaml index 58cf784e..0769f484 100644 --- a/packages/pinball_components/pubspec.yaml +++ b/packages/pinball_components/pubspec.yaml @@ -62,6 +62,7 @@ flutter: - assets/images/android/ramp/arrow/ - assets/images/android/bumper/a/ - assets/images/android/bumper/b/ + - assets/images/android/bumper/cow/ - assets/images/kicker/ - assets/images/plunger/ - assets/images/slingshot/ @@ -73,6 +74,11 @@ flutter: - assets/images/backboard/ - assets/images/google_word/ - assets/images/signpost/ + - assets/images/multiplier/x2/ + - assets/images/multiplier/x3/ + - assets/images/multiplier/x4/ + - assets/images/multiplier/x5/ + - assets/images/multiplier/x6/ flutter_gen: line_length: 80 diff --git a/packages/pinball_components/sandbox/lib/main.dart b/packages/pinball_components/sandbox/lib/main.dart index 96083717..1f0077fb 100644 --- a/packages/pinball_components/sandbox/lib/main.dart +++ b/packages/pinball_components/sandbox/lib/main.dart @@ -27,6 +27,7 @@ void main() { addScoreTextStories(dashbook); addBackboardStories(dashbook); addDinoWallStories(dashbook); + addMultipliersStories(dashbook); runApp(dashbook); } diff --git a/packages/pinball_components/sandbox/lib/stories/android_acres/android_bumper_cow_game.dart b/packages/pinball_components/sandbox/lib/stories/android_acres/android_bumper_cow_game.dart new file mode 100644 index 00000000..3b0aa828 --- /dev/null +++ b/packages/pinball_components/sandbox/lib/stories/android_acres/android_bumper_cow_game.dart @@ -0,0 +1,33 @@ +import 'dart:async'; + +import 'package:flame/extensions.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:sandbox/stories/ball/basic_ball_game.dart'; + +class AndroidBumperCowGame extends BallGame { + AndroidBumperCowGame() + : super( + imagesFileNames: [ + Assets.images.androidBumper.cow.lit.keyName, + Assets.images.androidBumper.cow.dimmed.keyName, + ], + ); + + static const description = ''' + Shows how a AndroidBumper.cow is rendered. + + - Activate the "trace" parameter to overlay the body. +'''; + + @override + Future onLoad() async { + await super.onLoad(); + + camera.followVector2(Vector2.zero()); + await add( + AndroidBumper.cow()..priority = 1, + ); + + await traceAllBodies(); + } +} diff --git a/packages/pinball_components/sandbox/lib/stories/android_acres/stories.dart b/packages/pinball_components/sandbox/lib/stories/android_acres/stories.dart index fb3071df..ec4a783e 100644 --- a/packages/pinball_components/sandbox/lib/stories/android_acres/stories.dart +++ b/packages/pinball_components/sandbox/lib/stories/android_acres/stories.dart @@ -2,6 +2,7 @@ import 'package:dashbook/dashbook.dart'; import 'package:sandbox/common/common.dart'; import 'package:sandbox/stories/android_acres/android_bumper_a_game.dart'; import 'package:sandbox/stories/android_acres/android_bumper_b_game.dart'; +import 'package:sandbox/stories/android_acres/android_bumper_cow_game.dart'; import 'package:sandbox/stories/android_acres/android_spaceship_game.dart'; import 'package:sandbox/stories/android_acres/spaceship_rail_game.dart'; import 'package:sandbox/stories/android_acres/spaceship_ramp_game.dart'; @@ -18,6 +19,11 @@ void addAndroidAcresStories(Dashbook dashbook) { description: AndroidBumperBGame.description, gameBuilder: (_) => AndroidBumperBGame(), ) + ..addGame( + title: 'Android Bumper Cow', + description: AndroidBumperCowGame.description, + gameBuilder: (_) => AndroidBumperCowGame(), + ) ..addGame( title: 'Android Spaceship', description: AndroidSpaceshipGame.description, diff --git a/packages/pinball_components/sandbox/lib/stories/multipliers/multipliers_game.dart b/packages/pinball_components/sandbox/lib/stories/multipliers/multipliers_game.dart new file mode 100644 index 00000000..ae641623 --- /dev/null +++ b/packages/pinball_components/sandbox/lib/stories/multipliers/multipliers_game.dart @@ -0,0 +1,97 @@ +import 'dart:math' as math; +import 'package:flame/input.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter/services.dart'; +import 'package:pinball_components/pinball_components.dart'; +import 'package:sandbox/stories/ball/basic_ball_game.dart'; + +class MultipliersGame extends BallGame with KeyboardEvents { + MultipliersGame() + : super( + imagesFileNames: [ + Assets.images.multiplier.x2.lit.keyName, + Assets.images.multiplier.x2.dimmed.keyName, + Assets.images.multiplier.x3.lit.keyName, + Assets.images.multiplier.x3.dimmed.keyName, + Assets.images.multiplier.x4.lit.keyName, + Assets.images.multiplier.x4.dimmed.keyName, + Assets.images.multiplier.x5.lit.keyName, + Assets.images.multiplier.x5.dimmed.keyName, + Assets.images.multiplier.x6.lit.keyName, + Assets.images.multiplier.x6.dimmed.keyName, + ], + ); + + static const description = ''' + Shows how the Multipliers are rendered. + + - Tap anywhere on the screen to spawn a ball into the game. + - Press digits 2 to 6 for toggle state multipliers 2 to 6. +'''; + + final List multipliers = [ + Multiplier.x2( + position: Vector2(-20, 0), + angle: -15 * math.pi / 180, + ), + Multiplier.x3( + position: Vector2(20, -5), + angle: 15 * math.pi / 180, + ), + Multiplier.x4( + position: Vector2(0, -15), + angle: 0, + ), + Multiplier.x5( + position: Vector2(-10, -25), + angle: -3 * math.pi / 180, + ), + Multiplier.x6( + position: Vector2(10, -35), + angle: 8 * math.pi / 180, + ), + ]; + + @override + Future onLoad() async { + await super.onLoad(); + + camera.followVector2(Vector2.zero()); + + await addAll(multipliers); + await traceAllBodies(); + } + + @override + KeyEventResult onKeyEvent( + RawKeyEvent event, + Set keysPressed, + ) { + if (event is RawKeyDownEvent) { + var currentMultiplier = 1; + + if (event.logicalKey == LogicalKeyboardKey.digit2) { + currentMultiplier = 2; + } + if (event.logicalKey == LogicalKeyboardKey.digit3) { + currentMultiplier = 3; + } + if (event.logicalKey == LogicalKeyboardKey.digit4) { + currentMultiplier = 4; + } + if (event.logicalKey == LogicalKeyboardKey.digit5) { + currentMultiplier = 5; + } + if (event.logicalKey == LogicalKeyboardKey.digit6) { + currentMultiplier = 6; + } + + for (final multiplier in multipliers) { + multiplier.bloc.next(currentMultiplier); + } + + return KeyEventResult.handled; + } + return KeyEventResult.ignored; + } +} diff --git a/packages/pinball_components/sandbox/lib/stories/multipliers/stories.dart b/packages/pinball_components/sandbox/lib/stories/multipliers/stories.dart new file mode 100644 index 00000000..48b6da6d --- /dev/null +++ b/packages/pinball_components/sandbox/lib/stories/multipliers/stories.dart @@ -0,0 +1,11 @@ +import 'package:dashbook/dashbook.dart'; +import 'package:sandbox/common/common.dart'; +import 'package:sandbox/stories/multipliers/multipliers_game.dart'; + +void addMultipliersStories(Dashbook dashbook) { + dashbook.storiesOf('Multipliers').addGame( + title: 'Multipliers', + description: MultipliersGame.description, + gameBuilder: (_) => MultipliersGame(), + ); +} diff --git a/packages/pinball_components/sandbox/lib/stories/stories.dart b/packages/pinball_components/sandbox/lib/stories/stories.dart index 9e1d44d8..d5e410b4 100644 --- a/packages/pinball_components/sandbox/lib/stories/stories.dart +++ b/packages/pinball_components/sandbox/lib/stories/stories.dart @@ -10,6 +10,7 @@ export 'flutter_forest/stories.dart'; export 'google_word/stories.dart'; export 'launch_ramp/stories.dart'; export 'layer/stories.dart'; +export 'multipliers/stories.dart'; export 'plunger/stories.dart'; export 'score_text/stories.dart'; export 'slingshot/stories.dart'; diff --git a/packages/pinball_components/sandbox/pubspec.lock b/packages/pinball_components/sandbox/pubspec.lock index 8d61da32..d2500fbe 100644 --- a/packages/pinball_components/sandbox/pubspec.lock +++ b/packages/pinball_components/sandbox/pubspec.lock @@ -15,6 +15,13 @@ packages: url: "https://pub.dartlang.org" source: hosted version: "2.8.2" + bloc: + dependency: transitive + description: + name: bloc + url: "https://pub.dartlang.org" + source: hosted + version: "8.0.3" boolean_selector: dependency: transitive description: @@ -171,7 +178,7 @@ packages: name: js url: "https://pub.dartlang.org" source: hosted - version: "0.6.4" + version: "0.6.3" json_annotation: dependency: transitive description: @@ -199,7 +206,7 @@ packages: name: material_color_utilities url: "https://pub.dartlang.org" source: hosted - version: "0.1.4" + version: "0.1.3" meta: dependency: transitive description: @@ -220,7 +227,7 @@ packages: name: path url: "https://pub.dartlang.org" source: hosted - version: "1.8.1" + version: "1.8.0" path_provider_linux: dependency: transitive description: @@ -351,7 +358,7 @@ packages: name: source_span url: "https://pub.dartlang.org" source: hosted - version: "1.8.2" + version: "1.8.1" stack_trace: dependency: transitive description: @@ -386,7 +393,7 @@ packages: name: test_api url: "https://pub.dartlang.org" source: hosted - version: "0.4.9" + version: "0.4.8" typed_data: dependency: transitive description: @@ -456,7 +463,7 @@ packages: name: vector_math url: "https://pub.dartlang.org" source: hosted - version: "2.1.2" + version: "2.1.1" very_good_analysis: dependency: "direct dev" description: diff --git a/packages/pinball_components/test/helpers/mocks.dart b/packages/pinball_components/test/helpers/mocks.dart index 2230becb..33c5670d 100644 --- a/packages/pinball_components/test/helpers/mocks.dart +++ b/packages/pinball_components/test/helpers/mocks.dart @@ -24,3 +24,5 @@ class MockGoogleLetterCubit extends Mock implements GoogleLetterCubit {} class MockSparkyBumperCubit extends Mock implements SparkyBumperCubit {} class MockDashNestBumperCubit extends Mock implements DashNestBumperCubit {} + +class MockMultiplierCubit extends Mock implements MultiplierCubit {} diff --git a/packages/pinball_components/test/src/components/android_bumper/android_bumper_test.dart b/packages/pinball_components/test/src/components/android_bumper/android_bumper_test.dart index 44346d53..a5256b79 100644 --- a/packages/pinball_components/test/src/components/android_bumper/android_bumper_test.dart +++ b/packages/pinball_components/test/src/components/android_bumper/android_bumper_test.dart @@ -17,6 +17,8 @@ void main() { Assets.images.android.bumper.a.dimmed.keyName, Assets.images.android.bumper.b.lit.keyName, Assets.images.android.bumper.b.dimmed.keyName, + Assets.images.android.bumper.cow.lit.keyName, + Assets.images.android.bumper.cow.dimmed.keyName, ]; final flameTester = FlameTester(() => TestGame(assets)); @@ -33,6 +35,12 @@ void main() { expect(game.contains(androidBumper), isTrue); }); + flameTester.test('"cow" loads correctly', (game) async { + final androidBumper = AndroidBumper.cow(); + await game.ensureAdd(androidBumper); + expect(game.contains(androidBumper), isTrue); + }); + // TODO(alestiago): Consider refactoring once the following is merged: // https://github.com/flame-engine/flame/pull/1538 // ignore: public_member_api_docs diff --git a/packages/pinball_components/test/src/components/bumping_behavior_test.dart b/packages/pinball_components/test/src/components/bumping_behavior_test.dart index d346a0ae..dd0493f7 100644 --- a/packages/pinball_components/test/src/components/bumping_behavior_test.dart +++ b/packages/pinball_components/test/src/components/bumping_behavior_test.dart @@ -7,22 +7,16 @@ import 'package:mocktail/mocktail.dart'; import 'package:pinball_components/src/components/bumping_behavior.dart'; import '../../helpers/helpers.dart'; -import 'layer_test.dart'; -class MockContactImpulse extends Mock implements ContactImpulse {} +class _MockContact extends Mock implements Contact {} -class MockManifold extends Mock implements Manifold {} +class _MockContactImpulse extends Mock implements ContactImpulse {} -class TestHeavyBodyComponent extends BodyComponent { +class _TestBodyComponent extends BodyComponent { @override - Body createBody() { - final shape = CircleShape(); - return world.createBody( - BodyDef( - type: BodyType.dynamic, - ), - )..createFixtureFromShape(shape, 20); - } + Body createBody() => world.createBody( + BodyDef(type: BodyType.dynamic), + )..createFixtureFromShape(CircleShape(), 1); } void main() { @@ -32,7 +26,7 @@ void main() { group('BumpingBehavior', () { flameTester.test('can be added', (game) async { final behavior = BumpingBehavior(strength: 0); - final component = TestBodyComponent(); + final component = _TestBodyComponent(); await component.add(behavior); await game.ensureAdd(component); }); @@ -40,16 +34,18 @@ void main() { flameTester.testGameWidget( 'the bump is greater when the strengh is greater', setUp: (game, tester) async { - final component1 = TestBodyComponent(); - final behavior1 = BumpingBehavior(strength: 1); + final component1 = _TestBodyComponent(); + final behavior1 = BumpingBehavior(strength: 1) + ..worldManifold.normal.setFrom(Vector2.all(1)); await component1.add(behavior1); - final component2 = TestBodyComponent(); - final behavior2 = BumpingBehavior(strength: 2); + final component2 = _TestBodyComponent(); + final behavior2 = BumpingBehavior(strength: 2) + ..worldManifold.normal.setFrom(Vector2.all(1)); await component2.add(behavior2); - final dummy1 = TestHeavyBodyComponent(); - final dummy2 = TestHeavyBodyComponent(); + final dummy1 = _TestBodyComponent(); + final dummy2 = _TestBodyComponent(); await game.ensureAddAll([ component1, @@ -58,14 +54,8 @@ void main() { dummy2, ]); - expect(dummy1.body.inverseMass, greaterThan(0)); - expect(dummy2.body.inverseMass, greaterThan(0)); - - final contact = MockContact(); - final manifold = MockManifold(); - final contactImpulse = MockContactImpulse(); - when(() => manifold.localPoint).thenReturn(Vector2.all(1)); - when(() => contact.manifold).thenReturn(manifold); + final contact = _MockContact(); + final contactImpulse = _MockContactImpulse(); behavior1.postSolve(dummy1, contact, contactImpulse); behavior2.postSolve(dummy2, contact, contactImpulse); diff --git a/packages/pinball_components/test/src/components/golden/multipliers/x2-dimmed.png b/packages/pinball_components/test/src/components/golden/multipliers/x2-dimmed.png new file mode 100644 index 00000000..ca2d8bf1 Binary files /dev/null and b/packages/pinball_components/test/src/components/golden/multipliers/x2-dimmed.png differ diff --git a/packages/pinball_components/test/src/components/golden/multipliers/x2-lit.png b/packages/pinball_components/test/src/components/golden/multipliers/x2-lit.png new file mode 100644 index 00000000..94001e27 Binary files /dev/null and b/packages/pinball_components/test/src/components/golden/multipliers/x2-lit.png differ diff --git a/packages/pinball_components/test/src/components/golden/multipliers/x3-dimmed.png b/packages/pinball_components/test/src/components/golden/multipliers/x3-dimmed.png new file mode 100644 index 00000000..4727ea3e Binary files /dev/null and b/packages/pinball_components/test/src/components/golden/multipliers/x3-dimmed.png differ diff --git a/packages/pinball_components/test/src/components/golden/multipliers/x3-lit.png b/packages/pinball_components/test/src/components/golden/multipliers/x3-lit.png new file mode 100644 index 00000000..f2f84178 Binary files /dev/null and b/packages/pinball_components/test/src/components/golden/multipliers/x3-lit.png differ diff --git a/packages/pinball_components/test/src/components/golden/multipliers/x4-dimmed.png b/packages/pinball_components/test/src/components/golden/multipliers/x4-dimmed.png new file mode 100644 index 00000000..76c84994 Binary files /dev/null and b/packages/pinball_components/test/src/components/golden/multipliers/x4-dimmed.png differ diff --git a/packages/pinball_components/test/src/components/golden/multipliers/x4-lit.png b/packages/pinball_components/test/src/components/golden/multipliers/x4-lit.png new file mode 100644 index 00000000..b4918e62 Binary files /dev/null and b/packages/pinball_components/test/src/components/golden/multipliers/x4-lit.png differ diff --git a/packages/pinball_components/test/src/components/golden/multipliers/x5-dimmed.png b/packages/pinball_components/test/src/components/golden/multipliers/x5-dimmed.png new file mode 100644 index 00000000..2bbbf1ef Binary files /dev/null and b/packages/pinball_components/test/src/components/golden/multipliers/x5-dimmed.png differ diff --git a/packages/pinball_components/test/src/components/golden/multipliers/x5-lit.png b/packages/pinball_components/test/src/components/golden/multipliers/x5-lit.png new file mode 100644 index 00000000..5e750af8 Binary files /dev/null and b/packages/pinball_components/test/src/components/golden/multipliers/x5-lit.png differ diff --git a/packages/pinball_components/test/src/components/golden/multipliers/x6-dimmed.png b/packages/pinball_components/test/src/components/golden/multipliers/x6-dimmed.png new file mode 100644 index 00000000..aff09619 Binary files /dev/null and b/packages/pinball_components/test/src/components/golden/multipliers/x6-dimmed.png differ diff --git a/packages/pinball_components/test/src/components/golden/multipliers/x6-lit.png b/packages/pinball_components/test/src/components/golden/multipliers/x6-lit.png new file mode 100644 index 00000000..7e5edc10 Binary files /dev/null and b/packages/pinball_components/test/src/components/golden/multipliers/x6-lit.png differ diff --git a/packages/pinball_components/test/src/components/google_letter/google_letter_test.dart b/packages/pinball_components/test/src/components/google_letter/google_letter_test.dart index 624168b9..7ad0e64b 100644 --- a/packages/pinball_components/test/src/components/google_letter/google_letter_test.dart +++ b/packages/pinball_components/test/src/components/google_letter/google_letter_test.dart @@ -1,6 +1,7 @@ // ignore_for_file: cascade_invocations import 'package:bloc_test/bloc_test.dart'; +import 'package:flame/components.dart'; import 'package:flame_test/flame_test.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mocktail/mocktail.dart'; @@ -80,6 +81,16 @@ void main() { }, ); + flameTester.test('adds new children', (game) async { + final component = Component(); + final googleLetter = GoogleLetter( + 1, + children: [component], + ); + await game.ensureAdd(googleLetter); + expect(googleLetter.children, contains(component)); + }); + test('throws error when index out of range', () { expect(() => GoogleLetter(-1), throwsA(isA())); expect(() => GoogleLetter(6), throwsA(isA())); diff --git a/packages/pinball_components/test/src/components/kicker_test.dart b/packages/pinball_components/test/src/components/kicker_test.dart index 8c48a1fb..aebf9380 100644 --- a/packages/pinball_components/test/src/components/kicker_test.dart +++ b/packages/pinball_components/test/src/components/kicker_test.dart @@ -1,5 +1,6 @@ // ignore_for_file: cascade_invocations +import 'package:flame/components.dart'; import 'package:flame_forge2d/flame_forge2d.dart'; import 'package:flame_test/flame_test.dart'; import 'package:flutter_test/flutter_test.dart'; @@ -44,6 +45,16 @@ void main() { }, ); + flameTester.test('adds new children', (game) async { + final component = Component(); + final kicker = Kicker( + side: BoardSide.left, + children: [component], + ); + await game.ensureAdd(kicker); + expect(kicker.children, contains(component)); + }); + flameTester.test( 'body is static', (game) async { diff --git a/packages/pinball_components/test/src/components/multiplier/cubit/multiplier_cubit_test.dart b/packages/pinball_components/test/src/components/multiplier/cubit/multiplier_cubit_test.dart new file mode 100644 index 00000000..35ed652e --- /dev/null +++ b/packages/pinball_components/test/src/components/multiplier/cubit/multiplier_cubit_test.dart @@ -0,0 +1,118 @@ +// ignore_for_file: prefer_const_constructors + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:pinball_components/pinball_components.dart'; + +void main() { + group( + 'MultiplierCubit', + () { + blocTest( + "emits [lit] when 'next' on x2 dimmed with x2 multiplier value", + build: () => MultiplierCubit(MultiplierValue.x2), + act: (bloc) => bloc.next(2), + expect: () => [ + isA() + ..having( + (state) => state.spriteState, + 'spriteState', + MultiplierSpriteState.lit, + ), + ], + ); + + blocTest( + "emits [lit] when 'next' on x3 dimmed with x3 multiplier value", + build: () => MultiplierCubit(MultiplierValue.x3), + act: (bloc) => bloc.next(3), + expect: () => [ + isA() + ..having( + (state) => state.spriteState, + 'spriteState', + MultiplierSpriteState.lit, + ), + ], + ); + + blocTest( + "emits [lit] when 'next' on x4 dimmed with x4 multiplier value", + build: () => MultiplierCubit(MultiplierValue.x4), + act: (bloc) => bloc.next(4), + expect: () => [ + isA() + ..having( + (state) => state.spriteState, + 'spriteState', + MultiplierSpriteState.lit, + ), + ], + ); + + blocTest( + "emits [lit] when 'next' on x5 dimmed with x5 multiplier value", + build: () => MultiplierCubit(MultiplierValue.x5), + act: (bloc) => bloc.next(5), + expect: () => [ + isA() + ..having( + (state) => state.spriteState, + 'spriteState', + MultiplierSpriteState.lit, + ), + ], + ); + + blocTest( + "emits [lit] when 'next' on x6 dimmed with x6 multiplier value", + build: () => MultiplierCubit(MultiplierValue.x6), + act: (bloc) => bloc.next(6), + expect: () => [ + isA() + ..having( + (state) => state.spriteState, + 'spriteState', + MultiplierSpriteState.lit, + ), + ], + ); + + blocTest( + "emits [dimmed] when 'next' on lit with different multiplier value", + build: () => MultiplierCubit(MultiplierValue.x2), + seed: () => MultiplierState( + value: MultiplierValue.x2, + spriteState: MultiplierSpriteState.lit, + ), + act: (bloc) => bloc.next(3), + expect: () => [ + isA() + ..having( + (state) => state.spriteState, + 'spriteState', + MultiplierSpriteState.dimmed, + ), + ], + ); + + blocTest( + "emits nothing when 'next' on lit with same multiplier value", + build: () => MultiplierCubit(MultiplierValue.x2), + seed: () => MultiplierState( + value: MultiplierValue.x2, + spriteState: MultiplierSpriteState.lit, + ), + act: (bloc) => bloc.next(2), + expect: () => [], + ); + + blocTest( + "emits nothing when 'next' on dimmed with different multiplier value", + build: () => MultiplierCubit(MultiplierValue.x2), + act: (bloc) => bloc.next(3), + expect: () => [], + ); + }, + ); +} diff --git a/packages/pinball_components/test/src/components/multiplier/cubit/multiplier_state_test.dart b/packages/pinball_components/test/src/components/multiplier/cubit/multiplier_state_test.dart new file mode 100644 index 00000000..9789d7c5 --- /dev/null +++ b/packages/pinball_components/test/src/components/multiplier/cubit/multiplier_state_test.dart @@ -0,0 +1,75 @@ +// ignore_for_file: prefer_const_constructors + +import 'package:flutter_test/flutter_test.dart'; +import 'package:pinball_components/src/pinball_components.dart'; + +void main() { + group('MultiplierState', () { + test('supports value equality', () { + expect( + MultiplierState( + value: MultiplierValue.x2, + spriteState: MultiplierSpriteState.lit, + ), + equals( + MultiplierState( + value: MultiplierValue.x2, + spriteState: MultiplierSpriteState.lit, + ), + ), + ); + }); + + group('constructor', () { + test('can be instantiated', () { + expect( + MultiplierState( + value: MultiplierValue.x2, + spriteState: MultiplierSpriteState.lit, + ), + isNotNull, + ); + }); + }); + + group('copyWith', () { + test( + 'copies correctly ' + 'when no argument specified', + () { + const multiplierState = MultiplierState( + value: MultiplierValue.x2, + spriteState: MultiplierSpriteState.lit, + ); + expect( + multiplierState.copyWith(), + equals(multiplierState), + ); + }, + ); + + test( + 'copies correctly ' + 'when all arguments specified', + () { + const multiplierState = MultiplierState( + value: MultiplierValue.x2, + spriteState: MultiplierSpriteState.lit, + ); + final otherMultiplierState = MultiplierState( + value: MultiplierValue.x2, + spriteState: MultiplierSpriteState.dimmed, + ); + expect(multiplierState, isNot(equals(otherMultiplierState))); + + expect( + multiplierState.copyWith( + spriteState: MultiplierSpriteState.dimmed, + ), + equals(otherMultiplierState), + ); + }, + ); + }); + }); +} diff --git a/packages/pinball_components/test/src/components/multiplier/multiplier_test.dart b/packages/pinball_components/test/src/components/multiplier/multiplier_test.dart new file mode 100644 index 00000000..edc2735f --- /dev/null +++ b/packages/pinball_components/test/src/components/multiplier/multiplier_test.dart @@ -0,0 +1,517 @@ +// ignore_for_file: cascade_invocations, prefer_const_constructors + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame/components.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; +import 'package:pinball_components/pinball_components.dart'; + +import '../../../helpers/helpers.dart'; + +void main() { + final bloc = MockMultiplierCubit(); + + group('Multiplier', () { + TestWidgetsFlutterBinding.ensureInitialized(); + final assets = [ + Assets.images.multiplier.x2.lit.keyName, + Assets.images.multiplier.x2.dimmed.keyName, + Assets.images.multiplier.x3.lit.keyName, + Assets.images.multiplier.x3.dimmed.keyName, + Assets.images.multiplier.x4.lit.keyName, + Assets.images.multiplier.x4.dimmed.keyName, + Assets.images.multiplier.x5.lit.keyName, + Assets.images.multiplier.x5.dimmed.keyName, + Assets.images.multiplier.x6.lit.keyName, + Assets.images.multiplier.x6.dimmed.keyName, + ]; + final flameTester = FlameTester(() => TestGame(assets)); + + flameTester.test('"x2" loads correctly', (game) async { + final multiplier = Multiplier.x2( + position: Vector2.zero(), + angle: 0, + ); + await game.ensureAdd(multiplier); + expect(game.contains(multiplier), isTrue); + }); + + flameTester.test('"x3" loads correctly', (game) async { + final multiplier = Multiplier.x3( + position: Vector2.zero(), + angle: 0, + ); + await game.ensureAdd(multiplier); + expect(game.contains(multiplier), isTrue); + }); + + flameTester.test('"x4" loads correctly', (game) async { + final multiplier = Multiplier.x4( + position: Vector2.zero(), + angle: 0, + ); + await game.ensureAdd(multiplier); + expect(game.contains(multiplier), isTrue); + }); + + flameTester.test('"x5" loads correctly', (game) async { + final multiplier = Multiplier.x5( + position: Vector2.zero(), + angle: 0, + ); + await game.ensureAdd(multiplier); + expect(game.contains(multiplier), isTrue); + }); + + flameTester.test('"x6" loads correctly', (game) async { + final multiplier = Multiplier.x6( + position: Vector2.zero(), + angle: 0, + ); + await game.ensureAdd(multiplier); + expect(game.contains(multiplier), isTrue); + }); + + group('renders correctly', () { + group('x2', () { + const multiplierValue = MultiplierValue.x2; + + flameTester.testGameWidget( + 'lit when bloc state is lit', + setUp: (game, tester) async { + await game.images.loadAll(assets); + + whenListen( + bloc, + const Stream.empty(), + initialState: MultiplierState( + value: multiplierValue, + spriteState: MultiplierSpriteState.lit, + ), + ); + + final multiplier = Multiplier.test( + value: multiplierValue, + bloc: bloc, + ); + await game.ensureAdd(multiplier); + await tester.pump(); + + game.camera.followVector2(Vector2.zero()); + }, + verify: (game, tester) async { + expect( + game + .descendants() + .whereType() + .first + .current, + MultiplierSpriteState.lit, + ); + + await expectLater( + find.byGame(), + matchesGoldenFile('../golden/multipliers/x2-lit.png'), + ); + }, + ); + + flameTester.testGameWidget( + 'dimmed when bloc state is dimmed', + setUp: (game, tester) async { + await game.images.loadAll(assets); + + whenListen( + bloc, + const Stream.empty(), + initialState: MultiplierState( + value: multiplierValue, + spriteState: MultiplierSpriteState.dimmed, + ), + ); + + final multiplier = Multiplier.test( + value: multiplierValue, + bloc: bloc, + ); + await game.ensureAdd(multiplier); + await tester.pump(); + + game.camera.followVector2(Vector2.zero()); + }, + verify: (game, tester) async { + expect( + game + .descendants() + .whereType() + .first + .current, + MultiplierSpriteState.dimmed, + ); + + await expectLater( + find.byGame(), + matchesGoldenFile('../golden/multipliers/x2-dimmed.png'), + ); + }, + ); + }); + + group('x3', () { + const multiplierValue = MultiplierValue.x3; + + flameTester.testGameWidget( + 'lit when bloc state is lit', + setUp: (game, tester) async { + await game.images.loadAll(assets); + + whenListen( + bloc, + const Stream.empty(), + initialState: MultiplierState( + value: multiplierValue, + spriteState: MultiplierSpriteState.lit, + ), + ); + + final multiplier = Multiplier.test( + value: multiplierValue, + bloc: bloc, + ); + await game.ensureAdd(multiplier); + await tester.pump(); + + game.camera.followVector2(Vector2.zero()); + }, + verify: (game, tester) async { + expect( + game + .descendants() + .whereType() + .first + .current, + MultiplierSpriteState.lit, + ); + + await expectLater( + find.byGame(), + matchesGoldenFile('../golden/multipliers/x3-lit.png'), + ); + }, + ); + + flameTester.testGameWidget( + 'dimmed when bloc state is dimmed', + setUp: (game, tester) async { + await game.images.loadAll(assets); + + whenListen( + bloc, + const Stream.empty(), + initialState: MultiplierState( + value: multiplierValue, + spriteState: MultiplierSpriteState.dimmed, + ), + ); + + final multiplier = Multiplier.test( + value: multiplierValue, + bloc: bloc, + ); + await game.ensureAdd(multiplier); + await tester.pump(); + + game.camera.followVector2(Vector2.zero()); + }, + verify: (game, tester) async { + expect( + game + .descendants() + .whereType() + .first + .current, + MultiplierSpriteState.dimmed, + ); + + await expectLater( + find.byGame(), + matchesGoldenFile('../golden/multipliers/x3-dimmed.png'), + ); + }, + ); + }); + + group('x4', () { + const multiplierValue = MultiplierValue.x4; + + flameTester.testGameWidget( + 'lit when bloc state is lit', + setUp: (game, tester) async { + await game.images.loadAll(assets); + + whenListen( + bloc, + const Stream.empty(), + initialState: MultiplierState( + value: multiplierValue, + spriteState: MultiplierSpriteState.lit, + ), + ); + + final multiplier = Multiplier.test( + value: multiplierValue, + bloc: bloc, + ); + await game.ensureAdd(multiplier); + await tester.pump(); + + game.camera.followVector2(Vector2.zero()); + }, + verify: (game, tester) async { + expect( + game + .descendants() + .whereType() + .first + .current, + MultiplierSpriteState.lit, + ); + + await expectLater( + find.byGame(), + matchesGoldenFile('../golden/multipliers/x4-lit.png'), + ); + }, + ); + + flameTester.testGameWidget( + 'dimmed when bloc state is dimmed', + setUp: (game, tester) async { + await game.images.loadAll(assets); + + whenListen( + bloc, + const Stream.empty(), + initialState: MultiplierState( + value: multiplierValue, + spriteState: MultiplierSpriteState.dimmed, + ), + ); + + final multiplier = Multiplier.test( + value: multiplierValue, + bloc: bloc, + ); + await game.ensureAdd(multiplier); + await tester.pump(); + + game.camera.followVector2(Vector2.zero()); + }, + verify: (game, tester) async { + expect( + game + .descendants() + .whereType() + .first + .current, + MultiplierSpriteState.dimmed, + ); + + await expectLater( + find.byGame(), + matchesGoldenFile('../golden/multipliers/x4-dimmed.png'), + ); + }, + ); + }); + + group('x5', () { + const multiplierValue = MultiplierValue.x5; + + flameTester.testGameWidget( + 'lit when bloc state is lit', + setUp: (game, tester) async { + await game.images.loadAll(assets); + + whenListen( + bloc, + const Stream.empty(), + initialState: MultiplierState( + value: multiplierValue, + spriteState: MultiplierSpriteState.lit, + ), + ); + + final multiplier = Multiplier.test( + value: multiplierValue, + bloc: bloc, + ); + await game.ensureAdd(multiplier); + await tester.pump(); + + game.camera.followVector2(Vector2.zero()); + }, + verify: (game, tester) async { + expect( + game + .descendants() + .whereType() + .first + .current, + MultiplierSpriteState.lit, + ); + + await expectLater( + find.byGame(), + matchesGoldenFile('../golden/multipliers/x5-lit.png'), + ); + }, + ); + + flameTester.testGameWidget( + 'dimmed when bloc state is dimmed', + setUp: (game, tester) async { + await game.images.loadAll(assets); + + whenListen( + bloc, + const Stream.empty(), + initialState: MultiplierState( + value: multiplierValue, + spriteState: MultiplierSpriteState.dimmed, + ), + ); + + final multiplier = Multiplier.test( + value: multiplierValue, + bloc: bloc, + ); + await game.ensureAdd(multiplier); + await tester.pump(); + + game.camera.followVector2(Vector2.zero()); + }, + verify: (game, tester) async { + expect( + game + .descendants() + .whereType() + .first + .current, + MultiplierSpriteState.dimmed, + ); + + await expectLater( + find.byGame(), + matchesGoldenFile('../golden/multipliers/x5-dimmed.png'), + ); + }, + ); + }); + + group('x6', () { + const multiplierValue = MultiplierValue.x6; + + flameTester.testGameWidget( + 'lit when bloc state is lit', + setUp: (game, tester) async { + await game.images.loadAll(assets); + + whenListen( + bloc, + const Stream.empty(), + initialState: MultiplierState( + value: multiplierValue, + spriteState: MultiplierSpriteState.lit, + ), + ); + + final multiplier = Multiplier.test( + value: multiplierValue, + bloc: bloc, + ); + await game.ensureAdd(multiplier); + await tester.pump(); + + game.camera.followVector2(Vector2.zero()); + }, + verify: (game, tester) async { + expect( + game + .descendants() + .whereType() + .first + .current, + MultiplierSpriteState.lit, + ); + + await expectLater( + find.byGame(), + matchesGoldenFile('../golden/multipliers/x6-lit.png'), + ); + }, + ); + + flameTester.testGameWidget( + 'dimmed when bloc state is dimmed', + setUp: (game, tester) async { + await game.images.loadAll(assets); + + whenListen( + bloc, + const Stream.empty(), + initialState: MultiplierState( + value: multiplierValue, + spriteState: MultiplierSpriteState.dimmed, + ), + ); + + final multiplier = Multiplier.test( + value: multiplierValue, + bloc: bloc, + ); + await game.ensureAdd(multiplier); + await tester.pump(); + + game.camera.followVector2(Vector2.zero()); + }, + verify: (game, tester) async { + expect( + game + .descendants() + .whereType() + .first + .current, + MultiplierSpriteState.dimmed, + ); + + await expectLater( + find.byGame(), + matchesGoldenFile('../golden/multipliers/x6-dimmed.png'), + ); + }, + ); + }); + }); + + flameTester.test('closes bloc when removed', (game) async { + whenListen( + bloc, + const Stream.empty(), + initialState: MultiplierState( + value: MultiplierValue.x2, + spriteState: MultiplierSpriteState.dimmed, + ), + ); + when(bloc.close).thenAnswer((_) async {}); + final multiplier = Multiplier.test(value: MultiplierValue.x2, bloc: bloc); + + await game.ensureAdd(multiplier); + game.remove(multiplier); + await game.ready(); + + verify(bloc.close).called(1); + }); + }); +} diff --git a/packages/platform_helper/.gitignore b/packages/platform_helper/.gitignore new file mode 100644 index 00000000..d6130351 --- /dev/null +++ b/packages/platform_helper/.gitignore @@ -0,0 +1,39 @@ +# Miscellaneous +*.class +*.log +*.pyc +*.swp +.DS_Store +.atom/ +.buildlog/ +.history +.svn/ + +# IntelliJ related +*.iml +*.ipr +*.iws +.idea/ + +# VSCode related +.vscode/ + +# Flutter/Dart/Pub related +**/doc/api/ +**/ios/Flutter/.last_build_id +.dart_tool/ +.flutter-plugins +.flutter-plugins-dependencies +.packages +.pub-cache/ +.pub/ +/build/ + +# Web related +lib/generated_plugin_registrant.dart + +# Symbolication related +app.*.symbols + +# Obfuscation related +app.*.map.json diff --git a/packages/platform_helper/README.md b/packages/platform_helper/README.md new file mode 100644 index 00000000..7a96e658 --- /dev/null +++ b/packages/platform_helper/README.md @@ -0,0 +1,11 @@ +# platform_helper + +[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link] +[![License: MIT][license_badge]][license_link] + +Platform helper for Pinball application. + +[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg +[license_link]: https://opensource.org/licenses/MIT +[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg +[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis \ No newline at end of file diff --git a/packages/platform_helper/analysis_options.yaml b/packages/platform_helper/analysis_options.yaml new file mode 100644 index 00000000..3742fc3d --- /dev/null +++ b/packages/platform_helper/analysis_options.yaml @@ -0,0 +1 @@ +include: package:very_good_analysis/analysis_options.2.4.0.yaml \ No newline at end of file diff --git a/packages/platform_helper/lib/platform_helper.dart b/packages/platform_helper/lib/platform_helper.dart new file mode 100644 index 00000000..4b6d7f48 --- /dev/null +++ b/packages/platform_helper/lib/platform_helper.dart @@ -0,0 +1,3 @@ +library platform_helper; + +export 'src/platform_helper.dart'; diff --git a/packages/platform_helper/lib/src/platform_helper.dart b/packages/platform_helper/lib/src/platform_helper.dart new file mode 100644 index 00000000..638d1ab6 --- /dev/null +++ b/packages/platform_helper/lib/src/platform_helper.dart @@ -0,0 +1,12 @@ +import 'package:flutter/foundation.dart'; + +/// {@template platform_helper} +/// Returns whether the current platform is running on a mobile device. +/// {@endtemplate} +class PlatformHelper { + /// {@macro platform_helper} + bool get isMobile { + return defaultTargetPlatform == TargetPlatform.iOS || + defaultTargetPlatform == TargetPlatform.android; + } +} diff --git a/packages/platform_helper/pubspec.yaml b/packages/platform_helper/pubspec.yaml new file mode 100644 index 00000000..edff346a --- /dev/null +++ b/packages/platform_helper/pubspec.yaml @@ -0,0 +1,16 @@ +name: platform_helper +description: Platform helper for Pinball application. +version: 1.0.0+1 +publish_to: none + +environment: + sdk: ">=2.16.0 <3.0.0" + +dependencies: + flutter: + sdk: flutter + +dev_dependencies: + flutter_test: + sdk: flutter + very_good_analysis: ^2.4.0 \ No newline at end of file diff --git a/packages/platform_helper/test/src/platform_helper_test.dart b/packages/platform_helper/test/src/platform_helper_test.dart new file mode 100644 index 00000000..69bec3a8 --- /dev/null +++ b/packages/platform_helper/test/src/platform_helper_test.dart @@ -0,0 +1,39 @@ +// ignore_for_file: prefer_const_constructors +import 'package:flutter/foundation.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:platform_helper/platform_helper.dart'; + +void main() { + group('PlatformHelper', () { + test('can be instantiated', () { + expect(PlatformHelper(), isNotNull); + }); + + group('isMobile', () { + tearDown(() async { + debugDefaultTargetPlatformOverride = null; + }); + + test('returns true when defaultTargetPlatform is iOS', () async { + debugDefaultTargetPlatformOverride = TargetPlatform.iOS; + expect(PlatformHelper().isMobile, isTrue); + debugDefaultTargetPlatformOverride = null; + }); + + test('returns true when defaultTargetPlatform is android', () async { + debugDefaultTargetPlatformOverride = TargetPlatform.android; + expect(PlatformHelper().isMobile, isTrue); + debugDefaultTargetPlatformOverride = null; + }); + + test( + 'returns false when defaultTargetPlatform is niether iOS nor android', + () async { + debugDefaultTargetPlatformOverride = TargetPlatform.macOS; + expect(PlatformHelper().isMobile, isFalse); + debugDefaultTargetPlatformOverride = null; + }, + ); + }); + }); +} diff --git a/pubspec.lock b/pubspec.lock index 4b71c77b..ab39378a 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -513,6 +513,13 @@ packages: url: "https://pub.dartlang.org" source: hosted version: "3.1.0" + platform_helper: + dependency: "direct main" + description: + path: "packages/platform_helper" + relative: true + source: path + version: "1.0.0+1" plugin_platform_interface: dependency: transitive description: diff --git a/pubspec.yaml b/pubspec.yaml index f129ea19..51c85cd5 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -37,6 +37,8 @@ dependencies: path: packages/pinball_theme pinball_ui: path: packages/pinball_ui + platform_helper: + path: packages/platform_helper dev_dependencies: bloc_test: ^9.0.2 diff --git a/test/game/components/android_acres_test.dart b/test/game/components/android_acres_test.dart index a7862d03..aef6a812 100644 --- a/test/game/components/android_acres_test.dart +++ b/test/game/components/android_acres_test.dart @@ -30,6 +30,8 @@ void main() { Assets.images.android.bumper.a.dimmed.keyName, Assets.images.android.bumper.b.lit.keyName, Assets.images.android.bumper.b.dimmed.keyName, + Assets.images.android.bumper.cow.lit.keyName, + Assets.images.android.bumper.cow.dimmed.keyName, ]; final flameTester = FlameTester( () => EmptyPinballTestGame(assets: assets), @@ -76,7 +78,7 @@ void main() { ); flameTester.test( - 'two AndroidBumper', + 'three AndroidBumper', (game) async { final androidZone = AndroidAcres(); await game.addFromBlueprint(androidZone); @@ -84,7 +86,7 @@ void main() { expect( game.descendants().whereType().length, - equals(2), + equals(3), ); }, ); diff --git a/test/game/components/multipliers/behaviors/multipliers_behavior_test.dart b/test/game/components/multipliers/behaviors/multipliers_behavior_test.dart new file mode 100644 index 00000000..a4f3502c --- /dev/null +++ b/test/game/components/multipliers/behaviors/multipliers_behavior_test.dart @@ -0,0 +1,133 @@ +// ignore_for_file: cascade_invocations, prefer_const_constructors + +import 'dart:async'; + +import 'package:bloc_test/bloc_test.dart'; +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:mockingjay/mockingjay.dart'; +import 'package:pinball/game/components/multipliers/behaviors/behaviors.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; + +import '../../../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final assets = [ + Assets.images.multiplier.x2.lit.keyName, + Assets.images.multiplier.x2.dimmed.keyName, + Assets.images.multiplier.x3.lit.keyName, + Assets.images.multiplier.x3.dimmed.keyName, + Assets.images.multiplier.x4.lit.keyName, + Assets.images.multiplier.x4.dimmed.keyName, + Assets.images.multiplier.x5.lit.keyName, + Assets.images.multiplier.x5.dimmed.keyName, + Assets.images.multiplier.x6.lit.keyName, + Assets.images.multiplier.x6.dimmed.keyName, + ]; + + group('MultipliersBehavior', () { + late GameBloc gameBloc; + + setUp(() { + registerFallbackValue(MockComponent()); + gameBloc = MockGameBloc(); + whenListen( + gameBloc, + const Stream.empty(), + initialState: const GameState.initial(), + ); + }); + + final flameBlocTester = FlameBlocTester( + gameBuilder: EmptyPinballTestGame.new, + blocBuilder: () => gameBloc, + assets: assets, + ); + + group('listenWhen', () { + test('is true when the multiplier has changed', () { + final state = GameState( + score: 10, + multiplier: 2, + rounds: 0, + bonusHistory: const [], + ); + + final previous = GameState.initial(); + expect( + MultipliersBehavior().listenWhen(previous, state), + isTrue, + ); + }); + + test('is false when the multiplier state is the same', () { + final state = GameState( + score: 10, + multiplier: 1, + rounds: 0, + bonusHistory: const [], + ); + + final previous = GameState.initial(); + expect( + MultipliersBehavior().listenWhen(previous, state), + isFalse, + ); + }); + }); + + group('onNewState', () { + flameBlocTester.testGameWidget( + "calls 'next' once per each multiplier when GameBloc emit state", + setUp: (game, tester) async { + final behavior = MultipliersBehavior(); + final parent = Multipliers.test(); + final multiplierX2Cubit = MockMultiplierCubit(); + final multiplierX3Cubit = MockMultiplierCubit(); + final multipliers = [ + Multiplier.test( + value: MultiplierValue.x2, + bloc: multiplierX2Cubit, + ), + Multiplier.test( + value: MultiplierValue.x3, + bloc: multiplierX3Cubit, + ), + ]; + + whenListen( + multiplierX2Cubit, + const Stream.empty(), + initialState: MultiplierState.initial(MultiplierValue.x2), + ); + when(() => multiplierX2Cubit.next(any())).thenAnswer((_) async {}); + + whenListen( + multiplierX3Cubit, + const Stream.empty(), + initialState: MultiplierState.initial(MultiplierValue.x2), + ); + when(() => multiplierX3Cubit.next(any())).thenAnswer((_) async {}); + + await parent.addAll(multipliers); + await game.ensureAdd(parent); + await parent.ensureAdd(behavior); + + await tester.pump(); + + behavior.onNewState( + GameState.initial().copyWith(multiplier: 2), + ); + + for (final multiplier in multipliers) { + verify( + () => multiplier.bloc.next(any()), + ).called(1); + } + }, + ); + }); + }); +} diff --git a/test/game/components/multipliers/multipliers_test.dart b/test/game/components/multipliers/multipliers_test.dart new file mode 100644 index 00000000..6b2d95a6 --- /dev/null +++ b/test/game/components/multipliers/multipliers_test.dart @@ -0,0 +1,63 @@ +// ignore_for_file: cascade_invocations + +import 'package:flame_test/flame_test.dart'; +import 'package:flutter_test/flutter_test.dart'; +import 'package:pinball/game/game.dart'; +import 'package:pinball_components/pinball_components.dart'; + +import '../../../helpers/helpers.dart'; + +void main() { + TestWidgetsFlutterBinding.ensureInitialized(); + final assets = [ + Assets.images.multiplier.x2.lit.keyName, + Assets.images.multiplier.x2.dimmed.keyName, + Assets.images.multiplier.x3.lit.keyName, + Assets.images.multiplier.x3.dimmed.keyName, + Assets.images.multiplier.x4.lit.keyName, + Assets.images.multiplier.x4.dimmed.keyName, + Assets.images.multiplier.x5.lit.keyName, + Assets.images.multiplier.x5.dimmed.keyName, + Assets.images.multiplier.x6.lit.keyName, + Assets.images.multiplier.x6.dimmed.keyName, + ]; + + late GameBloc gameBloc; + + setUp(() { + gameBloc = GameBloc(); + }); + + final flameBlocTester = FlameBlocTester( + gameBuilder: EmptyPinballTestGame.new, + blocBuilder: () => gameBloc, + assets: assets, + ); + + group('Multipliers', () { + flameBlocTester.testGameWidget( + 'loads correctly', + setUp: (game, tester) async { + final multipliersGroup = Multipliers(); + await game.ensureAdd(multipliersGroup); + + expect(game.contains(multipliersGroup), isTrue); + }, + ); + + group('loads', () { + flameBlocTester.testGameWidget( + 'five Multiplier', + setUp: (game, tester) async { + final multipliersGroup = Multipliers(); + await game.ensureAdd(multipliersGroup); + + expect( + multipliersGroup.descendants().whereType().length, + equals(5), + ); + }, + ); + }); + }); +} diff --git a/test/game/pinball_game_test.dart b/test/game/pinball_game_test.dart index 585a081d..3a531cac 100644 --- a/test/game/pinball_game_test.dart +++ b/test/game/pinball_game_test.dart @@ -1,5 +1,6 @@ // ignore_for_file: cascade_invocations +import 'package:bloc_test/bloc_test.dart'; import 'package:flame/components.dart'; import 'package:flame/game.dart'; import 'package:flame_test/flame_test.dart'; @@ -18,6 +19,8 @@ void main() { Assets.images.android.bumper.a.dimmed.keyName, Assets.images.android.bumper.b.lit.keyName, Assets.images.android.bumper.b.dimmed.keyName, + Assets.images.android.bumper.cow.lit.keyName, + Assets.images.android.bumper.cow.dimmed.keyName, Assets.images.backboard.backboardScores.keyName, Assets.images.backboard.backboardGameOver.keyName, Assets.images.backboard.display.keyName, @@ -52,6 +55,16 @@ void main() { Assets.images.launchRamp.ramp.keyName, Assets.images.launchRamp.foregroundRailing.keyName, Assets.images.launchRamp.backgroundRailing.keyName, + Assets.images.multiplier.x2.lit.keyName, + Assets.images.multiplier.x2.dimmed.keyName, + Assets.images.multiplier.x3.lit.keyName, + Assets.images.multiplier.x3.dimmed.keyName, + Assets.images.multiplier.x4.lit.keyName, + Assets.images.multiplier.x4.dimmed.keyName, + Assets.images.multiplier.x5.lit.keyName, + Assets.images.multiplier.x5.dimmed.keyName, + Assets.images.multiplier.x6.lit.keyName, + Assets.images.multiplier.x6.dimmed.keyName, Assets.images.plunger.plunger.keyName, Assets.images.plunger.rocket.keyName, Assets.images.signpost.inactive.keyName, @@ -93,6 +106,17 @@ void main() { Assets.images.sparky.bumper.c.inactive.keyName, ]; + late GameBloc gameBloc; + + setUp(() { + gameBloc = MockGameBloc(); + whenListen( + gameBloc, + const Stream.empty(), + initialState: const GameState.initial(), + ); + }); + final flameTester = FlameTester( () => PinballTestGame(assets: assets), ); @@ -100,11 +124,16 @@ void main() { () => DebugPinballTestGame(assets: assets), ); + final flameBlocTester = FlameBlocTester( + gameBuilder: () => PinballTestGame(assets: assets), + blocBuilder: () => gameBloc, + ); + group('PinballGame', () { group('components', () { // TODO(alestiago): tests that Blueprints get added once the Blueprint // class is removed. - flameTester.test( + flameBlocTester.test( 'has only one Drain', (game) async { await game.ready(); @@ -115,11 +144,10 @@ void main() { }, ); - flameTester.test( + flameBlocTester.test( 'has only one BottomGroup', (game) async { await game.ready(); - expect( game.children.whereType().length, equals(1), @@ -127,7 +155,7 @@ void main() { }, ); - flameTester.test( + flameBlocTester.test( 'has only one Plunger', (game) async { await game.ready(); @@ -138,7 +166,7 @@ void main() { }, ); - flameTester.test('has one FlutterForest', (game) async { + flameBlocTester.test('has one FlutterForest', (game) async { await game.ready(); expect( game.children.whereType().length, @@ -146,7 +174,7 @@ void main() { ); }); - flameTester.test( + flameBlocTester.test( 'one GoogleWord', (game) async { await game.ready(); diff --git a/test/game/view/widgets/round_count_display_test.dart b/test/game/view/widgets/round_count_display_test.dart index dfa28869..8f5f7f13 100644 --- a/test/game/view/widgets/round_count_display_test.dart +++ b/test/game/view/widgets/round_count_display_test.dart @@ -108,7 +108,7 @@ void main() { expect( find.byWidgetPredicate( - (widget) => widget is Container && widget.color == AppColors.orange, + (widget) => widget is Container && widget.color == AppColors.yellow, ), findsOneWidget, ); @@ -125,7 +125,7 @@ void main() { find.byWidgetPredicate( (widget) => widget is Container && - widget.color == AppColors.orange.withAlpha(128), + widget.color == AppColors.yellow.withAlpha(128), ), findsOneWidget, ); diff --git a/test/helpers/mocks.dart b/test/helpers/mocks.dart index 6aab19a2..1578c3e0 100644 --- a/test/helpers/mocks.dart +++ b/test/helpers/mocks.dart @@ -7,7 +7,6 @@ import 'package:flutter/services.dart'; import 'package:leaderboard_repository/leaderboard_repository.dart'; import 'package:mocktail/mocktail.dart'; import 'package:pinball/game/game.dart'; -import 'package:pinball/leaderboard/leaderboard.dart'; import 'package:pinball/select_character/select_character.dart'; import 'package:pinball/start_game/start_game.dart'; import 'package:pinball_audio/pinball_audio.dart'; @@ -35,8 +34,6 @@ class MockGameState extends Mock implements GameState {} class MockCharacterThemeCubit extends Mock implements CharacterThemeCubit {} -class MockLeaderboardBloc extends Mock implements LeaderboardBloc {} - class MockLeaderboardRepository extends Mock implements LeaderboardRepository {} class MockRawKeyDownEvent extends Mock implements RawKeyDownEvent { @@ -67,6 +64,8 @@ class MockFilter extends Mock implements Filter {} class MockFixture extends Mock implements Fixture {} +class MockComponent extends Mock implements Component {} + class MockComponentSet extends Mock implements ComponentSet {} class MockDashNestBumper extends Mock implements DashNestBumper {} @@ -89,3 +88,9 @@ class MockGameFlowController extends Mock implements GameFlowController {} class MockAndroidBumper extends Mock implements AndroidBumper {} class MockSparkyBumper extends Mock implements SparkyBumper {} + +class MockMultiplier extends Mock implements Multiplier {} + +class MockMultipliersGroup extends Mock implements Multipliers {} + +class MockMultiplierCubit extends Mock implements MultiplierCubit {} diff --git a/test/leaderboard/bloc/leaderboard_bloc_test.dart b/test/leaderboard/bloc/leaderboard_bloc_test.dart deleted file mode 100644 index 2b217704..00000000 --- a/test/leaderboard/bloc/leaderboard_bloc_test.dart +++ /dev/null @@ -1,203 +0,0 @@ -// ignore_for_file: prefer_const_constructors - -import 'package:bloc_test/bloc_test.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:leaderboard_repository/leaderboard_repository.dart'; -import 'package:mocktail/mocktail.dart'; -import 'package:pinball/leaderboard/leaderboard.dart'; -import 'package:pinball_theme/pinball_theme.dart'; - -import '../../helpers/helpers.dart'; - -void main() { - group('LeaderboardBloc', () { - late LeaderboardRepository leaderboardRepository; - - setUp(() { - leaderboardRepository = MockLeaderboardRepository(); - }); - - test('initial state has state loading no ranking and empty leaderboard', - () { - final bloc = LeaderboardBloc(leaderboardRepository); - expect(bloc.state.status, equals(LeaderboardStatus.loading)); - expect(bloc.state.ranking.ranking, equals(0)); - expect(bloc.state.ranking.outOf, equals(0)); - expect(bloc.state.leaderboard.isEmpty, isTrue); - }); - - group('Top10Fetched', () { - const top10Scores = [ - 2500, - 2200, - 2200, - 2000, - 1800, - 1400, - 1300, - 1000, - 600, - 300, - 100, - ]; - - final top10Leaderboard = top10Scores - .map( - (score) => LeaderboardEntryData( - playerInitials: 'user$score', - score: score, - character: CharacterType.dash, - ), - ) - .toList(); - - blocTest( - 'emits [loading, success] statuses ' - 'when fetchTop10Leaderboard succeeds', - setUp: () { - when(() => leaderboardRepository.fetchTop10Leaderboard()).thenAnswer( - (_) async => top10Leaderboard, - ); - }, - build: () => LeaderboardBloc(leaderboardRepository), - act: (bloc) => bloc.add(Top10Fetched()), - expect: () => [ - LeaderboardState.initial(), - isA() - ..having( - (element) => element.status, - 'status', - equals(LeaderboardStatus.success), - ) - ..having( - (element) => element.leaderboard.length, - 'leaderboard', - equals(top10Leaderboard.length), - ) - ], - verify: (_) => - verify(() => leaderboardRepository.fetchTop10Leaderboard()) - .called(1), - ); - - blocTest( - 'emits [loading, error] statuses ' - 'when fetchTop10Leaderboard fails', - setUp: () { - when(() => leaderboardRepository.fetchTop10Leaderboard()).thenThrow( - Exception(), - ); - }, - build: () => LeaderboardBloc(leaderboardRepository), - act: (bloc) => bloc.add(Top10Fetched()), - expect: () => [ - LeaderboardState.initial(), - LeaderboardState.initial().copyWith(status: LeaderboardStatus.error), - ], - verify: (_) => - verify(() => leaderboardRepository.fetchTop10Leaderboard()) - .called(1), - errors: () => [isA()], - ); - }); - - group('LeaderboardEntryAdded', () { - final leaderboardEntry = LeaderboardEntryData( - playerInitials: 'ABC', - score: 1500, - character: CharacterType.dash, - ); - - final ranking = LeaderboardRanking(ranking: 3, outOf: 4); - - blocTest( - 'emits [loading, success] statuses ' - 'when addLeaderboardEntry succeeds', - setUp: () { - when( - () => leaderboardRepository.addLeaderboardEntry(leaderboardEntry), - ).thenAnswer( - (_) async => ranking, - ); - }, - build: () => LeaderboardBloc(leaderboardRepository), - act: (bloc) => bloc.add(LeaderboardEntryAdded(entry: leaderboardEntry)), - expect: () => [ - LeaderboardState.initial(), - isA() - ..having( - (element) => element.status, - 'status', - equals(LeaderboardStatus.success), - ) - ..having( - (element) => element.ranking, - 'ranking', - equals(ranking), - ) - ], - verify: (_) => verify( - () => leaderboardRepository.addLeaderboardEntry(leaderboardEntry), - ).called(1), - ); - - blocTest( - 'emits [loading, error] statuses ' - 'when addLeaderboardEntry fails', - setUp: () { - when( - () => leaderboardRepository.addLeaderboardEntry(leaderboardEntry), - ).thenThrow( - Exception(), - ); - }, - build: () => LeaderboardBloc(leaderboardRepository), - act: (bloc) => bloc.add(LeaderboardEntryAdded(entry: leaderboardEntry)), - expect: () => [ - LeaderboardState.initial(), - LeaderboardState.initial().copyWith(status: LeaderboardStatus.error), - ], - verify: (_) => verify( - () => leaderboardRepository.addLeaderboardEntry(leaderboardEntry), - ).called(1), - errors: () => [isA()], - ); - }); - }); - - group('CharacterTypeX', () { - test('converts CharacterType.android to AndroidTheme', () { - expect(CharacterType.android.toTheme, equals(AndroidTheme())); - }); - - test('converts CharacterType.dash to DashTheme', () { - expect(CharacterType.dash.toTheme, equals(DashTheme())); - }); - - test('converts CharacterType.dino to DinoTheme', () { - expect(CharacterType.dino.toTheme, equals(DinoTheme())); - }); - - test('converts CharacterType.sparky to SparkyTheme', () { - expect(CharacterType.sparky.toTheme, equals(SparkyTheme())); - }); - }); - - group('CharacterThemeX', () { - test('converts AndroidTheme to CharacterType.android', () { - expect(AndroidTheme().toType, equals(CharacterType.android)); - }); - - test('converts DashTheme to CharacterType.dash', () { - expect(DashTheme().toType, equals(CharacterType.dash)); - }); - - test('converts DinoTheme to CharacterType.dino', () { - expect(DinoTheme().toType, equals(CharacterType.dino)); - }); - - test('converts SparkyTheme to CharacterType.sparky', () { - expect(SparkyTheme().toType, equals(CharacterType.sparky)); - }); - }); -} diff --git a/test/leaderboard/bloc/leaderboard_event_test.dart b/test/leaderboard/bloc/leaderboard_event_test.dart deleted file mode 100644 index 33199ca1..00000000 --- a/test/leaderboard/bloc/leaderboard_event_test.dart +++ /dev/null @@ -1,41 +0,0 @@ -// ignore_for_file: prefer_const_constructors - -import 'package:flutter_test/flutter_test.dart'; -import 'package:leaderboard_repository/leaderboard_repository.dart'; -import 'package:pinball/leaderboard/leaderboard.dart'; - -void main() { - group('GameEvent', () { - group('Top10Fetched', () { - test('can be instantiated', () { - expect(const Top10Fetched(), isNotNull); - }); - - test('supports value equality', () { - expect( - Top10Fetched(), - equals(const Top10Fetched()), - ); - }); - }); - - group('LeaderboardEntryAdded', () { - const leaderboardEntry = LeaderboardEntryData( - playerInitials: 'ABC', - score: 1500, - character: CharacterType.dash, - ); - - test('can be instantiated', () { - expect(const LeaderboardEntryAdded(entry: leaderboardEntry), isNotNull); - }); - - test('supports value equality', () { - expect( - LeaderboardEntryAdded(entry: leaderboardEntry), - equals(const LeaderboardEntryAdded(entry: leaderboardEntry)), - ); - }); - }); - }); -} diff --git a/test/leaderboard/bloc/leaderboard_state_test.dart b/test/leaderboard/bloc/leaderboard_state_test.dart deleted file mode 100644 index 1b5d41d9..00000000 --- a/test/leaderboard/bloc/leaderboard_state_test.dart +++ /dev/null @@ -1,72 +0,0 @@ -// ignore_for_file: prefer_const_constructors - -import 'package:flutter_test/flutter_test.dart'; -import 'package:leaderboard_repository/leaderboard_repository.dart'; -import 'package:pinball/leaderboard/leaderboard.dart'; -import 'package:pinball_theme/pinball_theme.dart'; - -void main() { - group('LeaderboardState', () { - test('supports value equality', () { - expect( - LeaderboardState.initial(), - equals( - LeaderboardState.initial(), - ), - ); - }); - - group('constructor', () { - test('can be instantiated', () { - expect( - LeaderboardState.initial(), - isNotNull, - ); - }); - }); - - group('copyWith', () { - final leaderboardEntry = LeaderboardEntry( - rank: '1', - playerInitials: 'ABC', - score: 1500, - character: DashTheme().leaderboardIcon, - ); - - test( - 'copies correctly ' - 'when no argument specified', - () { - const leaderboardState = LeaderboardState.initial(); - expect( - leaderboardState.copyWith(), - equals(leaderboardState), - ); - }, - ); - - test( - 'copies correctly ' - 'when all arguments specified', - () { - const leaderboardState = LeaderboardState.initial(); - final otherLeaderboardState = LeaderboardState( - status: LeaderboardStatus.success, - ranking: LeaderboardRanking(ranking: 0, outOf: 0), - leaderboard: [leaderboardEntry], - ); - expect(leaderboardState, isNot(equals(otherLeaderboardState))); - - expect( - leaderboardState.copyWith( - status: otherLeaderboardState.status, - ranking: otherLeaderboardState.ranking, - leaderboard: otherLeaderboardState.leaderboard, - ), - equals(otherLeaderboardState), - ); - }, - ); - }); - }); -} diff --git a/test/leaderboard/view/leaderboard_page_test.dart b/test/leaderboard/view/leaderboard_page_test.dart deleted file mode 100644 index daacb4a7..00000000 --- a/test/leaderboard/view/leaderboard_page_test.dart +++ /dev/null @@ -1,165 +0,0 @@ -// ignore_for_file: prefer_const_constructors - -import 'package:bloc_test/bloc_test.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_bloc/flutter_bloc.dart'; -import 'package:flutter_test/flutter_test.dart'; -import 'package:leaderboard_repository/leaderboard_repository.dart'; -import 'package:mockingjay/mockingjay.dart'; -import 'package:pinball/l10n/l10n.dart'; -import 'package:pinball/leaderboard/leaderboard.dart'; -import 'package:pinball_theme/pinball_theme.dart'; - -import '../../helpers/helpers.dart'; - -void main() { - group('LeaderboardPage', () { - testWidgets('renders LeaderboardView', (tester) async { - await tester.pumpApp( - LeaderboardPage( - theme: DashTheme(), - ), - ); - - expect(find.byType(LeaderboardView), findsOneWidget); - }); - - testWidgets('route returns a valid navigation route', (tester) async { - await expectNavigatesToRoute( - tester, - LeaderboardPage.route( - theme: DashTheme(), - ), - ); - }); - }); - - group('LeaderboardView', () { - late LeaderboardBloc leaderboardBloc; - - setUp(() { - leaderboardBloc = MockLeaderboardBloc(); - }); - - testWidgets('renders correctly', (tester) async { - final l10n = await AppLocalizations.delegate.load(Locale('en')); - whenListen( - leaderboardBloc, - const Stream.empty(), - initialState: LeaderboardState.initial(), - ); - - await tester.pumpApp( - BlocProvider.value( - value: leaderboardBloc, - child: LeaderboardView( - theme: DashTheme(), - ), - ), - ); - - expect(find.text(l10n.leaderboard), findsOneWidget); - expect(find.text(l10n.retry), findsOneWidget); - }); - - testWidgets('renders loading view when bloc emits [loading]', - (tester) async { - whenListen( - leaderboardBloc, - const Stream.empty(), - initialState: LeaderboardState.initial(), - ); - - await tester.pumpApp( - BlocProvider.value( - value: leaderboardBloc, - child: LeaderboardView( - theme: DashTheme(), - ), - ), - ); - - expect(find.byType(CircularProgressIndicator), findsOneWidget); - expect(find.text('There was en error loading data!'), findsNothing); - expect(find.byType(ListView), findsNothing); - }); - - testWidgets('renders error view when bloc emits [error]', (tester) async { - whenListen( - leaderboardBloc, - const Stream.empty(), - initialState: LeaderboardState.initial().copyWith( - status: LeaderboardStatus.error, - ), - ); - - await tester.pumpApp( - BlocProvider.value( - value: leaderboardBloc, - child: LeaderboardView( - theme: DashTheme(), - ), - ), - ); - - expect(find.byType(CircularProgressIndicator), findsNothing); - expect(find.text('There was en error loading data!'), findsOneWidget); - expect(find.byType(ListView), findsNothing); - }); - - testWidgets('renders success view when bloc emits [success]', - (tester) async { - final l10n = await AppLocalizations.delegate.load(Locale('en')); - whenListen( - leaderboardBloc, - const Stream.empty(), - initialState: LeaderboardState( - status: LeaderboardStatus.success, - ranking: LeaderboardRanking(ranking: 0, outOf: 0), - leaderboard: [ - LeaderboardEntry( - rank: '1', - playerInitials: 'ABC', - score: 10000, - character: DashTheme().leaderboardIcon, - ), - ], - ), - ); - - await tester.pumpApp( - BlocProvider.value( - value: leaderboardBloc, - child: LeaderboardView( - theme: DashTheme(), - ), - ), - ); - - expect(find.byType(CircularProgressIndicator), findsNothing); - expect(find.text('There was en error loading data!'), findsNothing); - expect(find.text(l10n.rank), findsOneWidget); - expect(find.text(l10n.character), findsOneWidget); - expect(find.text(l10n.username), findsOneWidget); - expect(find.text(l10n.score), findsOneWidget); - expect(find.byType(ListView), findsOneWidget); - }); - - testWidgets('navigates to CharacterSelectionPage when retry is tapped', - (tester) async { - final navigator = MockNavigator(); - when(() => navigator.push(any())).thenAnswer((_) async {}); - - await tester.pumpApp( - LeaderboardPage( - theme: DashTheme(), - ), - navigator: navigator, - ); - await tester.ensureVisible(find.byType(TextButton)); - await tester.tap(find.byType(TextButton)); - - verify(() => navigator.push(any())).called(1); - }); - }); -} diff --git a/test/select_character/view/character_selection_page_test.dart b/test/select_character/view/character_selection_page_test.dart index 0dda92d7..dc5d70ea 100644 --- a/test/select_character/view/character_selection_page_test.dart +++ b/test/select_character/view/character_selection_page_test.dart @@ -1,5 +1,7 @@ // ignore_for_file: prefer_const_constructors +import 'dart:async'; + import 'package:bloc_test/bloc_test.dart'; import 'package:flutter/material.dart'; import 'package:flutter_test/flutter_test.dart'; @@ -84,17 +86,68 @@ void main() { .called(1); }); - testWidgets('displays how to play dialog when start is tapped', + group('HowToPlayDialog', () { + testWidgets( + 'is displayed for 3 seconds when start is tapped', (tester) async { - await tester.pumpApp( - CharacterSelectionView(), - characterThemeCubit: characterThemeCubit, + await tester.pumpApp( + Scaffold( + body: Builder( + builder: (context) { + return ElevatedButton( + onPressed: () { + Navigator.of(context) + .push(CharacterSelectionDialog.route()); + }, + child: Text('Tap me'), + ); + }, + ), + ), + characterThemeCubit: characterThemeCubit, + ); + await tester.tap(find.text('Tap me')); + await tester.pumpAndSettle(); + await tester.ensureVisible(find.byType(TextButton)); + await tester.tap(find.byType(TextButton)); + await tester.pumpAndSettle(); + expect(find.byType(HowToPlayDialog), findsOneWidget); + await tester.pump(Duration(seconds: 3)); + await tester.pumpAndSettle(); + expect(find.byType(HowToPlayDialog), findsNothing); + }, ); - await tester.ensureVisible(find.byType(TextButton)); - await tester.tap(find.byType(TextButton)); - await tester.pumpAndSettle(); - expect(find.byType(HowToPlayDialog), findsOneWidget); + testWidgets( + 'can be dismissed manually before 3 seconds have passed', + (tester) async { + await tester.pumpApp( + Scaffold( + body: Builder( + builder: (context) { + return ElevatedButton( + onPressed: () { + Navigator.of(context) + .push(CharacterSelectionDialog.route()); + }, + child: Text('Tap me'), + ); + }, + ), + ), + characterThemeCubit: characterThemeCubit, + ); + await tester.tap(find.text('Tap me')); + await tester.pumpAndSettle(); + await tester.ensureVisible(find.byType(TextButton)); + await tester.tap(find.byType(TextButton)); + await tester.pumpAndSettle(); + expect(find.byType(HowToPlayDialog), findsOneWidget); + await tester.tapAt(Offset(1, 1)); + await tester.pumpAndSettle(); + expect(find.byType(HowToPlayDialog), findsNothing); + }, + ); }); }); diff --git a/test/start_game/widgets/how_to_play_dialog_test.dart b/test/start_game/widgets/how_to_play_dialog_test.dart index c31ac1a3..1de4c2ad 100644 --- a/test/start_game/widgets/how_to_play_dialog_test.dart +++ b/test/start_game/widgets/how_to_play_dialog_test.dart @@ -2,41 +2,68 @@ import 'package:flutter/material.dart'; import 'package:flutter_test/flutter_test.dart'; +import 'package:mocktail/mocktail.dart'; import 'package:pinball/l10n/l10n.dart'; import 'package:pinball/start_game/start_game.dart'; +import 'package:platform_helper/platform_helper.dart'; import '../../helpers/helpers.dart'; +class MockPlatformHelper extends Mock implements PlatformHelper {} + void main() { group('HowToPlayDialog', () { - testWidgets('displays content', (tester) async { - final l10n = await AppLocalizations.delegate.load(Locale('en')); - - await tester.pumpApp(HowToPlayDialog()); + late AppLocalizations l10n; + late PlatformHelper platformHelper; - expect(find.text(l10n.launchControls), findsOneWidget); + setUp(() async { + l10n = await AppLocalizations.delegate.load(Locale('en')); + platformHelper = MockPlatformHelper(); }); - }); - group('KeyIndicator', () { - testWidgets('fromKeyName renders correctly', (tester) async { - const keyName = 'A'; + testWidgets( + 'can be instantiated without passing in a platform helper', + (tester) async { + await tester.pumpApp(HowToPlayDialog()); + expect(find.byType(HowToPlayDialog), findsOneWidget); + }, + ); + testWidgets('displays content for desktop', (tester) async { + when(() => platformHelper.isMobile).thenAnswer((_) => false); await tester.pumpApp( - KeyIndicator.fromKeyName(keyName: keyName), + HowToPlayDialog( + platformHelper: platformHelper, + ), ); - - expect(find.text(keyName), findsOneWidget); + expect(find.text(l10n.howToPlay), findsOneWidget); + expect(find.text(l10n.tipsForFlips), findsOneWidget); + expect(find.text(l10n.launchControls), findsOneWidget); + expect(find.text(l10n.flipperControls), findsOneWidget); + expect(find.byType(KeyButton), findsNWidgets(7)); }); - testWidgets('fromIcon renders correctly', (tester) async { - const keyIcon = Icons.keyboard_arrow_down; + testWidgets('displays content for mobile', (tester) async { + when(() => platformHelper.isMobile).thenAnswer((_) => true); + await tester.pumpApp( + HowToPlayDialog( + platformHelper: platformHelper, + ), + ); + expect(find.text(l10n.howToPlay), findsOneWidget); + expect(find.text(l10n.tipsForFlips), findsOneWidget); + expect(find.text(l10n.tapAndHoldRocket), findsOneWidget); + expect(find.text(l10n.tapLeftRightScreen), findsOneWidget); + }); + }); + group('KeyButton', () { + testWidgets('renders correctly', (tester) async { await tester.pumpApp( - KeyIndicator.fromIcon(keyIcon: keyIcon), + KeyButton(control: Control.a), ); - expect(find.byIcon(keyIcon), findsOneWidget); + expect(find.text('A'), findsOneWidget); }); }); } diff --git a/web/index.html b/web/index.html index 37e17170..e1544bf2 100644 --- a/web/index.html +++ b/web/index.html @@ -56,6 +56,13 @@ I/O Pinball Machine - Flutter + +