Compare commits
22 Commits
wyatt_bloc
...
master
Author | SHA1 | Date | |
---|---|---|---|
0a3f0094c4 | |||
6fd18e7aca | |||
d69106adeb | |||
cca7b29a6d | |||
283bf80243 | |||
d217a202cb | |||
48c5215c70 | |||
dc9ce095b4 | |||
3cebc34e46 | |||
3706ab8f1c | |||
995e122c1b | |||
1492745e54 | |||
08218f7080 | |||
59bca9045e | |||
41382aad2f | |||
7785f3f117 | |||
e030375fec | |||
375bb8f04a | |||
1cadba5cd5 | |||
75340f1b5a | |||
78456c01a6 | |||
45458e7784 |
36
CHANGELOG.md
36
CHANGELOG.md
@ -3,6 +3,42 @@
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
## 2023-11-18
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_bloc_helper` - `v2.0.2`](#wyatt_bloc_helper---v202)
|
||||
- [`wyatt_bloc_layout` - `v0.1.2+5`](#wyatt_bloc_layout---v0125)
|
||||
- [`wyatt_cloud_messaging_bloc_base` - `v0.1.1+3`](#wyatt_cloud_messaging_bloc_base---v0113)
|
||||
- [`wyatt_i18n` - `v2.0.2`](#wyatt_i18n---v202)
|
||||
- [`wyatt_ui_kit` - `v3.2.4`](#wyatt_ui_kit---v324)
|
||||
- [`wyatt_cloud_messaging_bloc_firebase` - `v0.1.0+3`](#wyatt_cloud_messaging_bloc_firebase---v0103)
|
||||
|
||||
Packages with dependency updates only:
|
||||
|
||||
> Packages listed below depend on other packages in this workspace that have had changes. Their versions have been incremented to bump the minimum dependency versions of the packages they depend upon in this project.
|
||||
|
||||
- `wyatt_bloc_layout` - `v0.1.2+5`
|
||||
- `wyatt_cloud_messaging_bloc_base` - `v0.1.1+3`
|
||||
- `wyatt_i18n` - `v2.0.2`
|
||||
- `wyatt_ui_kit` - `v3.2.4`
|
||||
- `wyatt_cloud_messaging_bloc_firebase` - `v0.1.0+3`
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_bloc_helper` - `v2.0.2`
|
||||
|
||||
- **FIX**: compilation issue with flutter 3.16.0 and generics name.
|
||||
|
||||
|
||||
## 2023-11-14
|
||||
|
||||
### Changes
|
||||
|
81
README.md
81
README.md
@ -36,23 +36,23 @@
|
||||
|
||||
<!-- code_chunk_output -->
|
||||
|
||||
* [About](#about)
|
||||
* [Contribution](#contribution)
|
||||
+ [Prerequisite](#prerequisite)
|
||||
+ [Create a new package](#create-a-new-package)
|
||||
- [About](#about)
|
||||
- [Usage](#usage)
|
||||
- [Contribution](#contribution)
|
||||
- [Prerequisite](#prerequisite)
|
||||
- [Create a new package](#create-a-new-package)
|
||||
- [Naming](#naming)
|
||||
+ [Create issues](#create-issues)
|
||||
+ [Branches](#branches)
|
||||
+ [Commits](#commits)
|
||||
- [Create issues](#create-issues)
|
||||
- [Branches](#branches)
|
||||
- [Commits](#commits)
|
||||
- [Before pushing](#before-pushing)
|
||||
+ [Merge your work](#merge-your-work)
|
||||
+ [Update version.](#update-version)
|
||||
+ [Publish your package](#publish-your-package)
|
||||
+ [Badging](#badging)
|
||||
* [Usage](#usage)
|
||||
* [Simple work flow diagramm](#simple-work-flow-diagramm)
|
||||
* [Status](#status)
|
||||
* [License](#license)
|
||||
- [Merge your work](#merge-your-work)
|
||||
- [Update version.](#update-version)
|
||||
- [Publish your package](#publish-your-package)
|
||||
- [Badging](#badging)
|
||||
- [Simple work flow diagramm](#simple-work-flow-diagramm)
|
||||
- [Status](#status)
|
||||
- [License](#license)
|
||||
|
||||
<!-- /code_chunk_output -->
|
||||
|
||||
@ -68,6 +68,21 @@ Those packages are developed by [Wyatt Studio](https://wyatt-studio.fr) and are
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
You can add any package of the `packages/` sub directory in your project.
|
||||
|
||||
```yaml
|
||||
dependencies:
|
||||
wyatt_analysis:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
version: ^2.4.1
|
||||
```
|
||||
|
||||
> You can also use the `git` protocol. But it's not recommended since it's not handle version constraints.
|
||||
|
||||
---
|
||||
|
||||
## Contribution
|
||||
|
||||
Clone this repo.
|
||||
@ -109,12 +124,17 @@ Create a new package in `packages/` folder.
|
||||
To create a new package in the packages/ folder, run the following command in the terminal:
|
||||
|
||||
```shell
|
||||
mason make wyatt_package_template --package_name <name> --description A new Wyatt package --flutter false
|
||||
mason upgrade
|
||||
mason make wyatt_package_template \
|
||||
--package_name <name> \
|
||||
--description A new Wyatt package \
|
||||
--flutter false
|
||||
-o packages/<name>
|
||||
```
|
||||
|
||||
> Browse our [bricks](https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-bricks) for more information.
|
||||
|
||||
The <name> variable in the above command is important and must be clear and understandable.
|
||||
The `<name>` variable in the above command is important and must be clear and understandable. (see [Naming](#naming))
|
||||
|
||||
After creating the package, bootstrap the project with the `melos bs` command.
|
||||
|
||||
@ -129,7 +149,7 @@ It have to be clear and intelligible.
|
||||
For example, if the name is `CRUD BLOC` the following naming conventions should be used:
|
||||
|
||||
1. package name: `wyatt_crud_bloc`
|
||||
2. example name: `example`
|
||||
2. example name: `wyatt_crud_bloc_example`
|
||||
|
||||
### Create issues
|
||||
|
||||
@ -141,7 +161,9 @@ For example, if you want to work on the `i18n` package, you should create an iss
|
||||
|
||||
The `master` branch is protected and cannot be pushed to directly. Please create a separate branch for each feature or task, with a name that corresponds to the related issue. The branch name should follow this format:
|
||||
|
||||
`scope/type/short-name`
|
||||
```text
|
||||
scope/type/short-name
|
||||
```
|
||||
|
||||
For example, if you are working on the `i18n` package and you want to add a new feature, you should create a branch named `i18n/feat/add-new-feature` .
|
||||
|
||||
@ -172,9 +194,9 @@ Some examples :
|
||||
* `docs: update readme.` = update **this** readme file.
|
||||
* `fix(crud)!: fix bug in awesome() function. (closes #32)` = fix a bug, `!` is important and indicate `BREAKING CHANGES` linked with the 32nd issue.
|
||||
|
||||
When you have completed your development work and are ready to resolve the related issue, you can close it via your commit message by including (closes #issue_number). For example:
|
||||
When you have completed your development work and are ready to resolve the related issue, you can close it via your commit message by including `(closes #issue_number)` . For example:
|
||||
|
||||
```shell
|
||||
```text
|
||||
feat(auth): add AWS support. (closes #31)
|
||||
```
|
||||
|
||||
@ -262,22 +284,7 @@ or
|
||||
|
||||
```
|
||||
|
||||
> Some packages requires Flutter, so please specify it.
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
You can add any package of the `packages/` sub directory in your project.
|
||||
|
||||
```yaml
|
||||
dependencies:
|
||||
wyatt_analysis:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
version: ^2.4.1
|
||||
```
|
||||
|
||||
> You can also use the `git` protocol. But it's not recommended since it's not handle version constraints.
|
||||
> **Warning** Some packages requires Flutter, so please specify it.
|
||||
|
||||
---
|
||||
|
||||
|
@ -1 +1 @@
|
||||
{"bricks":{"wyatt_component_template":{"git":{"url":"ssh://git@git.wyatt-studio.fr:993/Wyatt-FOSS/wyatt-bricks.git","path":"bricks/wyatt_component_template","ref":"7cea909470ce75b91840f479649b93f953ded596"}}}}
|
||||
{"bricks":{"wyatt_component_template":{"git":{"url":"ssh://git@git.wyatt-studio.fr:993/Wyatt-FOSS/wyatt-bricks.git","path":"bricks/wyatt_component_template","ref":"1f3807adb548a7d65ead7f19e8b743462cb6be22"}},"wyatt_package_template":{"git":{"url":"ssh://git@git.wyatt-studio.fr:993/Wyatt-FOSS/wyatt-bricks.git","path":"bricks/wyatt_package_template","ref":"1f3807adb548a7d65ead7f19e8b743462cb6be22"}}}}
|
28
melos.yaml
28
melos.yaml
@ -1,10 +1,13 @@
|
||||
name: Wyatt-Packages
|
||||
# repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||
|
||||
sdkPath: auto
|
||||
|
||||
packages:
|
||||
- packages/**
|
||||
- "packages/**"
|
||||
|
||||
ignore:
|
||||
- "packages/**/example"
|
||||
- "packages/**/.dart_tool/**"
|
||||
|
||||
sdkPath: auto
|
||||
|
||||
ide:
|
||||
intellij:
|
||||
@ -16,7 +19,6 @@ command:
|
||||
linkToCommits: false # Gitea not yet supported
|
||||
workspaceChangelog: true
|
||||
includeCommitId: false # Generate error in Melos 3...
|
||||
branch: master
|
||||
message: |
|
||||
chore(release): publish packages
|
||||
|
||||
@ -27,11 +29,6 @@ command:
|
||||
post: melos exec --flutter --concurrency=3 -- "flutter clean"
|
||||
|
||||
scripts:
|
||||
analyze:
|
||||
run: |
|
||||
melos exec --flutter --concurrency=1 -- flutter analyze --fatal-infos
|
||||
description: Run `flutter analyze` for all flutter packages.
|
||||
|
||||
fix:apply:
|
||||
run: melos exec --concurrency=1 -- dart fix . --apply
|
||||
description: Run and apply `dart fix` for all packages.
|
||||
@ -40,14 +37,6 @@ scripts:
|
||||
run: melos exec --concurrency=1 -- dart fix . --set-exit-if-changed
|
||||
description: Run `dart fix` checks for all packages.
|
||||
|
||||
format:
|
||||
run: melos exec --concurrency=1 -- dart format .
|
||||
description: Run `dart format` for all packages.
|
||||
|
||||
lint:all:
|
||||
run: melos run analyze && melos run format
|
||||
description: Run all static analysis checks.
|
||||
|
||||
clean:deep:
|
||||
run: git clean -x -d -f -q
|
||||
description: Clean things very deeply with `git clean`.
|
||||
@ -101,6 +90,3 @@ scripts:
|
||||
description: |
|
||||
Validate that all packages are ready to be published.
|
||||
Note: This will not actually publish anything.
|
||||
|
||||
# publish:
|
||||
# run: melos publish --diff="origin/$DRONE_COMMIT_BRANCH...HEAD" --no-dry-run --yes
|
||||
|
@ -50,10 +50,10 @@ class Photo extends Entity {
|
||||
}
|
||||
```
|
||||
|
||||
Then create the data sources by extending `BaseLocalDataSource` or `BaseRemoteDataSource` depending the type of data source.
|
||||
Then create the data sources by extending `BaseDataSource` :
|
||||
|
||||
```dart
|
||||
abstract class PhotoRemoteDataSource extends BaseRemoteDataSource {
|
||||
abstract class PhotoRemoteDataSource extends BaseDataSource {
|
||||
Future<Photo> getPhoto(int id);
|
||||
Future<List<Photo>> getAllPhotos({int? start, int? limit});
|
||||
}
|
||||
@ -78,14 +78,31 @@ Several use cases are supported :
|
||||
* Classic usecase :
|
||||
|
||||
```dart
|
||||
class Test extends AsyncUseCase<QueryParameters, List<Photo>>> {
|
||||
class RetrieveAllAlbums extends AsyncUseCase<QueryParameters, List<Album>> {
|
||||
const RetrieveAllAlbums(this._photoRepository);
|
||||
final PhotoRepository _photoRepository;
|
||||
|
||||
@override
|
||||
FuturOrResult<List<Photo>>> call(QueryParameters? params) {
|
||||
final photos = _photoRepository.getAllPhotos(
|
||||
FutureOrResult<List<Album>> execute(QueryParameters params) {
|
||||
final albums = _photoRepository.getAllAlbums(
|
||||
start: params.start,
|
||||
limit: params.limit,
|
||||
);
|
||||
return albums;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
* No parameter usecase :
|
||||
|
||||
```dart
|
||||
class DisplayFavorites extends NoParamsAsyncUseCase<List<Photo>> {
|
||||
const DisplayFavorites(this._photoRepository);
|
||||
final PhotoRepository _photoRepository;
|
||||
|
||||
@override
|
||||
FutureOrResult<List<Photo>> execute() {
|
||||
final photos = _photoRepository.getAllPhotosFromFavorites();
|
||||
return photos;
|
||||
}
|
||||
}
|
||||
@ -94,48 +111,51 @@ class Test extends AsyncUseCase<QueryParameters, List<Photo>>> {
|
||||
You can add alternatve scenarios and check pre/post conditions using our extensions :
|
||||
|
||||
```dart
|
||||
class SearchPhotos extends AsyncUseCase<QueryParameters, List<Photo>>> {
|
||||
class RetrieveAllAlbums extends AsyncUseCase<QueryParameters, List<Album>> {
|
||||
const RetrieveAllAlbums(this._photoRepository);
|
||||
final PhotoRepository _photoRepository;
|
||||
|
||||
@override
|
||||
FutureOrResult<List<Photo>>> call(QueryParameters? params) {
|
||||
final photos = _photoRepository.getAllPhotos(
|
||||
FutureOrResult<List<Album>> execute(QueryParameters params) {
|
||||
final albums = _photoRepository.getAllAlbums(
|
||||
start: params.start,
|
||||
limit: params.limit,
|
||||
);
|
||||
return photos;
|
||||
return albums;
|
||||
}
|
||||
|
||||
@override
|
||||
FutureOr<void> onStart(QueryParameters? params) {
|
||||
if(params.start == null || params.limit == null){
|
||||
throw ClientException('Préconndition non valides');
|
||||
if (params.start < 0) {
|
||||
throw const ClientException('Invalid start parameter');
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
```
|
||||
|
||||
You can implement error scenarios overriding `onError` , or check postconditions by overriding `onComplete` .
|
||||
You can implement error scenarios overriding `onException` , or check postconditions by overriding `onComplete` .
|
||||
|
||||
* Stream usecase :
|
||||
|
||||
```dart
|
||||
class SearchPhotos extends StreamUseCase<QueryParameters, List<Photo>>> {
|
||||
class RetrieveAllAlbums extends AsyncUseCase<QueryParameters, List<Album>> {
|
||||
const RetrieveAllAlbums(this._photoRepository);
|
||||
final PhotoRepository _photoRepository;
|
||||
|
||||
@override
|
||||
FutureOrResult<Stream<List<Photo>>>> call(QueryParameters? params) {
|
||||
final photos = _photoRepository.getAllPhotos(
|
||||
FutureOrResult<List<Album>> execute(QueryParameters params) {
|
||||
final albums = _photoRepository.getAllAlbums(
|
||||
start: params.start,
|
||||
limit: params.limit,
|
||||
);
|
||||
return photos;
|
||||
return albums;
|
||||
}
|
||||
|
||||
@override
|
||||
FutureOrResult<List<Album>> onException(Object e) => Ok([]);
|
||||
}
|
||||
```
|
||||
|
||||
On this case, observers allow you to add alternative scenarios when data changed, overriding `onData` or `onDone` .
|
||||
|
||||
Please note that to use handlers, call `call` method and not `execute` .
|
||||
|
||||
> In fact, here we need a new parameter object, so let's create it:
|
||||
|
@ -88,8 +88,8 @@ class PhotoRepositoryImpl extends PhotoRepository {
|
||||
}
|
||||
return Ok(response);
|
||||
} catch (_) {
|
||||
return const Err(
|
||||
ClientException('Cannot retrieve all photos from favorites.'),
|
||||
return Err(
|
||||
const ClientException('Cannot retrieve all photos from favorites.'),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
@ -17,7 +17,7 @@
|
||||
import 'package:architecture_example/domain/entities/photo.dart';
|
||||
import 'package:wyatt_architecture/wyatt_architecture.dart';
|
||||
|
||||
abstract class FavoriteLocalDataSource extends BaseLocalDataSource {
|
||||
abstract class FavoriteLocalDataSource extends BaseDataSource {
|
||||
Future<void> addPhotoToFavorites(Photo photo);
|
||||
Future<void> deletePhotoFromFavorites(int id);
|
||||
Future<List<int>> getAllPhotosFromFavorites();
|
||||
|
@ -17,7 +17,7 @@
|
||||
import 'package:architecture_example/domain/entities/album.dart';
|
||||
import 'package:wyatt_architecture/wyatt_architecture.dart';
|
||||
|
||||
abstract class AlbumRemoteDataSource extends BaseRemoteDataSource {
|
||||
abstract class AlbumRemoteDataSource extends BaseDataSource {
|
||||
Future<Album> getAlbum(int id);
|
||||
Future<List<Album>> getAllAlbums({int? start, int? limit});
|
||||
}
|
||||
|
@ -17,7 +17,7 @@
|
||||
import 'package:architecture_example/domain/entities/photo.dart';
|
||||
import 'package:wyatt_architecture/wyatt_architecture.dart';
|
||||
|
||||
abstract class PhotoRemoteDataSource extends BaseRemoteDataSource {
|
||||
abstract class PhotoRemoteDataSource extends BaseDataSource {
|
||||
Future<Photo> getPhoto(int id);
|
||||
Future<List<Photo>> getAllPhotos({int? start, int? limit});
|
||||
Future<List<Photo>> getPhotosFromAlbum(int albumId, {int? start, int? limit});
|
||||
|
@ -14,26 +14,17 @@
|
||||
// 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 'dart:async';
|
||||
|
||||
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 AsyncUseCase<Photo, List<Photo>> {
|
||||
AddPhotoToFavorites(this._photoRepository);
|
||||
const AddPhotoToFavorites(this._photoRepository);
|
||||
final PhotoRepository _photoRepository;
|
||||
|
||||
@override
|
||||
FutureOrResult<List<Photo>> execute(Photo? params) async {
|
||||
await _photoRepository.addPhotoToFavorites(params!);
|
||||
FutureOrResult<List<Photo>> execute(Photo params) async {
|
||||
await _photoRepository.addPhotoToFavorites(params);
|
||||
return _photoRepository.getAllPhotosFromFavorites();
|
||||
}
|
||||
|
||||
@override
|
||||
FutureOr<void> onStart(Photo? params) {
|
||||
if (params == null) {
|
||||
throw const ClientException('Photo cannot be null');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -14,23 +14,14 @@
|
||||
// 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 'dart:async';
|
||||
|
||||
import 'package:architecture_example/domain/repositories/photo_repository.dart';
|
||||
import 'package:wyatt_architecture/wyatt_architecture.dart';
|
||||
|
||||
class CheckIfPhotoIsInFavorites extends AsyncUseCase<int, bool> {
|
||||
CheckIfPhotoIsInFavorites(this._photoRepository);
|
||||
const CheckIfPhotoIsInFavorites(this._photoRepository);
|
||||
final PhotoRepository _photoRepository;
|
||||
|
||||
@override
|
||||
FutureOrResult<bool> execute(int? params) async =>
|
||||
_photoRepository.checkIfPhotoIsInFavorites(params!);
|
||||
|
||||
@override
|
||||
FutureOr<void> onStart(int? params) {
|
||||
if (params == null) {
|
||||
throw const ClientException('id cannot be null');
|
||||
}
|
||||
}
|
||||
FutureOrResult<bool> execute(int params) async =>
|
||||
_photoRepository.checkIfPhotoIsInFavorites(params);
|
||||
}
|
||||
|
@ -18,12 +18,12 @@ 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 AsyncUseCase<NoParam, List<Photo>> {
|
||||
DisplayFavorites(this._photoRepository);
|
||||
class DisplayFavorites extends NoParamsAsyncUseCase<List<Photo>> {
|
||||
const DisplayFavorites(this._photoRepository);
|
||||
final PhotoRepository _photoRepository;
|
||||
|
||||
@override
|
||||
FutureOrResult<List<Photo>> execute(void params) {
|
||||
FutureOrResult<List<Photo>> execute() {
|
||||
final photos = _photoRepository.getAllPhotosFromFavorites();
|
||||
return photos;
|
||||
}
|
||||
|
@ -14,26 +14,17 @@
|
||||
// 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 'dart:async';
|
||||
|
||||
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 AsyncUseCase<int, Photo> {
|
||||
DisplayPhoto(this._photoRepository);
|
||||
const DisplayPhoto(this._photoRepository);
|
||||
final PhotoRepository _photoRepository;
|
||||
|
||||
@override
|
||||
FutureOrResult<Photo> execute(int? params) {
|
||||
final photo = _photoRepository.getPhoto(params!);
|
||||
FutureOrResult<Photo> execute(int params) {
|
||||
final photo = _photoRepository.getPhoto(params);
|
||||
return photo;
|
||||
}
|
||||
|
||||
@override
|
||||
FutureOr<void> onStart(int? params) {
|
||||
if (params == null) {
|
||||
throw const ClientException('id cannot be null');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -14,32 +14,23 @@
|
||||
// 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 'dart:async';
|
||||
|
||||
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 AsyncUseCase<QueryParameters, List<Photo>> {
|
||||
OpenAlbum(this._photoRepository);
|
||||
const OpenAlbum(this._photoRepository);
|
||||
final PhotoRepository _photoRepository;
|
||||
|
||||
@override
|
||||
FutureOrResult<List<Photo>> execute(QueryParameters? params) {
|
||||
FutureOrResult<List<Photo>> execute(QueryParameters params) {
|
||||
final photos = _photoRepository.getPhotosFromAlbum(
|
||||
params!.albumId,
|
||||
params.albumId,
|
||||
start: params.start,
|
||||
limit: params.limit,
|
||||
);
|
||||
|
||||
return photos;
|
||||
}
|
||||
|
||||
@override
|
||||
FutureOr<void> onStart(QueryParameters? params) {
|
||||
if (params == null) {
|
||||
throw const ClientException('params cannot be null');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -14,26 +14,17 @@
|
||||
// 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 'dart:async';
|
||||
|
||||
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 AsyncUseCase<int, List<Photo>> {
|
||||
RemovePhotoFromFavorites(this._photoRepository);
|
||||
const RemovePhotoFromFavorites(this._photoRepository);
|
||||
final PhotoRepository _photoRepository;
|
||||
|
||||
@override
|
||||
FutureOrResult<List<Photo>> execute(int? params) async {
|
||||
await _photoRepository.deletePhotoFromFavorites(params!);
|
||||
FutureOrResult<List<Photo>> execute(int params) async {
|
||||
await _photoRepository.deletePhotoFromFavorites(params);
|
||||
return _photoRepository.getAllPhotosFromFavorites();
|
||||
}
|
||||
|
||||
@override
|
||||
FutureOr<void> onStart(int? params) {
|
||||
if (params == null) {
|
||||
throw const ClientException('id cannot be null');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -14,30 +14,21 @@
|
||||
// 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 'dart:async';
|
||||
|
||||
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 AsyncUseCase<QueryParameters, List<Album>> {
|
||||
RetrieveAllAlbums(this._photoRepository);
|
||||
const RetrieveAllAlbums(this._photoRepository);
|
||||
final PhotoRepository _photoRepository;
|
||||
|
||||
@override
|
||||
FutureOrResult<List<Album>> execute(QueryParameters? params) {
|
||||
FutureOrResult<List<Album>> execute(QueryParameters params) {
|
||||
final albums = _photoRepository.getAllAlbums(
|
||||
start: params!.start,
|
||||
start: params.start,
|
||||
limit: params.limit,
|
||||
);
|
||||
return albums;
|
||||
}
|
||||
|
||||
@override
|
||||
FutureOr<void> onStart(QueryParameters? params) {
|
||||
if (params == null) {
|
||||
throw const ClientException('params cannot be null');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -44,7 +44,7 @@ dependencies:
|
||||
|
||||
wyatt_bloc_helper:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
version: ^2.0.1
|
||||
version: ^2.0.2
|
||||
wyatt_http_client:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
version: ^2.0.1
|
||||
|
@ -15,3 +15,5 @@
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
export 'exceptions/exceptions.dart';
|
||||
export 'extensions/object_extension.dart';
|
||||
export 'mixins/observers.dart';
|
||||
|
@ -14,8 +14,6 @@
|
||||
// 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:wyatt_type_utils/wyatt_type_utils.dart';
|
||||
|
||||
/// {@template app_exception}
|
||||
/// [AppException] is a base class for all exceptions in the wyatt architecture.
|
||||
/// {@endtemplate}
|
||||
@ -27,7 +25,7 @@ abstract class AppException implements Exception {
|
||||
|
||||
@override
|
||||
String toString() {
|
||||
if (message.isNotNullOrEmpty) {
|
||||
if (message?.isNotEmpty ?? false) {
|
||||
return '$runtimeType: $message';
|
||||
} else {
|
||||
return '$runtimeType: An exception occured';
|
||||
|
@ -0,0 +1,23 @@
|
||||
// Copyright (C) 2024 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:wyatt_architecture/src/core/exceptions/exceptions.dart';
|
||||
|
||||
extension ObjectExtension on Object? {
|
||||
AppException toException() => this is AppException
|
||||
? this! as AppException
|
||||
: ClientException(this?.toString());
|
||||
}
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2024 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
@ -16,30 +16,26 @@
|
||||
|
||||
import 'dart:async';
|
||||
|
||||
import 'package:wyatt_architecture/wyatt_architecture.dart';
|
||||
import 'package:wyatt_architecture/src/core/exceptions/exceptions.dart';
|
||||
import 'package:wyatt_architecture/src/domain/usecase.dart';
|
||||
|
||||
/// Usecase observers
|
||||
mixin Observer<Parameters, ReturnType> {
|
||||
mixin Observer<I, O> {
|
||||
/// Called before usecase is runned.
|
||||
/// Useful to check the preconditions
|
||||
FutureOr<void> onStart(Parameters? params) {}
|
||||
|
||||
/// Called when error occures during main scenario
|
||||
/// Useful to run alternative scenario
|
||||
FutureOr<void> onError(AppException? error) {}
|
||||
FutureOr<void> onStart(I? params) {}
|
||||
}
|
||||
|
||||
/// Specific observer for classic usecase
|
||||
mixin AsyncObserver<ReturnType> {
|
||||
/// Called when usecase is completed
|
||||
FutureOr<void> onComplete(ReturnType? data) {}
|
||||
/// Exception observer
|
||||
mixin ExceptionObserver<O> {
|
||||
/// Called on error
|
||||
/// Useful to handle exceptions
|
||||
FutureOr<void> onError(AppException e) {}
|
||||
}
|
||||
|
||||
/// Specific observer for stream case usecase
|
||||
mixin StreamObserver<ReturnType> {
|
||||
/// Replaces the data event handler of this subscription.
|
||||
void onDone() {}
|
||||
|
||||
/// Replaces the done event handler of this subscription.
|
||||
void onData(ReturnType? data) {}
|
||||
/// Completer observer
|
||||
mixin CompleterObserver<O> {
|
||||
/// Called after usecase is runned.
|
||||
/// Useful to log the result
|
||||
FutureOr<void> onComplete(Res<O>? result) {}
|
||||
}
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2024 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
@ -1,20 +1,19 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2024 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/>.
|
||||
|
||||
export 'data_sources/data_sources.dart';
|
||||
export 'entities/entities.dart';
|
||||
export 'repositories/repositories.dart';
|
||||
export 'usecases/usecases.dart';
|
||||
export 'base_repository.dart';
|
||||
export 'entity.dart';
|
||||
export 'usecase.dart';
|
||||
|
153
packages/wyatt_architecture/lib/src/domain/usecase.dart
Normal file
153
packages/wyatt_architecture/lib/src/domain/usecase.dart
Normal file
@ -0,0 +1,153 @@
|
||||
// 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 'dart:async';
|
||||
|
||||
import 'package:generic_usecase/generic_usecase.dart' as generic;
|
||||
import 'package:wyatt_architecture/src/core/exceptions/exceptions.dart';
|
||||
import 'package:wyatt_architecture/src/core/extensions/object_extension.dart';
|
||||
import 'package:wyatt_architecture/src/core/mixins/observers.dart';
|
||||
import 'package:wyatt_type_utils/wyatt_type_utils.dart';
|
||||
|
||||
typedef Res<T> = Result<T, AppException>;
|
||||
typedef FutureOrResult<T> = FutureOr<Res<T>>;
|
||||
typedef StreamResult<T> = Stream<Res<T>>;
|
||||
|
||||
/// A wrapper around [Result] to make it easier to use with AppException.
|
||||
Future<Res<T>> unsafe<T>(FutureOr<T> Function() fn) =>
|
||||
Result.tryCatchAsync<T, AppException, Object>(
|
||||
() => Future.sync(fn),
|
||||
(e) => e.toException(),
|
||||
);
|
||||
|
||||
abstract class AsyncUseCase<I, O> extends generic.Usecase<I, Res<O>>
|
||||
with Observer<I, O>, ExceptionObserver<O>, CompleterObserver<O> {
|
||||
const AsyncUseCase() : super();
|
||||
|
||||
@override
|
||||
FutureOr<generic.ConditionsResult> checkPreconditions(I? params) async {
|
||||
try {
|
||||
await onStart(params);
|
||||
return generic.ConditionsResult(isValid: true);
|
||||
} catch (e) {
|
||||
return generic.ConditionsResult(isValid: false, message: e.toString());
|
||||
}
|
||||
}
|
||||
|
||||
@override
|
||||
FutureOr<generic.ConditionsResult> checkPostconditions(Res<O>? result) async {
|
||||
try {
|
||||
await onComplete(result);
|
||||
return generic.ConditionsResult(isValid: true);
|
||||
} catch (e) {
|
||||
return generic.ConditionsResult(isValid: false, message: e.toString());
|
||||
}
|
||||
}
|
||||
|
||||
@override
|
||||
FutureOrResult<O> onException(Object e) async {
|
||||
final exception = e.toException();
|
||||
await onError(exception);
|
||||
|
||||
return Err(exception);
|
||||
}
|
||||
}
|
||||
|
||||
abstract class NoParamsAsyncUseCase<O> extends generic.NoParamsUsecase<Res<O>>
|
||||
with ExceptionObserver<O>, CompleterObserver<O> {
|
||||
const NoParamsAsyncUseCase() : super();
|
||||
|
||||
@override
|
||||
FutureOr<generic.ConditionsResult> checkPostconditions(Res<O>? result) async {
|
||||
try {
|
||||
await onComplete(result);
|
||||
return generic.ConditionsResult(isValid: true);
|
||||
} catch (e) {
|
||||
return generic.ConditionsResult(isValid: false, message: e.toString());
|
||||
}
|
||||
}
|
||||
|
||||
@override
|
||||
FutureOrResult<O> onException(Object e) async {
|
||||
final exception = e.toException();
|
||||
await onError(exception);
|
||||
|
||||
return Err(exception);
|
||||
}
|
||||
}
|
||||
|
||||
abstract class StreamUseCase<I, O> extends generic.StreamUsecase<I, Res<O>>
|
||||
with Observer<I, O>, ExceptionObserver<O> {
|
||||
const StreamUseCase() : super();
|
||||
|
||||
@override
|
||||
FutureOr<generic.ConditionsResult> checkPreconditions(I? params) async {
|
||||
try {
|
||||
await onStart(params);
|
||||
return generic.ConditionsResult(isValid: true);
|
||||
} catch (e) {
|
||||
return generic.ConditionsResult(isValid: false, message: e.toString());
|
||||
}
|
||||
}
|
||||
|
||||
StreamSubscription<Res<O>> listen(
|
||||
I params,
|
||||
void Function(Res<O>)? onData, {
|
||||
Function? onError,
|
||||
void Function()? onDone,
|
||||
bool? cancelOnError,
|
||||
}) =>
|
||||
super.call(params).listen(
|
||||
onData,
|
||||
onError: onError,
|
||||
onDone: onDone,
|
||||
cancelOnError: cancelOnError,
|
||||
);
|
||||
|
||||
@override
|
||||
FutureOrResult<O> onException(Object e) async {
|
||||
final exception = e.toException();
|
||||
await onError(exception);
|
||||
|
||||
return Err(exception);
|
||||
}
|
||||
}
|
||||
|
||||
abstract class NoParamsStreamUseCase<O>
|
||||
extends generic.NoParamsStreamUsecase<Res<O>> with ExceptionObserver<O> {
|
||||
const NoParamsStreamUseCase() : super();
|
||||
|
||||
StreamSubscription<Res<O>> listen(
|
||||
void Function(Res<O>)? onData, {
|
||||
Function? onError,
|
||||
void Function()? onDone,
|
||||
bool? cancelOnError,
|
||||
}) =>
|
||||
super.call().listen(
|
||||
onData,
|
||||
onError: onError,
|
||||
onDone: onDone,
|
||||
cancelOnError: cancelOnError,
|
||||
);
|
||||
|
||||
@override
|
||||
FutureOrResult<O> onException(Object e) async {
|
||||
final exception = e.toException();
|
||||
await onError(exception);
|
||||
|
||||
return Err(exception);
|
||||
}
|
||||
}
|
@ -1,100 +0,0 @@
|
||||
// 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 'dart:async';
|
||||
|
||||
import 'package:wyatt_architecture/src/core/exceptions/exceptions.dart';
|
||||
import 'package:wyatt_architecture/src/domain/usecases/observers.dart';
|
||||
import 'package:wyatt_type_utils/wyatt_type_utils.dart';
|
||||
|
||||
typedef FutureOrResult<T> = FutureOr<Result<T, AppException>>;
|
||||
typedef StreamResult<T> = Stream<Result<T, AppException>>;
|
||||
|
||||
/// {@template base_usecase}
|
||||
/// Abstract class of any use case.
|
||||
/// {@endtemplate}
|
||||
abstract class BaseUseCase<Parameters, ReturnType> {
|
||||
/// {@macro base_usecase}
|
||||
const BaseUseCase();
|
||||
|
||||
/// Run use case scenarios
|
||||
ReturnType call(Parameters parameters);
|
||||
|
||||
/// Private function to implement main scenario
|
||||
/// of your usecase.
|
||||
ReturnType execute(Parameters params);
|
||||
}
|
||||
|
||||
/// {@template usecase}
|
||||
/// Abstract class of a use case that deals specifically
|
||||
/// with the response and its state.
|
||||
/// {@endtemplate}
|
||||
abstract class UseCase<Parameters, ReturnType>
|
||||
extends BaseUseCase<Parameters?, FutureOrResult<ReturnType>>
|
||||
with Observer<Parameters, ReturnType> {
|
||||
/// {@macro usecase}
|
||||
const UseCase();
|
||||
|
||||
FutureOr<void> _onSuccess(ReturnType data);
|
||||
|
||||
/// Supports the result of the main scenario and integrates
|
||||
/// some alternative scenarios if necessary.
|
||||
@override
|
||||
FutureOrResult<ReturnType> call(Parameters? parameters) async {
|
||||
try {
|
||||
await onStart(parameters);
|
||||
final response = await execute(parameters);
|
||||
if (response.isErr) {
|
||||
await onError(response.err);
|
||||
} else if (response.isOk && response.ok != null) {
|
||||
await _onSuccess(response.ok as ReturnType);
|
||||
}
|
||||
return response;
|
||||
} catch (e) {
|
||||
return Err(ClientException(e.toString()));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// {@template async_usecase}
|
||||
/// Abtstract classic usecase bases on futures
|
||||
/// {@endtemplate}
|
||||
abstract class AsyncUseCase<Parameters, ReturnType>
|
||||
extends UseCase<Parameters?, ReturnType> with AsyncObserver<ReturnType> {
|
||||
/// {@macro async_usecase}
|
||||
const AsyncUseCase();
|
||||
|
||||
@override
|
||||
FutureOr<void> _onSuccess(ReturnType data) => onComplete(data);
|
||||
}
|
||||
|
||||
/// {@template stream_usecase}
|
||||
/// Abstract specific usecase bases on streams
|
||||
/// {@endtemplate}
|
||||
abstract class StreamUseCase<Parameters, ReturnType>
|
||||
extends UseCase<Parameters?, Stream<ReturnType>>
|
||||
with StreamObserver<ReturnType> {
|
||||
/// {@macro stream_usecase}
|
||||
const StreamUseCase();
|
||||
|
||||
@override
|
||||
FutureOr<void> _onSuccess(Stream<ReturnType> data) {
|
||||
data.listen(
|
||||
onData,
|
||||
onDone: onDone,
|
||||
);
|
||||
}
|
||||
}
|
@ -1,19 +0,0 @@
|
||||
// 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/>.
|
||||
|
||||
export 'no_param.dart';
|
||||
export 'observers.dart';
|
||||
export 'usecase.dart';
|
@ -15,4 +15,5 @@
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
export 'core/core.dart';
|
||||
export 'data/base_data_source.dart';
|
||||
export 'domain/domain.dart';
|
||||
|
@ -1,16 +1,16 @@
|
||||
# Copyright (C) 2023 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/>.
|
||||
|
||||
@ -22,9 +22,10 @@ version: 0.2.0+1
|
||||
publish_to: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
|
||||
environment:
|
||||
sdk: ">=2.17.0 <3.0.0"
|
||||
sdk: "^3.0.0"
|
||||
|
||||
dependencies:
|
||||
generic_usecase: ^3.0.0
|
||||
wyatt_type_utils:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
version: ^0.0.5
|
||||
@ -32,4 +33,4 @@ dependencies:
|
||||
dev_dependencies:
|
||||
wyatt_analysis:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
version: ^2.5.0
|
||||
version: ^2.6.1
|
||||
|
@ -27,34 +27,34 @@ class ExampleAuthenticationCubit extends AuthenticationCubit<int> {
|
||||
Result<Account, AppException> result) async {
|
||||
debugPrint('onReauthenticate');
|
||||
|
||||
return const Ok(1);
|
||||
return Ok(1);
|
||||
}
|
||||
|
||||
@override
|
||||
FutureOrResult<int?> onRefresh(Result<Account, AppException> result) {
|
||||
debugPrint('onRefresh');
|
||||
|
||||
return const Ok(1);
|
||||
return Ok(1);
|
||||
}
|
||||
|
||||
@override
|
||||
FutureOrResult<int?> onSignInFromCache(AuthenticationSession<int> session) {
|
||||
debugPrint('onSignInFromCache');
|
||||
|
||||
return const Ok(1);
|
||||
return Ok(1);
|
||||
}
|
||||
|
||||
@override
|
||||
FutureOrResult<void> onSignOut() {
|
||||
debugPrint('onSignOut');
|
||||
|
||||
return const Ok(null);
|
||||
return Ok(null);
|
||||
}
|
||||
|
||||
@override
|
||||
FutureOrResult<void> onDelete() {
|
||||
debugPrint('onDelete');
|
||||
|
||||
return const Ok(null);
|
||||
return Ok(null);
|
||||
}
|
||||
}
|
||||
|
@ -30,7 +30,7 @@ class ExampleSignInCubit extends SignInCubit<int> {
|
||||
Result<Account, AppException> result, WyattForm form) {
|
||||
debugPrint('onSignInWithEmailAndPassword: ${result.ok?.accessToken}');
|
||||
|
||||
return const Ok(1);
|
||||
return Ok(1);
|
||||
}
|
||||
|
||||
@override
|
||||
@ -38,7 +38,7 @@ class ExampleSignInCubit extends SignInCubit<int> {
|
||||
Result<Account, AppException> result, WyattForm form) {
|
||||
debugPrint('onSignInAnonymously');
|
||||
|
||||
return const Ok(1);
|
||||
return Ok(1);
|
||||
}
|
||||
|
||||
@override
|
||||
@ -46,6 +46,6 @@ class ExampleSignInCubit extends SignInCubit<int> {
|
||||
Result<Account, AppException> result, WyattForm form) {
|
||||
debugPrint('onSignInWithGoogle');
|
||||
|
||||
return const Ok(1);
|
||||
return Ok(1);
|
||||
}
|
||||
}
|
||||
|
@ -30,6 +30,6 @@ class ExampleSignUpCubit extends SignUpCubit<int> {
|
||||
Result<Account, AppException> result, WyattForm form) async {
|
||||
debugPrint('onSignUpWithEmailAndPassword');
|
||||
|
||||
return const Ok(1);
|
||||
return Ok(1);
|
||||
}
|
||||
}
|
||||
|
@ -28,7 +28,7 @@ class ExampleEditAccountCubit extends EditAccountCubit<int> {
|
||||
Result<Account, AppException> result, WyattForm form) async {
|
||||
debugPrint('onEmailUpdated');
|
||||
|
||||
return const Ok(1);
|
||||
return Ok(1);
|
||||
}
|
||||
|
||||
@override
|
||||
@ -36,6 +36,6 @@ class ExampleEditAccountCubit extends EditAccountCubit<int> {
|
||||
Result<Account, AppException> result, WyattForm form) async {
|
||||
debugPrint('onPasswordUpdated');
|
||||
|
||||
return const Ok(1);
|
||||
return Ok(1);
|
||||
}
|
||||
}
|
||||
|
@ -20,7 +20,7 @@ import 'package:wyatt_authentication_bloc/src/domain/entities/account.dart';
|
||||
/// {@template authentication_cache_data_source}
|
||||
/// A data source that manages the cache strategy.
|
||||
/// {@endtemplate}
|
||||
abstract class AuthenticationCacheDataSource<Data> extends BaseLocalDataSource {
|
||||
abstract class AuthenticationCacheDataSource<Data> extends BaseDataSource {
|
||||
/// {@macro authentication_cache_data_source}
|
||||
const AuthenticationCacheDataSource();
|
||||
|
||||
|
@ -20,8 +20,7 @@ import 'package:wyatt_authentication_bloc/wyatt_authentication_bloc.dart';
|
||||
/// {@template authentication_session_data_source}
|
||||
/// A data source that manages the current session.
|
||||
/// {@endtemplate}
|
||||
abstract class AuthenticationSessionDataSource<Data>
|
||||
extends BaseLocalDataSource {
|
||||
abstract class AuthenticationSessionDataSource<Data> extends BaseDataSource {
|
||||
/// {@macro authentication_session_data_source}
|
||||
const AuthenticationSessionDataSource();
|
||||
|
||||
|
@ -22,8 +22,7 @@ import 'package:wyatt_authentication_bloc/src/domain/entities/account.dart';
|
||||
/// It is responsible for all the external communication with the authentication
|
||||
/// providers.
|
||||
/// {@endtemplate}
|
||||
abstract class AuthenticationRemoteDataSource<Data>
|
||||
extends BaseRemoteDataSource {
|
||||
abstract class AuthenticationRemoteDataSource<Data> extends BaseDataSource {
|
||||
/// {@macro authentication_remote_data_source}
|
||||
const AuthenticationRemoteDataSource();
|
||||
|
||||
|
@ -43,12 +43,12 @@ class EditAccountCubit<Data> extends BaseEditAccountCubit<Data>
|
||||
Result<Account, AppException> result,
|
||||
WyattForm form,
|
||||
) =>
|
||||
const Ok(null);
|
||||
Ok(null);
|
||||
|
||||
@override
|
||||
FutureOrResult<Data?> onPasswordUpdated(
|
||||
Result<Account, AppException> result,
|
||||
WyattForm form,
|
||||
) =>
|
||||
const Ok(null);
|
||||
Ok(null);
|
||||
}
|
||||
|
@ -48,19 +48,19 @@ class SignInCubit<Data> extends BaseSignInCubit<Data>
|
||||
Result<Account, AppException> result,
|
||||
WyattForm form,
|
||||
) =>
|
||||
const Ok(null);
|
||||
Ok(null);
|
||||
|
||||
@override
|
||||
FutureOrResult<Data?> onSignInWithEmailAndPassword(
|
||||
Result<Account, AppException> result,
|
||||
WyattForm form,
|
||||
) =>
|
||||
const Ok(null);
|
||||
Ok(null);
|
||||
|
||||
@override
|
||||
FutureOrResult<Data?> onSignInWithGoogle(
|
||||
Result<Account, AppException> result,
|
||||
WyattForm form,
|
||||
) =>
|
||||
const Ok(null);
|
||||
Ok(null);
|
||||
}
|
||||
|
@ -43,5 +43,5 @@ class SignUpCubit<Data> extends BaseSignUpCubit<Data>
|
||||
Result<Account, AppException> result,
|
||||
WyattForm form,
|
||||
) =>
|
||||
const Ok(null);
|
||||
Ok(null);
|
||||
}
|
||||
|
@ -30,26 +30,26 @@ class TestAuthenticationCubit extends AuthenticationCubit<int> {
|
||||
TestAuthenticationCubit({required super.authenticationRepository});
|
||||
|
||||
@override
|
||||
FutureOrResult<void> onDelete() async => const Ok(null);
|
||||
FutureOrResult<void> onDelete() async => Ok(null);
|
||||
|
||||
@override
|
||||
FutureOrResult<int?> onReauthenticate(
|
||||
Result<Account, AppException> result,
|
||||
) async =>
|
||||
const Ok(null);
|
||||
Ok(null);
|
||||
|
||||
@override
|
||||
FutureOrResult<int?> onRefresh(Result<Account, AppException> result) async =>
|
||||
const Ok(null);
|
||||
Ok(null);
|
||||
|
||||
@override
|
||||
FutureOrResult<int?> onSignInFromCache(
|
||||
AuthenticationSession<int> session,
|
||||
) async =>
|
||||
const Ok(null);
|
||||
Ok(null);
|
||||
|
||||
@override
|
||||
FutureOrResult<void> onSignOut() async => const Ok(null);
|
||||
FutureOrResult<void> onSignOut() async => Ok(null);
|
||||
}
|
||||
|
||||
void main() {
|
||||
@ -92,7 +92,7 @@ void main() {
|
||||
build: () => TestAuthenticationCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
),
|
||||
seed: () => const AuthenticationState.unknown(),
|
||||
seed: AuthenticationState.unknown,
|
||||
expect: () => [AuthenticationState<int>.authenticated(session)],
|
||||
);
|
||||
|
||||
@ -108,7 +108,7 @@ void main() {
|
||||
build: () => TestAuthenticationCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
),
|
||||
seed: () => const AuthenticationState.unknown(),
|
||||
seed: AuthenticationState.unknown,
|
||||
expect: () => [const AuthenticationState<int>.unauthenticated()],
|
||||
);
|
||||
});
|
||||
@ -119,7 +119,7 @@ void main() {
|
||||
setUp: () {
|
||||
when(
|
||||
() => authenticationRepository.signOut(),
|
||||
).thenAnswer((_) async => const Ok(null));
|
||||
).thenAnswer((_) async => Ok(null));
|
||||
},
|
||||
build: () => TestAuthenticationCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
|
@ -84,7 +84,7 @@ void main() {
|
||||
'invokes sendEmailVerification,',
|
||||
setUp: () {
|
||||
when(() => authenticationRepository.sendEmailVerification())
|
||||
.thenAnswer((_) async => const Ok(null));
|
||||
.thenAnswer((_) async => Ok(null));
|
||||
},
|
||||
build: () => EmailVerificationCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
@ -100,12 +100,12 @@ void main() {
|
||||
'emits success',
|
||||
setUp: () {
|
||||
when(() => authenticationRepository.sendEmailVerification())
|
||||
.thenAnswer((_) async => const Ok(null));
|
||||
.thenAnswer((_) async => Ok(null));
|
||||
},
|
||||
build: () => EmailVerificationCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
),
|
||||
seed: () => const EmailVerificationState(),
|
||||
seed: EmailVerificationState.new,
|
||||
act: (cubit) => cubit.sendEmailVerification(),
|
||||
expect: () => [
|
||||
const EmailVerificationState(
|
||||
@ -121,12 +121,12 @@ void main() {
|
||||
'emits failure',
|
||||
setUp: () {
|
||||
when(() => authenticationRepository.sendEmailVerification())
|
||||
.thenAnswer((_) async => const Err(ServerException('erreur')));
|
||||
.thenAnswer((_) async => Err(const ServerException('erreur')));
|
||||
},
|
||||
build: () => EmailVerificationCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
),
|
||||
seed: () => const EmailVerificationState(),
|
||||
seed: EmailVerificationState.new,
|
||||
act: (cubit) => cubit.sendEmailVerification(),
|
||||
expect: () => [
|
||||
const EmailVerificationState(
|
||||
@ -183,7 +183,7 @@ void main() {
|
||||
build: () => EmailVerificationCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
),
|
||||
seed: () => const EmailVerificationState(),
|
||||
seed: EmailVerificationState.new,
|
||||
act: (cubit) => cubit.checkEmailVerification(),
|
||||
expect: () => [
|
||||
const EmailVerificationState(
|
||||
@ -206,7 +206,7 @@ void main() {
|
||||
build: () => EmailVerificationCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
),
|
||||
seed: () => const EmailVerificationState(),
|
||||
seed: EmailVerificationState.new,
|
||||
act: (cubit) => cubit.checkEmailVerification(),
|
||||
expect: () => [
|
||||
const EmailVerificationState(
|
||||
@ -222,12 +222,12 @@ void main() {
|
||||
'emits failure on refresh error',
|
||||
setUp: () {
|
||||
when(() => authenticationRepository.refresh())
|
||||
.thenAnswer((_) async => const Err(ServerException('erreur')));
|
||||
.thenAnswer((_) async => Err(const ServerException('erreur')));
|
||||
},
|
||||
build: () => EmailVerificationCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
),
|
||||
seed: () => const EmailVerificationState(),
|
||||
seed: EmailVerificationState.new,
|
||||
act: (cubit) => cubit.checkEmailVerification(),
|
||||
expect: () => [
|
||||
const EmailVerificationState(
|
||||
|
@ -57,7 +57,7 @@ void main() {
|
||||
() => authenticationRepository.sendPasswordResetEmail(
|
||||
email: any(named: 'email'),
|
||||
),
|
||||
).thenAnswer((_) async => const Ok(null));
|
||||
).thenAnswer((_) async => Ok(null));
|
||||
|
||||
when(
|
||||
() => authenticationRepository.formRepository,
|
||||
@ -157,7 +157,7 @@ void main() {
|
||||
authenticationRepository: authenticationRepository,
|
||||
),
|
||||
act: (cubit) => cubit.submit(),
|
||||
expect: () => const <PasswordResetState>[],
|
||||
expect: () => <PasswordResetState>[],
|
||||
);
|
||||
|
||||
blocTest<PasswordResetCubit<int>, PasswordResetState>(
|
||||
@ -272,7 +272,7 @@ void main() {
|
||||
() => authenticationRepository.sendPasswordResetEmail(
|
||||
email: any(named: 'email'),
|
||||
),
|
||||
).thenAnswer((_) async => const Err(ServerException()));
|
||||
).thenAnswer((_) async => Err(const ServerException()));
|
||||
when(
|
||||
() => formRepository.accessForm(AuthFormName.passwordResetForm),
|
||||
).thenAnswer(
|
||||
|
@ -435,7 +435,7 @@ void main() {
|
||||
email: any(named: 'email'),
|
||||
password: any(named: 'password'),
|
||||
),
|
||||
).thenAnswer((_) async => const Err(ServerException()));
|
||||
).thenAnswer((_) async => Err(const ServerException()));
|
||||
when(
|
||||
() => formRepository.accessForm(AuthFormName.signInForm),
|
||||
).thenAnswer(
|
||||
@ -615,7 +615,7 @@ void main() {
|
||||
setUp: () {
|
||||
when(
|
||||
() => authenticationRepository.signInAnonymously(),
|
||||
).thenAnswer((_) async => const Err(ServerException()));
|
||||
).thenAnswer((_) async => Err(const ServerException()));
|
||||
},
|
||||
build: () => SignInCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
|
@ -406,7 +406,7 @@ void main() {
|
||||
email: any(named: 'email'),
|
||||
password: any(named: 'password'),
|
||||
),
|
||||
).thenAnswer((_) async => const Err(ServerException()));
|
||||
).thenAnswer((_) async => Err(const ServerException()));
|
||||
when(
|
||||
() => formRepository.accessForm(AuthFormName.signUpForm),
|
||||
).thenAnswer(
|
||||
|
@ -1,3 +1,7 @@
|
||||
## 2.0.2
|
||||
|
||||
- **FIX**: compilation issue with flutter 3.16.0 and generics name.
|
||||
|
||||
## 2.0.1
|
||||
|
||||
- **REFACTOR**: docs + nullable multiprovider attributes.
|
||||
|
@ -1,5 +1,5 @@
|
||||
<!--
|
||||
* Copyright (C) 2022 WYATT GROUP
|
||||
* Copyright (C) 2023 WYATT GROUP
|
||||
* Please see the AUTHORS file for details.
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
|
@ -26,6 +26,6 @@ subprojects {
|
||||
project.evaluationDependsOn(':app')
|
||||
}
|
||||
|
||||
task clean(type: Delete) {
|
||||
tasks.register("clean", Delete) {
|
||||
delete rootProject.buildDir
|
||||
}
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -18,7 +18,7 @@ publish_to: 'none' # Remove this line if you wish to publish to pub.dev
|
||||
version: 1.0.0+1
|
||||
|
||||
environment:
|
||||
sdk: ">=2.17.0 <3.0.0"
|
||||
sdk: ">=3.0.0 <4.0.0"
|
||||
|
||||
# Dependencies specify other packages that your package needs in order to work.
|
||||
# To automatically upgrade your package dependencies to the latest versions
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
@ -24,10 +24,10 @@ import 'package:wyatt_bloc_helper/src/mixins/repository_base_provider_mixin.dart
|
||||
|
||||
/// {@template bloc_provider}
|
||||
/// Need to implement a [create] function that is responsible for
|
||||
/// creating the [Bloc] and a [builder] which will return a child
|
||||
/// creating the bloc [B] and a [builder] which will return a child
|
||||
/// that have access to the instance via `context.read<Bloc>()`.
|
||||
/// It is used as a dependency injection (DI) widget so that a single instance
|
||||
/// of a [Bloc] can be provided to multiple widgets within a subtree.
|
||||
/// of a bloc [B] can be provided to multiple widgets within a subtree.
|
||||
///
|
||||
/// It automatically handles closing the instance when used with [create].
|
||||
/// By default, [create] is called only when the instance is accessed.
|
||||
@ -36,12 +36,12 @@ import 'package:wyatt_bloc_helper/src/mixins/repository_base_provider_mixin.dart
|
||||
/// By default, it provide already provided instance found in the tree.
|
||||
/// To override this behavior, set [smart] to `false`.
|
||||
/// {@endtemplate}
|
||||
abstract class BlocProviderScreen<Bloc extends blocbase.Bloc<Event, State>,
|
||||
Event, State extends Object> extends BlocBaseProviderScreen<Bloc, State>
|
||||
abstract class BlocProviderScreen<B extends blocbase.Bloc<E, S>, E,
|
||||
S extends Object> extends BlocBaseProviderScreen<B, S>
|
||||
with
|
||||
BlocBaseProviderMixin<Bloc>,
|
||||
BlocBaseProviderMixin<B>,
|
||||
RepositoryProviderMixin,
|
||||
BlocProviderMixin<Bloc, Event> {
|
||||
BlocProviderMixin<B, E> {
|
||||
/// {@macro bloc_provider}
|
||||
const BlocProviderScreen({super.key, super.lazy = true, super.smart = true});
|
||||
}
|
||||
@ -53,11 +53,11 @@ abstract class BlocProviderScreen<Bloc extends blocbase.Bloc<Event, State>,
|
||||
/// An optional [shouldBuildWhen] and [shouldListenWhen] can be implemented
|
||||
/// for more granular control over when [onListen] and [onBuild] are called.
|
||||
/// The [shouldListenWhen] and [shouldBuildWhen] will be invoked on
|
||||
/// each [Bloc] or `state` change.
|
||||
/// each bloc [B] or `state` change.
|
||||
/// They each take the previous `state` and current `state` and must return
|
||||
/// a [bool] which determines whether or not the [onBuild] and/or [onListen]
|
||||
/// function will be invoked.
|
||||
/// The previous `state` will be initialized to the `state` of the [Bloc] when
|
||||
/// The previous `state` will be initialized to the `state` of the bloc [B] when
|
||||
/// the BlocConsumer is initialized.
|
||||
/// [shouldListenWhen] and [shouldBuildWhen] are optional and if they
|
||||
/// aren't implemented, they will default to `true`.
|
||||
@ -65,28 +65,28 @@ abstract class BlocProviderScreen<Bloc extends blocbase.Bloc<Event, State>,
|
||||
/// An optional [parent] can also be implemented. This build a wrapper arround
|
||||
/// the built BlocConsumer that is **not** rebuild on each state.
|
||||
/// {@endtemplate}
|
||||
abstract class BlocConsumerScreen<Bloc extends blocbase.Bloc<Event, State>,
|
||||
Event, State extends Object> extends BlocBaseConsumerScreen<Bloc, State>
|
||||
abstract class BlocConsumerScreen<B extends blocbase.Bloc<E, S>, E,
|
||||
S extends Object> extends BlocBaseConsumerScreen<B, S>
|
||||
with
|
||||
BlocBaseProviderMixin<Bloc>,
|
||||
BlocBaseProviderMixin<B>,
|
||||
RepositoryProviderMixin,
|
||||
BlocProviderMixin<Bloc, Event> {
|
||||
BlocProviderMixin<B, E> {
|
||||
/// {@macro bloc_consumer}
|
||||
const BlocConsumerScreen({super.key});
|
||||
}
|
||||
|
||||
/// {@template bloc_screen}
|
||||
/// Provide AND access to a [Bloc].
|
||||
/// Provide AND access to a bloc [B].
|
||||
///
|
||||
/// This extends [BlocConsumerScreen] with the methods
|
||||
/// of [BlocBaseScreen].
|
||||
/// {@endtemplate}
|
||||
abstract class BlocScreen<Bloc extends blocbase.Bloc<Event, State>, Event,
|
||||
State extends Object> extends BlocBaseScreen<Bloc, State>
|
||||
abstract class BlocScreen<B extends blocbase.Bloc<E, S>, E, S extends Object>
|
||||
extends BlocBaseScreen<B, S>
|
||||
with
|
||||
BlocBaseProviderMixin<Bloc>,
|
||||
BlocBaseProviderMixin<B>,
|
||||
RepositoryProviderMixin,
|
||||
BlocProviderMixin<Bloc, Event> {
|
||||
BlocProviderMixin<B, E> {
|
||||
/// {@macro bloc_screen}
|
||||
const BlocScreen({super.key, super.lazy = true, super.smart = true});
|
||||
}
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
@ -24,11 +24,11 @@ import 'package:flutter_bloc/flutter_bloc.dart';
|
||||
/// An optional [shouldBuildWhen] and [shouldListenWhen] can be implemented
|
||||
/// for more granular control over when [onListen] and [onBuild] are called.
|
||||
/// The [shouldListenWhen] and [shouldBuildWhen] will be invoked on
|
||||
/// each [Bloc] or `state` change.
|
||||
/// each bloc [B] or `state` change.
|
||||
/// They each take the previous `state` and current `state` and must return
|
||||
/// a [bool] which determines whether or not the [onBuild] and/or [onListen]
|
||||
/// function will be invoked.
|
||||
/// The previous `state` will be initialized to the `state` of the [Bloc] when
|
||||
/// The previous `state` will be initialized to the `state` of the bloc [B] when
|
||||
/// the [BlocConsumer] is initialized.
|
||||
/// [shouldListenWhen] and [shouldBuildWhen] are optional and if they
|
||||
/// aren't implemented, they will default to `true`.
|
||||
@ -36,39 +36,39 @@ import 'package:flutter_bloc/flutter_bloc.dart';
|
||||
/// An optional [parent] can also be implemented. This build a wrapper arround
|
||||
/// the built [BlocConsumer] that is **not** rebuild on each state.
|
||||
/// {@endtemplate}
|
||||
abstract class BlocBaseConsumerScreen<Bloc extends BlocBase<State>,
|
||||
State extends Object> extends StatelessWidget {
|
||||
abstract class BlocBaseConsumerScreen<B extends BlocBase<S>, S extends Object>
|
||||
extends StatelessWidget {
|
||||
/// {@macro bloc_base_consumer}
|
||||
const BlocBaseConsumerScreen({super.key});
|
||||
|
||||
/// Takes the previous `state` and the current `state` and is responsible for
|
||||
/// returning a [bool] which determines whether or not to trigger
|
||||
/// [onBuild] with the current `state`.
|
||||
bool shouldBuildWhen(State previous, State current) => true;
|
||||
bool shouldBuildWhen(S previous, S current) => true;
|
||||
|
||||
/// Takes the previous `state` and the current `state` and is responsible for
|
||||
/// returning a [bool] which determines whether or not to trigger
|
||||
/// [onListen] with the current `state`.
|
||||
bool shouldListenWhen(State previous, State current) => true;
|
||||
bool shouldListenWhen(S previous, S current) => true;
|
||||
|
||||
/// The [parent] function which will be invoked on build.
|
||||
/// The [parent] takes a `BuildContext` that **doesn't have** access
|
||||
/// to the [Bloc] or [Cubit].
|
||||
/// to the bloc [B] or [Cubit].
|
||||
Widget parent(BuildContext context, Widget child) => child;
|
||||
|
||||
/// The [onBuild] function which will be invoked on each widget build.
|
||||
/// The [onBuild] takes the `BuildContext` and current `state` and
|
||||
/// must return a widget.
|
||||
Widget onBuild(BuildContext context, State state);
|
||||
Widget onBuild(BuildContext context, S state) => const SizedBox.shrink();
|
||||
|
||||
/// Takes the `BuildContext` along with the `state`
|
||||
/// and is responsible for executing in response to `state` changes.
|
||||
void onListen(BuildContext context, State state) {}
|
||||
void onListen(BuildContext context, S state) {}
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) => parent(
|
||||
context,
|
||||
BlocConsumer<Bloc, State>(
|
||||
BlocConsumer<B, S>(
|
||||
listenWhen: shouldListenWhen,
|
||||
listener: onListen,
|
||||
buildWhen: shouldBuildWhen,
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
@ -20,10 +20,10 @@ import 'package:wyatt_bloc_helper/src/utils/smart_provider.dart';
|
||||
|
||||
/// {@template bloc_base_provider}
|
||||
/// Need to implement a [create] function that is responsible for
|
||||
/// creating the [Bloc] or [Cubit] and a [builder] which will return a child
|
||||
/// creating the bloc or cubit [B] and a [builder] which will return a child
|
||||
/// that have access to the instance via `context.read<Bloc>()`.
|
||||
/// It is used as a dependency injection (DI) widget so that a single instance
|
||||
/// of a [Bloc] or [Cubit] can be provided to multiple widgets within a subtree.
|
||||
/// of a bloc or cubit [B] can be provided to multiple widgets within a subtree.
|
||||
///
|
||||
/// It automatically handles closing the instance when used with [create].
|
||||
/// By default, [create] is called only when the instance is accessed.
|
||||
@ -32,8 +32,8 @@ import 'package:wyatt_bloc_helper/src/utils/smart_provider.dart';
|
||||
/// By default, it provide already provided instance found in the tree.
|
||||
/// To override this behavior, set [smart] to `false`.
|
||||
/// {@endtemplate}
|
||||
abstract class BlocBaseProviderScreen<Bloc extends BlocBase<State>,
|
||||
State extends Object> extends StatelessWidget {
|
||||
abstract class BlocBaseProviderScreen<B extends BlocBase<S>, S extends Object>
|
||||
extends StatelessWidget {
|
||||
/// {@macro bloc_base_provider}
|
||||
const BlocBaseProviderScreen({
|
||||
super.key,
|
||||
@ -41,32 +41,32 @@ abstract class BlocBaseProviderScreen<Bloc extends BlocBase<State>,
|
||||
this.smart = true,
|
||||
});
|
||||
|
||||
/// Whether the [Bloc] or [Cubit] should be created lazily.
|
||||
/// Defaults to `true` which means the [Bloc] or [Cubit] is created only when
|
||||
/// Whether the bloc or cubit [B] should be created lazily.
|
||||
/// Defaults to `true` which means the bloc or cubit [B] is created only when
|
||||
/// accessed the first time, not when provided.
|
||||
final bool lazy;
|
||||
|
||||
/// Whether this uses [SmartProvider].
|
||||
/// Defaults to `true`. But if you want to provide new [Bloc] or [Cubit]
|
||||
/// Defaults to `true`. But if you want to provide new bloc or cubit [B]
|
||||
/// of a same type in a sub-tree you may have to disable this.
|
||||
final bool smart;
|
||||
|
||||
/// Creates the [Bloc] or [Cubit] to be used.
|
||||
Bloc create(BuildContext context);
|
||||
/// Creates the bloc or cubit [B] to be used.
|
||||
B create(BuildContext context);
|
||||
|
||||
/// Initialize the [Bloc] or [Cubit].
|
||||
/// Initialize the bloc or cubit [B].
|
||||
///
|
||||
/// This function is useful when using with [SmartProvider], because
|
||||
/// if you want to pass an initial event to your bloc you can pass it in
|
||||
/// `create` function but if you re-use the bloc below in the tree this event
|
||||
/// will never be re-pass.
|
||||
Bloc init(BuildContext context, Bloc bloc) => bloc;
|
||||
B init(BuildContext context, B bloc) => bloc;
|
||||
|
||||
/// Creates the child [Widget] to be used.
|
||||
Widget builder(BuildContext context);
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) => SmartProvider.bloc<Bloc, State>(
|
||||
Widget build(BuildContext context) => SmartProvider.bloc<B, S>(
|
||||
context,
|
||||
lazy: lazy,
|
||||
enable: smart,
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
@ -20,14 +20,14 @@ import 'package:wyatt_bloc_helper/src/bloc_base/bloc_base_consumer_screen.dart';
|
||||
import 'package:wyatt_bloc_helper/src/utils/smart_provider.dart';
|
||||
|
||||
/// {@template bloc_base_screen}
|
||||
/// Provide AND access to a [Bloc] or [Cubit].
|
||||
/// Provide AND access to a bloc or cubit [B].
|
||||
///
|
||||
/// This extends [BlocBaseConsumerScreen] with the methods
|
||||
// ignore: comment_references
|
||||
/// of [BlocBaseProviderScreen].
|
||||
/// {@endtemplate}
|
||||
abstract class BlocBaseScreen<Bloc extends BlocBase<State>,
|
||||
State extends Object> extends BlocBaseConsumerScreen<Bloc, State> {
|
||||
abstract class BlocBaseScreen<B extends BlocBase<S>, S extends Object>
|
||||
extends BlocBaseConsumerScreen<B, S> {
|
||||
/// {@macro bloc_base_screen}
|
||||
const BlocBaseScreen({
|
||||
super.key,
|
||||
@ -35,8 +35,8 @@ abstract class BlocBaseScreen<Bloc extends BlocBase<State>,
|
||||
this.smart = true,
|
||||
});
|
||||
|
||||
/// Whether the [Bloc] or [Cubit] should be created lazily.
|
||||
/// Defaults to `true` which means the [Bloc] is created only when
|
||||
/// Whether the bloc or cubit [B] should be created lazily.
|
||||
/// Defaults to `true` which means the bloc is created only when
|
||||
/// accessed the first time, not when provided.
|
||||
final bool lazy;
|
||||
|
||||
@ -45,19 +45,19 @@ abstract class BlocBaseScreen<Bloc extends BlocBase<State>,
|
||||
/// in a sub-tree you may have to disable this.
|
||||
final bool smart;
|
||||
|
||||
/// Creates the [Cubit] or [Bloc] to be used.
|
||||
Bloc create(BuildContext context);
|
||||
/// Creates the cubit or bloc to be used.
|
||||
B create(BuildContext context);
|
||||
|
||||
/// Initialize the [Bloc] or [Cubit].
|
||||
/// Initialize the bloc or cubit [B].
|
||||
///
|
||||
/// This function is useful when using with [SmartProvider], because
|
||||
/// if you want to pass an initial event to your bloc you can pass it in
|
||||
/// `create` function but if you re-use the bloc below in the tree this event
|
||||
/// will never be re-pass.
|
||||
Bloc init(BuildContext context, Bloc bloc) => bloc;
|
||||
B init(BuildContext context, B bloc) => bloc;
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) => SmartProvider.bloc<Bloc, State>(
|
||||
Widget build(BuildContext context) => SmartProvider.bloc<B, S>(
|
||||
context,
|
||||
lazy: lazy,
|
||||
enable: smart,
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
@ -23,10 +23,10 @@ import 'package:wyatt_bloc_helper/src/mixins/repository_base_provider_mixin.dart
|
||||
|
||||
/// {@template cubit_provider}
|
||||
/// Need to implement a [create] function that is responsible for
|
||||
/// creating the [Cubit] and a [builder] which will return a child
|
||||
/// creating the cubit [C] and a [builder] which will return a child
|
||||
/// that have access to the instance via `context.read<Cubit>()`.
|
||||
/// It is used as a dependency injection (DI) widget so that a single instance
|
||||
/// of a [Cubit] can be provided to multiple widgets within a subtree.
|
||||
/// of a cubit [C] can be provided to multiple widgets within a subtree.
|
||||
///
|
||||
/// It automatically handles closing the instance when used with [create].
|
||||
/// By default, [create] is called only when the instance is accessed.
|
||||
@ -35,9 +35,9 @@ import 'package:wyatt_bloc_helper/src/mixins/repository_base_provider_mixin.dart
|
||||
/// By default, it provide already provided instance in found in the tree.
|
||||
/// To override this behavior, set [smart] to `false`.
|
||||
/// {@endtemplate}
|
||||
abstract class CubitProviderScreen<Cubit extends blocbase.Cubit<State>,
|
||||
State extends Object> extends BlocBaseProviderScreen<Cubit, State>
|
||||
with BlocBaseProviderMixin<Cubit>, RepositoryProviderMixin {
|
||||
abstract class CubitProviderScreen<C extends blocbase.Cubit<S>,
|
||||
S extends Object> extends BlocBaseProviderScreen<C, S>
|
||||
with BlocBaseProviderMixin<C>, RepositoryProviderMixin {
|
||||
/// {@macro cubit_provider}
|
||||
const CubitProviderScreen({super.key, super.lazy = true, super.smart = true});
|
||||
}
|
||||
@ -49,35 +49,35 @@ abstract class CubitProviderScreen<Cubit extends blocbase.Cubit<State>,
|
||||
/// An optional [shouldBuildWhen] and [shouldListenWhen] can be implemented
|
||||
/// for more granular control over when [onListen] and [onBuild] are called.
|
||||
/// The [shouldListenWhen] and [shouldBuildWhen] will be invoked on
|
||||
/// each [Cubit] or `state` change.
|
||||
/// each cubit [C] or `state` change.
|
||||
/// They each take the previous `state` and current `state` and must return
|
||||
/// a [bool] which determines whether or not the [onBuild] and/or [onListen]
|
||||
/// function will be invoked.
|
||||
/// The previous `state` will be initialized to the `state` of the [Cubit] when
|
||||
/// the BlocConsumer is initialized.
|
||||
/// The previous `state` will be initialized to the `state` of the cubit [C]
|
||||
/// when the BlocConsumer is initialized.
|
||||
/// [shouldListenWhen] and [shouldBuildWhen] are optional and if they
|
||||
/// aren't implemented, they will default to `true`.
|
||||
///
|
||||
/// An optional [parent] can also be implemented. This build a wrapper arround
|
||||
/// the built BlocConsumer that is **not** rebuild on each state.
|
||||
/// {@endtemplate}
|
||||
abstract class CubitConsumerScreen<Cubit extends blocbase.Cubit<State>,
|
||||
State extends Object> extends BlocBaseConsumerScreen<Cubit, State>
|
||||
with BlocBaseProviderMixin<Cubit>, RepositoryProviderMixin {
|
||||
abstract class CubitConsumerScreen<C extends blocbase.Cubit<S>,
|
||||
S extends Object> extends BlocBaseConsumerScreen<C, S>
|
||||
with BlocBaseProviderMixin<C>, RepositoryProviderMixin {
|
||||
/// {@macro cubit_consumer}
|
||||
const CubitConsumerScreen({super.key});
|
||||
}
|
||||
|
||||
/// {@template cubit_screen}
|
||||
/// Provide AND access to a [Cubit].
|
||||
/// Provide AND access to a cubit [C].
|
||||
///
|
||||
/// This extends [CubitConsumerScreen] with the methods
|
||||
// ignore: comment_references
|
||||
/// of [CubitProviderScreen].
|
||||
/// {@endtemplate}
|
||||
abstract class CubitScreen<Cubit extends blocbase.Cubit<State>,
|
||||
State extends Object> extends BlocBaseScreen<Cubit, State>
|
||||
with BlocBaseProviderMixin<Cubit>, RepositoryProviderMixin {
|
||||
abstract class CubitScreen<C extends blocbase.Cubit<S>, S extends Object>
|
||||
extends BlocBaseScreen<C, S>
|
||||
with BlocBaseProviderMixin<C>, RepositoryProviderMixin {
|
||||
/// {@macro cubit_screen}
|
||||
const CubitScreen({super.key, super.lazy = true, super.smart = true});
|
||||
}
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
@ -18,10 +18,10 @@ import 'package:flutter/widgets.dart';
|
||||
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||
|
||||
/// A mixin that provides implementation of helper methods for
|
||||
/// [Bloc] and [Cubit] widgets.
|
||||
mixin BlocBaseProviderMixin<Bloc extends BlocBase<Object>> {
|
||||
/// bloc and cubit [B] widgets.
|
||||
mixin BlocBaseProviderMixin<B extends BlocBase<Object>> {
|
||||
/// Returns the [BlocBase] used by this [BlocBaseProviderMixin].
|
||||
Bloc bloc(BuildContext context) => context.read<Bloc>();
|
||||
B bloc(BuildContext context) => context.read<B>();
|
||||
|
||||
/// Returns another [BlocBase] **not** used by this [BlocBaseProviderMixin].
|
||||
/// Short hand for `context.read<AnotherBloc>();`
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
@ -17,12 +17,11 @@
|
||||
import 'package:flutter/widgets.dart';
|
||||
import 'package:flutter_bloc/flutter_bloc.dart' as blocbase;
|
||||
|
||||
/// [Bloc] specific mixin that provides implementation
|
||||
/// Bloc [B] specific mixin that provides implementation
|
||||
/// of helper methods for events.
|
||||
mixin BlocProviderMixin<Bloc extends blocbase.Bloc<Event, Object>, Event> {
|
||||
/// Add an event to the [Bloc].
|
||||
mixin BlocProviderMixin<B extends blocbase.Bloc<E, Object>, E> {
|
||||
/// Add an event to the [B].
|
||||
///
|
||||
/// Short hand for `context.read<Bloc>().add(event)`.
|
||||
void add(BuildContext context, Event event) =>
|
||||
context.read<Bloc>().add(event);
|
||||
void add(BuildContext context, E event) => context.read<B>().add(event);
|
||||
}
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
@ -20,7 +20,6 @@ import 'package:flutter_bloc/flutter_bloc.dart';
|
||||
/// A mixin that provides implementation of helper methods for
|
||||
/// Repository widgets.
|
||||
mixin RepositoryProviderMixin {
|
||||
/// Returns the [Repository] used by this [Widget].
|
||||
Repository repo<Repository>(BuildContext context) =>
|
||||
context.read<Repository>();
|
||||
/// Returns the [R] used by this [Widget].
|
||||
R repo<R>(BuildContext context) => context.read<R>();
|
||||
}
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
@ -19,10 +19,10 @@ import 'package:wyatt_bloc_helper/src/repository/repository_provider_screen.dart
|
||||
|
||||
/// {@template repository_provider}
|
||||
/// Need to implement a [create] function that is responsible for
|
||||
/// creating the [Repository] and a [builder] which will return a child
|
||||
/// creating the [R] and a [builder] which will return a child
|
||||
/// that have access to the instance via `context.read<Repository>()`.
|
||||
/// It is used as a dependency injection (DI) widget so that a single instance
|
||||
/// of a [Repository] can be provided to multiple widgets within a subtree.
|
||||
/// of a [R] can be provided to multiple widgets within a subtree.
|
||||
///
|
||||
/// It automatically handles closing the instance when used with [create].
|
||||
/// By default, [create] is called only when the instance is accessed.
|
||||
@ -31,9 +31,9 @@ import 'package:wyatt_bloc_helper/src/repository/repository_provider_screen.dart
|
||||
/// By default, it provide already provided instance found in the tree.
|
||||
/// To override this behavior, set [smart] to `false`.
|
||||
/// {@endtemplate}
|
||||
abstract class RepositoryProviderScreen<Repository>
|
||||
extends RepositoryBaseProviderScreen<Repository>
|
||||
with RepositoryProviderMixin {
|
||||
abstract class RepositoryProviderScreen<R>
|
||||
extends RepositoryBaseProviderScreen<R> with RepositoryProviderMixin {
|
||||
/// {@macro repository_provider}
|
||||
@Deprecated('Useless provider screen. Use get_it instead.')
|
||||
const RepositoryProviderScreen({super.key});
|
||||
}
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
@ -19,10 +19,10 @@ import 'package:wyatt_bloc_helper/src/utils/smart_provider.dart';
|
||||
|
||||
/// {@template repository_base_provider}
|
||||
/// Need to implement a [create] function that is responsible for
|
||||
/// creating the [Repository] and a [builder] which will return a child
|
||||
/// creating the [R] and a [builder] which will return a child
|
||||
/// that have access to the instance via `context.read<Repository>()`.
|
||||
/// It is used as a dependency injection (DI) widget so that a single instance
|
||||
/// of a [Repository] can be provided to multiple widgets within a subtree.
|
||||
/// of a [R] can be provided to multiple widgets within a subtree.
|
||||
///
|
||||
/// It automatically handles closing the instance when used with [create].
|
||||
/// By default, [create] is called only when the instance is accessed.
|
||||
@ -31,8 +31,7 @@ import 'package:wyatt_bloc_helper/src/utils/smart_provider.dart';
|
||||
/// By default, it provide already provided instance found in the tree.
|
||||
/// To override this behavior, set [smart] to `false`.
|
||||
/// {@endtemplate}
|
||||
abstract class RepositoryBaseProviderScreen<Repository>
|
||||
extends StatelessWidget {
|
||||
abstract class RepositoryBaseProviderScreen<R> extends StatelessWidget {
|
||||
/// {@macro repository_base_provider}
|
||||
const RepositoryBaseProviderScreen({
|
||||
super.key,
|
||||
@ -40,32 +39,32 @@ abstract class RepositoryBaseProviderScreen<Repository>
|
||||
this.smart = true,
|
||||
});
|
||||
|
||||
/// Whether the [Repository] should be created lazily.
|
||||
/// Defaults to `true` which means the [Repository] is created only when
|
||||
/// Whether the [R] should be created lazily.
|
||||
/// Defaults to `true` which means the [R] is created only when
|
||||
/// accessed the first time, not when provided.
|
||||
final bool lazy;
|
||||
|
||||
/// Whether this uses [SmartProvider].
|
||||
/// Defaults to `true`. But if you want to provide new [Repository] of a
|
||||
/// Defaults to `true`. But if you want to provide new [R] of a
|
||||
/// same type in a sub-tree you may have to disable this.
|
||||
final bool smart;
|
||||
|
||||
/// Creates the [Repository] to be used.
|
||||
Repository create(BuildContext context);
|
||||
/// Creates the [R] to be used.
|
||||
R create(BuildContext context);
|
||||
|
||||
/// Initialize the [Repository].
|
||||
/// Initialize the [R].
|
||||
///
|
||||
/// This function is useful when using with [SmartProvider], because
|
||||
/// if you want to pass an initial call on your repository you can
|
||||
/// call it in `create` function but if you re-provide the repo below in the
|
||||
/// tree this action will never be call again.
|
||||
Repository init(BuildContext context, Repository repository) => repository;
|
||||
R init(BuildContext context, R repository) => repository;
|
||||
|
||||
/// Creates the child [Widget] to be used.
|
||||
Widget builder(BuildContext context);
|
||||
|
||||
@override
|
||||
Widget build(BuildContext context) => SmartProvider.repo<Repository>(
|
||||
Widget build(BuildContext context) => SmartProvider.repo<R>(
|
||||
context,
|
||||
lazy: lazy,
|
||||
enable: smart,
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
@ -18,32 +18,31 @@ import 'package:flutter/widgets.dart';
|
||||
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||
|
||||
/// A utility class that provides a way to create a [BlocProvider] or
|
||||
/// [RepositoryProvider] with a [Bloc] or Repository that is already
|
||||
/// [RepositoryProvider] with a bloc or Repository that is already
|
||||
/// available in the widget tree.
|
||||
abstract class SmartProvider {
|
||||
/// Creates a [BlocProvider] with a [Bloc] that is possibly already
|
||||
/// Creates a [BlocProvider] with a bloc [B] that is possibly already
|
||||
/// available in the widget tree.
|
||||
static BlocProvider<Bloc>
|
||||
bloc<Bloc extends BlocBase<State>, State extends Object>(
|
||||
static BlocProvider<B> bloc<B extends BlocBase<S>, S extends Object>(
|
||||
BuildContext context, {
|
||||
required Bloc Function(BuildContext) create,
|
||||
required Bloc Function(BuildContext, Bloc) init,
|
||||
required B Function(BuildContext) create,
|
||||
required B Function(BuildContext, B) init,
|
||||
Widget? child,
|
||||
bool lazy = true,
|
||||
bool enable = true,
|
||||
}) {
|
||||
if (enable) {
|
||||
final bloc = context.read<Bloc?>();
|
||||
final bloc = context.read<B?>();
|
||||
if (bloc != null) {
|
||||
final b = bloc;
|
||||
return BlocProvider<Bloc>.value(
|
||||
return BlocProvider<B>.value(
|
||||
value: init(context, b),
|
||||
child: child,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return BlocProvider<Bloc>(
|
||||
return BlocProvider<B>(
|
||||
lazy: lazy,
|
||||
create: (_) => init(context, create(context)),
|
||||
child: child,
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,4 +1,4 @@
|
||||
// Copyright (C) 2022 WYATT GROUP
|
||||
// Copyright (C) 2023 WYATT GROUP
|
||||
// Please see the AUTHORS file for details.
|
||||
//
|
||||
// This program is free software: you can redistribute it and/or modify
|
||||
|
@ -1,7 +1,7 @@
|
||||
name: wyatt_bloc_helper
|
||||
description: Your best friend for blocs in Flutter
|
||||
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_bloc_helper
|
||||
version: 2.0.1
|
||||
version: 2.0.2
|
||||
|
||||
publish_to: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
|
||||
|
@ -1,3 +1,7 @@
|
||||
## 0.1.2+5
|
||||
|
||||
- Update a dependency to the latest release.
|
||||
|
||||
## 0.1.2+4
|
||||
|
||||
- Update a dependency to the latest release.
|
||||
|
@ -36,7 +36,7 @@ dependencies:
|
||||
|
||||
wyatt_bloc_helper:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
version: ^2.0.1
|
||||
version: ^2.0.2
|
||||
wyatt_ui_layout:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
version: ^0.1.2+3
|
||||
|
@ -1,7 +1,7 @@
|
||||
name: wyatt_bloc_layout
|
||||
description: Layouts based on bloc helper library
|
||||
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_bloc_layout
|
||||
version: 0.1.2+4
|
||||
version: 0.1.2+5
|
||||
|
||||
publish_to: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
|
||||
@ -15,7 +15,7 @@ dependencies:
|
||||
|
||||
wyatt_bloc_helper:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
version: ^2.0.1
|
||||
version: ^2.0.2
|
||||
|
||||
wyatt_ui_layout:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
|
@ -1,3 +1,7 @@
|
||||
## 0.1.1+3
|
||||
|
||||
- Update a dependency to the latest release.
|
||||
|
||||
## 0.1.1+2
|
||||
|
||||
- **FIX**: apply dart format.
|
||||
|
@ -17,12 +17,12 @@
|
||||
import 'package:wyatt_architecture/wyatt_architecture.dart';
|
||||
import 'package:wyatt_cloud_messaging_bloc_base/src/domain/repositories/cloud_messaging_repository.dart';
|
||||
|
||||
class InitCloudmessagingUseCase extends AsyncUseCase<NoParam, void> {
|
||||
class InitCloudmessagingUseCase extends NoParamsAsyncUseCase<void> {
|
||||
InitCloudmessagingUseCase({
|
||||
required CloudMessagingRepository notificationRepository,
|
||||
}) : _notificationRepository = notificationRepository;
|
||||
final CloudMessagingRepository _notificationRepository;
|
||||
@override
|
||||
FutureOrResult<void> execute(NoParam? params) =>
|
||||
FutureOrResult<void> execute() =>
|
||||
_notificationRepository.init();
|
||||
}
|
||||
|
@ -24,13 +24,13 @@ import 'package:wyatt_cloud_messaging_bloc_base/src/domain/repositories/cloud_me
|
||||
import 'package:wyatt_type_utils/wyatt_type_utils.dart';
|
||||
|
||||
class ListenNotificationUseCase
|
||||
extends StreamUseCase<NoParam, RemoteNotification> {
|
||||
extends NoParamsAsyncUseCase<Stream<RemoteNotification>> {
|
||||
ListenNotificationUseCase({
|
||||
required CloudMessagingRepository notificationRepository,
|
||||
}) : _notificationRepository = notificationRepository;
|
||||
final CloudMessagingRepository _notificationRepository;
|
||||
@override
|
||||
FutureOrResult<Stream<RemoteNotification>> execute(NoParam? params) async {
|
||||
FutureOrResult<Stream<RemoteNotification>> execute() async {
|
||||
Stream<RemoteNotification>? notificationStream;
|
||||
|
||||
final notificationStreamResponse =
|
||||
@ -66,7 +66,7 @@ class ListenNotificationUseCase
|
||||
}
|
||||
|
||||
if (notificationStream == null) {
|
||||
return const Err(NotificationException('Cannot listen notifications'));
|
||||
return Err(const NotificationException('Cannot listen notifications'));
|
||||
}
|
||||
|
||||
return Ok(notificationStream);
|
||||
|
@ -18,11 +18,9 @@ import 'dart:async';
|
||||
|
||||
import 'package:equatable/equatable.dart';
|
||||
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||
import 'package:wyatt_architecture/wyatt_architecture.dart';
|
||||
import 'package:wyatt_cloud_messaging_bloc_base/src/domain/entities/remote_notifications.dart';
|
||||
import 'package:wyatt_cloud_messaging_bloc_base/src/domain/usecases/listen_notification_use_case.dart';
|
||||
import 'package:wyatt_cloud_messaging_bloc_base/src/domain/usecases/subscribe_to_notification_topic_use_case.dart';
|
||||
|
||||
import 'package:wyatt_cloud_messaging_bloc_base/src/domain/usecases/unsubscribe_from_notification_topic_use_case.dart';
|
||||
|
||||
part 'cloud_messaging_state.dart';
|
||||
@ -46,7 +44,7 @@ class CloudMessagingCubit extends Cubit<CloudmessagingState> {
|
||||
final OnNotification? handleNotification;
|
||||
|
||||
Future<void> listenNotification() async {
|
||||
final notificaitons = await _listenNotification.execute(const NoParam());
|
||||
final notificaitons = await _listenNotification.execute();
|
||||
if (notificaitons.isOk) {
|
||||
notificaitons.ok?.listen((notification) {
|
||||
emit(CloudmessagingState(notification));
|
||||
|
@ -1,7 +1,7 @@
|
||||
name: wyatt_cloud_messaging_bloc_base
|
||||
description: A starting point for Dart libraries or applications.
|
||||
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_notification_bloc
|
||||
version: 0.1.1+2
|
||||
version: 0.1.1+3
|
||||
|
||||
publish_to: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
|
||||
@ -27,7 +27,7 @@ dependencies:
|
||||
version: ^0.0.5
|
||||
wyatt_bloc_helper:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
version: ^2.0.1
|
||||
version: ^2.0.2
|
||||
|
||||
|
||||
|
||||
|
@ -1,3 +1,7 @@
|
||||
## 0.1.0+3
|
||||
|
||||
- Update a dependency to the latest release.
|
||||
|
||||
## 0.1.0+2
|
||||
|
||||
- **REFACTOR**(cloud_messaging_bloc_firebase): update deps.
|
||||
|
@ -1,7 +1,7 @@
|
||||
name: wyatt_cloud_messaging_bloc_firebase
|
||||
description: A.
|
||||
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_cloud_messaging_bloc_firebase
|
||||
version: 0.1.0+2
|
||||
version: 0.1.0+3
|
||||
|
||||
publish_to: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
|
||||
@ -14,7 +14,7 @@ dependencies:
|
||||
|
||||
wyatt_cloud_messaging_bloc_base:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
version: ^0.1.1+2
|
||||
version: ^0.1.1+3
|
||||
|
||||
|
||||
path: ^1.8.0
|
||||
|
8
packages/wyatt_continuous_deployment/.gitignore
vendored
Normal file
8
packages/wyatt_continuous_deployment/.gitignore
vendored
Normal file
@ -0,0 +1,8 @@
|
||||
# https://dart.dev/guides/libraries/private-files
|
||||
# Created by `dart pub`
|
||||
.dart_tool/
|
||||
|
||||
# Avoid committing pubspec.lock for library packages; see
|
||||
# https://dart.dev/guides/libraries/private-files#pubspeclock.
|
||||
pubspec.lock
|
||||
!bin/
|
34
packages/wyatt_continuous_deployment/.vscode/launch.json
vendored
Normal file
34
packages/wyatt_continuous_deployment/.vscode/launch.json
vendored
Normal file
@ -0,0 +1,34 @@
|
||||
/*
|
||||
* Copyright (C) 2023 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/>.
|
||||
*/
|
||||
|
||||
{
|
||||
// Use IntelliSense to learn about possible attributes.
|
||||
// Hover to view descriptions of existing attributes.
|
||||
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "Launch Example",
|
||||
"request": "launch",
|
||||
"type": "dart",
|
||||
"cwd": "example/",
|
||||
"program": "lib/main.dart",
|
||||
"flutterMode": "debug"
|
||||
},
|
||||
]
|
||||
}
|
72
packages/wyatt_continuous_deployment/.vscode/settings.json
vendored
Normal file
72
packages/wyatt_continuous_deployment/.vscode/settings.json
vendored
Normal file
@ -0,0 +1,72 @@
|
||||
{
|
||||
"dart.runPubGetOnPubspecChanges": "never",
|
||||
"bloc.newCubitTemplate.type": "equatable",
|
||||
"psi-header.changes-tracking": {
|
||||
"isActive": true
|
||||
},
|
||||
"psi-header.config": {
|
||||
"blankLinesAfter": 1,
|
||||
"forceToTop": true
|
||||
},
|
||||
"psi-header.lang-config": [
|
||||
{
|
||||
"beforeHeader": [
|
||||
"# -*- coding:utf-8 -*-",
|
||||
"#!/usr/bin/env python3"
|
||||
],
|
||||
"begin": "###",
|
||||
"end": "###",
|
||||
"language": "python",
|
||||
"prefix": "# "
|
||||
},
|
||||
{
|
||||
"beforeHeader": [
|
||||
"#!/usr/bin/env sh",
|
||||
""
|
||||
],
|
||||
"language": "shellscript",
|
||||
"begin": "",
|
||||
"end": "",
|
||||
"prefix": "# "
|
||||
},
|
||||
{
|
||||
"begin": "",
|
||||
"end": "",
|
||||
"language": "dart",
|
||||
"prefix": "// "
|
||||
},
|
||||
{
|
||||
"begin": "",
|
||||
"end": "",
|
||||
"language": "yaml",
|
||||
"prefix": "# "
|
||||
},
|
||||
{
|
||||
"begin": "<!--",
|
||||
"end": "-->",
|
||||
"language": "markdown",
|
||||
},
|
||||
],
|
||||
"psi-header.templates": [
|
||||
{
|
||||
"language": "*",
|
||||
"template": [
|
||||
"Copyright (C) <<year>> 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/>."
|
||||
],
|
||||
}
|
||||
],
|
||||
}
|
8
packages/wyatt_continuous_deployment/AUTHORS
Normal file
8
packages/wyatt_continuous_deployment/AUTHORS
Normal file
@ -0,0 +1,8 @@
|
||||
# Below is a list of people and organizations that have contributed
|
||||
# to this project. Names should be added to the list like so:
|
||||
#
|
||||
# Name/Organization <email address>
|
||||
|
||||
Wyatt Group S.A.S
|
||||
Hugo Pointcheval <hugo.pointcheval@wyatt-studio.fr>
|
||||
Malo Léon <malo.leon@wyatt-studio.fr>
|
3
packages/wyatt_continuous_deployment/CHANGELOG.md
Normal file
3
packages/wyatt_continuous_deployment/CHANGELOG.md
Normal file
@ -0,0 +1,3 @@
|
||||
## 1.0.0
|
||||
|
||||
- Initial version.
|
674
packages/wyatt_continuous_deployment/LICENSE
Normal file
674
packages/wyatt_continuous_deployment/LICENSE
Normal file
@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
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
|
||||
(at your option) 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/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
56
packages/wyatt_continuous_deployment/README.md
Normal file
56
packages/wyatt_continuous_deployment/README.md
Normal file
@ -0,0 +1,56 @@
|
||||
<!--
|
||||
* Copyright (C) 2023 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/>.
|
||||
-->
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# Dart - Wyatt Continuous Deployment
|
||||
|
||||
<p align="left">
|
||||
<a href="https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis"><img src="https://img.shields.io/badge/Style-Wyatt%20Analysis-blue.svg?style=flat-square" alt="Style: Wyatt Analysis" /></a>
|
||||
<img src="https://img.shields.io/badge/SDK-Dart%20%7C%20Flutter-blue?style=flat-square" alt="SDK: Dart & Flutter" />
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
Wyatt c d
|
||||
|
||||
## Features
|
||||
|
||||
TODO: List what your package can do. Maybe include images, gifs, or videos.
|
||||
|
||||
## Getting started
|
||||
|
||||
TODO: List prerequisites and provide or point to information on how to
|
||||
start using the package.
|
||||
|
||||
## Usage
|
||||
|
||||
TODO: Include short and useful examples for package users. Add longer examples
|
||||
to `/example` folder.
|
||||
|
||||
```dart
|
||||
const like = 'sample';
|
||||
```
|
||||
|
||||
## Additional information
|
||||
|
||||
TODO: Tell users more about the package: where to find more information, how to
|
||||
contribute to the package, how to file issues, what response they can expect
|
||||
from the package authors, and more.
|
27
packages/wyatt_continuous_deployment/analysis_options.yaml
Normal file
27
packages/wyatt_continuous_deployment/analysis_options.yaml
Normal file
@ -0,0 +1,27 @@
|
||||
include: package:wyatt_analysis/analysis_options.yaml
|
||||
|
||||
analyzer:
|
||||
plugins:
|
||||
- dart_code_linter
|
||||
|
||||
dart_code_linter:
|
||||
anti-patterns:
|
||||
- long-method
|
||||
- long-parameter-list
|
||||
metrics:
|
||||
cyclomatic-complexity: 20
|
||||
maximum-nesting-level: 5
|
||||
number-of-parameters: 10
|
||||
source-lines-of-code: 400
|
||||
metrics-exclude:
|
||||
- test/**
|
||||
rules:
|
||||
- newline-before-return
|
||||
- no-boolean-literal-compare
|
||||
- no-empty-block
|
||||
- prefer-trailing-comma
|
||||
- prefer-conditional-expressions
|
||||
- no-equal-then-else
|
||||
- avoid-border-all
|
||||
- prefer-const-border-radius
|
||||
- prefer-using-list-view
|
@ -0,0 +1,20 @@
|
||||
import 'dart:io';
|
||||
|
||||
import 'package:mason_logger/mason_logger.dart';
|
||||
import 'package:wyatt_continuous_deployment/src/bootstrap.dart';
|
||||
import 'package:wyatt_continuous_deployment/src/wyatt_continuous_deployment_command_runner.dart';
|
||||
|
||||
Future<void> main(List<String> args) async {
|
||||
await bootstrap(Logger());
|
||||
await flushThenExit(await WyattContinuousDeploymentCommandRunner().run(args));
|
||||
}
|
||||
|
||||
/// Flushes the stdout and stderr streams, then exits the program with the given
|
||||
/// status code.
|
||||
///
|
||||
/// This returns a Future that will never complete, since the program will have
|
||||
/// exited already. This is useful to prevent Future chains from proceeding
|
||||
/// after you've decided to exit.
|
||||
Future<dynamic> flushThenExit(int status) =>
|
||||
Future.wait<void>([stdout.close(), stderr.close()])
|
||||
.then<void>((_) => exit(status));
|
44
packages/wyatt_continuous_deployment/example/.gitignore
vendored
Normal file
44
packages/wyatt_continuous_deployment/example/.gitignore
vendored
Normal file
@ -0,0 +1,44 @@
|
||||
# Miscellaneous
|
||||
*.class
|
||||
*.log
|
||||
*.pyc
|
||||
*.swp
|
||||
.DS_Store
|
||||
.atom/
|
||||
.buildlog/
|
||||
.history
|
||||
.svn/
|
||||
migrate_working_dir/
|
||||
|
||||
# IntelliJ related
|
||||
*.iml
|
||||
*.ipr
|
||||
*.iws
|
||||
.idea/
|
||||
|
||||
# The .vscode folder contains launch configuration and tasks you configure in
|
||||
# VS Code which you may wish to be included in version control, so this line
|
||||
# is commented out by default.
|
||||
#.vscode/
|
||||
|
||||
# Flutter/Dart/Pub related
|
||||
**/doc/api/
|
||||
**/ios/Flutter/.last_build_id
|
||||
.dart_tool/
|
||||
.flutter-plugins
|
||||
.flutter-plugins-dependencies
|
||||
.packages
|
||||
.pub-cache/
|
||||
.pub/
|
||||
/build/
|
||||
|
||||
# Symbolication related
|
||||
app.*.symbols
|
||||
|
||||
# Obfuscation related
|
||||
app.*.map.json
|
||||
|
||||
# Android Studio will place build artifacts here
|
||||
/android/app/debug
|
||||
/android/app/profile
|
||||
/android/app/release
|
30
packages/wyatt_continuous_deployment/example/.metadata
Normal file
30
packages/wyatt_continuous_deployment/example/.metadata
Normal file
@ -0,0 +1,30 @@
|
||||
# This file tracks properties of this Flutter project.
|
||||
# Used by Flutter tool to assess capabilities and perform upgrades etc.
|
||||
#
|
||||
# This file should be version controlled.
|
||||
|
||||
version:
|
||||
revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
|
||||
channel: stable
|
||||
|
||||
project_type: app
|
||||
|
||||
# Tracks metadata for the flutter migrate command
|
||||
migration:
|
||||
platforms:
|
||||
- platform: root
|
||||
create_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
|
||||
base_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
|
||||
- platform: web
|
||||
create_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
|
||||
base_revision: b06b8b2710955028a6b562f5aa6fe62941d6febf
|
||||
|
||||
# User provided section
|
||||
|
||||
# List of Local paths (relative to this file) that should be
|
||||
# ignored by the migrate tool.
|
||||
#
|
||||
# Files that are not part of the templates will be ignored by default.
|
||||
unmanaged_files:
|
||||
- 'lib/main.dart'
|
||||
- 'ios/Runner.xcodeproj/project.pbxproj'
|
16
packages/wyatt_continuous_deployment/example/README.md
Normal file
16
packages/wyatt_continuous_deployment/example/README.md
Normal file
@ -0,0 +1,16 @@
|
||||
# example
|
||||
|
||||
A new Flutter project.
|
||||
|
||||
## Getting Started
|
||||
|
||||
This project is a starting point for a Flutter application.
|
||||
|
||||
A few resources to get you started if this is your first Flutter project:
|
||||
|
||||
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
|
||||
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
|
||||
|
||||
For help getting started with Flutter development, view the
|
||||
[online documentation](https://docs.flutter.dev/), which offers tutorials,
|
||||
samples, guidance on mobile development, and a full API reference.
|
@ -0,0 +1,7 @@
|
||||
|
||||
|
||||
|
||||
include: package:wyatt_analysis/analysis_options.yaml
|
||||
|
||||
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user