Skip to content

Commit

Permalink
refactor: update examples to use RepositoryProvider new dispose A…
Browse files Browse the repository at this point in the history
…PI (#4366)
  • Loading branch information
felangel authored Mar 1, 2025
1 parent 9969fc3 commit 24e6f0e
Show file tree
Hide file tree
Showing 20 changed files with 146 additions and 99 deletions.
9 changes: 5 additions & 4 deletions examples/flutter_todos/lib/app/app.dart
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@ import 'package:flutter_todos/theme/theme.dart';
import 'package:todos_repository/todos_repository.dart';

class App extends StatelessWidget {
const App({required this.todosRepository, super.key});
const App({required this.createTodosRepository, super.key});

final TodosRepository todosRepository;
final TodosRepository Function() createTodosRepository;

@override
Widget build(BuildContext context) {
return RepositoryProvider.value(
value: todosRepository,
return RepositoryProvider<TodosRepository>(
create: (_) => createTodosRepository(),
dispose: (repository) => repository.dispose(),
child: const AppView(),
);
}
Expand Down
4 changes: 1 addition & 3 deletions examples/flutter_todos/lib/bootstrap.dart
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,5 @@ void bootstrap({required TodosApi todosApi}) {

Bloc.observer = const AppBlocObserver();

final todosRepository = TodosRepository(todosApi: todosApi);

runApp(App(todosRepository: todosRepository));
runApp(App(createTodosRepository: () => TodosRepository(todosApi: todosApi)));
}
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,7 @@ class TodosRepository {
/// Returns the number of updated todos.
Future<int> completeAll({required bool isCompleted}) =>
_todosApi.completeAll(isCompleted: isCompleted);

/// Disposes any resources managed by the repository.
void dispose() => _todosApi.close();
}
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ void main() {
when(
() => api.completeAll(isCompleted: any(named: 'isCompleted')),
).thenAnswer((_) async => 0);
when(() => api.close()).thenAnswer((_) async {});
});

TodosRepository createSubject() => TodosRepository(todosApi: api);
Expand Down Expand Up @@ -124,5 +125,14 @@ void main() {
verify(() => api.completeAll(isCompleted: true)).called(1);
});
});

group('dispose', () {
test('closes the underlying api client', () {
final subject = createSubject();
verifyNever(api.close);
subject.dispose();
verify(api.close).called(1);
});
});
});
}
82 changes: 41 additions & 41 deletions examples/flutter_todos/pubspec.lock
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ packages:
dependency: transitive
description:
name: async
sha256: "947bfcf187f74dbc5e146c9eb9c0f10c9f8b30743e341481c1e2ed3ecc18c20c"
sha256: d2872f9c19731c2e5f10444b14686eb7cc85c76274bd6c16e1816bff9a3bab63
url: "https://pub.dev"
source: hosted
version: "2.11.0"
version: "2.12.0"
bloc:
dependency: "direct main"
description:
Expand All @@ -56,34 +56,34 @@ packages:
dependency: transitive
description:
name: boolean_selector
sha256: "6cfb5af12253eaf2b368f07bacc5a80d1301a071c73360d746b7f2e32d762c66"
sha256: "8aab1771e1243a5063b8b0ff68042d67334e3feab9e95b9490f9a6ebf73b42ea"
url: "https://pub.dev"
source: hosted
version: "2.1.1"
version: "2.1.2"
characters:
dependency: transitive
description:
name: characters
sha256: "04a925763edad70e8443c99234dc3328f442e811f1d8fd1a72f1c8ad0f69a605"
sha256: f71061c654a3380576a52b451dd5532377954cf9dbd272a78fc8479606670803
url: "https://pub.dev"
source: hosted
version: "1.3.0"
version: "1.4.0"
clock:
dependency: transitive
description:
name: clock
sha256: cb6d7f03e1de671e34607e909a7213e31d7752be4fb66a86d29fe1eb14bfb5cf
sha256: fddb70d9b5277016c77a80201021d40a2247104d9f4aa7bab7157b7e3f05b84b
url: "https://pub.dev"
source: hosted
version: "1.1.1"
version: "1.1.2"
collection:
dependency: transitive
description:
name: collection
sha256: a1ace0a119f20aabc852d165077c036cd864315bd99b7eaa10a60100341941bf
sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76"
url: "https://pub.dev"
source: hosted
version: "1.19.0"
version: "1.19.1"
convert:
dependency: transitive
description:
Expand Down Expand Up @@ -128,10 +128,10 @@ packages:
dependency: transitive
description:
name: fake_async
sha256: "511392330127add0b769b75a987850d136345d9227c6b94c96a04cf4a391bf78"
sha256: "6a95e56b2449df2273fd8c45a662d6947ce1ebb7aafe80e550a3f68297f3cacc"
url: "https://pub.dev"
source: hosted
version: "1.3.1"
version: "1.3.2"
ffi:
dependency: transitive
description:
Expand Down Expand Up @@ -243,18 +243,18 @@ packages:
dependency: transitive
description:
name: leak_tracker
sha256: "7bb2830ebd849694d1ec25bf1f44582d6ac531a57a365a803a6034ff751d2d06"
sha256: c35baad643ba394b40aac41080300150a4f08fd0fd6a10378f8f7c6bc161acec
url: "https://pub.dev"
source: hosted
version: "10.0.7"
version: "10.0.8"
leak_tracker_flutter_testing:
dependency: transitive
description:
name: leak_tracker_flutter_testing
sha256: "9491a714cca3667b60b5c420da8217e6de0d1ba7a5ec322fab01758f6998f379"
sha256: f8b613e7e6a13ec79cfdc0e97638fddb3ab848452eff057653abd3edba760573
url: "https://pub.dev"
source: hosted
version: "3.0.8"
version: "3.0.9"
leak_tracker_testing:
dependency: transitive
description:
Expand Down Expand Up @@ -290,10 +290,10 @@ packages:
dependency: transitive
description:
name: matcher
sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
sha256: dc58c723c3c24bf8d3e2d3ad3f2f9d7bd9cf43ec6feaa64181775e60190153f2
url: "https://pub.dev"
source: hosted
version: "0.12.16+1"
version: "0.12.17"
material_color_utilities:
dependency: transitive
description:
Expand All @@ -306,10 +306,10 @@ packages:
dependency: transitive
description:
name: meta
sha256: bdb68674043280c3428e9ec998512fb681678676b3c54e773629ffe74419f8c7
sha256: e3641ec5d63ebf0d9b41bd43201a66e3fc79a65db5f61fc181f04cd27aab950c
url: "https://pub.dev"
source: hosted
version: "1.15.0"
version: "1.16.0"
mime:
dependency: transitive
description:
Expand Down Expand Up @@ -362,10 +362,10 @@ packages:
dependency: transitive
description:
name: path
sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
sha256: "75cca69d1490965be98c73ceaea117e8a04dd21217b37b292c9ddbec0d955bc5"
url: "https://pub.dev"
source: hosted
version: "1.9.0"
version: "1.9.1"
path_provider_linux:
dependency: transitive
description:
Expand Down Expand Up @@ -551,66 +551,66 @@ packages:
dependency: transitive
description:
name: source_span
sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c"
sha256: "254ee5351d6cb365c859e20ee823c3bb479bf4a293c22d17a9f1bf144ce86f7c"
url: "https://pub.dev"
source: hosted
version: "1.10.0"
version: "1.10.1"
stack_trace:
dependency: transitive
description:
name: stack_trace
sha256: "9f47fd3630d76be3ab26f0ee06d213679aa425996925ff3feffdec504931c377"
sha256: "8b27215b45d22309b5cddda1aa2b19bdfec9df0e765f2de506401c071d38d1b1"
url: "https://pub.dev"
source: hosted
version: "1.12.0"
version: "1.12.1"
stream_channel:
dependency: transitive
description:
name: stream_channel
sha256: ba2aa5d8cc609d96bbb2899c28934f9e1af5cddbd60a827822ea467161eb54e7
sha256: "969e04c80b8bcdf826f8f16579c7b14d780458bd97f56d107d3950fdbeef059d"
url: "https://pub.dev"
source: hosted
version: "2.1.2"
version: "2.1.4"
string_scanner:
dependency: transitive
description:
name: string_scanner
sha256: "688af5ed3402a4bde5b3a6c15fd768dbf2621a614950b17f04626c431ab3c4c3"
sha256: "921cd31725b72fe181906c6a94d987c78e3b98c2e205b397ea399d4054872b43"
url: "https://pub.dev"
source: hosted
version: "1.3.0"
version: "1.4.1"
term_glyph:
dependency: transitive
description:
name: term_glyph
sha256: a29248a84fbb7c79282b40b8c72a1209db169a2e0542bce341da992fe1bc7e84
sha256: "7f554798625ea768a7518313e58f83891c7f5024f88e46e7182a4558850a4b8e"
url: "https://pub.dev"
source: hosted
version: "1.2.1"
version: "1.2.2"
test:
dependency: transitive
description:
name: test
sha256: "713a8789d62f3233c46b4a90b174737b2c04cb6ae4500f2aa8b1be8f03f5e67f"
sha256: "301b213cd241ca982e9ba50266bd3f5bd1ea33f1455554c5abb85d1be0e2d87e"
url: "https://pub.dev"
source: hosted
version: "1.25.8"
version: "1.25.15"
test_api:
dependency: transitive
description:
name: test_api
sha256: "664d3a9a64782fcdeb83ce9c6b39e78fd2971d4e37827b9b06c3aa1edc5e760c"
sha256: fb31f383e2ee25fbbfe06b40fe21e1e458d14080e3c67e7ba0acfde4df4e0bbd
url: "https://pub.dev"
source: hosted
version: "0.7.3"
version: "0.7.4"
test_core:
dependency: transitive
description:
name: test_core
sha256: "12391302411737c176b0b5d6491f466b0dd56d4763e347b6714efbaa74d7953d"
sha256: "84d17c3486c8dfdbe5e12a50c8ae176d15e2a771b96909a9442b40173649ccaa"
url: "https://pub.dev"
source: hosted
version: "0.6.5"
version: "0.6.8"
todos_api:
dependency: "direct main"
description:
Expand Down Expand Up @@ -653,10 +653,10 @@ packages:
dependency: transitive
description:
name: vm_service
sha256: f6be3ed8bd01289b34d679c2b62226f63c0e69f9fd2e50a6b3c1c729a961041b
sha256: "0968250880a6c5fe7edc067ed0a13d4bae1577fe2771dcf3010d52c4a9d3ca14"
url: "https://pub.dev"
source: hosted
version: "14.3.0"
version: "14.3.1"
watcher:
dependency: transitive
description:
Expand Down Expand Up @@ -714,5 +714,5 @@ packages:
source: hosted
version: "3.1.3"
sdks:
dart: ">=3.6.0 <4.0.0"
dart: ">=3.7.0-0 <4.0.0"
flutter: ">=3.24.0"
2 changes: 1 addition & 1 deletion examples/flutter_todos/test/app_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ void main() {
group('App', () {
testWidgets('renders AppView', (tester) async {
await tester.pumpWidget(
App(todosRepository: todosRepository),
App(createTodosRepository: () => todosRepository),
);

expect(find.byType(AppView), findsOneWidget);
Expand Down
15 changes: 8 additions & 7 deletions examples/flutter_weather/lib/app.dart
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,17 @@ import 'package:weather_repository/weather_repository.dart'
show WeatherRepository;

class WeatherApp extends StatelessWidget {
const WeatherApp({required WeatherRepository weatherRepository, super.key})
: _weatherRepository = weatherRepository;

final WeatherRepository _weatherRepository;
const WeatherApp({super.key});

@override
Widget build(BuildContext context) {
return BlocProvider(
create: (_) => WeatherCubit(_weatherRepository),
child: const WeatherAppView(),
return RepositoryProvider(
create: (_) => WeatherRepository(),
dispose: (repository) => repository.dispose(),
child: BlocProvider(
create: (context) => WeatherCubit(context.read<WeatherRepository>()),
child: const WeatherAppView(),
),
);
}
}
Expand Down
3 changes: 1 addition & 2 deletions examples/flutter_weather/lib/main.dart
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import 'package:flutter_weather/app.dart';
import 'package:flutter_weather/weather_bloc_observer.dart';
import 'package:hydrated_bloc/hydrated_bloc.dart';
import 'package:path_provider/path_provider.dart';
import 'package:weather_repository/weather_repository.dart';

void main() async {
WidgetsFlutterBinding.ensureInitialized();
Expand All @@ -14,5 +13,5 @@ void main() async {
? HydratedStorageDirectory.web
: HydratedStorageDirectory((await getTemporaryDirectory()).path),
);
runApp(WeatherApp(weatherRepository: WeatherRepository()));
runApp(WeatherApp());
}
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,9 @@ class OpenMeteoApiClient {

return Weather.fromJson(weatherJson);
}

/// Closes the underlying http client.
void close() {
_httpClient.close();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -198,5 +198,12 @@ void main() {
);
});
});

group('close', () {
test('closes the underlying http client', () {
apiClient.close();
verify(httpClient.close).called(1);
});
});
});
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ class WeatherRepository {
condition: weather.weatherCode.toInt().toCondition,
);
}

void dispose() {
_weatherApiClient.close();
}
}

extension on int {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -228,5 +228,12 @@ void main() {
);
});
});

group('dispose', () {
test('closes the weather api client', () {
weatherRepository.dispose();
verify(weatherApiClient.close).called(1);
});
});
});
}
Loading

0 comments on commit 24e6f0e

Please sign in to comment.