refactor: move spaceship exit rail (#130)

* refactor: moved SpaceshipExitRail to pinball components

* test: refactor tests and coverage

* chore: ignore cascade invocations on tests

* refactor: renamed SpaceshipExitRail to SpaceshipRail

lib/game/components/components.dart

@@ -6,5 +6,4 @@ export 'flutter_forest.dart';
 export 'launcher_ramp.dart';
 export 'plunger.dart';
 export 'score_points.dart';
-export 'spaceship_exit_rail.dart';
 export 'wall.dart';

lib/game/game_assets.dart

@@ -28,8 +28,10 @@ extension PinballGameAssetsX on PinballGame {
       images.load(
         components.Assets.images.spaceshipRamp.spaceshipRailingFg.keyName,
       ),
+      images.load(
+        components.Assets.images.spaceshipRamp.spaceshipDropTube.keyName,
+      ),
       images.load(Assets.images.components.background.path),
-      images.load(Assets.images.components.spaceshipDropTube.path),
     ]);
   }
 }

lib/game/pinball_game.dart

@@ -45,7 +45,7 @@ class PinballGame extends Forge2DGame
     );
     unawaited(
       addFromBlueprint(
-        SpaceshipExitRail(),
+        SpaceshipRail(),
       ),
     );
 

lib/gen/assets.gen.dart

@@ -20,10 +20,6 @@ class $AssetsImagesComponentsGen {
   /// File path: assets/images/components/background.png
   AssetGenImage get background =>
       const AssetGenImage('assets/images/components/background.png');
-
-  /// File path: assets/images/components/spaceship-drop-tube.png
-  AssetGenImage get spaceshipDropTube =>
-      const AssetGenImage('assets/images/components/spaceship-drop-tube.png');
 }
 
 class Assets {

packages/pinball_components/lib/gen/assets.gen.dart

@@ -83,6 +83,10 @@ class $AssetsImagesFlipperGen {
 class $AssetsImagesSpaceshipRampGen {
   const $AssetsImagesSpaceshipRampGen();
 
+  /// File path: assets/images/spaceship_ramp/spaceship_drop_tube.png
+  AssetGenImage get spaceshipDropTube => const AssetGenImage(
+      'assets/images/spaceship_ramp/spaceship_drop_tube.png');
+
   /// File path: assets/images/spaceship_ramp/spaceship_railing_bg.png
   AssetGenImage get spaceshipRailingBg => const AssetGenImage(
       'assets/images/spaceship_ramp/spaceship_railing_bg.png');

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

@@ -15,4 +15,5 @@ export 'layer.dart';
 export 'ramp_opening.dart';
 export 'shapes/shapes.dart';
 export 'spaceship.dart';
+export 'spaceship_rail.dart';
 export 'spaceship_ramp.dart';

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

@@ -37,7 +37,7 @@ class Spaceship extends Forge2DBlueprint {
       AndroidHead()..initialPosition = position,
       SpaceshipHole(
         outsideLayer: Layer.spaceshipExitRail,
-        outsidePriority: 2,
+        outsidePriority: SpaceshipRail.ballPriorityWhenOnSpaceshipRail,
       )..initialPosition = position - Vector2(5.2, 4.8),
       SpaceshipHole()..initialPosition = position - Vector2(-7.2, 0.8),
       SpaceshipWall()..initialPosition = position,

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

@@ -4,30 +4,30 @@ import 'dart:math' as math;
 
 import 'package:flame/components.dart';
 import 'package:flame_forge2d/flame_forge2d.dart';
-import 'package:pinball/gen/assets.gen.dart';
+import 'package:pinball_components/gen/assets.gen.dart';
 import 'package:pinball_components/pinball_components.dart' hide Assets;
 
-/// {@template spaceship_exit_rail}
+/// {@template spaceship_rail}
 /// A [Blueprint] for the spaceship drop tube.
 /// {@endtemplate}
-class SpaceshipExitRail extends Forge2DBlueprint {
+class SpaceshipRail extends Forge2DBlueprint {
-  /// {@macro spaceship_exit_rail}
+  /// {@macro spaceship_rail}
-  SpaceshipExitRail();
+  SpaceshipRail();
 
-  /// Base priority for wall while be on [_SpaceshipExitRailRamp].
+  /// Base priority for ball while be in [_SpaceshipRailRamp].
-  static const ballPriorityWhenOnSpaceshipExitRail = 2;
+  static const ballPriorityWhenOnSpaceshipRail = 2;
 
   @override
   void build(_) {
     addAllContactCallback([
-      SpaceshipExitRailEndBallContactCallback(),
+      SpaceshipRailExitBallContactCallback(),
     ]);
 
-    final exitRailRamp = _SpaceshipExitRailRamp();
+    final exitRailRamp = _SpaceshipRailRamp();
-    final exitRailEnd = SpaceshipExitRailEnd();
+    final exitRailEnd = SpaceshipRailExit();
-    final topBase = _SpaceshipExitRailBase(radius: 0.55)
+    final topBase = _SpaceshipRailBase(radius: 0.55)
       ..initialPosition = Vector2(-26.15, 18.65);
-    final bottomBase = _SpaceshipExitRailBase(radius: 0.8)
+    final bottomBase = _SpaceshipRailBase(radius: 0.8)
       ..initialPosition = Vector2(-25.5, -12.9);
 
     addAll([
@@ -39,11 +39,11 @@ class SpaceshipExitRail extends Forge2DBlueprint {
   }
 }
 
-class _SpaceshipExitRailRamp extends BodyComponent
+/// Represents the spaceship drop rail from the [Spaceship].
-    with InitialPosition, Layered {
+class _SpaceshipRailRamp extends BodyComponent with InitialPosition, Layered {
-  _SpaceshipExitRailRamp()
+  _SpaceshipRailRamp()
       : super(
-          priority: SpaceshipExitRail.ballPriorityWhenOnSpaceshipExitRail - 1,
+          priority: SpaceshipRail.ballPriorityWhenOnSpaceshipRail - 1,
         ) {
     renderBody = false;
     layer = Layer.spaceshipExitRail;
@@ -73,7 +73,7 @@ class _SpaceshipExitRailRamp extends BodyComponent
 
     final middleLeftCurveShape = BezierCurveShape(
       controlPoints: [
-        Vector2(-30.93, 18.2),
+        topLeftCurveShape.vertices.last,
         Vector2(-22.6, 10.3),
         Vector2(-30, 0.2),
       ],
@@ -83,7 +83,7 @@ class _SpaceshipExitRailRamp extends BodyComponent
 
     final bottomLeftCurveShape = BezierCurveShape(
       controlPoints: [
-        Vector2(-30, 0.2),
+        middleLeftCurveShape.vertices.last,
         Vector2(-36, -8.6),
         Vector2(-32.04, -18.3),
       ],
@@ -101,7 +101,7 @@ class _SpaceshipExitRailRamp extends BodyComponent
 
     final middleRightCurveShape = BezierCurveShape(
       controlPoints: [
-        Vector2(-27.2, 21.3),
+        topRightStraightShape.vertex1,
         Vector2(-16.5, 11.4),
         Vector2(-25.29, -1.7),
       ],
@@ -111,7 +111,7 @@ class _SpaceshipExitRailRamp extends BodyComponent
 
     final bottomRightCurveShape = BezierCurveShape(
       controlPoints: [
-        Vector2(-25.29, -1.7),
+        middleRightCurveShape.vertices.last,
         Vector2(-29.91, -8.5),
         Vector2(-26.8, -15.7),
       ],
@@ -142,7 +142,7 @@ class _SpaceshipExitRailRamp extends BodyComponent
 
   Future<void> _loadSprite() async {
     final sprite = await gameRef.loadSprite(
-      Assets.images.components.spaceshipDropTube.path,
+      Assets.images.spaceshipRamp.spaceshipDropTube.keyName,
     );
     final spriteComponent = SpriteComponent(
       sprite: sprite,
@@ -155,11 +155,11 @@ class _SpaceshipExitRailRamp extends BodyComponent
   }
 }
 
-class _SpaceshipExitRailBase extends BodyComponent
+/// Represents the ground bases of the [_SpaceshipRailRamp].
-    with InitialPosition, Layered {
+class _SpaceshipRailBase extends BodyComponent with InitialPosition, Layered {
-  _SpaceshipExitRailBase({required this.radius})
+  _SpaceshipRailBase({required this.radius})
       : super(
-          priority: SpaceshipExitRail.ballPriorityWhenOnSpaceshipExitRail + 1,
+          priority: SpaceshipRail.ballPriorityWhenOnSpaceshipRail + 1,
         ) {
     renderBody = false;
     layer = Layer.board;
@@ -181,13 +181,13 @@ class _SpaceshipExitRailBase extends BodyComponent
   }
 }
 
-/// {@template spaceship_exit_rail_end}
+/// {@template spaceship_rail_exit}
 /// A sensor [BodyComponent] responsible for sending the [Ball]
 /// back to the board.
 /// {@endtemplate}
-class SpaceshipExitRailEnd extends RampOpening {
+class SpaceshipRailExit extends RampOpening {
-  /// {@macro spaceship_exit_rail_end}
+  /// {@macro spaceship_rail_exit}
-  SpaceshipExitRailEnd()
+  SpaceshipRailExit()
       : super(
           insideLayer: Layer.spaceshipExitRail,
           orientation: RampOrientation.down,
@@ -209,14 +209,14 @@ class SpaceshipExitRailEnd extends RampOpening {
 }
 
 /// [ContactCallback] that handles the contact between the [Ball]
-/// and a [SpaceshipExitRailEnd].
+/// and a [SpaceshipRailExit].
 ///
 /// It resets the [Ball] priority and filter data so it will "be back" on the
 /// board.
-class SpaceshipExitRailEndBallContactCallback
+class SpaceshipRailExitBallContactCallback
-    extends ContactCallback<SpaceshipExitRailEnd, Ball> {
+    extends ContactCallback<SpaceshipRailExit, Ball> {
   @override
-  void begin(SpaceshipExitRailEnd exitRail, Ball ball, _) {
+  void begin(SpaceshipRailExit exitRail, Ball ball, _) {
     ball
       ..sendTo(exitRail.outsidePriority)
       ..layer = exitRail.outsideLayer;

packages/pinball_components/test/helpers/mocks.dart

@@ -17,6 +17,8 @@ class MockSpaceshipEntrance extends Mock implements SpaceshipEntrance {}
 
 class MockSpaceshipHole extends Mock implements SpaceshipHole {}
 
+class MockSpaceshipRailExit extends Mock implements SpaceshipRailExit {}
+
 class MockContact extends Mock implements Contact {}
 
 class MockContactCallback extends Mock

packages/pinball_components/test/src/components/spaceship_rail_test.dart

@@ -0,0 +1,82 @@
+// ignore_for_file: cascade_invocations
+
+import 'package:flame_forge2d/flame_forge2d.dart';
+import 'package:flame_test/flame_test.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:mocktail/mocktail.dart';
+import 'package:pinball_components/pinball_components.dart';
+
+import '../../helpers/helpers.dart';
+
+void main() {
+  group('SpaceshipRail', () {
+    TestWidgetsFlutterBinding.ensureInitialized();
+    final flameTester = FlameTester(TestGame.new);
+
+    flameTester.test(
+      'loads correctly',
+      (game) async {
+        final spaceshipRail = SpaceshipRail();
+        await game.addFromBlueprint(spaceshipRail);
+        await game.ready();
+
+        for (final element in spaceshipRail.components) {
+          expect(game.contains(element), isTrue);
+        }
+      },
+    );
+  });
+
+  // TODO(alestiago): Make ContactCallback private and use `beginContact`
+  // instead.
+  group('SpaceshipRailExitBallContactCallback', () {
+    late Forge2DGame game;
+    late SpaceshipRailExit railExit;
+    late Ball ball;
+    late Body body;
+    late Fixture fixture;
+    late Filter filterData;
+
+    setUp(() {
+      game = MockGame();
+
+      railExit = MockSpaceshipRailExit();
+
+      ball = MockBall();
+      body = MockBody();
+      when(() => ball.gameRef).thenReturn(game);
+      when(() => ball.body).thenReturn(body);
+
+      fixture = MockFixture();
+      filterData = MockFilter();
+      when(() => body.fixtures).thenReturn([fixture]);
+      when(() => fixture.filterData).thenReturn(filterData);
+    });
+
+    setUp(() {
+      when(() => ball.priority).thenReturn(1);
+      when(() => railExit.outsideLayer).thenReturn(Layer.board);
+      when(() => railExit.outsidePriority).thenReturn(0);
+    });
+
+    test('changes the ball priority on contact', () {
+      SpaceshipRailExitBallContactCallback().begin(
+        railExit,
+        ball,
+        MockContact(),
+      );
+
+      verify(() => ball.sendTo(railExit.outsidePriority)).called(1);
+    });
+
+    test('changes the ball layer on contact', () {
+      SpaceshipRailExitBallContactCallback().begin(
+        railExit,
+        ball,
+        MockContact(),
+      );
+
+      verify(() => ball.layer = railExit.outsideLayer).called(1);
+    });
+  });
+}

test/game/components/spaceship_exit_rail_test.dart

@@ -1,64 +0,0 @@
-import 'package:flame_forge2d/flame_forge2d.dart';
-import 'package:flutter_test/flutter_test.dart';
-import 'package:mocktail/mocktail.dart';
-import 'package:pinball/game/game.dart';
-import 'package:pinball_components/pinball_components.dart';
-
-import '../../helpers/helpers.dart';
-
-void main() {
-  group('SpaceshipExitRail', () {
-    late PinballGame game;
-    late SpaceshipExitRailEnd exitRailEnd;
-    late Ball ball;
-    late Body body;
-    late Fixture fixture;
-    late Filter filterData;
-
-    setUp(() {
-      game = MockPinballGame();
-
-      exitRailEnd = MockSpaceshipExitRailEnd();
-
-      ball = MockBall();
-      body = MockBody();
-      when(() => ball.gameRef).thenReturn(game);
-      when(() => ball.body).thenReturn(body);
-
-      fixture = MockFixture();
-      filterData = MockFilter();
-      when(() => body.fixtures).thenReturn([fixture]);
-      when(() => fixture.filterData).thenReturn(filterData);
-    });
-
-    // TODO(alestiago): Make ContactCallback private and use `beginContact`
-    // instead.
-    group('SpaceshipExitHoleBallContactCallback', () {
-      setUp(() {
-        when(() => ball.priority).thenReturn(1);
-        when(() => exitRailEnd.outsideLayer).thenReturn(Layer.board);
-        when(() => exitRailEnd.outsidePriority).thenReturn(0);
-      });
-
-      test('changes the ball priority on contact', () {
-        SpaceshipExitRailEndBallContactCallback().begin(
-          exitRailEnd,
-          ball,
-          MockContact(),
-        );
-
-        verify(() => ball.sendTo(exitRailEnd.outsidePriority)).called(1);
-      });
-
-      test('changes the ball layer on contact', () {
-        SpaceshipExitRailEndBallContactCallback().begin(
-          exitRailEnd,
-          ball,
-          MockContact(),
-        );
-
-        verify(() => ball.layer = exitRailEnd.outsideLayer).called(1);
-      });
-    });
-  });
-}

test/helpers/mocks.dart

@@ -66,8 +66,6 @@ class MockFilter extends Mock implements Filter {}
 
 class MockFixture extends Mock implements Fixture {}
 
-class MockSpaceshipExitRailEnd extends Mock implements SpaceshipExitRailEnd {}
-
 class MockComponentSet extends Mock implements ComponentSet {}
 
 class MockDashNestBumper extends Mock implements DashNestBumper {}