Default, common use stubs

[erickzanardo]

Mocktail could provide some default stub instances that are common use and not project specific.

A common one that I usually end up writing on every project is a VoidCallbackStub, usually to check if a onPressed callback was called on widget testing.

An implementation suggestion:

class _VoidCallbackStub {
  void onCall() {}
}

class VoidCallbackStub extends Mock implements _VoidCallbackStub {}

then we could use it like the following:

      final listener = VoidCallbackStub();
      await _pumpWidget(
        tester,
        CustomButton(
          label: 'label',
          onPressed: listener.onCall,
        ),
      );

      await tester.tap(find.byType(GestureDetector));
      await tester.pumpAndSettle();
   
      verify(listener.onCall).called(1);

Is this something worth adding to Mocktail?

[felangel]

Hey @erickzanardo 👋
Thanks for opening an issue!

After some discussions, I think it would be best if we kept package:mocktail as a package which contains the core mocking APIs and for convenience APIs like this we could create a separate package. What do you think?

Also, for scenarios like the one you described it might be easier to forego using mocktail completely like:

var onPressedCallCount = 0;
await tester.pumpWidget(
  CustomButton(onPressed: () => onPressedCallCount++),
);
await tester.tap(...)
expect(onPressedCallCount, equals(1));

Let me know what you think and sorry for the delayed reply!

[erickzanardo]

Hey, thanks for the response.

Yeah, the counter variable is something that I also used and it work perfectly, but this proposal makes it a little bit more convenient.

A separate package sounds good too! Would that be something that could be kept under this mono repo? If so I would love to do a PR including it.

Otherwise if you prefer to make it external, I could maintain it.

[felangel]

Sorry for the delayed response! I'd prefer to create a separate package (maybe https://pub.dev/packages/mocktailx would accept a PR?).

Let me know what you think 👍

[erickzanardo]

Sounds good! I will work on this on a external package, thanks @felangel !