doc(arch): add fully featured example

2022-11-08 20:09:18 -05:00
parent db67491876
commit 6602db215f
109 changed files with 4499 additions and 29 deletions
@@ -0,0 +1,31 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:architecture_example/domain/entities/photo.dart';
+import 'package:architecture_example/domain/repositories/photo_repository.dart';
+import 'package:wyatt_architecture/wyatt_architecture.dart';
+
+class AddPhotoToFavorites extends UseCase<Photo, List<Photo>> {
+  final PhotoRepository _photoRepository;
+
+  AddPhotoToFavorites(this._photoRepository);
+
+  @override
+  FutureResult<List<Photo>> call(Photo params) async {
+    await _photoRepository.addPhotoToFavorites(params);
+    return _photoRepository.getAllPhotosFromFavorites();
+  }
+}
@@ -0,0 +1,28 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:architecture_example/domain/repositories/photo_repository.dart';
+import 'package:wyatt_architecture/wyatt_architecture.dart';
+
+class CheckIfPhotoIsInFavorites extends UseCase<int, bool> {
+  final PhotoRepository _photoRepository;
+
+  CheckIfPhotoIsInFavorites(this._photoRepository);
+
+  @override
+  FutureResult<bool> call(int params) async =>
+      _photoRepository.checkIfPhotoIsInFavorites(params);
+}
@@ -0,0 +1,31 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+// 
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:architecture_example/domain/entities/photo.dart';
+import 'package:architecture_example/domain/repositories/photo_repository.dart';
+import 'package:wyatt_architecture/wyatt_architecture.dart';
+
+class DisplayFavorites extends UseCase<void, List<Photo>> {
+  final PhotoRepository _photoRepository;
+
+  DisplayFavorites(this._photoRepository);
+
+  @override
+  FutureResult<List<Photo>> call(void params) {
+    final photos = _photoRepository.getAllPhotosFromFavorites();
+    return photos;
+  }
+}
@@ -0,0 +1,31 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:architecture_example/domain/entities/photo.dart';
+import 'package:architecture_example/domain/repositories/photo_repository.dart';
+import 'package:wyatt_architecture/wyatt_architecture.dart';
+
+class DisplayPhoto extends UseCase<int, Photo> {
+  final PhotoRepository _photoRepository;
+
+  DisplayPhoto(this._photoRepository);
+
+  @override
+  FutureResult<Photo> call(int params) {
+    final photo = _photoRepository.getPhoto(params);
+    return photo;
+  }
+}
@@ -0,0 +1,37 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:architecture_example/domain/entities/photo.dart';
+import 'package:architecture_example/domain/repositories/photo_repository.dart';
+import 'package:architecture_example/domain/usecases/photos/params/query_parameters.dart';
+import 'package:wyatt_architecture/wyatt_architecture.dart';
+
+class OpenAlbum extends UseCase<QueryParameters, List<Photo>> {
+  final PhotoRepository _photoRepository;
+
+  OpenAlbum(this._photoRepository);
+
+  @override
+  FutureResult<List<Photo>> call(QueryParameters params) {
+    final photos = _photoRepository.getPhotosFromAlbum(
+      params.albumId,
+      start: params.start,
+      limit: params.limit,
+    );
+
+    return photos;
+  }
+}
@@ -0,0 +1,23 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+class QueryParameters {
+  final int albumId;
+  final int? start;
+  final int? limit;
+
+  QueryParameters(this.start, this.limit, {this.albumId = -1});
+}
@@ -0,0 +1,31 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:architecture_example/domain/entities/photo.dart';
+import 'package:architecture_example/domain/repositories/photo_repository.dart';
+import 'package:wyatt_architecture/wyatt_architecture.dart';
+
+class RemovePhotoFromFavorites extends UseCase<int, List<Photo>> {
+  final PhotoRepository _photoRepository;
+
+  RemovePhotoFromFavorites(this._photoRepository);
+
+  @override
+  FutureResult<List<Photo>> call(int params) async {
+    await _photoRepository.deletePhotoFromFavorites(params);
+    return _photoRepository.getAllPhotosFromFavorites();
+  }
+}
@@ -0,0 +1,35 @@
+// Copyright (C) 2022 WYATT GROUP
+// Please see the AUTHORS file for details.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+import 'package:architecture_example/domain/entities/album.dart';
+import 'package:architecture_example/domain/repositories/photo_repository.dart';
+import 'package:architecture_example/domain/usecases/photos/params/query_parameters.dart';
+import 'package:wyatt_architecture/wyatt_architecture.dart';
+
+class RetrieveAllAlbums extends UseCase<QueryParameters, List<Album>> {
+  final PhotoRepository _photoRepository;
+
+  RetrieveAllAlbums(this._photoRepository);
+
+  @override
+  FutureResult<List<Album>> call(QueryParameters params) {
+    final albums = _photoRepository.getAllAlbums(
+      start: params.start,
+      limit: params.limit,
+    );
+    return albums;
+  }
+}