pinball/packages/pinball_components/test/src/components/plunger_test.dart

// 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:pinball_components/pinball_components.dart';

import '../../helpers/helpers.dart';

void main() {
  TestWidgetsFlutterBinding.ensureInitialized();
  final flameTester = FlameTester(TestGame.new);

  group('Plunger', () {
    const compressionDistance = 0.0;

    flameTester.testGameWidget(
      'renders correctly',
      setUp: (game, tester) async {
        await game.ensureAdd(Plunger(compressionDistance: compressionDistance));

        game.camera.followVector2(Vector2.zero());
        game.camera.zoom = 4.1;
      },
      verify: (game, tester) async {
        await expectLater(
          find.byGame<TestGame>(),
          matchesGoldenFile('golden/plunger.png'),
        );
      },
    );

    flameTester.test(
      'loads correctly',
      (game) async {
        await game.ready();
        final plunger = Plunger(
          compressionDistance: compressionDistance,
        );
        await game.ensureAdd(plunger);

        expect(game.contains(plunger), isTrue);
      },
    );

    group('body', () {
      flameTester.test(
        'is dynamic',
        (game) async {
          final plunger = Plunger(
            compressionDistance: compressionDistance,
          );
          await game.ensureAdd(plunger);

          expect(plunger.body.bodyType, equals(BodyType.dynamic));
        },
      );

      flameTester.test(
        'ignores gravity',
        (game) async {
          final plunger = Plunger(
            compressionDistance: compressionDistance,
          );
          await game.ensureAdd(plunger);

          expect(plunger.body.gravityScale, equals(Vector2.zero()));
        },
      );
    });

    group('fixture', () {
      flameTester.test(
        'exists',
        (game) async {
          final plunger = Plunger(
            compressionDistance: compressionDistance,
          );
          await game.ensureAdd(plunger);

          expect(plunger.body.fixtures[0], isA<Fixture>());
        },
      );

      flameTester.test(
        'shape is a polygon',
        (game) async {
          final plunger = Plunger(
            compressionDistance: compressionDistance,
          );
          await game.ensureAdd(plunger);

          final fixture = plunger.body.fixtures[0];
          expect(fixture.shape.shapeType, equals(ShapeType.polygon));
        },
      );

      flameTester.test(
        'has density',
        (game) async {
          final plunger = Plunger(
            compressionDistance: compressionDistance,
          );
          await game.ensureAdd(plunger);

          final fixture = plunger.body.fixtures[0];
          expect(fixture.density, greaterThan(0));
        },
      );
    });

    group('pull', () {
      flameTester.test(
        'moves downwards when pull is called',
        (game) async {
          final plunger = Plunger(
            compressionDistance: compressionDistance,
          );
          await game.ensureAdd(plunger);
          plunger.pull();

          expect(plunger.body.linearVelocity.y, isPositive);
          expect(plunger.body.linearVelocity.x, isZero);
        },
      );
    });

    group('release', () {
      late Plunger plunger;

      setUp(() {
        plunger = Plunger(
          compressionDistance: compressionDistance,
        );
      });

      flameTester.test(
          'moves upwards when release is called '
          'and plunger is below its starting position', (game) async {
        await game.ensureAdd(plunger);
        plunger.body.setTransform(Vector2(0, 1), 0);
        plunger.release();

        expect(plunger.body.linearVelocity.y, isNegative);
        expect(plunger.body.linearVelocity.x, isZero);
      });

      flameTester.test(
        'does not move when release is called '
        'and plunger is in its starting position',
        (game) async {
          await game.ensureAdd(plunger);
          plunger.release();

          expect(plunger.body.linearVelocity.y, isZero);
          expect(plunger.body.linearVelocity.x, isZero);
        },
      );
    });
  });

  group('PlungerAnchor', () {
    const compressionDistance = 10.0;

    flameTester.test(
      'position is a compression distance below the Plunger',
      (game) async {
        final plunger = Plunger(
          compressionDistance: compressionDistance,
        );
        await game.ensureAdd(plunger);

        final plungerAnchor = PlungerAnchor(plunger: plunger);
        await game.ensureAdd(plungerAnchor);

        expect(
          plungerAnchor.body.position.y,
          equals(plunger.body.position.y + compressionDistance),
        );
      },
    );
  });

  group('PlungerAnchorPrismaticJointDef', () {
    const compressionDistance = 10.0;
    late Plunger plunger;
    late PlungerAnchor anchor;

    setUp(() {
      plunger = Plunger(
        compressionDistance: compressionDistance,
      );
      anchor = PlungerAnchor(plunger: plunger);
    });

    group('initializes with', () {
      flameTester.test(
        'plunger body as bodyA',
        (game) async {
          await game.ensureAdd(plunger);
          await game.ensureAdd(anchor);

          final jointDef = PlungerAnchorPrismaticJointDef(
            plunger: plunger,
            anchor: anchor,
          );

          expect(jointDef.bodyA, equals(plunger.body));
        },
      );

      flameTester.test(
        'anchor body as bodyB',
        (game) async {
          await game.ensureAdd(plunger);
          await game.ensureAdd(anchor);

          final jointDef = PlungerAnchorPrismaticJointDef(
            plunger: plunger,
            anchor: anchor,
          );
          game.world.createJoint(PrismaticJoint(jointDef));

          expect(jointDef.bodyB, equals(anchor.body));
        },
      );

      flameTester.test(
        'limits enabled',
        (game) async {
          await game.ensureAdd(plunger);
          await game.ensureAdd(anchor);

          final jointDef = PlungerAnchorPrismaticJointDef(
            plunger: plunger,
            anchor: anchor,
          );
          game.world.createJoint(PrismaticJoint(jointDef));

          expect(jointDef.enableLimit, isTrue);
        },
      );

      flameTester.test(
        'lower translation limit as negative infinity',
        (game) async {
          await game.ensureAdd(plunger);
          await game.ensureAdd(anchor);

          final jointDef = PlungerAnchorPrismaticJointDef(
            plunger: plunger,
            anchor: anchor,
          );
          game.world.createJoint(PrismaticJoint(jointDef));

          expect(jointDef.lowerTranslation, equals(double.negativeInfinity));
        },
      );

      flameTester.test(
        'connected body collison enabled',
        (game) async {
          await game.ensureAdd(plunger);
          await game.ensureAdd(anchor);

          final jointDef = PlungerAnchorPrismaticJointDef(
            plunger: plunger,
            anchor: anchor,
          );
          game.world.createJoint(PrismaticJoint(jointDef));

          expect(jointDef.collideConnected, isTrue);
        },
      );
    });

    flameTester.testGameWidget(
      'plunger cannot go below anchor',
      setUp: (game, tester) async {
        await game.ensureAdd(plunger);
        await game.ensureAdd(anchor);

        // Giving anchor a shape for the plunger to collide with.
        anchor.body.createFixtureFromShape(PolygonShape()..setAsBoxXY(2, 1));

        final jointDef = PlungerAnchorPrismaticJointDef(
          plunger: plunger,
          anchor: anchor,
        );
        game.world.createJoint(PrismaticJoint(jointDef));

        await tester.pump(const Duration(seconds: 1));
      },
      verify: (game, tester) async {
        expect(plunger.body.position.y < anchor.body.position.y, isTrue);
      },
    );

    flameTester.testGameWidget(
      'plunger cannot excessively exceed starting position',
      setUp: (game, tester) async {
        await game.ensureAdd(plunger);
        await game.ensureAdd(anchor);

        final jointDef = PlungerAnchorPrismaticJointDef(
          plunger: plunger,
          anchor: anchor,
        );
        game.world.createJoint(PrismaticJoint(jointDef));

        plunger.body.setTransform(Vector2(0, -1), 0);

        await tester.pump(const Duration(seconds: 1));
      },
      verify: (game, tester) async {
        expect(plunger.body.position.y < 1, isTrue);
      },
    );
  });
}