Compare commits
105 Commits
layouts/fe
...
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 | |||
31350762c5 | |||
088d4bb184 | |||
12568b3ada | |||
3a7b7dfd1d | |||
ff0f76d910 | |||
54bff3e72e | |||
c19bb76d5c | |||
bd80934196 | |||
74593fa9fc | |||
af841baefb | |||
993c8b60ac | |||
e94db052b8 | |||
8a026cf541 | |||
f2c33feb73 | |||
14a5abd439 | |||
72150de3a3 | |||
524efa2fd1 | |||
5d88a338ba | |||
1fa8bd6287 | |||
7c03ca3317 | |||
11fcce7f87 | |||
008facdb6c | |||
3911942a81 | |||
84a6705446 | |||
5a7b8bf958 | |||
b2d97623b7 | |||
efa4c4e13d | |||
edb74a6748 | |||
e460908a7c | |||
c19e016702 | |||
0a950638db | |||
2addc94405 | |||
2add09840d | |||
59fcd93aa5 | |||
1c47fa8e94 | |||
791a6d0f83 | |||
8be4efbb52 | |||
693e3398b6 | |||
a6903ae432 | |||
a4c73421d2 | |||
227158725d | |||
cc41b7b589 | |||
e74346b655 | |||
54bd147e87 | |||
543b9421ca | |||
33f075e3c2 | |||
c13d06105b | |||
a1c44bfb28 | |||
a8e826f58b | |||
9704177c5a | |||
024c5a8c88 | |||
c0d8425552 | |||
c0d9447183 | |||
64f588a819 | |||
871c52f54d | |||
18fffa09fb | |||
51efc56ced | |||
f4972e629d | |||
2b0fa4b578 | |||
1be187b83d | |||
18e8d1c754 | |||
bcc5c0f268 | |||
68ace8e39f | |||
d32bf9a38f | |||
bbfbf40126 | |||
![]() |
792c3f774e | ||
56dc31ace5 | |||
6f6722f56d | |||
140ca77f56 | |||
8adc68230c | |||
ef19191093 | |||
873a3b426d | |||
296bb0175e | |||
9a3ae2de5c | |||
a078f6b6b0 | |||
fd40d1be3d | |||
952d3f8539 | |||
5de3dbd5b3 | |||
874d85f29c | |||
a82d28a6d5 | |||
80135a611d | |||
93873e3134 | |||
553b6763af |
@ -584,7 +584,6 @@ new_version.sh
|
||||
.latest_version
|
||||
.vscode/
|
||||
example/
|
||||
models/
|
||||
build/
|
||||
*.iml
|
||||
|
||||
tool/
|
||||
|
472
CHANGELOG.md
472
CHANGELOG.md
@ -3,6 +3,478 @@
|
||||
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
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- [`wyatt_crud_bloc` - `v0.2.0`](#wyatt_crud_bloc---v020)
|
||||
- [`wyatt_crud_bloc_firestore` - `v0.2.0`](#wyatt_crud_bloc_firestore---v020)
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_bloc_layout` - `v0.1.2+4`](#wyatt_bloc_layout---v0124)
|
||||
|
||||
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+4`
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_crud_bloc` - `v0.2.0`
|
||||
|
||||
- **REFACTOR**: make CrudLoading instanciable.
|
||||
- **FIX**: rename wyatt_bruc_bloc_firestore main package file.
|
||||
- **FIX**: apply dart format.
|
||||
- **FIX**: apply dart fix --apply.
|
||||
- **FEAT**(crud): add streaming usecase (closes #180).
|
||||
- **DOCS**(crud): update readme.
|
||||
- **BREAKING** **FEAT**(crud): make crudbuilder integration more easy by integrating blocbuilder (closes #181).
|
||||
- **BREAKING** **FEAT**(crud): move crud firestore implementation into his own package.
|
||||
|
||||
#### `wyatt_crud_bloc_firestore` - `v0.2.0`
|
||||
|
||||
- **FIX**: rename wyatt_bruc_bloc_firestore main package file.
|
||||
- **DOCS**(crud): update readme.
|
||||
- **BREAKING** **FEAT**(crud): move crud firestore implementation into his own package.
|
||||
|
||||
|
||||
## 2023-10-04
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_authentication_bloc` - `v0.5.1+3`](#wyatt_authentication_bloc---v0513)
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_authentication_bloc` - `v0.5.1+3`
|
||||
|
||||
- upgrade deps
|
||||
|
||||
|
||||
## 2023-09-29
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_ui_kit` - `v3.2.3`](#wyatt_ui_kit---v323)
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_ui_kit` - `v3.2.3`
|
||||
|
||||
- **REFACTOR**: swap gesture dector in top navbar to allow bigger tap zone.
|
||||
|
||||
|
||||
## 2023-09-01
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_ui_components` - `v0.3.0+2`](#wyatt_ui_components---v0302)
|
||||
- [`wyatt_bloc_layout` - `v0.1.2+3`](#wyatt_bloc_layout---v0123)
|
||||
- [`wyatt_ui_kit` - `v3.2.2`](#wyatt_ui_kit---v322)
|
||||
- [`wyatt_ui_layout` - `v0.1.2+3`](#wyatt_ui_layout---v0123)
|
||||
|
||||
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+3`
|
||||
- `wyatt_ui_kit` - `v3.2.2`
|
||||
- `wyatt_ui_layout` - `v0.1.2+3`
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_ui_components` - `v0.3.0+2`
|
||||
|
||||
- **FIX**: make components nullable.
|
||||
|
||||
|
||||
## 2023-08-30
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_ui_layout` - `v0.1.2+2`](#wyatt_ui_layout---v0122)
|
||||
- [`wyatt_bloc_layout` - `v0.1.2+2`](#wyatt_bloc_layout---v0122)
|
||||
|
||||
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+2`
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_ui_layout` - `v0.1.2+2`
|
||||
|
||||
- **FIX**(ui_layout): fix bottom navbar layouts.
|
||||
- **FIX**(ui_layout): fix topappbar layouts.
|
||||
- **FIX**: make components nullable.
|
||||
|
||||
|
||||
## 2023-08-28
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_ui_components` - `v0.3.0+1`](#wyatt_ui_components---v0301)
|
||||
- [`wyatt_bloc_layout` - `v0.1.2+1`](#wyatt_bloc_layout---v0121)
|
||||
- [`wyatt_ui_layout` - `v0.1.2+1`](#wyatt_ui_layout---v0121)
|
||||
- [`wyatt_ui_kit` - `v3.2.1`](#wyatt_ui_kit---v321)
|
||||
|
||||
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+1`
|
||||
- `wyatt_ui_layout` - `v0.1.2+1`
|
||||
- `wyatt_ui_kit` - `v3.2.1`
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_ui_components` - `v0.3.0+1`
|
||||
|
||||
- **FIX**(ui_components): rollback private fileds in component theme data.
|
||||
|
||||
|
||||
## 2023-08-28
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- [`wyatt_ui_components` - `v0.3.0`](#wyatt_ui_components---v030)
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_architecture` - `v0.2.0+1`](#wyatt_architecture---v0201)
|
||||
- [`wyatt_authentication_bloc` - `v0.5.1+2`](#wyatt_authentication_bloc---v0512)
|
||||
- [`wyatt_bloc_layout` - `v0.1.2`](#wyatt_bloc_layout---v012)
|
||||
- [`wyatt_cloud_messaging_bloc_base` - `v0.1.1+2`](#wyatt_cloud_messaging_bloc_base---v0112)
|
||||
- [`wyatt_cloud_messaging_bloc_firebase` - `v0.1.0+2`](#wyatt_cloud_messaging_bloc_firebase---v0102)
|
||||
- [`wyatt_crud_bloc` - `v0.1.1+1`](#wyatt_crud_bloc---v0111)
|
||||
- [`wyatt_form_bloc` - `v0.2.0+4`](#wyatt_form_bloc---v0204)
|
||||
- [`wyatt_http_client` - `v2.0.1`](#wyatt_http_client---v201)
|
||||
- [`wyatt_i18n` - `v2.0.1`](#wyatt_i18n---v201)
|
||||
- [`wyatt_ui_kit` - `v3.2.0`](#wyatt_ui_kit---v320)
|
||||
- [`wyatt_ui_layout` - `v0.1.2`](#wyatt_ui_layout---v012)
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_ui_components` - `v0.3.0`
|
||||
|
||||
- **FIX**: apply dart format.
|
||||
- **FEAT**(ui_components): marking fields as private since it was accessible from getters.
|
||||
- **BREAKING** **FEAT**(ui_components): available same type component usage (#200).
|
||||
|
||||
#### `wyatt_architecture` - `v0.2.0+1`
|
||||
|
||||
- **FIX**: apply dart fix --apply.
|
||||
|
||||
#### `wyatt_authentication_bloc` - `v0.5.1+2`
|
||||
|
||||
- **FIX**(authentication_bloc): upgrade google sign to his major v.
|
||||
- **FIX**: apply dart format.
|
||||
- **FIX**: apply dart fix --apply.
|
||||
- **FIX**(authentication_bloc): go router version refactoring.
|
||||
- **FIX**: use correct behavior subject for stream session.
|
||||
|
||||
#### `wyatt_bloc_layout` - `v0.1.2`
|
||||
|
||||
- **REFACTOR**(bloc_layouts): refactored block using the ui layout package, due to breaking changes.
|
||||
- **FIX**(bloc_layout): typo on erroId.
|
||||
- **FIX**: apply dart fix --apply.
|
||||
- **FEAT**(bloc_layout): add components ids in crud mixin.
|
||||
- **DOCS**: update plantuml models.
|
||||
|
||||
#### `wyatt_cloud_messaging_bloc_base` - `v0.1.1+2`
|
||||
|
||||
- **FIX**: apply dart format.
|
||||
- **FIX**: apply dart fix --apply.
|
||||
- **DOCS**(cloud_messaging_bloc): add reamde.
|
||||
|
||||
#### `wyatt_cloud_messaging_bloc_firebase` - `v0.1.0+2`
|
||||
|
||||
- **REFACTOR**(cloud_messaging_bloc_firebase): update deps.
|
||||
- **DOCS**(cloud_messaging_bloc): add reamde.
|
||||
|
||||
#### `wyatt_crud_bloc` - `v0.1.1+1`
|
||||
|
||||
- **FIX**: apply dart format.
|
||||
- **FIX**: apply dart fix --apply.
|
||||
|
||||
#### `wyatt_form_bloc` - `v0.2.0+4`
|
||||
|
||||
- **FIX**: apply dart format.
|
||||
|
||||
#### `wyatt_http_client` - `v2.0.1`
|
||||
|
||||
- **FIX**: apply dart fix --apply.
|
||||
|
||||
#### `wyatt_i18n` - `v2.0.1`
|
||||
|
||||
- **FIX**: apply dart fix --apply.
|
||||
|
||||
#### `wyatt_ui_kit` - `v3.2.0`
|
||||
|
||||
- **REFACTOR**(ui_kit): Refactored code using the UI components package, due to breaking changes.
|
||||
- **FIX**: apply dart format.
|
||||
- **FIX**: apply dart fix --apply.
|
||||
- **FEAT**: implement notification abstraction package.
|
||||
|
||||
#### `wyatt_ui_layout` - `v0.1.2`
|
||||
|
||||
- **REFACTOR**(ui_layouts): Refactored block using the UI components package, introducing breaking changes.
|
||||
- **FEAT**: implement notification abstraction package.
|
||||
|
||||
|
||||
## 2023-08-21
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_i18n` - `v2.0.0+1`](#wyatt_i18n---v2001)
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_i18n` - `v2.0.0+1`
|
||||
|
||||
|
||||
## 2023-08-18
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_cloud_messaging_bloc_base` - `v0.1.1+1`](#wyatt_cloud_messaging_bloc_base---v0111)
|
||||
- [`wyatt_cloud_messaging_bloc_firebase` - `v0.1.0+1`](#wyatt_cloud_messaging_bloc_firebase---v0101)
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_cloud_messaging_bloc_base` - `v0.1.1+1`
|
||||
|
||||
- **FIX**: fix unimplemented error in listenable use case.
|
||||
|
||||
#### `wyatt_cloud_messaging_bloc_firebase` - `v0.1.0+1`
|
||||
|
||||
- **REFACTOR**(cloud_messaging_bloc_firebase): update deps.
|
||||
|
||||
|
||||
## 2023-08-18
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_cloud_messaging_bloc_base` - `v0.1.1`](#wyatt_cloud_messaging_bloc_base---v011)
|
||||
- [`wyatt_cloud_messaging_bloc_firebase` - `v0.1.0+1`](#wyatt_cloud_messaging_bloc_firebase---v0101)
|
||||
|
||||
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_cloud_messaging_bloc_firebase` - `v0.1.0+1`
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_cloud_messaging_bloc_base` - `v0.1.1`
|
||||
|
||||
- **REFACTOR**: modify methods on usage.
|
||||
- **FIX**: fix notifs listeners.
|
||||
- **FEAT**: check exception in listen notifications use cases.
|
||||
|
||||
|
||||
## 2023-08-16
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_authentication_bloc` - `v0.5.1+1`](#wyatt_authentication_bloc---v0511)
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_authentication_bloc` - `v0.5.1+1`
|
||||
|
||||
- **FIX**: use correct behavior subject for stream session.
|
||||
|
||||
|
||||
## 2023-08-09
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_authentication_bloc` - `v0.5.1`](#wyatt_authentication_bloc---v051)
|
||||
- [`wyatt_bloc_layout` - `v0.1.1`](#wyatt_bloc_layout---v011)
|
||||
- [`wyatt_ui_components` - `v0.2.2`](#wyatt_ui_components---v022)
|
||||
- [`wyatt_ui_kit` - `v3.1.0`](#wyatt_ui_kit---v310)
|
||||
- [`wyatt_ui_layout` - `v0.1.1`](#wyatt_ui_layout---v011)
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_authentication_bloc` - `v0.5.1`
|
||||
|
||||
- **FIX**(authentication): try/catch on cache retrieve.
|
||||
- **FEAT**(auth): add mocked cache data source.
|
||||
|
||||
#### `wyatt_bloc_layout` - `v0.1.1`
|
||||
|
||||
- **FEAT**(bloc_layout): add consumer layouts.
|
||||
- **FEAT**(ui_layout-bloc_layout): proxy scaffold fields.
|
||||
|
||||
#### `wyatt_ui_components` - `v0.2.2`
|
||||
|
||||
- **FIX**: upgrade to flutter 3.10.
|
||||
- **FEAT**: add items manipulation in bottom bar component.
|
||||
- **FEAT**(ui): export pricing card.
|
||||
- **FEAT**(ui): proxy some rich text parameters.
|
||||
|
||||
#### `wyatt_ui_kit` - `v3.1.0`
|
||||
|
||||
- **FIX**: upgrade to flutter 3.10.
|
||||
- **FEAT**(ui): export pricing card.
|
||||
- **FEAT**(ui): proxy some rich text parameters.
|
||||
- **FEAT**(ui): tweak some values.
|
||||
|
||||
#### `wyatt_ui_layout` - `v0.1.1`
|
||||
|
||||
- **FEAT**(ui_layout-bloc_layout): proxy scaffold fields.
|
||||
|
||||
|
||||
## 2023-05-06
|
||||
|
||||
### Changes
|
||||
|
||||
---
|
||||
|
||||
Packages with breaking changes:
|
||||
|
||||
- There are no breaking changes in this release.
|
||||
|
||||
Packages with other changes:
|
||||
|
||||
- [`wyatt_authentication_bloc` - `v0.5.0+1`](#wyatt_authentication_bloc---v0501)
|
||||
|
||||
---
|
||||
|
||||
#### `wyatt_authentication_bloc` - `v0.5.0+1`
|
||||
|
||||
- **REFACTOR**(authentication): controle cache checking.
|
||||
|
||||
|
||||
## 2023-05-04
|
||||
|
||||
### 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
|
||||
|
@ -1 +0,0 @@
|
||||
2.5.0
|
@ -1,3 +1,29 @@
|
||||
## 2.6.1
|
||||
|
||||
- **REMOVED** diagnostic_describe_all_properties (https://dart.dev/tools/linter-rules/diagnostic_describe_all_properties)
|
||||
|
||||
## 2.6.0
|
||||
|
||||
- **ADDED** deprecated_member_use_from_same_package (https://dart.dev/tools/linter-rules/deprecated_member_use_from_same_package)
|
||||
- **ADDED** diagnostic_describe_all_properties (https://dart.dev/tools/linter-rules/diagnostic_describe_all_properties)
|
||||
- **ADDED** implicit_reopen (https://dart.dev/tools/linter-rules/implicit_reopen)
|
||||
- **ADDED** invalid_case_patterns (https://dart.dev/tools/linter-rules/invalid_case_patterns)
|
||||
- **ADDED** matching_super_parameters (https://dart.dev/tools/linter-rules/matching_super_parameters)
|
||||
- **ADDED** no_literal_bool_comparisons (https://dart.dev/tools/linter-rules/no_literal_bool_comparisons)
|
||||
- **ADDED** no_self_assignments (https://dart.dev/tools/linter-rules/no_self_assignments)
|
||||
- **ADDED** no_wildcard_variable_uses (https://dart.dev/tools/linter-rules/no_wildcard_variable_uses)
|
||||
- **ADDED** prefer_final_parameters (https://dart.dev/tools/linter-rules/prefer_final_parameters)
|
||||
- **ADDED** prefer_foreach (https://dart.dev/tools/linter-rules/prefer_foreach)
|
||||
- **ADDED** type_literal_in_constant_pattern (https://dart.dev/tools/linter-rules/type_literal_in_constant_pattern)
|
||||
- **ADDED** unnecessary_breaks (https://dart.dev/tools/linter-rules/unnecessary_breaks)
|
||||
- **ADDED** unnecessary_library_directive (https://dart.dev/tools/linter-rules/unnecessary_library_directive)
|
||||
- **ADDED** unnecessary_null_aware_operator_on_extension_on_nullable (https://dart.dev/tools/linter-rules/unnecessary_null_aware_operator_on_extension_on_nullable)
|
||||
- **REMOVED** always_require_non_null_named_parameters (https://dart.dev/tools/linter-rules/always_require_non_null_named_parameters)
|
||||
- **REMOVED** avoid_returning_null_for_future (https://dart.dev/tools/linter-rules/avoid_returning_null_for_future)
|
||||
- **REMOVED** iterable_contains_unrelated_type (https://dart.dev/tools/linter-rules/iterable_contains_unrelated_type)
|
||||
- **REMOVED** list_remove_unrelated_type (https://dart.dev/tools/linter-rules/list_remove_unrelated_type)
|
||||
- **REMOVED** prefer_equal_for_default_values (https://dart.dev/tools/linter-rules/prefer_equal_for_default_values)
|
||||
|
||||
## 2.5.0
|
||||
|
||||
- **FIX**(analysis): remove depencies sort. (4e3b288e)
|
||||
|
@ -20,7 +20,7 @@
|
||||
|
||||

|
||||
|
||||
This package provides lint rules for Dart and Flutter which are used at [Wyatt Studio](https://wyatt-studio.fr). For more information, see the complete list of options in **lib/analysis_options.2.5.0.yaml**.
|
||||
This package provides lint rules for Dart and Flutter which are used at [Wyatt Studio](https://wyatt-studio.fr). For more information, see the complete list of options in **lib/analysis_options.2.6.1.yaml**.
|
||||
|
||||
**Note**: This package was heavily inspired by [pedantic](https://github.com/dart-lang/pedantic), [Very Good Analysis](https://github.com/VeryGoodOpenSource/very_good_analysis) and the official [flutter_lints](https://pub.dev/packages/flutter_lints).
|
||||
|
||||
@ -29,7 +29,7 @@ This package provides lint rules for Dart and Flutter which are used at [Wyatt
|
||||
Using CLI:
|
||||
|
||||
```sh
|
||||
dart pub add wyatt_analysis:2.5.0 --dev --hosted-url=https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
dart pub add wyatt_analysis:2.6.1 --dev --hosted-url=https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
```
|
||||
|
||||
## Usage
|
||||
@ -39,7 +39,7 @@ To use the lints, add a dependency in your `pubspec.yaml` :
|
||||
```yaml
|
||||
wyatt_analysis:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
version: 2.5.0
|
||||
version: 2.6.1
|
||||
```
|
||||
|
||||
Then, add an include in `analysis_options.yaml` :
|
||||
@ -57,13 +57,13 @@ include: package:wyatt_analysis/analysis_options.flutter.yaml
|
||||
If you wish to restrict the lint version, specify a version of `analysis_options.yaml` instead:
|
||||
|
||||
```yaml
|
||||
include: package:wyatt_analysis/analysis_options.flutter.2.5.0.yaml
|
||||
include: package:wyatt_analysis/analysis_options.flutter.2.6.1.yaml
|
||||
```
|
||||
|
||||
If you just want **Dart** version:
|
||||
|
||||
```yaml
|
||||
include: package:wyatt_analysis/analysis_options.2.5.0.yaml
|
||||
include: package:wyatt_analysis/analysis_options.2.6.1.yaml
|
||||
```
|
||||
|
||||
## Suppressing Lints
|
||||
@ -117,12 +117,44 @@ To indicate your project is using `wyatt_analysis` → [![style: wyatt analysis]
|
||||
When you want to create a new version of the plugin. Before any modification, execute the following command to create new files:
|
||||
|
||||
```sh
|
||||
./new_version.sh <new_version>
|
||||
./tool/new_version.sh <version>
|
||||
```
|
||||
|
||||
The previous version is automatically detected thanks to the `.latest_version` file.
|
||||
So `.latest_version` needs to be versioned!
|
||||
The previous version is automatically retrieved from the `pubspec.yaml` file.
|
||||
|
||||
This script will create the following files:
|
||||
* `lib/analysis_options.<version>.yaml`
|
||||
* `lib/analysis_options.flutter.<version>.yaml`
|
||||
|
||||
And update the following files:
|
||||
* `README.md`
|
||||
* `pubspec.yaml`
|
||||
* `lib/analysis_options.yaml`
|
||||
* `lib/analysis_options.flutter.yaml`
|
||||
* `lib/wyatt_analysis.dart`
|
||||
|
||||
Then, you can use the following command to retrieve latest available lints from the official linter.
|
||||
|
||||
```sh
|
||||
./tool/check_rules.sh
|
||||
```
|
||||
|
||||
After that, you can modify the files `lib/analysis_options.<version>.yaml` and `lib/analysis_options.flutter.<version>.yaml` to add new lints or remove some.
|
||||
|
||||
Then you can sort the lints with the following command:
|
||||
|
||||
```sh
|
||||
./tool/sort_rules.sh
|
||||
```
|
||||
|
||||
Finally, you can generate the changelog with the following command:
|
||||
|
||||
```sh
|
||||
./tool/generate_changelog.sh <old_version>
|
||||
```
|
||||
|
||||
The new version is automatically retrieved from the `pubspec.yaml` file. But **you have to specify** the previous version.
|
||||
|
||||
## Notes
|
||||
|
||||
You can explore every lint rules [here](https://dart-lang.github.io/linter/lints/).
|
||||
You can explore every lint rules [here](https://dart.dev/tool/linter-rules).
|
||||
|
231
packages/wyatt_analysis/lib/analysis_options.2.6.0.yaml
Normal file
231
packages/wyatt_analysis/lib/analysis_options.2.6.0.yaml
Normal file
@ -0,0 +1,231 @@
|
||||
# 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/>.
|
||||
|
||||
analyzer:
|
||||
language:
|
||||
strict-casts: true
|
||||
strict-inference: true
|
||||
strict-raw-types: true
|
||||
errors:
|
||||
todo: ignore
|
||||
close_sinks: ignore
|
||||
missing_required_param: error
|
||||
missing_return: error
|
||||
record_literal_one_positional_no_trailing_comma: error
|
||||
collection_methods_unrelated_type: warning
|
||||
unrelated_type_equality_checks: warning
|
||||
exclude:
|
||||
- lib/l10n/**
|
||||
- lib/generated/**
|
||||
- lib/gen/**
|
||||
- lib/generated_plugin_registrant.dart
|
||||
- test/.test_coverage.dart
|
||||
- "**/*.g.dart"
|
||||
- "**/*.freezed.dart"
|
||||
linter:
|
||||
rules:
|
||||
- always_declare_return_types
|
||||
- always_put_control_body_on_new_line
|
||||
- always_put_required_named_parameters_first
|
||||
- always_use_package_imports
|
||||
- annotate_overrides
|
||||
- avoid_bool_literals_in_conditional_expressions
|
||||
- avoid_catching_errors
|
||||
- avoid_double_and_int_checks
|
||||
- avoid_dynamic_calls
|
||||
- avoid_empty_else
|
||||
- avoid_equals_and_hash_code_on_mutable_classes
|
||||
- avoid_escaping_inner_quotes
|
||||
- avoid_field_initializers_in_const_classes
|
||||
- avoid_final_parameters
|
||||
- avoid_function_literals_in_foreach_calls
|
||||
- avoid_init_to_null
|
||||
- avoid_js_rounded_ints
|
||||
- avoid_multiple_declarations_per_line
|
||||
- avoid_null_checks_in_equality_operators
|
||||
- avoid_positional_boolean_parameters
|
||||
- avoid_private_typedef_functions
|
||||
- avoid_redundant_argument_values
|
||||
- avoid_relative_lib_imports
|
||||
- avoid_renaming_method_parameters
|
||||
- avoid_return_types_on_setters
|
||||
- avoid_returning_null
|
||||
- avoid_returning_null_for_void
|
||||
- avoid_returning_this
|
||||
- avoid_setters_without_getters
|
||||
- avoid_shadowing_type_parameters
|
||||
- avoid_single_cascade_in_expression_statements
|
||||
- avoid_slow_async_io
|
||||
- avoid_type_to_string
|
||||
- avoid_types_as_parameter_names
|
||||
- avoid_types_on_closure_parameters
|
||||
- avoid_unused_constructor_parameters
|
||||
- avoid_void_async
|
||||
- await_only_futures
|
||||
- camel_case_extensions
|
||||
- camel_case_types
|
||||
- cancel_subscriptions
|
||||
- cascade_invocations
|
||||
- cast_nullable_to_non_nullable
|
||||
- collection_methods_unrelated_type
|
||||
- combinators_ordering
|
||||
- comment_references
|
||||
- conditional_uri_does_not_exist
|
||||
- constant_identifier_names
|
||||
- control_flow_in_finally
|
||||
- curly_braces_in_flow_control_structures
|
||||
- dangling_library_doc_comments
|
||||
- depend_on_referenced_packages
|
||||
- deprecated_consistency
|
||||
- deprecated_member_use_from_same_package
|
||||
- directives_ordering
|
||||
- empty_catches
|
||||
- empty_constructor_bodies
|
||||
- empty_statements
|
||||
- eol_at_end_of_file
|
||||
- exhaustive_cases
|
||||
- file_names
|
||||
- flutter_style_todos
|
||||
- hash_and_equals
|
||||
- implementation_imports
|
||||
- implicit_call_tearoffs
|
||||
- implicit_reopen
|
||||
- invalid_case_patterns
|
||||
- join_return_with_assignment
|
||||
- leading_newlines_in_multiline_strings
|
||||
- library_names
|
||||
- library_prefixes
|
||||
- library_private_types_in_public_api
|
||||
- lines_longer_than_80_chars
|
||||
- literal_only_boolean_expressions
|
||||
- matching_super_parameters
|
||||
- missing_whitespace_between_adjacent_strings
|
||||
- no_adjacent_strings_in_list
|
||||
- no_default_cases
|
||||
- no_duplicate_case_values
|
||||
- no_leading_underscores_for_library_prefixes
|
||||
- no_leading_underscores_for_local_identifiers
|
||||
- no_literal_bool_comparisons
|
||||
- no_runtimeType_toString
|
||||
- no_self_assignments
|
||||
- no_wildcard_variable_uses
|
||||
- non_constant_identifier_names
|
||||
- noop_primitive_operations
|
||||
- null_check_on_nullable_type_parameter
|
||||
- null_closures
|
||||
- one_member_abstracts
|
||||
- only_throw_errors
|
||||
- overridden_fields
|
||||
- package_api_docs
|
||||
- package_names
|
||||
- package_prefixed_library_names
|
||||
- parameter_assignments
|
||||
- prefer_adjacent_string_concatenation
|
||||
- prefer_asserts_in_initializer_lists
|
||||
- prefer_asserts_with_message
|
||||
- prefer_collection_literals
|
||||
- prefer_conditional_assignment
|
||||
- prefer_const_constructors
|
||||
- prefer_const_constructors_in_immutables
|
||||
- prefer_const_declarations
|
||||
- prefer_const_literals_to_create_immutables
|
||||
- prefer_constructors_over_static_methods
|
||||
- prefer_contains
|
||||
- prefer_expression_function_bodies
|
||||
- prefer_final_fields
|
||||
- prefer_final_in_for_each
|
||||
- prefer_final_locals
|
||||
- prefer_for_elements_to_map_fromIterable
|
||||
- prefer_foreach
|
||||
- prefer_function_declarations_over_variables
|
||||
- prefer_generic_function_type_aliases
|
||||
- prefer_if_elements_to_conditional_expressions
|
||||
- prefer_if_null_operators
|
||||
- prefer_initializing_formals
|
||||
- prefer_inlined_adds
|
||||
- prefer_int_literals
|
||||
- prefer_interpolation_to_compose_strings
|
||||
- prefer_is_empty
|
||||
- prefer_is_not_empty
|
||||
- prefer_is_not_operator
|
||||
- prefer_iterable_whereType
|
||||
- prefer_mixin
|
||||
- prefer_null_aware_method_calls
|
||||
- prefer_null_aware_operators
|
||||
- prefer_single_quotes
|
||||
- prefer_spread_collections
|
||||
- prefer_typing_uninitialized_variables
|
||||
- prefer_void_to_null
|
||||
- provide_deprecation_message
|
||||
- recursive_getters
|
||||
- require_trailing_commas
|
||||
- slash_for_doc_comments
|
||||
- sort_constructors_first
|
||||
- sort_unnamed_constructors_first
|
||||
- test_types_in_equals
|
||||
- throw_in_finally
|
||||
- tighten_type_of_initializing_formals
|
||||
- type_annotate_public_apis
|
||||
- type_init_formals
|
||||
- type_literal_in_constant_pattern
|
||||
- unawaited_futures
|
||||
- unnecessary_await_in_return
|
||||
- unnecessary_brace_in_string_interps
|
||||
- unnecessary_breaks
|
||||
- unnecessary_const
|
||||
- unnecessary_constructor_name
|
||||
- unnecessary_getters_setters
|
||||
- unnecessary_lambdas
|
||||
- unnecessary_late
|
||||
- unnecessary_library_directive
|
||||
- unnecessary_new
|
||||
- unnecessary_null_aware_assignments
|
||||
- unnecessary_null_aware_operator_on_extension_on_nullable
|
||||
- unnecessary_null_checks
|
||||
- unnecessary_null_in_if_null_operators
|
||||
- unnecessary_nullable_for_final_variable_declarations
|
||||
- unnecessary_overrides
|
||||
- unnecessary_parenthesis
|
||||
- unnecessary_raw_strings
|
||||
- unnecessary_statements
|
||||
- unnecessary_string_escapes
|
||||
- unnecessary_string_interpolations
|
||||
- unnecessary_this
|
||||
- unnecessary_to_list_in_spreads
|
||||
- unrelated_type_equality_checks
|
||||
- unsafe_html
|
||||
- use_enums
|
||||
- use_function_type_syntax_for_parameters
|
||||
- use_if_null_to_convert_nulls_to_bools
|
||||
- use_is_even_rather_than_modulo
|
||||
- use_late_for_private_fields_and_variables
|
||||
- use_named_constants
|
||||
- use_raw_strings
|
||||
- use_rethrow_when_possible
|
||||
- use_setters_to_change_properties
|
||||
- use_string_buffers
|
||||
- use_string_in_part_of_directives
|
||||
- use_super_parameters
|
||||
- use_test_throws_matchers
|
||||
- use_to_and_as_if_applicable
|
||||
- valid_regexps
|
||||
- void_checks
|
||||
# Ignored rules (incompatible with some of our rules)
|
||||
# - always_specify_types
|
||||
# - prefer_double_quotes
|
||||
# - prefer_relative_imports
|
||||
# - unnecessary_final
|
||||
# - prefer_final_parameters
|
231
packages/wyatt_analysis/lib/analysis_options.2.6.1.yaml
Normal file
231
packages/wyatt_analysis/lib/analysis_options.2.6.1.yaml
Normal file
@ -0,0 +1,231 @@
|
||||
# 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/>.
|
||||
|
||||
analyzer:
|
||||
language:
|
||||
strict-casts: true
|
||||
strict-inference: true
|
||||
strict-raw-types: true
|
||||
errors:
|
||||
todo: ignore
|
||||
close_sinks: ignore
|
||||
missing_required_param: error
|
||||
missing_return: error
|
||||
record_literal_one_positional_no_trailing_comma: error
|
||||
collection_methods_unrelated_type: warning
|
||||
unrelated_type_equality_checks: warning
|
||||
exclude:
|
||||
- lib/l10n/**
|
||||
- lib/generated/**
|
||||
- lib/gen/**
|
||||
- lib/generated_plugin_registrant.dart
|
||||
- test/.test_coverage.dart
|
||||
- "**/*.g.dart"
|
||||
- "**/*.freezed.dart"
|
||||
linter:
|
||||
rules:
|
||||
- always_declare_return_types
|
||||
- always_put_control_body_on_new_line
|
||||
- always_put_required_named_parameters_first
|
||||
- always_use_package_imports
|
||||
- annotate_overrides
|
||||
- avoid_bool_literals_in_conditional_expressions
|
||||
- avoid_catching_errors
|
||||
- avoid_double_and_int_checks
|
||||
- avoid_dynamic_calls
|
||||
- avoid_empty_else
|
||||
- avoid_equals_and_hash_code_on_mutable_classes
|
||||
- avoid_escaping_inner_quotes
|
||||
- avoid_field_initializers_in_const_classes
|
||||
- avoid_final_parameters
|
||||
- avoid_function_literals_in_foreach_calls
|
||||
- avoid_init_to_null
|
||||
- avoid_js_rounded_ints
|
||||
- avoid_multiple_declarations_per_line
|
||||
- avoid_null_checks_in_equality_operators
|
||||
- avoid_positional_boolean_parameters
|
||||
- avoid_private_typedef_functions
|
||||
- avoid_redundant_argument_values
|
||||
- avoid_relative_lib_imports
|
||||
- avoid_renaming_method_parameters
|
||||
- avoid_return_types_on_setters
|
||||
- avoid_returning_null
|
||||
- avoid_returning_null_for_void
|
||||
- avoid_returning_this
|
||||
- avoid_setters_without_getters
|
||||
- avoid_shadowing_type_parameters
|
||||
- avoid_single_cascade_in_expression_statements
|
||||
- avoid_slow_async_io
|
||||
- avoid_type_to_string
|
||||
- avoid_types_as_parameter_names
|
||||
- avoid_types_on_closure_parameters
|
||||
- avoid_unused_constructor_parameters
|
||||
- avoid_void_async
|
||||
- await_only_futures
|
||||
- camel_case_extensions
|
||||
- camel_case_types
|
||||
- cancel_subscriptions
|
||||
- cascade_invocations
|
||||
- cast_nullable_to_non_nullable
|
||||
- collection_methods_unrelated_type
|
||||
- combinators_ordering
|
||||
- comment_references
|
||||
- conditional_uri_does_not_exist
|
||||
- constant_identifier_names
|
||||
- control_flow_in_finally
|
||||
- curly_braces_in_flow_control_structures
|
||||
- dangling_library_doc_comments
|
||||
- depend_on_referenced_packages
|
||||
- deprecated_consistency
|
||||
- deprecated_member_use_from_same_package
|
||||
- directives_ordering
|
||||
- empty_catches
|
||||
- empty_constructor_bodies
|
||||
- empty_statements
|
||||
- eol_at_end_of_file
|
||||
- exhaustive_cases
|
||||
- file_names
|
||||
- flutter_style_todos
|
||||
- hash_and_equals
|
||||
- implementation_imports
|
||||
- implicit_call_tearoffs
|
||||
- implicit_reopen
|
||||
- invalid_case_patterns
|
||||
- join_return_with_assignment
|
||||
- leading_newlines_in_multiline_strings
|
||||
- library_names
|
||||
- library_prefixes
|
||||
- library_private_types_in_public_api
|
||||
- lines_longer_than_80_chars
|
||||
- literal_only_boolean_expressions
|
||||
- matching_super_parameters
|
||||
- missing_whitespace_between_adjacent_strings
|
||||
- no_adjacent_strings_in_list
|
||||
- no_default_cases
|
||||
- no_duplicate_case_values
|
||||
- no_leading_underscores_for_library_prefixes
|
||||
- no_leading_underscores_for_local_identifiers
|
||||
- no_literal_bool_comparisons
|
||||
- no_runtimeType_toString
|
||||
- no_self_assignments
|
||||
- no_wildcard_variable_uses
|
||||
- non_constant_identifier_names
|
||||
- noop_primitive_operations
|
||||
- null_check_on_nullable_type_parameter
|
||||
- null_closures
|
||||
- one_member_abstracts
|
||||
- only_throw_errors
|
||||
- overridden_fields
|
||||
- package_api_docs
|
||||
- package_names
|
||||
- package_prefixed_library_names
|
||||
- parameter_assignments
|
||||
- prefer_adjacent_string_concatenation
|
||||
- prefer_asserts_in_initializer_lists
|
||||
- prefer_asserts_with_message
|
||||
- prefer_collection_literals
|
||||
- prefer_conditional_assignment
|
||||
- prefer_const_constructors
|
||||
- prefer_const_constructors_in_immutables
|
||||
- prefer_const_declarations
|
||||
- prefer_const_literals_to_create_immutables
|
||||
- prefer_constructors_over_static_methods
|
||||
- prefer_contains
|
||||
- prefer_expression_function_bodies
|
||||
- prefer_final_fields
|
||||
- prefer_final_in_for_each
|
||||
- prefer_final_locals
|
||||
- prefer_for_elements_to_map_fromIterable
|
||||
- prefer_foreach
|
||||
- prefer_function_declarations_over_variables
|
||||
- prefer_generic_function_type_aliases
|
||||
- prefer_if_elements_to_conditional_expressions
|
||||
- prefer_if_null_operators
|
||||
- prefer_initializing_formals
|
||||
- prefer_inlined_adds
|
||||
- prefer_int_literals
|
||||
- prefer_interpolation_to_compose_strings
|
||||
- prefer_is_empty
|
||||
- prefer_is_not_empty
|
||||
- prefer_is_not_operator
|
||||
- prefer_iterable_whereType
|
||||
- prefer_mixin
|
||||
- prefer_null_aware_method_calls
|
||||
- prefer_null_aware_operators
|
||||
- prefer_single_quotes
|
||||
- prefer_spread_collections
|
||||
- prefer_typing_uninitialized_variables
|
||||
- prefer_void_to_null
|
||||
- provide_deprecation_message
|
||||
- recursive_getters
|
||||
- require_trailing_commas
|
||||
- slash_for_doc_comments
|
||||
- sort_constructors_first
|
||||
- sort_unnamed_constructors_first
|
||||
- test_types_in_equals
|
||||
- throw_in_finally
|
||||
- tighten_type_of_initializing_formals
|
||||
- type_annotate_public_apis
|
||||
- type_init_formals
|
||||
- type_literal_in_constant_pattern
|
||||
- unawaited_futures
|
||||
- unnecessary_await_in_return
|
||||
- unnecessary_brace_in_string_interps
|
||||
- unnecessary_breaks
|
||||
- unnecessary_const
|
||||
- unnecessary_constructor_name
|
||||
- unnecessary_getters_setters
|
||||
- unnecessary_lambdas
|
||||
- unnecessary_late
|
||||
- unnecessary_library_directive
|
||||
- unnecessary_new
|
||||
- unnecessary_null_aware_assignments
|
||||
- unnecessary_null_aware_operator_on_extension_on_nullable
|
||||
- unnecessary_null_checks
|
||||
- unnecessary_null_in_if_null_operators
|
||||
- unnecessary_nullable_for_final_variable_declarations
|
||||
- unnecessary_overrides
|
||||
- unnecessary_parenthesis
|
||||
- unnecessary_raw_strings
|
||||
- unnecessary_statements
|
||||
- unnecessary_string_escapes
|
||||
- unnecessary_string_interpolations
|
||||
- unnecessary_this
|
||||
- unnecessary_to_list_in_spreads
|
||||
- unrelated_type_equality_checks
|
||||
- unsafe_html
|
||||
- use_enums
|
||||
- use_function_type_syntax_for_parameters
|
||||
- use_if_null_to_convert_nulls_to_bools
|
||||
- use_is_even_rather_than_modulo
|
||||
- use_late_for_private_fields_and_variables
|
||||
- use_named_constants
|
||||
- use_raw_strings
|
||||
- use_rethrow_when_possible
|
||||
- use_setters_to_change_properties
|
||||
- use_string_buffers
|
||||
- use_string_in_part_of_directives
|
||||
- use_super_parameters
|
||||
- use_test_throws_matchers
|
||||
- use_to_and_as_if_applicable
|
||||
- valid_regexps
|
||||
- void_checks
|
||||
# Ignored rules (incompatible with some of our rules)
|
||||
# - always_specify_types
|
||||
# - prefer_double_quotes
|
||||
# - prefer_relative_imports
|
||||
# - unnecessary_final
|
||||
# - prefer_final_parameters
|
@ -0,0 +1,32 @@
|
||||
# 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/>.
|
||||
|
||||
include: package:wyatt_analysis/analysis_options.2.6.0.yaml
|
||||
linter:
|
||||
rules:
|
||||
- avoid_print
|
||||
- avoid_unnecessary_containers
|
||||
- avoid_web_libraries_in_flutter
|
||||
- diagnostic_describe_all_properties
|
||||
- no_logic_in_create_state
|
||||
- sized_box_for_whitespace
|
||||
- sized_box_shrink_expand
|
||||
- sort_child_properties_last
|
||||
- use_build_context_synchronously
|
||||
- use_colored_box
|
||||
- use_decorated_box
|
||||
- use_full_hex_values_for_flutter_colors
|
||||
- use_key_in_widget_constructors
|
@ -0,0 +1,31 @@
|
||||
# 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/>.
|
||||
|
||||
include: package:wyatt_analysis/analysis_options.2.6.1.yaml
|
||||
linter:
|
||||
rules:
|
||||
- avoid_print
|
||||
- avoid_unnecessary_containers
|
||||
- avoid_web_libraries_in_flutter
|
||||
- no_logic_in_create_state
|
||||
- sized_box_for_whitespace
|
||||
- sized_box_shrink_expand
|
||||
- sort_child_properties_last
|
||||
- use_build_context_synchronously
|
||||
- use_colored_box
|
||||
- use_decorated_box
|
||||
- use_full_hex_values_for_flutter_colors
|
||||
- use_key_in_widget_constructors
|
@ -1,4 +1,3 @@
|
||||
|
||||
# Copyright (C) 2023 WYATT GROUP
|
||||
# Please see the AUTHORS file for details.
|
||||
#
|
||||
@ -15,5 +14,4 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
include: package:wyatt_analysis/analysis_options.flutter.2.5.0.yaml
|
||||
|
||||
include: package:wyatt_analysis/analysis_options.flutter.2.6.1.yaml
|
||||
|
@ -1,4 +1,3 @@
|
||||
|
||||
# Copyright (C) 2023 WYATT GROUP
|
||||
# Please see the AUTHORS file for details.
|
||||
#
|
||||
@ -15,5 +14,4 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
include: package:wyatt_analysis/analysis_options.2.5.0.yaml
|
||||
|
||||
include: package:wyatt_analysis/analysis_options.2.6.1.yaml
|
||||
|
@ -18,4 +18,4 @@
|
||||
/// used internally at [Wyatt Studio](https://wyatt-studio.fr).
|
||||
library wyatt_analysis;
|
||||
|
||||
const String wyattAnalysisVersion = '2.5.0';
|
||||
const String wyattAnalysisVersion = '2.6.1';
|
||||
|
@ -1,142 +0,0 @@
|
||||
#!/usr/bin/env sh
|
||||
|
||||
# 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/>.
|
||||
|
||||
usage="
|
||||
usage:
|
||||
$(basename "$0") <new_version> -- create new analyzer files.
|
||||
|
||||
where:
|
||||
new_version: new version, for example \`2.4.0\`"
|
||||
|
||||
new=$1
|
||||
|
||||
if [ -z "$new" ]; then
|
||||
echo "new_version cannot be null"
|
||||
echo "${usage}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
SCRIPT_PATH="${BASH_SOURCE:-$0}"
|
||||
ABS_SCRIPT_PATH="$(realpath "${SCRIPT_PATH}")"
|
||||
ABS_DIRECTORY="$(dirname "${ABS_SCRIPT_PATH}")"
|
||||
|
||||
LATEST_VERSION="${ABS_DIRECTORY}/.latest_version"
|
||||
|
||||
# Read latest version
|
||||
if [ -e "$LATEST_VERSION" ]; then
|
||||
old=$(cat "$LATEST_VERSION")
|
||||
echo "> latest package version is: $old"
|
||||
echo "> new package version is: $new"
|
||||
else
|
||||
echo "latest version is not set"
|
||||
echo "create a file named \`.latest_version\` in the root of the project"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
LIB="${ABS_DIRECTORY}/lib/wyatt_analysis.dart"
|
||||
OPTIONS="${ABS_DIRECTORY}/lib/analysis_options.yaml"
|
||||
OLD_OPTIONS="${ABS_DIRECTORY}/lib/analysis_options.${old}.yaml"
|
||||
NEW_OPTIONS="${ABS_DIRECTORY}/lib/analysis_options.${new}.yaml"
|
||||
|
||||
OPTIONS_FLUTTER="${ABS_DIRECTORY}/lib/analysis_options.flutter.yaml"
|
||||
OLD_OPTIONS_FLUTTER="${ABS_DIRECTORY}/lib/analysis_options.flutter.${old}.yaml"
|
||||
NEW_OPTIONS_FLUTTER="${ABS_DIRECTORY}/lib/analysis_options.flutter.${new}.yaml"
|
||||
|
||||
|
||||
if [ ! -e "$OLD_OPTIONS" ]; then
|
||||
echo "analysis_options.${old}.yaml doesn't exists"
|
||||
echo "${usage}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ ! -e "$OLD_OPTIONS_FLUTTER" ]; then
|
||||
echo "analysis_options.flutter.${old}.yaml doesn't exists"
|
||||
echo "${usage}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ -e "$NEW_OPTIONS" ]; then
|
||||
echo "analysis_options.${new}.yaml already exists"
|
||||
echo "${usage}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ -e "$NEW_OPTIONS_FLUTTER" ]; then
|
||||
echo "analysis_options.flutter.${old}.yaml already exists"
|
||||
echo "${usage}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Copy previous version files
|
||||
cp "${OLD_OPTIONS}" "${NEW_OPTIONS}"
|
||||
cp "${OLD_OPTIONS_FLUTTER}" "${NEW_OPTIONS_FLUTTER}"
|
||||
|
||||
# Search and replace old version string occurences in new files
|
||||
sed -e "s/${old}/${new}/g" "${NEW_OPTIONS_FLUTTER}" > tempfile.tmp
|
||||
mv -f tempfile.tmp "${NEW_OPTIONS_FLUTTER}"
|
||||
|
||||
sed -e "s/${old}/${new}/g" "${LIB}" > tempfile.tmp
|
||||
mv -f tempfile.tmp "${LIB}"
|
||||
|
||||
sed -e "s/${old}/${new}/g" "README.md" > tempfile.tmp
|
||||
mv -f tempfile.tmp "README.md"
|
||||
|
||||
echo "
|
||||
# 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/>.
|
||||
|
||||
include: package:wyatt_analysis/analysis_options.${new}.yaml
|
||||
" > "${OPTIONS}"
|
||||
|
||||
echo "
|
||||
# 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/>.
|
||||
|
||||
include: package:wyatt_analysis/analysis_options.flutter.${new}.yaml
|
||||
" > "${OPTIONS_FLUTTER}"
|
||||
|
||||
# Update latest version
|
||||
echo "${new}" > "$LATEST_VERSION"
|
||||
|
||||
exit 0
|
@ -17,9 +17,9 @@
|
||||
name: wyatt_analysis
|
||||
description: Lint rules for Dart and Flutter used internally at Wyatt Studio.
|
||||
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis
|
||||
version: 2.5.0
|
||||
version: 2.6.1
|
||||
|
||||
publish_to: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
|
||||
environment:
|
||||
sdk: ">=2.12.0 <3.0.0"
|
||||
sdk: ">=3.0.0 <4.0.0"
|
||||
|
105
packages/wyatt_analysis/tool/check_rules.sh
Executable file
105
packages/wyatt_analysis/tool/check_rules.sh
Executable file
@ -0,0 +1,105 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# 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/>.
|
||||
|
||||
# This script scrapes the latest version of the ruleset from the
|
||||
# official Dart repository and tests it against the latest version of
|
||||
# the Wyatt Analysis ruleset.
|
||||
|
||||
basename=$(basename "$0")
|
||||
basepath=$(dirname "$0")
|
||||
official_ruleset_url="https://raw.githubusercontent.com/dart-lang/sdk/main/pkg/linter/example/all.yaml"
|
||||
|
||||
red=$(tput setaf 1)
|
||||
blue=$(tput setaf 4)
|
||||
yellow=$(tput setaf 3)
|
||||
reset=$(tput sgr0)
|
||||
|
||||
# Check for dependencies.
|
||||
if ! command -v yq &>/dev/null; then
|
||||
echo "yq could not be found. Please install it and try again."
|
||||
echo "https://github.com/mikefarah/yq"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check for arguments, if no arguments read latest version from pubspec.yaml.
|
||||
if [ $# -eq 0 ]; then
|
||||
wyatt_analysis_version=$(yq eval '.version' "${basepath}/../pubspec.yaml")
|
||||
else
|
||||
wyatt_analysis_version=$1
|
||||
fi
|
||||
|
||||
# Read latest version
|
||||
wyatt_analysis_version=$(yq eval '.version' "${basepath}/../pubspec.yaml")
|
||||
|
||||
# Check if the version of the Wyatt Analysis ruleset is valid by checking if the file exists.
|
||||
if [ ! -f "$basepath/../lib/analysis_options.$wyatt_analysis_version.yaml" ]; then
|
||||
echo "Wyatt Analysis version $wyatt_analysis_version could not be found."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Found Wyatt Analysis version $wyatt_analysis_version"
|
||||
|
||||
# Generate temporary directory.
|
||||
tmp_dir=$(mktemp -d)
|
||||
|
||||
# Download the official ruleset.
|
||||
curl -s "$official_ruleset_url" >"$tmp_dir/official.yaml"
|
||||
|
||||
# List yaml elements in the official ruleset, "linter.rules" and save it in an array.
|
||||
official_rules=($(yq eval '.linter.rules | .[]' "$tmp_dir/official.yaml"))
|
||||
echo "Finding differences between the official ruleset and the Wyatt Analysis ruleset..."
|
||||
echo "This may take a while..."
|
||||
|
||||
# Merges the wyatt dart analysis ruleset with the wyatt flutter analysis ruleset.
|
||||
yq ea '. as $item ireduce ({}; . *+ $item)' "$basepath/../lib/analysis_options.$wyatt_analysis_version.yaml" "$basepath/../lib/analysis_options.flutter.$wyatt_analysis_version.yaml" >"$tmp_dir/wyatt.yaml"
|
||||
|
||||
# List yaml elements in the Wyatt Analysis ruleset, "linter.rules" and save it in an array.
|
||||
wyatt_rules=($(yq eval '.linter.rules | .[]' "$tmp_dir/wyatt.yaml"))
|
||||
|
||||
# Read merged files, and list all ignored rules (starting with a # -).
|
||||
ignored_rules=($(grep -oP '(?<=# - ).*' "$tmp_dir/wyatt.yaml"))
|
||||
|
||||
echo "Found $(echo "${official_rules[@]}" | wc -w) rules in the official ruleset."
|
||||
echo "Found $(echo "${wyatt_rules[@]}" | wc -w) rules in the Wyatt Analysis ruleset."
|
||||
echo "Found $(echo "${ignored_rules[@]}" | wc -w) ignored rules in the Wyatt Analysis ruleset."
|
||||
|
||||
# Iterate over the official ruleset.
|
||||
for rule in "${official_rules[@]}"; do
|
||||
# Check if the rule is in the Wyatt Analysis ruleset.
|
||||
if ! grep -q "$rule" "$tmp_dir/wyatt.yaml"; then
|
||||
echo "${red}+ $rule${reset} (https://dart.dev/tools/linter-rules/$rule)"
|
||||
fi
|
||||
done
|
||||
|
||||
# Iterate over the Wyatt Analysis ruleset and print the rules that are not in the official ruleset.
|
||||
for rule in "${wyatt_rules[@]}"; do
|
||||
# Check if the rule is in the official ruleset.
|
||||
if ! grep -q "$rule" "$tmp_dir/official.yaml"; then
|
||||
echo "${blue}- $rule${reset} (https://dart.dev/tools/linter-rules/$rule)"
|
||||
fi
|
||||
done
|
||||
|
||||
# Iterate over the ignored rules and print them.
|
||||
for rule in "${ignored_rules[@]}"; do
|
||||
echo "${yellow}~ $rule${reset} (https://dart.dev/tools/linter-rules/$rule)"
|
||||
done
|
||||
|
||||
# Remove temporary directory.
|
||||
rm -rf "$tmp_dir"
|
||||
|
||||
exit 0
|
109
packages/wyatt_analysis/tool/generate_changelog.sh
Executable file
109
packages/wyatt_analysis/tool/generate_changelog.sh
Executable file
@ -0,0 +1,109 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# 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/>.
|
||||
|
||||
basename=$(basename "$0")
|
||||
basepath=$(dirname "$0")
|
||||
|
||||
# Check for dependencies.
|
||||
if ! command -v yq &>/dev/null; then
|
||||
echo "yq could not be found. Please install it and try again."
|
||||
echo "https://github.com/mikefarah/yq"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check for arguments,
|
||||
# it should be the version of the old ruleset that you want to compare with the new ruleset.
|
||||
|
||||
if [ $# -eq 0 ]; then
|
||||
echo "Please provide the version of the old ruleset that you want to compare with the new ruleset."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Read the version of the old ruleset from the arguments.
|
||||
old_wyatt_analysis_version=$1
|
||||
|
||||
# Read the version of the new ruleset from pubspec.yaml.
|
||||
new_wyatt_analysis_version=$(yq eval '.version' "${basepath}/../pubspec.yaml")
|
||||
|
||||
# Check if the version of the Wyatt Analysis ruleset is valid by checking if the file exists.
|
||||
if [ ! -f "$basepath/../lib/analysis_options.$old_wyatt_analysis_version.yaml" ]; then
|
||||
echo "Wyatt Analysis version $old_wyatt_analysis_version could not be found."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ ! -f "$basepath/../lib/analysis_options.$new_wyatt_analysis_version.yaml" ]; then
|
||||
echo "Wyatt Analysis version $new_wyatt_analysis_version could not be found."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Found Wyatt Analysis version $old_wyatt_analysis_version and $new_wyatt_analysis_version"
|
||||
|
||||
# Generate temporary directory.
|
||||
tmp_dir=$(mktemp -d)
|
||||
|
||||
# Merges the wyatt dart analysis ruleset with the wyatt flutter analysis ruleset.
|
||||
yq ea '. as $item ireduce ({}; . *+ $item)' "$basepath/../lib/analysis_options.$old_wyatt_analysis_version.yaml" "$basepath/../lib/analysis_options.flutter.$old_wyatt_analysis_version.yaml" >"$tmp_dir/old_wyatt.yaml"
|
||||
|
||||
yq ea '. as $item ireduce ({}; . *+ $item)' "$basepath/../lib/analysis_options.$new_wyatt_analysis_version.yaml" "$basepath/../lib/analysis_options.flutter.$new_wyatt_analysis_version.yaml" >"$tmp_dir/new_wyatt.yaml"
|
||||
|
||||
# List yaml elements in the old ruleset, "linter.rules" and save it in an array.
|
||||
old_wyatt_rules=($(yq eval '.linter.rules | .[]' "$tmp_dir/old_wyatt.yaml"))
|
||||
|
||||
# List yaml elements in the new ruleset, "linter.rules" and save it in an array.
|
||||
new_wyatt_rules=($(yq eval '.linter.rules | .[]' "$tmp_dir/new_wyatt.yaml"))
|
||||
|
||||
# List all the rules that are in the old ruleset but not in the new ruleset.
|
||||
removed_rules=($(comm -23 <(printf '%s\n' "${old_wyatt_rules[@]}" | sort) <(printf '%s\n' "${new_wyatt_rules[@]}" | sort)))
|
||||
|
||||
# List all the rules that are in the new ruleset but not in the old ruleset.
|
||||
added_rules=($(comm -13 <(printf '%s\n' "${old_wyatt_rules[@]}" | sort) <(printf '%s\n' "${new_wyatt_rules[@]}" | sort)))
|
||||
|
||||
# Generate markdown file.
|
||||
|
||||
echo "## ${new_wyatt_analysis_version}" >"$tmp_dir/CHANGELOG.md"
|
||||
echo "" >>"$tmp_dir/CHANGELOG.md"
|
||||
|
||||
# Iterate over the added rules and print them in the markdown file.
|
||||
for rule in "${added_rules[@]}"; do
|
||||
echo " - **ADDED** $rule (https://dart.dev/tools/linter-rules/$rule)" >>"$tmp_dir/CHANGELOG.md"
|
||||
done
|
||||
|
||||
# Iterate over the removed rules and print them in the markdown file.
|
||||
for rule in "${removed_rules[@]}"; do
|
||||
echo " - **REMOVED** $rule (https://dart.dev/tools/linter-rules/$rule)" >>"$tmp_dir/CHANGELOG.md"
|
||||
done
|
||||
|
||||
echo "" >>"$tmp_dir/CHANGELOG.md"
|
||||
|
||||
# Print the contents of the markdown file.
|
||||
cat "$tmp_dir/CHANGELOG.md"
|
||||
|
||||
# Ask the user if they want to add the changes to the CHANGELOG.md file.
|
||||
read -p "Do you want to add the changes to the CHANGELOG.md file? (y/n) " -n 1 -r
|
||||
|
||||
if [[ $REPLY =~ ^[Yy]$ ]]; then
|
||||
# Add the changes to the top of the CHANGELOG.md file.
|
||||
cat "$tmp_dir/CHANGELOG.md" "$basepath/../CHANGELOG.md" >"$tmp_dir/CHANGELOG.md.tmp"
|
||||
cp -f "$tmp_dir/CHANGELOG.md.tmp" "$basepath/../CHANGELOG.md"
|
||||
rm -f "$tmp_dir/CHANGELOG.md.tmp"
|
||||
fi
|
||||
|
||||
# Remove temporary directory.
|
||||
rm -rf "$tmp_dir"
|
||||
|
||||
exit 0
|
98
packages/wyatt_analysis/tool/new_version.sh
Executable file
98
packages/wyatt_analysis/tool/new_version.sh
Executable file
@ -0,0 +1,98 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# 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/>.
|
||||
|
||||
basename=$(basename "$0")
|
||||
basepath=$(dirname "$0")
|
||||
|
||||
# Check for arguments, first argument should be wyatt_analysis_version.
|
||||
if [ $# -eq 0 ]; then
|
||||
echo "Usage: $basename <wyatt_analysis_version>"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
wyatt_analysis_version=$1
|
||||
|
||||
# Check for dependencies.
|
||||
if ! command -v yq &>/dev/null; then
|
||||
echo "yq could not be found. Please install it and try again."
|
||||
echo "https://github.com/mikefarah/yq"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Read latest version
|
||||
latest_version=$(yq eval '.version' "${basepath}/../pubspec.yaml")
|
||||
echo "> latest package version is: $latest_version"
|
||||
echo "> new package version is: $wyatt_analysis_version"
|
||||
|
||||
# Create array with all files that need to exist
|
||||
files=(
|
||||
"${basepath}/../pubspec.yaml"
|
||||
"${basepath}/../README.md"
|
||||
"${basepath}/../lib/wyatt_analysis.dart"
|
||||
"${basepath}/../lib/analysis_options.yaml"
|
||||
"${basepath}/../lib/analysis_options.flutter.yaml"
|
||||
"${basepath}/../lib/analysis_options.${latest_version}.yaml"
|
||||
"${basepath}/../lib/analysis_options.flutter.${latest_version}.yaml"
|
||||
)
|
||||
|
||||
# Check if all files exist
|
||||
for file in "${files[@]}"; do
|
||||
if [ ! -f "$file" ]; then
|
||||
echo "File ${file} doesn't exists"
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
|
||||
# Create new analysis_options files
|
||||
echo "Creating new analysis_options files"
|
||||
cp "${basepath}/../lib/analysis_options.${latest_version}.yaml" "${basepath}/../lib/analysis_options.${wyatt_analysis_version}.yaml"
|
||||
cp "${basepath}/../lib/analysis_options.flutter.${latest_version}.yaml" "${basepath}/../lib/analysis_options.flutter.${wyatt_analysis_version}.yaml"
|
||||
|
||||
# Update version in new analysis_options files
|
||||
echo "Updating version in new analysis_options files"
|
||||
sed -i.bu "s/${latest_version}/${wyatt_analysis_version}/g" "${basepath}/../lib/analysis_options.${wyatt_analysis_version}.yaml"
|
||||
rm "${basepath}/../lib/analysis_options.${wyatt_analysis_version}.yaml.bu"
|
||||
sed -i.bu "s/${latest_version}/${wyatt_analysis_version}/g" "${basepath}/../lib/analysis_options.flutter.${wyatt_analysis_version}.yaml"
|
||||
rm "${basepath}/../lib/analysis_options.flutter.${wyatt_analysis_version}.yaml.bu"
|
||||
|
||||
# Update version in pubspec.yaml
|
||||
echo "Updating version in pubspec.yaml"
|
||||
sed -i.bu "s/${latest_version}/${wyatt_analysis_version}/g" "${basepath}/../pubspec.yaml"
|
||||
rm "${basepath}/../pubspec.yaml.bu"
|
||||
|
||||
# Update version in README.md
|
||||
echo "Updating version in README.md"
|
||||
sed -i.bu "s/${latest_version}/${wyatt_analysis_version}/g" "${basepath}/../README.md"
|
||||
rm "${basepath}/../README.md.bu"
|
||||
|
||||
# Update version in wyatt_analysis.dart
|
||||
echo "Updating version in wyatt_analysis.dart"
|
||||
sed -i.bu "s/${latest_version}/${wyatt_analysis_version}/g" "${basepath}/../lib/wyatt_analysis.dart"
|
||||
rm "${basepath}/../lib/wyatt_analysis.dart.bu"
|
||||
|
||||
# Update version in analysis_options.yaml
|
||||
echo "Updating version in analysis_options.yaml"
|
||||
sed -i.bu "s/${latest_version}/${wyatt_analysis_version}/g" "${basepath}/../lib/analysis_options.yaml"
|
||||
rm "${basepath}/../lib/analysis_options.yaml.bu"
|
||||
|
||||
# Update version in analysis_options.flutter.yaml
|
||||
echo "Updating version in analysis_options.flutter.yaml"
|
||||
sed -i.bu "s/${latest_version}/${wyatt_analysis_version}/g" "${basepath}/../lib/analysis_options.flutter.yaml"
|
||||
rm "${basepath}/../lib/analysis_options.flutter.yaml.bu"
|
||||
|
||||
exit 0
|
59
packages/wyatt_analysis/tool/sort_rules.sh
Executable file
59
packages/wyatt_analysis/tool/sort_rules.sh
Executable file
@ -0,0 +1,59 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# 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/>.
|
||||
|
||||
basename=$(basename "$0")
|
||||
basepath=$(dirname "$0")
|
||||
|
||||
# Check for dependencies.
|
||||
if ! command -v yq &>/dev/null; then
|
||||
echo "yq could not be found. Please install it and try again."
|
||||
echo "https://github.com/mikefarah/yq"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check for arguments, if no arguments read latest version from pubspec.yaml.
|
||||
if [ $# -eq 0 ]; then
|
||||
wyatt_analysis_version=$(yq eval '.version' "${basepath}/../pubspec.yaml")
|
||||
else
|
||||
wyatt_analysis_version=$1
|
||||
fi
|
||||
|
||||
# Check if the version of the Wyatt Analysis ruleset is valid by checking if the file exists.
|
||||
if [ ! -f "$basepath/../lib/analysis_options.$wyatt_analysis_version.yaml" ]; then
|
||||
echo "Wyatt Analysis version $wyatt_analysis_version could not be found."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Found Wyatt Analysis version $wyatt_analysis_version"
|
||||
echo "Sorting rules..."
|
||||
|
||||
# Sort the rules in "lint.rules" alphabetically.
|
||||
yq eval '.linter.rules |= sort_by(.)' "$basepath/../lib/analysis_options.$wyatt_analysis_version.yaml" >"$basepath/../lib/analysis_options.$wyatt_analysis_version.yaml.tmp"
|
||||
|
||||
cp -f "$basepath/../lib/analysis_options.$wyatt_analysis_version.yaml.tmp" "$basepath/../lib/analysis_options.$wyatt_analysis_version.yaml"
|
||||
|
||||
rm -f "$basepath/../lib/analysis_options.$wyatt_analysis_version.yaml.tmp"
|
||||
|
||||
# Sort the rules in "lint.rules" alphabetically.
|
||||
yq eval '.linter.rules |= sort_by(.)' "$basepath/../lib/analysis_options.flutter.$wyatt_analysis_version.yaml" >"$basepath/../lib/analysis_options.flutter.$wyatt_analysis_version.yaml.tmp"
|
||||
|
||||
cp -f "$basepath/../lib/analysis_options.flutter.$wyatt_analysis_version.yaml.tmp" "$basepath/../lib/analysis_options.flutter.$wyatt_analysis_version.yaml"
|
||||
|
||||
rm -f "$basepath/../lib/analysis_options.flutter.$wyatt_analysis_version.yaml.tmp"
|
||||
|
||||
exit 0
|
@ -1,3 +1,7 @@
|
||||
## 0.2.0+1
|
||||
|
||||
- **FIX**: apply dart fix --apply.
|
||||
|
||||
## 0.2.0
|
||||
|
||||
> Note: This release has breaking changes.
|
||||
|
@ -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:
|
||||
|
@ -25,7 +25,7 @@ class AlbumMockDataSourceImpl extends AlbumRemoteDataSource {
|
||||
id: 1,
|
||||
userId: 1,
|
||||
title: 'Album 1',
|
||||
)
|
||||
),
|
||||
};
|
||||
|
||||
@override
|
||||
|
@ -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');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -58,8 +58,8 @@ class PhotosGridThumbnail
|
||||
bottom: 10,
|
||||
right: 10,
|
||||
child: Icon(Icons.favorite),
|
||||
)
|
||||
]
|
||||
),
|
||||
],
|
||||
],
|
||||
),
|
||||
);
|
||||
|
@ -44,10 +44,10 @@ 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.0
|
||||
version: ^2.0.1
|
||||
wyatt_type_utils:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
version: ^0.0.5
|
||||
|
@ -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,
|
||||
);
|
||||
}
|
||||
}
|
@ -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,30 +1,31 @@
|
||||
# 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/>.
|
||||
|
||||
name: wyatt_architecture
|
||||
description: Wyatt Architecture contains useful classes to help you to create a clean architecture following the Wyatt Architecture principles.
|
||||
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_architecture
|
||||
version: 0.2.0
|
||||
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
|
||||
|
@ -1,3 +1,28 @@
|
||||
## 0.5.1+3
|
||||
|
||||
- upgrade deps
|
||||
|
||||
## 0.5.1+2
|
||||
|
||||
- **FIX**(authentication_bloc): upgrade google sign to his major v.
|
||||
- **FIX**: apply dart format.
|
||||
- **FIX**: apply dart fix --apply.
|
||||
- **FIX**(authentication_bloc): go router version refactoring.
|
||||
- **FIX**: use correct behavior subject for stream session.
|
||||
|
||||
## 0.5.1+1
|
||||
|
||||
- **FIX**: use correct behavior subject for stream session.
|
||||
|
||||
## 0.5.1
|
||||
|
||||
- **FIX**(authentication): try/catch on cache retrieve.
|
||||
- **FEAT**(auth): add mocked cache data source.
|
||||
|
||||
## 0.5.0+1
|
||||
|
||||
- **REFACTOR**(authentication): controle cache checking.
|
||||
|
||||
## 0.5.0
|
||||
|
||||
> Note: This release has breaking changes.
|
||||
|
@ -71,7 +71,8 @@ class App extends StatelessWidget {
|
||||
if (authState.status != previous?.status) {
|
||||
previous = authState;
|
||||
// Checking if current path is onboarding or not
|
||||
final isOnboarding = AppRouter.publicRoutes.contains(state.subloc);
|
||||
final isOnboarding =
|
||||
AppRouter.publicRoutes.contains(state.matchedLocation);
|
||||
if (authState.status == AuthenticationStatus.unauthenticated) {
|
||||
debugPrint('Not logged');
|
||||
if (!isOnboarding) {
|
||||
|
@ -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);
|
||||
}
|
||||
}
|
||||
|
@ -30,11 +30,11 @@ dependencies:
|
||||
flutter:
|
||||
sdk: flutter
|
||||
|
||||
go_router: ^5.1.5
|
||||
go_router: ^10.1.0
|
||||
firebase_core: ^2.1.1
|
||||
flutter_bloc: ^8.1.1
|
||||
firebase_auth: ^4.2.0
|
||||
google_sign_in: ^5.4.2
|
||||
google_sign_in: ^6.1.4
|
||||
get_it: ^7.2.0
|
||||
|
||||
wyatt_authentication_bloc:
|
||||
@ -42,11 +42,11 @@ dependencies:
|
||||
|
||||
wyatt_form_bloc:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
version: 0.2.0+3
|
||||
version: 0.2.0+4
|
||||
|
||||
wyatt_architecture:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
version: 0.2.0
|
||||
version: 0.2.0+1
|
||||
|
||||
wyatt_type_utils:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
|
@ -33,7 +33,7 @@ abstract class Forms {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
customPasswordValidator ?? const Password.pure(),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
);
|
||||
@ -55,7 +55,7 @@ abstract class Forms {
|
||||
AuthFormField.password,
|
||||
customPasswordValidator ?? const Password.pure(),
|
||||
),
|
||||
...extraSignUpInputs ?? []
|
||||
...extraSignUpInputs ?? [],
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
);
|
||||
@ -93,7 +93,7 @@ abstract class Forms {
|
||||
customPasswordValidator ?? const Password.pure(),
|
||||
metadata: const FormInputMetadata(isRequired: false),
|
||||
),
|
||||
...extraEditAccountInputs ?? []
|
||||
...extraEditAccountInputs ?? [],
|
||||
],
|
||||
validationStrategy: const OnlyRequiredInputValidator(),
|
||||
name: AuthFormName.editAccountForm,
|
||||
|
@ -41,13 +41,17 @@ class AuthenticationFirebaseCacheDataSourceImpl<Data>
|
||||
return null;
|
||||
}
|
||||
|
||||
final jwt = await currentUser.getIdToken(true);
|
||||
final currentAccount = AccountModel.fromFirebaseUser(
|
||||
currentUser,
|
||||
accessToken: jwt,
|
||||
);
|
||||
try {
|
||||
final jwt = await currentUser.getIdToken(true);
|
||||
final currentAccount = AccountModel.fromFirebaseUser(
|
||||
currentUser,
|
||||
accessToken: jwt,
|
||||
);
|
||||
|
||||
return currentAccount;
|
||||
return currentAccount;
|
||||
} catch (e) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
// Already done by Firebase
|
||||
|
@ -0,0 +1,41 @@
|
||||
// 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/>.
|
||||
|
||||
import 'package:wyatt_authentication_bloc/wyatt_authentication_bloc.dart';
|
||||
|
||||
/// {@template authentication_mock_cache_data_source_impl}
|
||||
/// A data source that manages the cache strategy.
|
||||
/// This implementation is mocked.
|
||||
/// {@endtemplate}
|
||||
class AuthenticationMockCacheDataSourceImpl<Data>
|
||||
extends AuthenticationCacheDataSource<Data> {
|
||||
/// {@macro authentication_mock_cache_data_source_impl}
|
||||
AuthenticationMockCacheDataSourceImpl();
|
||||
|
||||
@override
|
||||
Future<void> cacheAccount(Account account) => Future.value();
|
||||
|
||||
/// Always returns null.
|
||||
@override
|
||||
Future<Account?> getCachedAccount() async {
|
||||
await Future<void>.delayed(const Duration(milliseconds: 200));
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
@override
|
||||
Future<void> removeCachedAccount() => Future.value();
|
||||
}
|
@ -16,6 +16,7 @@
|
||||
|
||||
import 'dart:async';
|
||||
|
||||
import 'package:rxdart/streams.dart';
|
||||
import 'package:rxdart/subjects.dart';
|
||||
import 'package:wyatt_authentication_bloc/src/domain/data_sources/local/authentication_session_data_source.dart';
|
||||
import 'package:wyatt_authentication_bloc/src/domain/entities/auth_session.dart';
|
||||
@ -28,7 +29,7 @@ class AuthenticationSessionDataSourceImpl<Data>
|
||||
/// {@macro authentication_session_data_source_impl}
|
||||
AuthenticationSessionDataSourceImpl();
|
||||
|
||||
final StreamController<AuthenticationSession<Data>> _sessionStream =
|
||||
final BehaviorSubject<AuthenticationSession<Data>> _sessionStream =
|
||||
BehaviorSubject();
|
||||
|
||||
@override
|
||||
@ -37,9 +38,10 @@ class AuthenticationSessionDataSourceImpl<Data>
|
||||
}
|
||||
|
||||
@override
|
||||
Future<AuthenticationSession<Data>> currentSession() => sessionStream().last;
|
||||
Future<AuthenticationSession<Data>> currentSession() async =>
|
||||
_sessionStream.value;
|
||||
|
||||
@override
|
||||
Stream<AuthenticationSession<Data>> sessionStream() =>
|
||||
_sessionStream.stream.asBroadcastStream();
|
||||
_sessionStream.shareValue();
|
||||
}
|
||||
|
@ -15,5 +15,6 @@
|
||||
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
export 'authentication_firebase_cache_data_source_impl.dart';
|
||||
export 'authentication_mock_cache_data_source_impl.dart';
|
||||
export 'authentication_secure_storage_cache_data_source_impl.dart';
|
||||
export 'authentication_session_data_source_impl.dart';
|
||||
|
@ -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();
|
||||
|
||||
|
@ -40,6 +40,7 @@ abstract class AuthenticationCubit<Data>
|
||||
/// {@macro authentication_cubit}
|
||||
AuthenticationCubit({
|
||||
required this.authenticationRepository,
|
||||
this.checkForCachedAccountOnInitialization = true,
|
||||
}) : super(const AuthenticationState.unknown()) {
|
||||
_init();
|
||||
}
|
||||
@ -47,6 +48,9 @@ abstract class AuthenticationCubit<Data>
|
||||
/// The authentication repository.
|
||||
final AuthenticationRepository<Data> authenticationRepository;
|
||||
|
||||
/// Automatically check for cached account on initialization.
|
||||
final bool checkForCachedAccountOnInitialization;
|
||||
|
||||
/// The latest session.
|
||||
AuthenticationSession<Data>? _latestSession;
|
||||
|
||||
@ -56,7 +60,9 @@ abstract class AuthenticationCubit<Data>
|
||||
_listenForAuthenticationChanges();
|
||||
|
||||
/// Check if there is a cached account.
|
||||
await authenticationRepository.checkForCachedAccount();
|
||||
if (checkForCachedAccountOnInitialization) {
|
||||
await checkForCachedAccount();
|
||||
}
|
||||
}
|
||||
|
||||
void _listenForAuthenticationChanges() {
|
||||
@ -148,6 +154,10 @@ abstract class AuthenticationCubit<Data>
|
||||
),
|
||||
).call();
|
||||
|
||||
/// Checks for cached account.
|
||||
FutureOr<void> checkForCachedAccount() async =>
|
||||
authenticationRepository.checkForCachedAccount();
|
||||
|
||||
/// Returns latest session.
|
||||
///
|
||||
/// Contains latest event and latest session data (account + extra data)
|
||||
|
@ -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);
|
||||
}
|
||||
|
@ -1,7 +1,7 @@
|
||||
name: wyatt_authentication_bloc
|
||||
description: Authentication BLoC for Flutter
|
||||
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_authentication_bloc
|
||||
version: 0.5.0
|
||||
version: 0.5.1+3
|
||||
|
||||
publish_to: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub
|
||||
|
||||
@ -11,31 +11,31 @@ environment:
|
||||
|
||||
dependencies:
|
||||
flutter: { sdk: flutter }
|
||||
crypto: ^3.0.2
|
||||
flutter_bloc: ^8.1.1
|
||||
crypto: ^3.0.3
|
||||
flutter_bloc: ^8.1.3
|
||||
equatable: ^2.0.5
|
||||
firebase_auth: ^4.2.0
|
||||
google_sign_in: ^5.4.2
|
||||
firebase_auth: ^4.10.1
|
||||
google_sign_in: ^6.1.5
|
||||
rxdart: ^0.27.7
|
||||
flutter_secure_storage: ^9.0.0
|
||||
http: ^1.1.0
|
||||
|
||||
wyatt_form_bloc:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
version: ^0.2.0+3
|
||||
version: ^0.2.0+4
|
||||
|
||||
wyatt_architecture:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
version: ^0.2.0
|
||||
version: ^0.2.0+1
|
||||
|
||||
wyatt_type_utils:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
version: ^0.0.5
|
||||
flutter_secure_storage: ^8.0.0
|
||||
http: ^0.13.5
|
||||
|
||||
dev_dependencies:
|
||||
flutter_test: { sdk: flutter }
|
||||
bloc_test: ^9.1.0
|
||||
mocktail: ^0.3.0
|
||||
mocktail: ^1.0.0
|
||||
|
||||
wyatt_analysis:
|
||||
hosted: https://git.wyatt-studio.fr/api/packages/Wyatt-FOSS/pub/
|
||||
|
@ -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,
|
||||
|
@ -46,7 +46,7 @@ void main() {
|
||||
AuthenticationSession.fromEvent(
|
||||
SignedInFromCacheEvent(account: account),
|
||||
data: 10,
|
||||
)
|
||||
),
|
||||
]),
|
||||
);
|
||||
|
||||
@ -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(
|
||||
@ -113,7 +113,7 @@ void main() {
|
||||
),
|
||||
const EmailVerificationState(
|
||||
status: FormStatus.submissionSuccess,
|
||||
)
|
||||
),
|
||||
],
|
||||
);
|
||||
|
||||
@ -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(
|
||||
@ -135,7 +135,7 @@ void main() {
|
||||
const EmailVerificationState(
|
||||
errorMessage: 'erreur',
|
||||
status: FormStatus.submissionFailure,
|
||||
)
|
||||
),
|
||||
],
|
||||
);
|
||||
});
|
||||
@ -183,7 +183,7 @@ void main() {
|
||||
build: () => EmailVerificationCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
),
|
||||
seed: () => const EmailVerificationState(),
|
||||
seed: EmailVerificationState.new,
|
||||
act: (cubit) => cubit.checkEmailVerification(),
|
||||
expect: () => [
|
||||
const EmailVerificationState(
|
||||
@ -192,7 +192,7 @@ void main() {
|
||||
const EmailVerificationState(
|
||||
isVerified: true,
|
||||
status: FormStatus.submissionSuccess,
|
||||
)
|
||||
),
|
||||
],
|
||||
);
|
||||
|
||||
@ -206,7 +206,7 @@ void main() {
|
||||
build: () => EmailVerificationCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
),
|
||||
seed: () => const EmailVerificationState(),
|
||||
seed: EmailVerificationState.new,
|
||||
act: (cubit) => cubit.checkEmailVerification(),
|
||||
expect: () => [
|
||||
const EmailVerificationState(
|
||||
@ -214,7 +214,7 @@ void main() {
|
||||
),
|
||||
const EmailVerificationState(
|
||||
status: FormStatus.submissionSuccess,
|
||||
)
|
||||
),
|
||||
],
|
||||
);
|
||||
|
||||
@ -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(
|
||||
@ -236,7 +236,7 @@ void main() {
|
||||
const EmailVerificationState(
|
||||
errorMessage: 'erreur',
|
||||
status: FormStatus.submissionFailure,
|
||||
)
|
||||
),
|
||||
],
|
||||
);
|
||||
});
|
||||
|
@ -41,7 +41,7 @@ void main() {
|
||||
final WyattForm form = WyattFormImpl(
|
||||
[
|
||||
FormInput(AuthFormField.email, const Email.pure()),
|
||||
FormInput(AuthFormField.password, const Password.pure())
|
||||
FormInput(AuthFormField.password, const Password.pure()),
|
||||
],
|
||||
name: AuthFormName.passwordResetForm,
|
||||
);
|
||||
@ -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>(
|
||||
@ -260,7 +260,7 @@ void main() {
|
||||
name: AuthFormName.passwordResetForm,
|
||||
),
|
||||
status: FormStatus.submissionSuccess,
|
||||
)
|
||||
),
|
||||
],
|
||||
);
|
||||
|
||||
@ -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(
|
||||
@ -327,7 +327,7 @@ void main() {
|
||||
name: AuthFormName.passwordResetForm,
|
||||
),
|
||||
status: FormStatus.submissionFailure,
|
||||
)
|
||||
),
|
||||
],
|
||||
);
|
||||
});
|
||||
|
@ -46,7 +46,7 @@ void main() {
|
||||
final WyattForm form = WyattFormImpl(
|
||||
[
|
||||
FormInput(AuthFormField.email, const Email.pure()),
|
||||
FormInput(AuthFormField.password, const Password.pure())
|
||||
FormInput(AuthFormField.password, const Password.pure()),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
);
|
||||
@ -102,7 +102,7 @@ void main() {
|
||||
AuthFormField.email,
|
||||
const Email.dirty(invalidEmailString),
|
||||
),
|
||||
FormInput(AuthFormField.password, const Password.pure())
|
||||
FormInput(AuthFormField.password, const Password.pure()),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -126,7 +126,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -145,7 +145,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -163,7 +163,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -191,7 +191,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(invalidPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -215,7 +215,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.pure(),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -234,7 +234,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.pure(),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -252,7 +252,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -287,7 +287,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -312,7 +312,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -331,7 +331,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -364,7 +364,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -383,7 +383,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -401,7 +401,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -417,12 +417,12 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
status: FormStatus.submissionSuccess,
|
||||
)
|
||||
),
|
||||
],
|
||||
);
|
||||
|
||||
@ -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(
|
||||
@ -448,7 +448,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -467,7 +467,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -485,7 +485,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -501,12 +501,12 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
status: FormStatus.submissionFailure,
|
||||
)
|
||||
),
|
||||
],
|
||||
);
|
||||
});
|
||||
@ -527,7 +527,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -566,7 +566,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -584,7 +584,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.pure(),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -600,12 +600,12 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.pure(),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
status: FormStatus.submissionSuccess,
|
||||
)
|
||||
),
|
||||
],
|
||||
);
|
||||
|
||||
@ -615,7 +615,7 @@ void main() {
|
||||
setUp: () {
|
||||
when(
|
||||
() => authenticationRepository.signInAnonymously(),
|
||||
).thenAnswer((_) async => const Err(ServerException()));
|
||||
).thenAnswer((_) async => Err(const ServerException()));
|
||||
},
|
||||
build: () => SignInCubit(
|
||||
authenticationRepository: authenticationRepository,
|
||||
@ -630,7 +630,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -648,7 +648,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.pure(),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
@ -664,12 +664,12 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.pure(),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
),
|
||||
status: FormStatus.submissionFailure,
|
||||
)
|
||||
),
|
||||
],
|
||||
);
|
||||
});
|
||||
|
@ -22,7 +22,7 @@ void main() {
|
||||
final WyattForm form = WyattFormImpl(
|
||||
[
|
||||
FormInput(AuthFormField.email, const Email.pure()),
|
||||
FormInput(AuthFormField.password, const Password.pure())
|
||||
FormInput(AuthFormField.password, const Password.pure()),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
);
|
||||
|
@ -46,7 +46,7 @@ void main() {
|
||||
final WyattForm form = WyattFormImpl(
|
||||
[
|
||||
FormInput(AuthFormField.email, const Email.pure()),
|
||||
FormInput(AuthFormField.password, const Password.pure())
|
||||
FormInput(AuthFormField.password, const Password.pure()),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
);
|
||||
@ -98,7 +98,7 @@ void main() {
|
||||
AuthFormField.email,
|
||||
const Email.dirty(invalidEmailString),
|
||||
),
|
||||
FormInput(AuthFormField.password, const Password.pure())
|
||||
FormInput(AuthFormField.password, const Password.pure()),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -122,7 +122,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -141,7 +141,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -159,7 +159,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -187,7 +187,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(invalidPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -211,7 +211,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.pure(),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -230,7 +230,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.pure(),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -248,7 +248,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -283,7 +283,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -302,7 +302,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -335,7 +335,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -354,7 +354,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -372,7 +372,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -388,12 +388,12 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
status: FormStatus.submissionSuccess,
|
||||
)
|
||||
),
|
||||
],
|
||||
);
|
||||
|
||||
@ -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(
|
||||
@ -419,7 +419,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -438,7 +438,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -456,7 +456,7 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
@ -472,12 +472,12 @@ void main() {
|
||||
FormInput(
|
||||
AuthFormField.password,
|
||||
const Password.dirty(validPasswordString),
|
||||
)
|
||||
),
|
||||
],
|
||||
name: AuthFormName.signUpForm,
|
||||
),
|
||||
status: FormStatus.submissionFailure,
|
||||
)
|
||||
),
|
||||
],
|
||||
);
|
||||
});
|
||||
@ -487,7 +487,7 @@ void main() {
|
||||
FormInput<dynamic, FormInputValidator<dynamic, ValidationError>,
|
||||
dynamic>>[
|
||||
FormInput(AuthFormField.email, const Email.pure()),
|
||||
FormInput(AuthFormField.password, const Password.pure())
|
||||
FormInput(AuthFormField.password, const Password.pure()),
|
||||
];
|
||||
|
||||
final inputsB = <
|
||||
|
@ -22,7 +22,7 @@ void main() {
|
||||
final WyattForm form = WyattFormImpl(
|
||||
[
|
||||
FormInput(AuthFormField.email, const Email.pure()),
|
||||
FormInput(AuthFormField.password, const Password.pure())
|
||||
FormInput(AuthFormField.password, const Password.pure()),
|
||||
],
|
||||
name: AuthFormName.signInForm,
|
||||
);
|
||||
|
@ -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>();`
|
||||
|
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