Merge remote-tracking branch 'origin/master' into bloc/feature/fix_and_repo

This commit is contained in:
Hugo Pointcheval 2022-11-06 16:56:03 -05:00
commit f45afa8a57
Signed by: hugo
GPG Key ID: A9E8E9615379254F
105 changed files with 4843 additions and 479 deletions

View File

@ -3,6 +3,113 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
## 2022-08-26
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`wyatt_form_bloc` - `v0.0.6`](#wyatt_form_bloc---v006)
- [`wyatt_authentication_bloc` - `v0.2.1+4`](#wyatt_authentication_bloc---v0214)
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_authentication_bloc` - `v0.2.1+4`
---
#### `wyatt_form_bloc` - `v0.0.6`
- **FEAT**: add raw form validator.
## 2022-08-25
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`wyatt_form_bloc` - `v0.0.5`](#wyatt_form_bloc---v005)
- [`wyatt_authentication_bloc` - `v0.2.1+3`](#wyatt_authentication_bloc---v0213)
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_authentication_bloc` - `v0.2.1+3`
---
#### `wyatt_form_bloc` - `v0.0.5`
- **FEAT**: update deps.
## 2022-08-25
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`wyatt_form_bloc` - `v0.0.4`](#wyatt_form_bloc---v004)
- [`wyatt_authentication_bloc` - `v0.2.1+2`](#wyatt_authentication_bloc---v0212)
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_authentication_bloc` - `v0.2.1+2`
---
#### `wyatt_form_bloc` - `v0.0.4`
- **FEAT**: add form validator class with strategy design pattern.
## 2022-07-18
### Changes
---
Packages with breaking changes:
- There are no breaking changes in this release.
Packages with other changes:
- [`wyatt_type_utils` - `v0.0.2`](#wyatt_type_utils---v002)
---
#### `wyatt_type_utils` - `v0.0.2`
- **FEAT**: add strongly typed Option and Result.
- **FEAT**: add mason generated package.
- **DOCS**: remove useless web example.
## 2022-07-12
### Changes

View File

@ -1,3 +1,15 @@
## 0.2.1+4
- Update a dependency to the latest release.
## 0.2.1+3
- Update a dependency to the latest release.
## 0.2.1+2
- Update a dependency to the latest release.
## 0.2.1+1
- Update a dependency to the latest release.

View File

@ -149,7 +149,7 @@ class _PasswordInput extends StatelessWidget {
.read<SignUpCubit>()
.state
.data
.valueOf<String, ValidationError>(formFieldConfirmedPassword),
.valueOf<String>(formFieldConfirmedPassword),
),
);
},
@ -202,7 +202,7 @@ class _CheckIsProInput extends StatelessWidget {
trailing: BlocBuilder<SignUpCubit, SignUpState>(
builder: (context, state) {
return Checkbox(
value: state.data.valueOf<bool, ValidationError>(formFieldPro),
value: state.data.valueOf<bool>(formFieldPro),
onChanged: (isPro) {
final value =
isPro!; // tristate is false, so value can't be null
@ -296,7 +296,7 @@ class SignUpForm extends StatelessWidget {
const SizedBox(height: 8),
BlocBuilder<SignUpCubit, SignUpState>(
builder: (context, state) {
if (state.data.valueOf<bool, ValidationError>(formFieldPro)) {
if (state.data.valueOf<bool>(formFieldPro)) {
return Column(children: [
_SirenInput(),
const SizedBox(height: 8),

View File

@ -38,7 +38,7 @@ dependencies:
wyatt_form_bloc:
git:
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
ref: wyatt_form_bloc-v0.0.3
ref: wyatt_form_bloc-v0.0.6
path: packages/wyatt_form_bloc
# The following adds the Cupertino Icons font to your application.

View File

@ -0,0 +1,47 @@
# Miscellaneous
*.class
*.log
*.pyc
*.swp
.DS_Store
.atom/
.buildlog/
.history
.svn/
migrate_working_dir/
# IntelliJ related
*.iml
*.ipr
*.iws
.idea/
# The .vscode folder contains launch configuration and tasks you configure in
# VS Code which you may wish to be included in version control, so this line
# is commented out by default.
#.vscode/
# Flutter/Dart/Pub related
**/doc/api/
**/ios/Flutter/.last_build_id
.dart_tool/
.flutter-plugins
.flutter-plugins-dependencies
.packages
.pub-cache/
.pub/
/build/
# Web related
lib/generated_plugin_registrant.dart
# Symbolication related
app.*.symbols
# Obfuscation related
app.*.map.json
# Android Studio will place build artifacts here
/android/app/debug
/android/app/profile
/android/app/release

View File

@ -0,0 +1,30 @@
# This file tracks properties of this Flutter project.
# Used by Flutter tool to assess capabilities and perform upgrades etc.
#
# This file should be version controlled.
version:
revision: f1875d570e39de09040c8f79aa13cc56baab8db1
channel: stable
project_type: app
# Tracks metadata for the flutter migrate command
migration:
platforms:
- platform: root
create_revision: f1875d570e39de09040c8f79aa13cc56baab8db1
base_revision: f1875d570e39de09040c8f79aa13cc56baab8db1
- platform: android
create_revision: f1875d570e39de09040c8f79aa13cc56baab8db1
base_revision: f1875d570e39de09040c8f79aa13cc56baab8db1
# User provided section
# List of Local paths (relative to this file) that should be
# ignored by the migrate tool.
#
# Files that are not part of the templates will be ignored by default.
unmanaged_files:
- 'lib/main.dart'
- 'ios/Runner.xcodeproj/project.pbxproj'

View File

@ -0,0 +1,25 @@
/*
* Author: Hugo Pointcheval
* Email: git@pcl.ovh
* -----
* File: launch.json
* Created Date: 19/08/2022 15:12:25
* Last Modified: 19/08/2022 15:22:02
* -----
* Copyright (c) 2022
*/
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "example_router",
"request": "launch",
"type": "dart",
"program": "lib/main.dart",
"flutterMode": "debug"
}
]
}

View File

@ -0,0 +1,16 @@
# example_router
A new Flutter project.
## Getting Started
This project is a starting point for a Flutter application.
A few resources to get you started if this is your first Flutter project:
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.

View File

@ -0,0 +1,29 @@
# This file configures the analyzer, which statically analyzes Dart code to
# check for errors, warnings, and lints.
#
# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
# invoked from the command line by running `flutter analyze`.
# The following line activates a set of recommended lints for Flutter apps,
# packages, and plugins designed to encourage good coding practices.
include: package:flutter_lints/flutter.yaml
linter:
# The lint rules applied to this project can be customized in the
# section below to disable rules from the `package:flutter_lints/flutter.yaml`
# included above or to enable additional rules. A list of all available lints
# and their documentation is published at
# https://dart-lang.github.io/linter/lints/index.html.
#
# Instead of disabling a lint rule for the entire project in the
# section below, it can also be suppressed for a single line of code
# or a specific dart file by using the `// ignore: name_of_lint` and
# `// ignore_for_file: name_of_lint` syntax on the line or in the file
# producing the lint.
rules:
# avoid_print: false # Uncomment to disable the `avoid_print` rule
# prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule
# Additional information about this file can be found at
# https://dart.dev/guides/language/analysis-options

View File

@ -0,0 +1,13 @@
gradle-wrapper.jar
/.gradle
/captures/
/gradlew
/gradlew.bat
/local.properties
GeneratedPluginRegistrant.java
# Remember to never publicly share your keystore.
# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
key.properties
**/*.keystore
**/*.jks

View File

@ -0,0 +1,74 @@
def localProperties = new Properties()
def localPropertiesFile = rootProject.file('local.properties')
if (localPropertiesFile.exists()) {
localPropertiesFile.withReader('UTF-8') { reader ->
localProperties.load(reader)
}
}
def flutterRoot = localProperties.getProperty('flutter.sdk')
if (flutterRoot == null) {
throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.")
}
def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
if (flutterVersionCode == null) {
flutterVersionCode = '1'
}
def flutterVersionName = localProperties.getProperty('flutter.versionName')
if (flutterVersionName == null) {
flutterVersionName = '1.0'
}
apply plugin: 'com.android.application'
// START: FlutterFire Configuration
apply plugin: 'com.google.gms.google-services'
// END: FlutterFire Configuration
apply plugin: 'kotlin-android'
apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
android {
compileSdkVersion flutter.compileSdkVersion
ndkVersion flutter.ndkVersion
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
kotlinOptions {
jvmTarget = '1.8'
}
sourceSets {
main.java.srcDirs += 'src/main/kotlin'
}
defaultConfig {
// TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
applicationId "com.example.example_router"
// You can update the following values to match your application needs.
// For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-build-configuration.
minSdkVersion 21
targetSdkVersion flutter.targetSdkVersion
versionCode flutterVersionCode.toInteger()
versionName flutterVersionName
}
buildTypes {
release {
// TODO: Add your own signing config for the release build.
// Signing with the debug keys for now, so `flutter run --release` works.
signingConfig signingConfigs.debug
}
}
}
flutter {
source '../..'
}
dependencies {
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
}

View File

@ -0,0 +1,8 @@
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.example_router">
<!-- The INTERNET permission is required for development. Specifically,
the Flutter tool needs it to communicate with the running application
to allow setting breakpoints, to provide hot reload, etc.
-->
<uses-permission android:name="android.permission.INTERNET"/>
</manifest>

View File

@ -0,0 +1,34 @@
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.example_router">
<application
android:label="example_router"
android:name="${applicationName}"
android:icon="@mipmap/ic_launcher">
<activity
android:name=".MainActivity"
android:exported="true"
android:launchMode="singleTop"
android:theme="@style/LaunchTheme"
android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
android:hardwareAccelerated="true"
android:windowSoftInputMode="adjustResize">
<!-- Specifies an Android theme to apply to this Activity as soon as
the Android process has started. This theme is visible to the user
while the Flutter UI initializes. After that, this theme continues
to determine the Window background behind the Flutter UI. -->
<meta-data
android:name="io.flutter.embedding.android.NormalTheme"
android:resource="@style/NormalTheme"
/>
<intent-filter>
<action android:name="android.intent.action.MAIN"/>
<category android:name="android.intent.category.LAUNCHER"/>
</intent-filter>
</activity>
<!-- Don't delete the meta-data below.
This is used by the Flutter tool to generate GeneratedPluginRegistrant.java -->
<meta-data
android:name="flutterEmbedding"
android:value="2" />
</application>
</manifest>

View File

@ -0,0 +1,6 @@
package com.example.example_router
import io.flutter.embedding.android.FlutterActivity
class MainActivity: FlutterActivity() {
}

View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Modify this file to customize your launch splash screen -->
<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
<item android:drawable="?android:colorBackground" />
<!-- You can insert your own image assets here -->
<!-- <item>
<bitmap
android:gravity="center"
android:src="@mipmap/launch_image" />
</item> -->
</layer-list>

View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Modify this file to customize your launch splash screen -->
<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
<item android:drawable="@android:color/white" />
<!-- You can insert your own image assets here -->
<!-- <item>
<bitmap
android:gravity="center"
android:src="@mipmap/launch_image" />
</item> -->
</layer-list>

Binary file not shown.

After

Width:  |  Height:  |  Size: 544 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 442 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 721 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 KiB

View File

@ -0,0 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<resources>
<!-- Theme applied to the Android Window while the process is starting when the OS's Dark Mode setting is on -->
<style name="LaunchTheme" parent="@android:style/Theme.Black.NoTitleBar">
<!-- Show a splash screen on the activity. Automatically removed when
the Flutter engine draws its first frame -->
<item name="android:windowBackground">@drawable/launch_background</item>
</style>
<!-- Theme applied to the Android Window as soon as the process has started.
This theme determines the color of the Android Window while your
Flutter UI initializes, as well as behind your Flutter UI while its
running.
This Theme is only used starting with V2 of Flutter's Android embedding. -->
<style name="NormalTheme" parent="@android:style/Theme.Black.NoTitleBar">
<item name="android:windowBackground">?android:colorBackground</item>
</style>
</resources>

View File

@ -0,0 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<resources>
<!-- Theme applied to the Android Window while the process is starting when the OS's Dark Mode setting is off -->
<style name="LaunchTheme" parent="@android:style/Theme.Light.NoTitleBar">
<!-- Show a splash screen on the activity. Automatically removed when
the Flutter engine draws its first frame -->
<item name="android:windowBackground">@drawable/launch_background</item>
</style>
<!-- Theme applied to the Android Window as soon as the process has started.
This theme determines the color of the Android Window while your
Flutter UI initializes, as well as behind your Flutter UI while its
running.
This Theme is only used starting with V2 of Flutter's Android embedding. -->
<style name="NormalTheme" parent="@android:style/Theme.Light.NoTitleBar">
<item name="android:windowBackground">?android:colorBackground</item>
</style>
</resources>

View File

@ -0,0 +1,8 @@
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.example_router">
<!-- The INTERNET permission is required for development. Specifically,
the Flutter tool needs it to communicate with the running application
to allow setting breakpoints, to provide hot reload, etc.
-->
<uses-permission android:name="android.permission.INTERNET"/>
</manifest>

View File

@ -0,0 +1,34 @@
buildscript {
ext.kotlin_version = '1.6.10'
repositories {
google()
mavenCentral()
}
dependencies {
classpath 'com.android.tools.build:gradle:7.1.2'
// START: FlutterFire Configuration
classpath 'com.google.gms:google-services:4.3.10'
// END: FlutterFire Configuration
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
}
}
allprojects {
repositories {
google()
mavenCentral()
}
}
rootProject.buildDir = '../build'
subprojects {
project.buildDir = "${rootProject.buildDir}/${project.name}"
}
subprojects {
project.evaluationDependsOn(':app')
}
task clean(type: Delete) {
delete rootProject.buildDir
}

View File

@ -0,0 +1,3 @@
org.gradle.jvmargs=-Xmx1536M
android.useAndroidX=true
android.enableJetifier=true

View File

@ -0,0 +1,6 @@
#Fri Jun 23 08:50:38 CEST 2017
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-all.zip

View File

@ -0,0 +1,11 @@
include ':app'
def localPropertiesFile = new File(rootProject.projectDir, "local.properties")
def properties = new Properties()
assert localPropertiesFile.exists()
localPropertiesFile.withReader("UTF-8") { reader -> properties.load(reader) }
def flutterSdkPath = properties.getProperty("flutter.sdk")
assert flutterSdkPath != null, "flutter.sdk not set in local.properties"
apply from: "$flutterSdkPath/packages/flutter_tools/gradle/app_plugin_loader.gradle"

View File

@ -0,0 +1,40 @@
// Author: Hugo Pointcheval
// Email: git@pcl.ovh
// -----
// File: bootstrap.dart
// Created Date: 19/08/2022 15:05:17
// Last Modified: 19/08/2022 15:21:47
// -----
// Copyright (c) 2022
import 'dart:async';
import 'package:example_router/core/utils/app_bloc_observer.dart';
import 'package:example_router/firebase_options.dart';
import 'package:firebase_core/firebase_core.dart';
import 'package:flutter/widgets.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:go_router/go_router.dart';
Future<void> bootstrap(FutureOr<Widget> Function() builder) async {
await runZonedGuarded(
() async {
WidgetsFlutterBinding.ensureInitialized();
FlutterError.onError = (details) {
debugPrint(details.toString());
};
await Firebase.initializeApp(
options: DefaultFirebaseOptions.currentPlatform,
);
GoRouter.setUrlPathStrategy(UrlPathStrategy.path);
Bloc.observer = AppBlocObserver();
runApp(await builder());
},
(error, stackTrace) => debugPrint(error.toString()),
);
}

View File

@ -0,0 +1,12 @@
// Author: Hugo Pointcheval
// Email: git@pcl.ovh
// -----
// File: form_field.dart
// Created Date: 19/08/2022 11:52:33
// Last Modified: 19/08/2022 16:35:39
// -----
// Copyright (c) 2022
abstract class AppFormField {
static const confirmedPassword = 'confirmedPassword';
}

View File

@ -0,0 +1,79 @@
// Author: Hugo Pointcheval
// Email: git@pcl.ovh
// -----
// File: router.dart
// Created Date: 19/08/2022 11:52:22
// Last Modified: 19/08/2022 16:39:07
// -----
// Copyright (c) 2022
import 'package:example_router/presentation/features/home/home_page.dart';
import 'package:example_router/presentation/features/sign_in/sign_in_page.dart';
import 'package:example_router/presentation/features/sign_up/sign_up_page.dart';
import 'package:example_router/presentation/features/sub/sub_page.dart';
import 'package:example_router/presentation/features/welcome/welcome_page.dart';
import 'package:flutter/cupertino.dart';
import 'package:go_router/go_router.dart';
class AppRouter {
/// Default transition for all pages
static Page<void> defaultTransition(
BuildContext context,
GoRouterState state,
Widget child,
) =>
CupertinoPage<void>(
key: state.pageKey,
child: child,
);
static final publicRoutes = ['/', '/sign_in', '/sign_up'];
static final List<GoRoute> routes = [
GoRoute(
path: '/',
name: WelcomePage.pageName,
pageBuilder: (context, state) => defaultTransition(
context,
state,
const WelcomePage(),
),
),
GoRoute(
path: '/sign_in',
name: SignInPage.pageName,
pageBuilder: (context, state) => defaultTransition(
context,
state,
const SignInPage(),
),
),
GoRoute(
path: '/sign_up',
name: SignUpPage.pageName,
pageBuilder: (context, state) => defaultTransition(
context,
state,
const SignUpPage(),
),
),
GoRoute(
path: '/home',
name: HomePage.pageName,
pageBuilder: (context, state) => defaultTransition(
context,
state,
const HomePage(),
),
),
GoRoute(
path: '/home/sub',
name: SubPage.pageName,
pageBuilder: (context, state) => defaultTransition(
context,
state,
const SubPage(),
),
),
];
}

View File

@ -0,0 +1,37 @@
// Author: Hugo Pointcheval
// Email: git@pcl.ovh
// -----
// File: app_bloc_observer.dart
// Created Date: 19/08/2022 12:02:23
// Last Modified: 19/08/2022 12:02:45
// -----
// Copyright (c) 2022
import 'package:flutter/foundation.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
class AppBlocObserver extends BlocObserver {
@override
void onEvent(Bloc bloc, Object? event) {
super.onEvent(bloc, event);
debugPrint(event.toString());
}
@override
void onError(BlocBase bloc, Object error, StackTrace stackTrace) {
debugPrint(error.toString());
super.onError(bloc, error, stackTrace);
}
@override
void onChange(BlocBase bloc, Change change) {
super.onChange(bloc, change);
debugPrint('curr:\t${change.currentState}\nnext:\t${change.nextState}');
}
@override
void onTransition(Bloc bloc, Transition transition) {
super.onTransition(bloc, transition);
debugPrint(transition.toString());
}
}

View File

@ -0,0 +1,21 @@
// Author: Hugo Pointcheval
// Email: git@pcl.ovh
// -----
// File: forms.dart
// Created Date: 19/08/2022 12:00:31
// Last Modified: 19/08/2022 16:35:52
// -----
// Copyright (c) 2022
import 'package:example_router/core/constants/form_field.dart';
import 'package:wyatt_form_bloc/wyatt_form_bloc.dart';
class Forms {
static FormData getNormalData() => const FormData([
FormInput(
AppFormField.confirmedPassword,
ConfirmedPassword.pure(),
metadata: FormInputMetadata<void>(export: false),
),
]);
}

View File

@ -0,0 +1,63 @@
// File generated by FlutterFire CLI.
// ignore_for_file: lines_longer_than_80_chars, avoid_classes_with_only_static_members
import 'package:firebase_core/firebase_core.dart' show FirebaseOptions;
import 'package:flutter/foundation.dart'
show defaultTargetPlatform, kIsWeb, TargetPlatform;
/// Default [FirebaseOptions] for use with your Firebase apps.
///
/// Example:
/// ```dart
/// import 'firebase_options.dart';
/// // ...
/// await Firebase.initializeApp(
/// options: DefaultFirebaseOptions.currentPlatform,
/// );
/// ```
class DefaultFirebaseOptions {
static FirebaseOptions get currentPlatform {
if (kIsWeb) {
throw UnsupportedError(
'DefaultFirebaseOptions have not been configured for web - '
'you can reconfigure this by running the FlutterFire CLI again.',
);
}
switch (defaultTargetPlatform) {
case TargetPlatform.android:
return android;
case TargetPlatform.iOS:
throw UnsupportedError(
'DefaultFirebaseOptions have not been configured for ios - '
'you can reconfigure this by running the FlutterFire CLI again.',
);
case TargetPlatform.macOS:
throw UnsupportedError(
'DefaultFirebaseOptions have not been configured for macos - '
'you can reconfigure this by running the FlutterFire CLI again.',
);
case TargetPlatform.windows:
throw UnsupportedError(
'DefaultFirebaseOptions have not been configured for windows - '
'you can reconfigure this by running the FlutterFire CLI again.',
);
case TargetPlatform.linux:
throw UnsupportedError(
'DefaultFirebaseOptions have not been configured for linux - '
'you can reconfigure this by running the FlutterFire CLI again.',
);
default:
throw UnsupportedError(
'DefaultFirebaseOptions are not supported for this platform.',
);
}
}
static const FirebaseOptions android = FirebaseOptions(
apiKey: 'AIzaSyAYS14uXupkS158Q5QAFP1864UrUN_yDSk',
appId: '1:136771801992:android:ac3cfeb99fb0763e97203d',
messagingSenderId: '136771801992',
projectId: 'tchat-beta',
databaseURL: 'https://tchat-beta.firebaseio.com',
storageBucket: 'tchat-beta.appspot.com',
);
}

View File

@ -0,0 +1,6 @@
import 'package:example_router/bootstrap.dart';
import 'package:example_router/presentation/features/app/app.dart';
void main() {
bootstrap(App.new);
}

View File

@ -0,0 +1,115 @@
// Author: Hugo Pointcheval
// Email: git@pcl.ovh
// -----
// File: app.dart
// Created Date: 19/08/2022 12:05:38
// Last Modified: Fri Aug 26 2022
// -----
// Copyright (c) 2022
import 'package:example_router/core/routes/router.dart';
import 'package:example_router/core/utils/forms.dart';
import 'package:example_router/presentation/features/home/home_page.dart';
import 'package:example_router/presentation/features/welcome/welcome_page.dart';
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:go_router/go_router.dart';
import 'package:wyatt_authentication_bloc/wyatt_authentication_bloc.dart';
class App extends StatelessWidget {
final AuthenticationRepository authenticationRepository =
AuthenticationRepositoryFirebase();
App({Key? key}) : super(key: key);
@override
Widget build(BuildContext context) {
AuthenticationState? previous;
final AuthenticationCubit authenticationCubit = AuthenticationCubit(
authenticationRepository: authenticationRepository,
onAuthSuccess: (user) async {
debugPrint(user.toString());
return {};
},
);
final GoRouter router = GoRouter(
initialLocation: '/',
routes: AppRouter.routes,
debugLogDiagnostics: true,
errorBuilder: (_, __) => const ColoredBox(
color: Colors.red,
),
refreshListenable: GoRouterRefreshStream(authenticationCubit.stream),
redirect: (state) {
final authState = authenticationCubit.state;
if (authState != previous) {
previous = authState;
// Check if current user is logged in
final loggedIn =
authState.status == AuthenticationStatus.authenticated;
// Checking if current path is onboarding or not
final isOnboarding = AppRouter.publicRoutes.contains(state.subloc);
if (!loggedIn) {
debugPrint('Not logged');
if (isOnboarding) {
return null;
} else {
return state.namedLocation(WelcomePage.pageName);
}
} else {
final email = authState.user?.email;
debugPrint('Logged as: $email');
if (isOnboarding) {
return state.namedLocation(HomePage.pageName);
} else {
return null;
}
}
}
return null;
},
);
return MultiRepositoryProvider(
providers: [
RepositoryProvider<AuthenticationRepository>.value(
value: authenticationRepository,
),
],
child: MultiBlocProvider(
providers: [
BlocProvider<AuthenticationCubit>.value(
value: authenticationCubit..init(),
),
BlocProvider<SignUpCubit>(
create: (_) => SignUpCubit(
authenticationRepository: authenticationRepository,
formData: Forms.getNormalData(),
onSignUpSuccess: (state, uid) async {
debugPrint(state.toString());
debugPrint(uid);
},
),
),
BlocProvider<SignInCubit>(
create: (_) => SignInCubit(
authenticationRepository: authenticationRepository,
),
),
],
child: MaterialApp.router(
title: 'Demo Authentication',
debugShowCheckedModeBanner: false,
routerDelegate: router.routerDelegate,
routeInformationParser: router.routeInformationParser,
routeInformationProvider: router.routeInformationProvider,
),
),
);
}
}

View File

@ -0,0 +1,55 @@
// Author: Hugo Pointcheval
// Email: git@pcl.ovh
// -----
// File: home_page.dart
// Created Date: 19/08/2022 14:38:24
// Last Modified: 19/08/2022 16:12:22
// -----
// Copyright (c) 2022
import 'package:example_router/presentation/features/sub/sub_page.dart';
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:go_router/go_router.dart';
import 'package:wyatt_authentication_bloc/wyatt_authentication_bloc.dart';
class HomePage extends StatelessWidget {
const HomePage({Key? key}) : super(key: key);
static String pageName = 'Home';
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: const Text('Home'),
actions: [
IconButton(
onPressed: () => context.read<AuthenticationCubit>().logOut(),
icon: const Icon(Icons.logout_rounded))
],
),
body: Padding(
padding: const EdgeInsets.all(8),
child: SingleChildScrollView(
child: Column(
children: [
BlocBuilder<AuthenticationCubit, AuthenticationState>(
builder: (context, state) {
final email = state.user?.email;
return Text('Logged as $email');
},
),
const SizedBox(
height: 8,
),
ElevatedButton(
onPressed: () => context.pushNamed(SubPage.pageName),
child: const Text('Go to sub page')),
],
),
),
),
);
}
}

View File

@ -0,0 +1,30 @@
// Author: Hugo Pointcheval
// Email: git@pcl.ovh
// -----
// File: sign_in_page.dart
// Created Date: 19/08/2022 12:41:42
// Last Modified: 19/08/2022 15:26:36
// -----
// Copyright (c) 2022
import 'package:example_router/presentation/features/sign_in/widgets/sign_in_form.dart';
import 'package:flutter/material.dart';
class SignInPage extends StatelessWidget {
const SignInPage({Key? key}) : super(key: key);
static String pageName = 'SignIn';
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(title: const Text('Sign In')),
body: const Padding(
padding: EdgeInsets.all(8),
child: SingleChildScrollView(
child: SignInForm(),
),
),
);
}
}

View File

@ -0,0 +1,105 @@
// Author: Hugo Pointcheval
// Email: git@pcl.ovh
// -----
// File: sign_in_form.dart
// Created Date: 19/08/2022 15:24:37
// Last Modified: 19/08/2022 16:35:01
// -----
// Copyright (c) 2022
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:wyatt_authentication_bloc/wyatt_authentication_bloc.dart';
class _EmailInput extends StatelessWidget {
@override
Widget build(BuildContext context) {
return BlocBuilder<SignInCubit, SignInState>(
buildWhen: (previous, current) => previous.email != current.email,
builder: (context, state) {
return TextField(
onChanged: (email) => context.read<SignInCubit>().emailChanged(email),
keyboardType: TextInputType.emailAddress,
decoration: InputDecoration(
labelText: 'Email',
helperText: '',
errorText: state.email.invalid ? 'Invalid email' : null,
),
);
},
);
}
}
class _PasswordInput extends StatelessWidget {
@override
Widget build(BuildContext context) {
return BlocBuilder<SignInCubit, SignInState>(
buildWhen: (previous, current) => previous.password != current.password,
builder: (context, state) {
return TextField(
onChanged: (password) {
context.read<SignInCubit>().passwordChanged(password);
},
obscureText: true,
decoration: InputDecoration(
labelText: 'Password',
helperText: '',
errorText: state.password.invalid ? 'Invalid password' : null,
),
);
},
);
}
}
class _SignInButton extends StatelessWidget {
@override
Widget build(BuildContext context) {
return BlocBuilder<SignInCubit, SignInState>(
builder: (context, state) {
return state.status.isSubmissionInProgress
? const CircularProgressIndicator()
: ElevatedButton(
onPressed: state.status.isValidated
? () =>
context.read<SignInCubit>().signInWithEmailAndPassword()
: null,
child: const Text('Sign in'),
);
},
);
}
}
class SignInForm extends StatelessWidget {
const SignInForm({Key? key}) : super(key: key);
@override
Widget build(BuildContext context) {
return BlocListener<SignInCubit, SignInState>(
listener: (context, state) {
if (state.status.isSubmissionSuccess) {
Navigator.of(context).pop();
} else if (state.status.isSubmissionFailure) {
ScaffoldMessenger.of(context)
..hideCurrentSnackBar()
..showSnackBar(
SnackBar(content: Text(state.errorMessage ?? 'Sign In Failure')),
);
}
},
child: SingleChildScrollView(
child: Column(
children: [
_EmailInput(),
const SizedBox(height: 8),
_PasswordInput(),
const SizedBox(height: 16),
_SignInButton(),
],
),
),
);
}
}

View File

@ -0,0 +1,30 @@
// Author: Hugo Pointcheval
// Email: git@pcl.ovh
// -----
// File: sign_up_page.dart
// Created Date: 19/08/2022 12:41:27
// Last Modified: 19/08/2022 14:58:51
// -----
// Copyright (c) 2022
import 'package:example_router/presentation/features/sign_up/widgets/sign_up_form.dart';
import 'package:flutter/material.dart';
class SignUpPage extends StatelessWidget {
const SignUpPage({Key? key}) : super(key: key);
static String pageName = 'SignUp';
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(title: const Text('Sign Up')),
body: const Padding(
padding: EdgeInsets.all(8),
child: SingleChildScrollView(
child: SignUpForm(),
),
),
);
}
}

View File

@ -0,0 +1,149 @@
// Author: Hugo Pointcheval
// Email: git@pcl.ovh
// -----
// File: sign_up_form.dart
// Created Date: 19/08/2022 14:41:08
// Last Modified: Fri Aug 26 2022
// -----
// Copyright (c) 2022
import 'package:example_router/core/constants/form_field.dart';
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:wyatt_authentication_bloc/wyatt_authentication_bloc.dart';
import 'package:wyatt_form_bloc/wyatt_form_bloc.dart';
class _EmailInput extends StatelessWidget {
@override
Widget build(BuildContext context) {
return BlocBuilder<SignUpCubit, SignUpState>(
buildWhen: (previous, current) => previous.email != current.email,
builder: (context, state) {
return TextField(
onChanged: (email) => context.read<SignUpCubit>().emailChanged(email),
keyboardType: TextInputType.emailAddress,
decoration: InputDecoration(
labelText: 'Email',
helperText: '',
errorText: state.email.invalid ? 'Invalid email' : null,
),
);
},
);
}
}
class _PasswordInput extends StatelessWidget {
@override
Widget build(BuildContext context) {
return BlocBuilder<SignUpCubit, SignUpState>(
buildWhen: (previous, current) => previous.password != current.password,
builder: (context, state) {
return TextField(
onChanged: (password) {
context.read<SignUpCubit>().passwordChanged(password);
context.read<SignUpCubit>().dataChanged(
AppFormField.confirmedPassword,
ConfirmedPassword.dirty(
password: password,
value: context
.read<SignUpCubit>()
.state
.data
.valueOf<String>(
AppFormField.confirmedPassword),
),
);
},
obscureText: true,
decoration: InputDecoration(
labelText: 'Password',
helperText: '',
errorText: state.password.invalid ? 'Invalid password' : null,
),
);
},
);
}
}
class _ConfirmPasswordInput extends StatelessWidget {
@override
Widget build(BuildContext context) {
return BlocBuilder<SignUpCubit, SignUpState>(
builder: (context, state) {
return TextField(
onChanged: (confirmPassword) => context
.read<SignUpCubit>()
.dataChanged(
AppFormField.confirmedPassword,
ConfirmedPassword.dirty(
password: context.read<SignUpCubit>().state.password.value,
value: confirmPassword,
),
),
obscureText: true,
decoration: InputDecoration(
labelText: 'Confirm password',
helperText: '',
errorText: state.data.isNotValid(AppFormField.confirmedPassword)
? 'Passwords do not match'
: null,
),
);
},
);
}
}
class _SignUpButton extends StatelessWidget {
@override
Widget build(BuildContext context) {
return BlocBuilder<SignUpCubit, SignUpState>(
builder: (context, state) {
return state.status.isSubmissionInProgress
? const CircularProgressIndicator()
: ElevatedButton(
onPressed: state.status.isValidated
? () => context.read<SignUpCubit>().signUpFormSubmitted()
: null,
child: const Text('Sign up'),
);
},
);
}
}
class SignUpForm extends StatelessWidget {
const SignUpForm({Key? key}) : super(key: key);
@override
Widget build(BuildContext context) {
return BlocListener<SignUpCubit, SignUpState>(
listener: (context, state) {
if (state.status.isSubmissionSuccess) {
Navigator.of(context).pop();
} else if (state.status.isSubmissionFailure) {
ScaffoldMessenger.of(context)
..hideCurrentSnackBar()
..showSnackBar(
SnackBar(content: Text(state.errorMessage ?? 'Sign Up Failure')),
);
}
},
child: SingleChildScrollView(
child: Column(
children: [
_EmailInput(),
const SizedBox(height: 8),
_PasswordInput(),
const SizedBox(height: 8),
_ConfirmPasswordInput(),
const SizedBox(height: 16),
_SignUpButton(),
],
),
),
);
}
}

View File

@ -0,0 +1,38 @@
// Author: Hugo Pointcheval
// Email: git@pcl.ovh
// -----
// File: sub_page.dart
// Created Date: 19/08/2022 16:10:05
// Last Modified: 19/08/2022 16:10:44
// -----
// Copyright (c) 2022
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:wyatt_authentication_bloc/wyatt_authentication_bloc.dart';
class SubPage extends StatelessWidget {
const SubPage({Key? key}) : super(key: key);
static String pageName = 'Sub';
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: const Text('Sub'),
actions: [
IconButton(
onPressed: () => context.read<AuthenticationCubit>().logOut(),
icon: const Icon(Icons.logout_rounded))
],
),
body: const Padding(
padding: EdgeInsets.all(8),
child: SingleChildScrollView(
child: Text('Another page'),
),
),
);
}
}

View File

@ -0,0 +1,53 @@
// Author: Hugo Pointcheval
// Email: git@pcl.ovh
// -----
// File: welcome_page.dart
// Created Date: 19/08/2022 12:33:21
// Last Modified: 19/08/2022 15:56:05
// -----
// Copyright (c) 2022
import 'package:example_router/presentation/features/sign_in/sign_in_page.dart';
import 'package:example_router/presentation/features/sign_up/sign_up_page.dart';
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:go_router/go_router.dart';
import 'package:wyatt_authentication_bloc/wyatt_authentication_bloc.dart';
class WelcomePage extends StatelessWidget {
const WelcomePage({Key? key}) : super(key: key);
static String pageName = 'Welcome';
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: const Text('Welcome'),
actions: [
IconButton(
onPressed: () => context.read<AuthenticationCubit>().changeStatus(
context.read<AuthenticationCubit>().state.user!),
icon: const Icon(Icons.refresh_rounded))
],
),
body: SingleChildScrollView(
child: Column(
children: [
ElevatedButton(
onPressed: () => context.pushNamed(SignUpPage.pageName),
child: const Text('Sign Up')),
ElevatedButton(
onPressed: () => context.pushNamed(SignInPage.pageName),
style: ButtonStyle(
backgroundColor:
MaterialStateProperty.all<Color>(Colors.white),
foregroundColor:
MaterialStateProperty.all<Color>(Colors.blue)),
child: const Text('Sign In'))
],
),
),
);
}
}

View File

@ -0,0 +1,100 @@
name: example_router
description: A new Flutter project.
# The following line prevents the package from being accidentally published to
# pub.dev using `flutter pub publish`. This is preferred for private packages.
publish_to: 'none' # Remove this line if you wish to publish to pub.dev
# The following defines the version and build number for your application.
# A version number is three numbers separated by dots, like 1.2.43
# followed by an optional build number separated by a +.
# Both the version and the builder number may be overridden in flutter
# build by specifying --build-name and --build-number, respectively.
# In Android, build-name is used as versionName while build-number used as versionCode.
# Read more about Android versioning at https://developer.android.com/studio/publish/versioning
# In iOS, build-name is used as CFBundleShortVersionString while build-number used as CFBundleVersion.
# Read more about iOS versioning at
# https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html
version: 1.0.0+1
environment:
sdk: ">=2.17.6 <3.0.0"
# Dependencies specify other packages that your package needs in order to work.
# To automatically upgrade your package dependencies to the latest versions
# consider running `flutter pub upgrade --major-versions`. Alternatively,
# dependencies can be manually updated by changing the version numbers below to
# the latest version available on pub.dev. To see which dependencies have newer
# versions available, run `flutter pub outdated`.
dependencies:
flutter:
sdk: flutter
go_router: ^4.2.8
firebase_core: ^1.21.0
flutter_bloc: ^8.1.1
wyatt_authentication_bloc:
path: "../"
wyatt_form_bloc:
git:
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
ref: wyatt_form_bloc-v0.0.6
path: packages/wyatt_form_bloc
# The following adds the Cupertino Icons font to your application.
# Use with the CupertinoIcons class for iOS style icons.
cupertino_icons: ^1.0.2
dev_dependencies:
flutter_test:
sdk: flutter
# The "flutter_lints" package below contains a set of recommended lints to
# encourage good coding practices. The lint set provided by the package is
# activated in the `analysis_options.yaml` file located at the root of your
# package. See that file for information about deactivating specific lint
# rules and activating additional ones.
flutter_lints: ^2.0.0
# For information on the generic Dart part of this file, see the
# following page: https://dart.dev/tools/pub/pubspec
# The following section is specific to Flutter packages.
flutter:
# The following line ensures that the Material Icons font is
# included with your application, so that you can use the icons in
# the material Icons class.
uses-material-design: true
# To add assets to your application, add an assets section, like this:
# assets:
# - images/a_dot_burr.jpeg
# - images/a_dot_ham.jpeg
# An image asset can refer to one or more resolution-specific "variants", see
# https://flutter.dev/assets-and-images/#resolution-aware
# For details regarding adding assets from package dependencies, see
# https://flutter.dev/assets-and-images/#from-packages
# To add custom fonts to your application, add a fonts section here,
# in this "flutter" section. Each entry in this list should have a
# "family" key with the font family name, and a "fonts" key with a
# list giving the asset and other descriptors for the font. For
# example:
# fonts:
# - family: Schyler
# fonts:
# - asset: fonts/Schyler-Regular.ttf
# - asset: fonts/Schyler-Italic.ttf
# style: italic
# - family: Trajan Pro
# fonts:
# - asset: fonts/TrajanPro.ttf
# - asset: fonts/TrajanPro_Bold.ttf
# weight: 700
#
# For details regarding fonts from package dependencies,
# see https://flutter.dev/custom-fonts/#from-packages

View File

@ -1,76 +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:bloc/bloc.dart';
import 'package:equatable/equatable.dart';
import 'package:wyatt_authentication_bloc/src/models/user/user_interface.dart';
import 'package:wyatt_authentication_bloc/src/repositories/authentication_repository_interface.dart';
part 'authentication_state.dart';
class AuthenticationCubit extends Cubit<AuthenticationState> {
final AuthenticationRepositoryInterface _authenticationRepository;
StreamSubscription<UserInterface>? _userSubscription;
final Future<Map<String, dynamic>> Function(UserInterface user)?
_onAuthSuccess;
AuthenticationCubit({
required AuthenticationRepositoryInterface authenticationRepository,
Future<Map<String, dynamic>> Function(UserInterface user)? onAuthSuccess,
}) : _authenticationRepository = authenticationRepository,
_onAuthSuccess = onAuthSuccess,
super(const AuthenticationState.unknown());
Future<void> init() async {
final _firstUser = await _authenticationRepository.user.first;
start();
return changeStatus(_firstUser);
}
bool start() {
_userSubscription = _authenticationRepository.user.listen(changeStatus);
return true;
}
bool stop() {
_userSubscription?.cancel();
return true;
}
Future<void> changeStatus(UserInterface user) async {
if (user.isNotEmpty) {
final Map<String, dynamic>? userData = await _onAuthSuccess?.call(user);
emit(AuthenticationState.authenticated(user, userData));
} else {
stop();
emit(const AuthenticationState.unauthenticated());
}
}
void logOut() {
unawaited(_authenticationRepository.signOut());
}
@override
Future<void> close() {
_userSubscription?.cancel();
return super.close();
}
}

View File

@ -14,5 +14,7 @@
// 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 'user_firebase.dart';
export 'user_interface.dart';
enum AuthCubitStatus {
started,
stoped,
}

View File

@ -29,11 +29,10 @@ abstract class AuthenticationFailureInterface implements Exception {
abstract class ApplyActionCodeFailureInterface
extends AuthenticationFailureInterface {
/// {@macro apply_action_code_failure}
ApplyActionCodeFailureInterface(String code, String message)
: super(code, message);
ApplyActionCodeFailureInterface(super.code, super.message);
/// {@macro apply_action_code_failure}
ApplyActionCodeFailureInterface.fromCode(String code) : super.fromCode(code);
ApplyActionCodeFailureInterface.fromCode(super.code) : super.fromCode();
}
/// {@template sign_up_with_email_and_password_failure}
@ -42,12 +41,11 @@ abstract class ApplyActionCodeFailureInterface
abstract class SignUpWithEmailAndPasswordFailureInterface
extends AuthenticationFailureInterface {
/// {@macro sign_up_with_email_and_password_failure}
SignUpWithEmailAndPasswordFailureInterface(String code, String message)
: super(code, message);
SignUpWithEmailAndPasswordFailureInterface(super.code, super.message);
/// {@macro sign_up_with_email_and_password_failure}
SignUpWithEmailAndPasswordFailureInterface.fromCode(String code)
: super.fromCode(code);
SignUpWithEmailAndPasswordFailureInterface.fromCode(super.code)
: super.fromCode();
}
/// {@template fetch_sign_in_methods_failure}
@ -56,12 +54,11 @@ abstract class SignUpWithEmailAndPasswordFailureInterface
abstract class FetchSignInMethodsForEmailFailureInterface
extends AuthenticationFailureInterface {
/// {@macro fetch_sign_in_methods_failure}
FetchSignInMethodsForEmailFailureInterface(String code, String message)
: super(code, message);
FetchSignInMethodsForEmailFailureInterface(super.code, super.message);
/// {@macro fetch_sign_in_methods_failure}
FetchSignInMethodsForEmailFailureInterface.fromCode(String code)
: super.fromCode(code);
FetchSignInMethodsForEmailFailureInterface.fromCode(super.code)
: super.fromCode();
}
/// {@template sign_in_with_credential_failure}
@ -70,12 +67,10 @@ abstract class FetchSignInMethodsForEmailFailureInterface
abstract class SignInWithCredentialFailureInterface
extends AuthenticationFailureInterface {
/// {@macro sign_in_with_credential_failure}
SignInWithCredentialFailureInterface(String code, String message)
: super(code, message);
SignInWithCredentialFailureInterface(super.code, super.message);
/// {@macro sign_in_with_credential_failure}
SignInWithCredentialFailureInterface.fromCode(String code)
: super.fromCode(code);
SignInWithCredentialFailureInterface.fromCode(super.code) : super.fromCode();
}
/// {@template sign_in_anonymously_failure}
@ -84,12 +79,10 @@ abstract class SignInWithCredentialFailureInterface
abstract class SignInAnonymouslyFailureInterface
extends AuthenticationFailureInterface {
/// {@macro sign_in_anonymously_failure}
SignInAnonymouslyFailureInterface(String code, String message)
: super(code, message);
SignInAnonymouslyFailureInterface(super.code, super.message);
/// {@macro sign_in_anonymously_failure}
SignInAnonymouslyFailureInterface.fromCode(String code)
: super.fromCode(code);
SignInAnonymouslyFailureInterface.fromCode(super.code) : super.fromCode();
}
/// {@template sign_in_with_google_failure}
@ -98,11 +91,10 @@ abstract class SignInAnonymouslyFailureInterface
abstract class SignInWithGoogleFailureInterface
extends AuthenticationFailureInterface {
/// {@macro sign_in_with_google_failure}
SignInWithGoogleFailureInterface(String code, String message)
: super(code, message);
SignInWithGoogleFailureInterface(super.code, super.message);
/// {@macro sign_in_with_google_failure}
SignInWithGoogleFailureInterface.fromCode(String code) : super.fromCode(code);
SignInWithGoogleFailureInterface.fromCode(super.code) : super.fromCode();
}
/// {@template sign_in_with_facebook_failure}
@ -111,12 +103,10 @@ abstract class SignInWithGoogleFailureInterface
abstract class SignInWithFacebookFailureInterface
extends AuthenticationFailureInterface {
/// {@macro sign_in_with_facebook_failure}
SignInWithFacebookFailureInterface(String code, String message)
: super(code, message);
SignInWithFacebookFailureInterface(super.code, super.message);
/// {@macro sign_in_with_facebook_failure}
SignInWithFacebookFailureInterface.fromCode(String code)
: super.fromCode(code);
SignInWithFacebookFailureInterface.fromCode(super.code) : super.fromCode();
}
/// {@template sign_in_with_apple_failure}
@ -125,11 +115,10 @@ abstract class SignInWithFacebookFailureInterface
abstract class SignInWithAppleFailureInterface
extends AuthenticationFailureInterface {
/// {@macro sign_in_with_apple_failure}
SignInWithAppleFailureInterface(String code, String message)
: super(code, message);
SignInWithAppleFailureInterface(super.code, super.message);
/// {@macro sign_in_with_apple_failure}
SignInWithAppleFailureInterface.fromCode(String code) : super.fromCode(code);
SignInWithAppleFailureInterface.fromCode(super.code) : super.fromCode();
}
/// {@template sign_in_with_twitter_failure}
@ -138,12 +127,10 @@ abstract class SignInWithAppleFailureInterface
abstract class SignInWithTwitterFailureInterface
extends AuthenticationFailureInterface {
/// {@macro sign_in_with_twitter_failure}
SignInWithTwitterFailureInterface(String code, String message)
: super(code, message);
SignInWithTwitterFailureInterface(super.code, super.message);
/// {@macro sign_in_with_twitter_failure}
SignInWithTwitterFailureInterface.fromCode(String code)
: super.fromCode(code);
SignInWithTwitterFailureInterface.fromCode(super.code) : super.fromCode();
}
/// {@template sign_in_with_email_link_failure}
@ -152,12 +139,10 @@ abstract class SignInWithTwitterFailureInterface
abstract class SignInWithEmailLinkFailureInterface
extends AuthenticationFailureInterface {
/// {@macro sign_in_with_email_link_failure}
SignInWithEmailLinkFailureInterface(String code, String message)
: super(code, message);
SignInWithEmailLinkFailureInterface(super.code, super.message);
/// {@macro sign_in_with_email_link_failure}
SignInWithEmailLinkFailureInterface.fromCode(String code)
: super.fromCode(code);
SignInWithEmailLinkFailureInterface.fromCode(super.code) : super.fromCode();
}
/// {@template sign_in_with_email_and_password_failure}
@ -166,12 +151,11 @@ abstract class SignInWithEmailLinkFailureInterface
abstract class SignInWithEmailAndPasswordFailureInterface
extends AuthenticationFailureInterface {
/// {@macro sign_in_with_email_and_password_failure}
SignInWithEmailAndPasswordFailureInterface(String code, String message)
: super(code, message);
SignInWithEmailAndPasswordFailureInterface(super.code, super.message);
/// {@macro sign_in_with_email_and_password_failure}
SignInWithEmailAndPasswordFailureInterface.fromCode(String code)
: super.fromCode(code);
SignInWithEmailAndPasswordFailureInterface.fromCode(super.code)
: super.fromCode();
}
/// {@template send_email_verification_failure}
@ -180,12 +164,10 @@ abstract class SignInWithEmailAndPasswordFailureInterface
abstract class SendEmailVerificationFailureInterface
extends AuthenticationFailureInterface {
/// {@macro send_email_verification_failure}
SendEmailVerificationFailureInterface(String code, String message)
: super(code, message);
SendEmailVerificationFailureInterface(super.code, super.message);
/// {@macro send_email_verification_failure}
SendEmailVerificationFailureInterface.fromCode(String code)
: super.fromCode(code);
SendEmailVerificationFailureInterface.fromCode(super.code) : super.fromCode();
}
/// {@template send_password_reset_email_failure}
@ -194,12 +176,11 @@ abstract class SendEmailVerificationFailureInterface
abstract class SendPasswordResetEmailFailureInterface
extends AuthenticationFailureInterface {
/// {@macro send_password_reset_email_failure}
SendPasswordResetEmailFailureInterface(String code, String message)
: super(code, message);
SendPasswordResetEmailFailureInterface(super.code, super.message);
/// {@macro send_password_reset_email_failure}
SendPasswordResetEmailFailureInterface.fromCode(String code)
: super.fromCode(code);
SendPasswordResetEmailFailureInterface.fromCode(super.code)
: super.fromCode();
}
/// {@template send_sign_in_link_email_failure}
@ -208,12 +189,10 @@ abstract class SendPasswordResetEmailFailureInterface
abstract class SendSignInLinkEmailFailureInterface
extends AuthenticationFailureInterface {
/// {@macro send_sign_in_link_email_failure}
SendSignInLinkEmailFailureInterface(String code, String message)
: super(code, message);
SendSignInLinkEmailFailureInterface(super.code, super.message);
/// {@macro send_sign_in_link_email_failure}
SendSignInLinkEmailFailureInterface.fromCode(String code)
: super.fromCode(code);
SendSignInLinkEmailFailureInterface.fromCode(super.code) : super.fromCode();
}
/// {@template confirm_password_reset_failure}
@ -222,12 +201,10 @@ abstract class SendSignInLinkEmailFailureInterface
abstract class ConfirmPasswordResetFailureInterface
extends AuthenticationFailureInterface {
/// {@macro confirm_password_reset_failure}
ConfirmPasswordResetFailureInterface(String code, String message)
: super(code, message);
ConfirmPasswordResetFailureInterface(super.code, super.message);
/// {@macro confirm_password_reset_failure}
ConfirmPasswordResetFailureInterface.fromCode(String code)
: super.fromCode(code);
ConfirmPasswordResetFailureInterface.fromCode(super.code) : super.fromCode();
}
/// {@template verify_password_reset_code_failure}
@ -236,12 +213,11 @@ abstract class ConfirmPasswordResetFailureInterface
abstract class VerifyPasswordResetCodeFailureInterface
extends AuthenticationFailureInterface {
/// {@macro verify_password_reset_code_failure}
VerifyPasswordResetCodeFailureInterface(String code, String message)
: super(code, message);
VerifyPasswordResetCodeFailureInterface(super.code, super.message);
/// {@macro verify_password_reset_code_failure}
VerifyPasswordResetCodeFailureInterface.fromCode(String code)
: super.fromCode(code);
VerifyPasswordResetCodeFailureInterface.fromCode(super.code)
: super.fromCode();
}
/// {@template refresh_failure}
@ -249,10 +225,10 @@ abstract class VerifyPasswordResetCodeFailureInterface
/// {@endtemplate}
abstract class RefreshFailureInterface extends AuthenticationFailureInterface {
/// {@macro refresh_failure}
RefreshFailureInterface(String code, String message) : super(code, message);
RefreshFailureInterface(super.code, super.message);
/// {@macro refresh_failure}
RefreshFailureInterface.fromCode(String code) : super.fromCode(code);
RefreshFailureInterface.fromCode(super.code) : super.fromCode();
}
/// {@template sign_out_failure}
@ -260,8 +236,8 @@ abstract class RefreshFailureInterface extends AuthenticationFailureInterface {
/// {@endtemplate}
abstract class SignOutFailureInterface extends AuthenticationFailureInterface {
/// {@macro sign_out_failure}
SignOutFailureInterface(String code, String message) : super(code, message);
SignOutFailureInterface(super.code, super.message);
/// {@macro sign_out_failure}
SignOutFailureInterface.fromCode(String code) : super.fromCode(code);
SignOutFailureInterface.fromCode(super.code) : super.fromCode();
}

View File

@ -14,7 +14,7 @@
// 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/src/models/exceptions/exceptions_interface.dart';
import 'package:wyatt_authentication_bloc/src/core/exceptions/exceptions.dart';
class ApplyActionCodeFailureFirebase extends ApplyActionCodeFailureInterface {
ApplyActionCodeFailureFirebase([String? code, String? message])
@ -148,35 +148,30 @@ class SignInWithCredentialFailureFirebase
class SignInWithGoogleFailureFirebase
extends SignInWithCredentialFailureFirebase
implements SignInWithGoogleFailureInterface {
SignInWithGoogleFailureFirebase([String? code, String? message])
: super(code, message);
SignInWithGoogleFailureFirebase.fromCode(String code) : super.fromCode(code);
SignInWithGoogleFailureFirebase([super.code, super.message]);
SignInWithGoogleFailureFirebase.fromCode(super.code) : super.fromCode();
}
class SignInWithFacebookFailureFirebase
extends SignInWithCredentialFailureFirebase
implements SignInWithFacebookFailureInterface {
SignInWithFacebookFailureFirebase([String? code, String? message])
: super(code, message);
SignInWithFacebookFailureFirebase.fromCode(String code)
: super.fromCode(code);
SignInWithFacebookFailureFirebase([super.code, super.message]);
SignInWithFacebookFailureFirebase.fromCode(super.code) : super.fromCode();
}
class SignInWithAppleFailureFirebase extends SignInWithCredentialFailureFirebase
implements SignInWithAppleFailureInterface {
SignInWithAppleFailureFirebase([String? code, String? message])
: super(code, message);
SignInWithAppleFailureFirebase.fromCode(String code) : super.fromCode(code);
SignInWithAppleFailureFirebase([super.code, super.message]);
SignInWithAppleFailureFirebase.fromCode(super.code) : super.fromCode();
}
class SignInWithTwitterFailureFirebase extends SignInWithCredentialFailureFirebase
class SignInWithTwitterFailureFirebase
extends SignInWithCredentialFailureFirebase
implements SignInWithAppleFailureInterface {
SignInWithTwitterFailureFirebase([String? code, String? message])
: super(code, message);
SignInWithTwitterFailureFirebase.fromCode(String code) : super.fromCode(code);
SignInWithTwitterFailureFirebase([super.code, super.message]);
SignInWithTwitterFailureFirebase.fromCode(super.code) : super.fromCode();
}
class SignInWithEmailLinkFailureFirebase
extends SignInWithEmailLinkFailureInterface {
SignInWithEmailLinkFailureFirebase([String? code, String? message])
@ -233,16 +228,14 @@ class SendEmailVerificationFailureFirebase
SendEmailVerificationFailureFirebase([String? code, String? message])
: super(code ?? 'unknown', message ?? 'An unknown error occurred.');
SendEmailVerificationFailureFirebase.fromCode(String code)
: super.fromCode(code);
SendEmailVerificationFailureFirebase.fromCode(super.code) : super.fromCode();
}
class SendPasswordResetEmailFailureFirebase
extends SendPasswordResetEmailFailureInterface {
SendPasswordResetEmailFailureFirebase([String? code, String? message])
: super(code ?? 'unknown', message ?? 'An unknown error occurred.');
SendPasswordResetEmailFailureFirebase.fromCode(String code)
: super.fromCode(code);
SendPasswordResetEmailFailureFirebase.fromCode(super.code) : super.fromCode();
}
class SendSignInLinkEmailFailureFirebase
@ -250,8 +243,7 @@ class SendSignInLinkEmailFailureFirebase
SendSignInLinkEmailFailureFirebase([String? code, String? message])
: super(code ?? 'unknown', message ?? 'An unknown error occurred.');
SendSignInLinkEmailFailureFirebase.fromCode(String code)
: super.fromCode(code);
SendSignInLinkEmailFailureFirebase.fromCode(super.code) : super.fromCode();
}
class ConfirmPasswordResetFailureFirebase
@ -259,8 +251,7 @@ class ConfirmPasswordResetFailureFirebase
ConfirmPasswordResetFailureFirebase([String? code, String? message])
: super(code ?? 'unknown', message ?? 'An unknown error occurred.');
ConfirmPasswordResetFailureFirebase.fromCode(String code)
: super.fromCode(code);
ConfirmPasswordResetFailureFirebase.fromCode(super.code) : super.fromCode();
}
class VerifyPasswordResetCodeFailureFirebase
@ -268,19 +259,19 @@ class VerifyPasswordResetCodeFailureFirebase
VerifyPasswordResetCodeFailureFirebase([String? code, String? message])
: super(code ?? 'unknown', message ?? 'An unknown error occurred.');
VerifyPasswordResetCodeFailureFirebase.fromCode(String code)
: super.fromCode(code);
VerifyPasswordResetCodeFailureFirebase.fromCode(super.code)
: super.fromCode();
}
class RefreshFailureFirebase extends RefreshFailureInterface {
RefreshFailureFirebase([String? code, String? message])
: super(code ?? 'unknown', message ?? 'An unknown error occurred.');
RefreshFailureFirebase.fromCode(String code) : super.fromCode(code);
RefreshFailureFirebase.fromCode(super.code) : super.fromCode();
}
class SignOutFailureFirebase extends SignOutFailureInterface {
SignOutFailureFirebase([String? code, String? message])
: super(code ?? 'unknown', message ?? 'An unknown error occurred.');
SignOutFailureFirebase.fromCode(String code) : super.fromCode(code);
SignOutFailureFirebase.fromCode(super.code) : super.fromCode();
}

View File

@ -0,0 +1,22 @@
// Copyright (C) 2022 WYATT GROUP
// Please see the AUTHORS file for details.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
import 'package:firebase_auth/firebase_auth.dart';
import 'package:wyatt_authentication_bloc/src/data/models/user_firebase.dart';
extension FirebaseAuthUserX on User {
UserFirebase get model => UserFirebase(this);
}

View File

@ -15,10 +15,9 @@
// along with this program. If not, see <https://www.gnu.org/licenses/>.
import 'package:firebase_auth/firebase_auth.dart';
import 'package:wyatt_authentication_bloc/src/domain/entities/user.dart' as wyatt;
import 'package:wyatt_authentication_bloc/src/models/user/user_interface.dart';
class UserFirebase implements UserInterface {
class UserFirebase implements wyatt.User {
final User? _user;
const UserFirebase(User user) : _user = user;

View File

@ -14,19 +14,24 @@
// 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:firebase_auth/firebase_auth.dart';
import 'package:flutter_facebook_auth/flutter_facebook_auth.dart';
import 'package:google_sign_in/google_sign_in.dart';
import 'package:sign_in_with_apple/sign_in_with_apple.dart';
import 'package:twitter_login/twitter_login.dart';
import 'package:wyatt_authentication_bloc/src/models/exceptions/exceptions_firebase.dart';
import 'package:wyatt_authentication_bloc/src/models/user/user_firebase.dart';
import 'package:wyatt_authentication_bloc/src/models/user/user_interface.dart';
import 'package:wyatt_authentication_bloc/src/repositories/authentication_repository_interface.dart';
import 'package:wyatt_authentication_bloc/src/utils/cryptography.dart';
import 'package:wyatt_authentication_bloc/src/core/enum/auth_cubit_status.dart';
import 'package:wyatt_authentication_bloc/src/core/exceptions/exceptions_firebase.dart';
import 'package:wyatt_authentication_bloc/src/core/extensions/firebase_auth_user_x.dart';
import 'package:wyatt_authentication_bloc/src/core/utils/cryptography.dart';
import 'package:wyatt_authentication_bloc/src/data/models/user_firebase.dart';
import 'package:wyatt_authentication_bloc/src/domain/entities/user.dart'
as wyatt;
import 'package:wyatt_authentication_bloc/src/domain/repositories/authentication_repository.dart';
class AuthenticationRepositoryFirebase
implements AuthenticationRepositoryInterface {
class AuthenticationRepositoryFirebase implements AuthenticationRepository {
final _controller = StreamController<AuthCubitStatus>();
final FirebaseAuth _firebaseAuth;
final TwitterLogin? _twitterLogin;
@ -36,23 +41,30 @@ class AuthenticationRepositoryFirebase
FirebaseAuth? firebaseAuth,
TwitterLogin? twitterLogin,
}) : _firebaseAuth = firebaseAuth ?? FirebaseAuth.instance,
_twitterLogin = twitterLogin;
@override
Stream<UserInterface> get user {
return _firebaseAuth.userChanges().map((User? firebaseUser) {
final UserFirebase user = firebaseUser == null
? const UserFirebase.empty()
: firebaseUser.model;
_userCache = user;
return user;
});
_twitterLogin = twitterLogin {
_controller.sink.add(AuthCubitStatus.stoped);
}
@override
UserInterface get currentUser {
return _userCache;
}
Stream<AuthCubitStatus> get cubitStatus =>
_controller.stream.asBroadcastStream();
@override
void changeCubitStatus(AuthCubitStatus status) =>
_controller.sink.add(status);
@override
Stream<wyatt.User> get user =>
_firebaseAuth.userChanges().map((firebaseUser) {
final UserFirebase user = (firebaseUser == null)
? const UserFirebase.empty()
: firebaseUser.model;
_userCache = user;
return user;
});
@override
wyatt.User get currentUser => _userCache;
@override
Future<void> applyActionCode(String code) async {
@ -324,9 +336,3 @@ class AuthenticationRepositoryFirebase
}
}
}
extension on User {
UserFirebase get model {
return UserFirebase(this);
}
}

View File

@ -14,9 +14,9 @@
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
abstract class UserInterface {
abstract class User {
/// The empty user constructor.
const UserInterface.empty();
const User.empty();
/// The users display name.
///

View File

@ -14,22 +14,29 @@
// 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/src/models/exceptions/exceptions_interface.dart';
import 'package:wyatt_authentication_bloc/src/models/user/user_interface.dart';
import 'package:wyatt_authentication_bloc/src/core/enum/auth_cubit_status.dart';
import 'package:wyatt_authentication_bloc/src/core/exceptions/exceptions.dart';
import 'package:wyatt_authentication_bloc/src/domain/entities/user.dart';
/// {@template authentication_repository}
/// Repository which manages user authentication.
/// {@endtemplate}
abstract class AuthenticationRepositoryInterface {
/// Stream of [UserInterface] which will emit the current user when
abstract class AuthenticationRepository {
/// Stream of [AuthCubitStatus] wich will emit the current cubit status.
Stream<AuthCubitStatus> get cubitStatus;
/// Changes cubit status.(Useful to start or stop the engine.)
void changeCubitStatus(AuthCubitStatus status);
/// Stream of [User] which will emit the current user when
/// the authentication state changes.
///
/// Emits [UserInterface.empty] if the user is not authenticated.
Stream<UserInterface> get user;
/// Emits [User.empty] if the user is not authenticated.
Stream<User> get user;
/// Returns the current cached account.
/// Defaults to [UserInterface.empty] if there is no cached user.
UserInterface get currentUser;
/// Defaults to [User.empty] if there is no cached user.
User get currentUser;
/// Applies action code
///
@ -122,7 +129,7 @@ abstract class AuthenticationRepositoryInterface {
Future<void> verifyPasswordResetCode({required String code});
/// Signs out the current user which will emit
/// [UserInterface.empty] from the [user] Stream.
/// [User.empty] from the [user] Stream.
Future<void> signOut();
/// Refreshes the current user.

View File

@ -16,41 +16,40 @@
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:wyatt_authentication_bloc/src/authentication/cubit/authentication_cubit.dart';
import 'package:wyatt_authentication_bloc/src/models/user/user_interface.dart';
import 'package:wyatt_authentication_bloc/src/domain/entities/user.dart';
import 'package:wyatt_authentication_bloc/src/features/authentication/cubit/authentication_cubit.dart';
class AuthenticationBuilder extends StatelessWidget {
class AuthenticationBuilder<Extra> extends StatelessWidget {
const AuthenticationBuilder({
Key? key,
required this.authenticated,
required this.unauthenticated,
required this.unknown,
}) : super(key: key);
super.key,
});
final Widget Function(
BuildContext context,
UserInterface user,
Map<String, dynamic>? userData,
User user,
Extra? extra,
) authenticated;
final Widget Function(BuildContext context) unauthenticated;
final Widget Function(BuildContext context) unknown;
@override
Widget build(BuildContext context) {
return BlocBuilder<AuthenticationCubit, AuthenticationState>(
builder: (context, state) {
if (state.status == AuthenticationStatus.authenticated) {
if (state.user != null) {
return authenticated(context, state.user!, state.userData);
} else {
Widget build(BuildContext context) =>
BlocBuilder<AuthenticationCubit<Extra>, AuthenticationState<Extra>>(
builder: (context, state) {
if (state.status == AuthenticationStatus.authenticated) {
if (state.user != null) {
return authenticated(context, state.user!, state.extra);
} else {
return unauthenticated(context);
}
} else if (state.status == AuthenticationStatus.unauthenticated) {
return unauthenticated(context);
} else {
return unknown(context);
}
} else if (state.status == AuthenticationStatus.unauthenticated) {
return unauthenticated(context);
} else {
return unknown(context);
}
},
);
}
},
);
}

View File

@ -0,0 +1,100 @@
// 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:equatable/equatable.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:wyatt_authentication_bloc/src/core/enum/auth_cubit_status.dart';
import 'package:wyatt_authentication_bloc/src/domain/entities/user.dart';
import 'package:wyatt_authentication_bloc/src/domain/repositories/authentication_repository.dart';
part 'authentication_state.dart';
class AuthenticationCubit<Extra> extends Cubit<AuthenticationState<Extra>> {
final AuthenticationRepository _authenticationRepository;
late final StreamSubscription<AuthCubitStatus> _statusSubscription;
StreamSubscription<User>? _userSubscription;
final Future<Extra?> Function(User user)? _onAuthSuccess;
AuthenticationCubit({
required AuthenticationRepository authenticationRepository,
Future<Extra?> Function(User user)? onAuthSuccess,
}) : _authenticationRepository = authenticationRepository,
_onAuthSuccess = onAuthSuccess,
super(const AuthenticationState.unknown()) {
_subscribeStatus();
}
Future<AuthCubitStatus> get status async =>
_authenticationRepository.cubitStatus.last;
void _subscribeStatus() {
try {
_statusSubscription = _authenticationRepository.cubitStatus.listen(
(status) {
switch (status) {
case AuthCubitStatus.started:
start();
break;
case AuthCubitStatus.stoped:
stop();
break;
}
},
);
} catch (_) {}
}
Future<void> init() async {
final firstUser = await _authenticationRepository.user.first;
_authenticationRepository.changeCubitStatus(AuthCubitStatus.started);
return changeStatus(firstUser);
}
bool start() {
_userSubscription = _authenticationRepository.user.listen(changeStatus);
return true;
}
bool stop() {
_userSubscription?.cancel();
return true;
}
Future<void> changeStatus(User user) async {
if (user.isNotEmpty) {
final Extra? extra = await _onAuthSuccess?.call(user);
emit(AuthenticationState.authenticated(user, extra));
} else {
_authenticationRepository.changeCubitStatus(AuthCubitStatus.stoped);
emit(const AuthenticationState.unauthenticated());
}
}
void logOut() {
unawaited(_authenticationRepository.signOut());
}
@override
Future<void> close() {
_userSubscription?.cancel();
_statusSubscription.cancel();
return super.close();
}
}

View File

@ -22,37 +22,36 @@ enum AuthenticationStatus {
unauthenticated,
}
class AuthenticationState extends Equatable {
class AuthenticationState<Extra> extends Equatable {
final AuthenticationStatus status;
final UserInterface? user;
final Map<String, dynamic>? userData;
final User? user;
final Extra? extra;
const AuthenticationState._({
required this.status,
this.user,
this.userData,
this.extra,
});
const AuthenticationState.unknown()
: this._(status: AuthenticationStatus.unknown);
const AuthenticationState.authenticated(
UserInterface user,
Map<String, dynamic>? userData,
User user,
Extra? extra,
) : this._(
status: AuthenticationStatus.authenticated,
user: user,
userData: userData,
extra: extra,
);
const AuthenticationState.unauthenticated()
: this._(status: AuthenticationStatus.unauthenticated);
@override
List<Object?> get props => [status, user, userData];
List<Object?> get props => [status, user, extra];
@override
// ignore: lines_longer_than_80_chars
String toString() =>
'AuthenticationState(status: $status, user: $user, userData: $userData)';
'AuthenticationState(status: $status, user: $user, extra: $extra)';
}

View File

@ -14,19 +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 'package:bloc/bloc.dart';
import 'package:equatable/equatable.dart';
import 'package:wyatt_authentication_bloc/src/models/exceptions/exceptions_interface.dart';
import 'package:wyatt_authentication_bloc/src/repositories/authentication_repository_interface.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:wyatt_authentication_bloc/src/core/exceptions/exceptions.dart';
import 'package:wyatt_authentication_bloc/src/domain/repositories/authentication_repository.dart';
import 'package:wyatt_form_bloc/wyatt_form_bloc.dart' show FormStatus;
part 'email_verification_state.dart';
class EmailVerificationCubit extends Cubit<EmailVerificationState> {
final AuthenticationRepositoryInterface _authenticationRepository;
final AuthenticationRepository _authenticationRepository;
EmailVerificationCubit(this._authenticationRepository)
: super(const EmailVerificationState());
EmailVerificationCubit({
required AuthenticationRepository authenticationRepository,
}) : _authenticationRepository = authenticationRepository,
super(const EmailVerificationState());
Future<void> sendEmailVerification() async {
emit(state.copyWith(status: FormStatus.submissionInProgress));

View File

@ -31,13 +31,11 @@ class EmailVerificationState extends Equatable {
bool? isVerified,
FormStatus? status,
String? errorMessage,
}) {
return EmailVerificationState(
}) => EmailVerificationState(
isVerified: isVerified ?? this.isVerified,
status: status ?? this.status,
errorMessage: errorMessage ?? this.errorMessage,
);
}
@override
List<Object> get props => [isVerified, status];

View File

@ -14,32 +14,40 @@
// 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:bloc/bloc.dart';
import 'package:equatable/equatable.dart';
import 'package:wyatt_authentication_bloc/src/models/exceptions/exceptions_interface.dart';
import 'package:wyatt_authentication_bloc/src/repositories/authentication_repository_interface.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:wyatt_authentication_bloc/src/core/exceptions/exceptions.dart';
import 'package:wyatt_authentication_bloc/src/domain/repositories/authentication_repository.dart';
import 'package:wyatt_form_bloc/wyatt_form_bloc.dart';
part 'password_reset_state.dart';
class PasswordResetCubit extends Cubit<PasswordResetState> {
final AuthenticationRepositoryInterface _authenticationRepository;
final AuthenticationRepository _authenticationRepository;
PasswordResetCubit(this._authenticationRepository)
: super(const PasswordResetState());
final FormValidator _validationStrategy;
PasswordResetCubit({
required AuthenticationRepository authenticationRepository,
FormValidator validationStrategy = const EveryInputValidator(),
}) : _authenticationRepository = authenticationRepository,
_validationStrategy = validationStrategy,
super(const PasswordResetState());
void emailChanged(String value) {
final Email email = Email.dirty(value);
emit(
state.copyWith(
email: email,
status: FormStatus.validate([email]),
status: _validationStrategy.rawValidate([email]),
),
);
}
Future<void> sendPasswordResetEmail() async {
if (!state.status.isValidated) return;
if (!state.status.isValidated) {
return;
}
emit(state.copyWith(status: FormStatus.submissionInProgress));
try {
await _authenticationRepository.sendPasswordResetEmail(

View File

@ -31,13 +31,11 @@ class PasswordResetState extends Equatable {
Email? email,
FormStatus? status,
String? errorMessage,
}) {
return PasswordResetState(
}) => PasswordResetState(
email: email ?? this.email,
status: status ?? this.status,
errorMessage: errorMessage ?? this.errorMessage,
);
}
@override
List<Object> get props => [email, status];

View File

@ -14,24 +14,25 @@
// 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:bloc/bloc.dart';
import 'package:equatable/equatable.dart';
import 'package:wyatt_authentication_bloc/src/authentication/cubit/authentication_cubit.dart';
import 'package:wyatt_authentication_bloc/src/models/exceptions/exceptions_interface.dart';
import 'package:wyatt_authentication_bloc/src/repositories/authentication_repository_interface.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:wyatt_authentication_bloc/src/core/enum/auth_cubit_status.dart';
import 'package:wyatt_authentication_bloc/src/core/exceptions/exceptions.dart';
import 'package:wyatt_authentication_bloc/src/domain/repositories/authentication_repository.dart';
import 'package:wyatt_form_bloc/wyatt_form_bloc.dart';
part 'sign_in_state.dart';
class SignInCubit extends Cubit<SignInState> {
final AuthenticationRepositoryInterface _authenticationRepository;
final AuthenticationCubit _authenticationCubit;
final AuthenticationRepository _authenticationRepository;
final FormValidator _validationStrategy;
SignInCubit({
required AuthenticationRepositoryInterface authenticationRepository,
required AuthenticationCubit authenticationCubit,
required AuthenticationRepository authenticationRepository,
FormValidator validationStrategy = const EveryInputValidator(),
}) : _authenticationRepository = authenticationRepository,
_authenticationCubit = authenticationCubit,
_validationStrategy = validationStrategy,
super(const SignInState());
void emailChanged(String value) {
@ -39,7 +40,7 @@ class SignInCubit extends Cubit<SignInState> {
emit(
state.copyWith(
email: email,
status: FormStatus.validate([email, state.password]),
status: _validationStrategy.rawValidate([email, state.password]),
),
);
}
@ -49,7 +50,7 @@ class SignInCubit extends Cubit<SignInState> {
emit(
state.copyWith(
password: password,
status: FormStatus.validate([state.email, password]),
status: _validationStrategy.rawValidate([state.email, password]),
),
);
}
@ -62,7 +63,7 @@ class SignInCubit extends Cubit<SignInState> {
emit(state.copyWith(status: FormStatus.submissionInProgress));
try {
await _authenticationRepository.signInAnonymously();
_authenticationCubit.start();
_authenticationRepository.changeCubitStatus(AuthCubitStatus.started);
emit(state.copyWith(status: FormStatus.submissionSuccess));
} on SignInAnonymouslyFailureInterface catch (e) {
emit(
@ -84,7 +85,7 @@ class SignInCubit extends Cubit<SignInState> {
emit(state.copyWith(status: FormStatus.submissionInProgress));
try {
await _authenticationRepository.signInWithGoogle();
_authenticationCubit.start();
_authenticationRepository.changeCubitStatus(AuthCubitStatus.started);
emit(state.copyWith(status: FormStatus.submissionSuccess));
} on SignInWithGoogleFailureInterface catch (e) {
emit(
@ -99,14 +100,16 @@ class SignInCubit extends Cubit<SignInState> {
}
Future<void> signInWithEmailAndPassword() async {
if (!state.status.isValidated) return;
if (!state.status.isValidated) {
return;
}
emit(state.copyWith(status: FormStatus.submissionInProgress));
try {
await _authenticationRepository.signInWithEmailAndPassword(
email: state.email.value,
password: state.password.value,
);
_authenticationCubit.start();
_authenticationRepository.changeCubitStatus(AuthCubitStatus.started);
emit(state.copyWith(status: FormStatus.submissionSuccess));
} on SignInWithEmailAndPasswordFailureInterface catch (e) {
emit(

View File

@ -34,25 +34,22 @@ class SignInState extends Equatable {
Password? password,
FormStatus? status,
String? errorMessage,
}) {
return SignInState(
email: email ?? this.email,
password: password ?? this.password,
status: status ?? this.status,
errorMessage: errorMessage ?? this.errorMessage,
);
}
}) =>
SignInState(
email: email ?? this.email,
password: password ?? this.password,
status: status ?? this.status,
errorMessage: errorMessage ?? this.errorMessage,
);
@override
List<Object> get props => [email, password, status];
@override
String toString() {
return '''
String toString() => '''
email: $email,
password: $password,
status: $status,
errorMessage: $errorMessage,
''';
}
}

View File

@ -16,30 +16,31 @@
import 'dart:async';
import 'package:bloc/bloc.dart';
import 'package:equatable/equatable.dart';
import 'package:flutter/foundation.dart';
import 'package:wyatt_authentication_bloc/src/authentication/cubit/authentication_cubit.dart';
import 'package:wyatt_authentication_bloc/src/models/exceptions/exceptions_interface.dart';
import 'package:wyatt_authentication_bloc/src/repositories/authentication_repository_interface.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:wyatt_authentication_bloc/src/core/enum/auth_cubit_status.dart';
import 'package:wyatt_authentication_bloc/src/core/exceptions/exceptions.dart';
import 'package:wyatt_authentication_bloc/src/domain/repositories/authentication_repository.dart';
import 'package:wyatt_form_bloc/wyatt_form_bloc.dart';
part 'sign_up_state.dart';
class SignUpCubit extends Cubit<SignUpState> {
final AuthenticationRepositoryInterface _authenticationRepository;
final AuthenticationCubit _authenticationCubit;
final AuthenticationRepository _authenticationRepository;
final Future Function(SignUpState state, String? uid)? _onSignUpSuccess;
final Future<void> Function(SignUpState state, String? uid)? _onSignUpSuccess;
final FormValidator _validationStrategy;
SignUpCubit({
required AuthenticationRepositoryInterface authenticationRepository,
required AuthenticationCubit authenticationCubit,
required FormData entries,
Future Function(SignUpState state, String? uid)? onSignUpSuccess,
required AuthenticationRepository authenticationRepository,
required FormData formData,
FormValidator validationStrategy = const EveryInputValidator(),
Future<void> Function(SignUpState state, String? uid)? onSignUpSuccess,
}) : _authenticationRepository = authenticationRepository,
_authenticationCubit = authenticationCubit,
_onSignUpSuccess = onSignUpSuccess,
super(SignUpState(data: entries));
_validationStrategy = validationStrategy,
super(SignUpState(data: formData));
void emailChanged(String value) {
final Email email = Email.dirty(value);
@ -53,7 +54,7 @@ class SignUpCubit extends Cubit<SignUpState> {
emit(
state.copyWith(
email: email,
status: FormStatus.validate(toValidate),
status: _validationStrategy.rawValidate(toValidate),
),
);
}
@ -70,25 +71,28 @@ class SignUpCubit extends Cubit<SignUpState> {
emit(
state.copyWith(
password: password,
status: FormStatus.validate(toValidate),
status: _validationStrategy.rawValidate(toValidate),
),
);
}
// Take from wyatt_form_bloc/wyatt_form_bloc.dart
void dataChanged<T>(String field, FormInputValidator dirtyValue) {
final _form = state.data.clone();
void dataChanged<T>(
String field,
FormInputValidator<T, ValidationError> dirtyValue,
) {
final form = state.data.clone();
if (_form.contains(field)) {
_form.updateValidator(field, dirtyValue);
if (form.contains(field)) {
form.updateValidator(field, dirtyValue);
} else {
throw Exception('Form field $field not found');
}
emit(
state.copyWith(
data: _form,
status: FormStatus.validate(
data: form,
status: _validationStrategy.rawValidate(
[
state.email,
state.password,
@ -104,27 +108,27 @@ class SignUpCubit extends Cubit<SignUpState> {
FormData data, {
SetOperation operation = SetOperation.replace,
}) {
FormData _form = data;
FormData form = data;
switch (operation) {
case SetOperation.replace:
_form = data;
form = data;
break;
case SetOperation.difference:
_form = state.data.difference(data);
form = state.data.difference(data);
break;
case SetOperation.intersection:
_form = state.data.intersection(data);
form = state.data.intersection(data);
break;
case SetOperation.union:
_form = state.data.union(data);
form = state.data.union(data);
break;
}
emit(
state.copyWith(
data: _form,
status: FormStatus.validate(
data: form,
status: _validationStrategy.rawValidate(
[
state.email,
state.password,
@ -136,7 +140,9 @@ class SignUpCubit extends Cubit<SignUpState> {
}
Future<void> signUpFormSubmitted() async {
if (!state.status.isValidated) return;
if (!state.status.isValidated) {
return;
}
emit(state.copyWith(status: FormStatus.submissionInProgress));
try {
final uid = await _authenticationRepository.signUp(
@ -144,16 +150,8 @@ class SignUpCubit extends Cubit<SignUpState> {
password: state.password.value,
);
await _onSignUpSuccess?.call(state, uid);
if (_authenticationCubit.start()) {
emit(state.copyWith(status: FormStatus.submissionSuccess));
} else {
emit(
state.copyWith(
errorMessage: 'Failed to start authentication cubit',
status: FormStatus.submissionFailure,
),
);
}
_authenticationRepository.changeCubitStatus(AuthCubitStatus.started);
emit(state.copyWith(status: FormStatus.submissionSuccess));
} on SignUpWithEmailAndPasswordFailureInterface catch (e) {
emit(
state.copyWith(

View File

@ -16,8 +16,7 @@
part of 'sign_up_cubit.dart';
@immutable
class SignUpState {
class SignUpState extends Equatable {
final Email email;
final Password password;
final FormStatus status;
@ -25,10 +24,10 @@ class SignUpState {
final String? errorMessage;
const SignUpState({
required this.data,
this.email = const Email.pure(),
this.password = const Password.pure(),
this.status = FormStatus.pure,
required this.data,
this.errorMessage,
});
@ -38,40 +37,19 @@ class SignUpState {
FormStatus? status,
FormData? data,
String? errorMessage,
}) {
return SignUpState(
email: email ?? this.email,
password: password ?? this.password,
status: status ?? this.status,
data: data ?? this.data,
errorMessage: errorMessage ?? this.errorMessage,
);
}
}) =>
SignUpState(
email: email ?? this.email,
password: password ?? this.password,
status: status ?? this.status,
data: data ?? this.data,
errorMessage: errorMessage ?? this.errorMessage,
);
@override
bool operator ==(Object other) {
if (identical(this, other)) return true;
return other is SignUpState &&
other.email == email &&
other.password == password &&
other.status == status &&
other.data == data &&
other.errorMessage == errorMessage;
}
String toString() => 'SignUpState(email: $email, password: $password, '
'status: $status, data: $data, errorMessage: $errorMessage)';
@override
int get hashCode {
return email.hashCode ^
password.hashCode ^
status.hashCode ^
data.hashCode ^
errorMessage.hashCode;
}
@override
String toString() {
// ignore: lines_longer_than_80_chars
return 'SignUpState(email: $email, password: $password, status: $status, data: $data, errorMessage: $errorMessage)';
}
List<Object?> get props => [email, password, status, data, errorMessage];
}

View File

@ -14,10 +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/>.
export 'authentication/authentication.dart';
export 'email_verification/email_verification.dart';
export 'models/models.dart';
export 'password_reset/password_reset.dart';
export 'repositories/repositories.dart';
export 'sign_in/sign_in.dart';
export 'sign_up/sign_up.dart';
export 'core/enum/auth_cubit_status.dart';
export 'core/exceptions/exceptions.dart';
export 'core/exceptions/exceptions_firebase.dart';
export 'core/extensions/firebase_auth_user_x.dart';
export 'core/utils/cryptography.dart';
export 'data/models/user_firebase.dart';
export 'data/repositories/authentication_repository_firebase.dart';
export 'domain/entities/user.dart';
export 'domain/repositories/authentication_repository.dart';
export 'features/authentication/authentication.dart';
export 'features/email_verification/email_verification.dart';
export 'features/password_reset/password_reset.dart';
export 'features/sign_in/sign_in.dart';
export 'features/sign_up/sign_up.dart';

View File

@ -1,10 +1,10 @@
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.2.1+1
version: 0.2.1+4
environment:
sdk: ">=2.15.1 <3.0.0"
sdk: ">=2.17.0 <3.0.0"
flutter: ">=1.17.0"
dependencies:
@ -23,7 +23,7 @@ dependencies:
wyatt_form_bloc:
git:
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
ref: wyatt_form_bloc-v0.0.3
ref: wyatt_form_bloc-v0.0.6
path: packages/wyatt_form_bloc
@ -31,6 +31,7 @@ dev_dependencies:
flutter_test:
sdk: flutter
bloc_test: ^9.0.3
mocktail: ^0.3.0
wyatt_analysis:
git:

View File

@ -20,66 +20,87 @@ import 'package:mocktail/mocktail.dart';
import 'package:wyatt_authentication_bloc/wyatt_authentication_bloc.dart';
class MockAuthenticationRepository extends Mock
implements AuthenticationRepositoryInterface {}
implements AuthenticationRepository {}
class MockUser extends Mock implements UserInterface {}
class MockUser extends Mock implements User {}
void main() {
group('AuthenticationCubit', () {
group('AuthenticationCubit<T>', () {
final MockUser user = MockUser();
late AuthenticationRepositoryInterface authenticationRepository;
late AuthenticationRepository authenticationRepository;
setUp(() {
authenticationRepository = MockAuthenticationRepository();
when(() => authenticationRepository.user).thenAnswer(
(_) => const Stream.empty(),
);
when(() => authenticationRepository.cubitStatus).thenAnswer(
(_) => Stream.fromIterable([AuthCubitStatus.stoped]),
);
when(
() => authenticationRepository.currentUser,
).thenReturn(const UserFirebase.empty());
).thenReturn(user);
});
test('initial state is unknown', () {
test('initial auth state is `unknown`', () {
expect(
AuthenticationCubit(authenticationRepository: authenticationRepository)
.state,
const AuthenticationState.unknown(),
AuthenticationCubit<void>(
authenticationRepository: authenticationRepository,
).state,
const AuthenticationState<Never>.unknown(),
);
});
test('initial cubit status is `stoped`', () async {
expect(
await AuthenticationCubit<void>(
authenticationRepository: authenticationRepository,
).status,
AuthCubitStatus.stoped,
);
});
group('UserChanged', () {
blocTest<AuthenticationCubit, AuthenticationState>(
blocTest<AuthenticationCubit<void>, AuthenticationState<void>>(
'emits authenticated when user is not empty',
setUp: () {
when(() => user.isNotEmpty).thenReturn(true);
when(() => authenticationRepository.user).thenAnswer(
(_) => Stream.value(user),
);
},
build: () => AuthenticationCubit(
authenticationRepository: authenticationRepository,
)..init(),
seed: () => const AuthenticationState.unknown(),
expect: () => [AuthenticationState.authenticated(user, null)],
);
blocTest<AuthenticationCubit, AuthenticationState>(
'emits unauthenticated when user is empty',
setUp: () {
when(() => authenticationRepository.user).thenAnswer(
(_) => Stream.value(const UserFirebase.empty()),
when(() => authenticationRepository.cubitStatus).thenAnswer(
(_) => Stream.value(AuthCubitStatus.started),
);
},
build: () => AuthenticationCubit(
authenticationRepository: authenticationRepository,
)..init(),
seed: () => const AuthenticationState.unknown(),
expect: () => [const AuthenticationState.unauthenticated()],
expect: () => [AuthenticationState<void>.authenticated(user, null)],
);
blocTest<AuthenticationCubit<void>, AuthenticationState<void>>(
'emits unauthenticated when user is empty',
setUp: () {
when(() => user.isEmpty).thenReturn(true);
when(() => user.isNotEmpty).thenReturn(false);
when(() => authenticationRepository.user).thenAnswer(
(_) => Stream.value(user),
);
when(() => authenticationRepository.cubitStatus).thenAnswer(
(_) => Stream.value(AuthCubitStatus.started),
);
},
build: () => AuthenticationCubit(
authenticationRepository: authenticationRepository,
)..init(),
seed: () => const AuthenticationState.unknown(),
expect: () => [const AuthenticationState<Never>.unauthenticated()],
);
});
group('LogoutRequested', () {
blocTest<AuthenticationCubit, AuthenticationState>(
blocTest<AuthenticationCubit<void>, AuthenticationState<void>>(
'invokes signOut',
setUp: () {
when(
@ -89,7 +110,7 @@ void main() {
build: () => AuthenticationCubit(
authenticationRepository: authenticationRepository,
),
act: (AuthenticationCubit cubit) => cubit.logOut(),
act: (cubit) => cubit.logOut(),
verify: (_) {
verify(() => authenticationRepository.signOut()).called(1);
},

View File

@ -18,13 +18,14 @@ import 'package:flutter_test/flutter_test.dart';
import 'package:mocktail/mocktail.dart';
import 'package:wyatt_authentication_bloc/wyatt_authentication_bloc.dart';
class MockUser extends Mock implements UserInterface {}
class MockUser extends Mock implements User {}
void main() {
group('AuthenticationState', () {
group('unauthenticated', () {
test('has correct status', () {
const AuthenticationState state = AuthenticationState.unauthenticated();
const AuthenticationState<void> state =
AuthenticationState.unauthenticated();
expect(state.status, AuthenticationStatus.unauthenticated);
expect(state.user, null);
});
@ -33,11 +34,23 @@ void main() {
group('authenticated', () {
test('has correct status', () {
final MockUser user = MockUser();
final AuthenticationState state =
final AuthenticationState<void> state =
AuthenticationState.authenticated(user, null);
expect(state.status, AuthenticationStatus.authenticated);
expect(state.user, user);
});
});
group('authenticated with extra data', () {
test('has correct status', () {
final MockUser user = MockUser();
const String extra = 'AwesomeExtraData';
final AuthenticationState<String> state =
AuthenticationState.authenticated(user, extra);
expect(state.status, AuthenticationStatus.authenticated);
expect(state.user, user);
expect(state.extra, extra);
});
});
});
}

View File

@ -21,9 +21,10 @@ import 'package:wyatt_authentication_bloc/wyatt_authentication_bloc.dart';
import 'package:wyatt_form_bloc/wyatt_form_bloc.dart';
class MockAuthenticationRepository extends Mock
implements AuthenticationRepositoryInterface {}
implements AuthenticationRepository {}
class MockAuthenticationCubit extends Mock implements AuthenticationCubit {}
class MockAuthenticationCubit extends Mock
implements AuthenticationCubit<void> {}
void main() {
const String invalidEmailString = 'invalid';
@ -39,8 +40,8 @@ void main() {
const Password validPassword = Password.dirty(validPasswordString);
group('SignInCubit', () {
late AuthenticationRepositoryInterface authenticationRepository;
late AuthenticationCubit authenticationCubit;
late AuthenticationRepository authenticationRepository;
late AuthenticationCubit<void> authenticationCubit;
setUp(() {
authenticationRepository = MockAuthenticationRepository();
@ -62,7 +63,6 @@ void main() {
expect(
SignInCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
).state,
const SignInState(),
);
@ -73,9 +73,8 @@ void main() {
'emits [invalid] when email/password are invalid',
build: () => SignInCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
),
act: (SignInCubit cubit) => cubit.emailChanged(invalidEmailString),
act: (cubit) => cubit.emailChanged(invalidEmailString),
expect: () => const <SignInState>[
SignInState(email: invalidEmail, status: FormStatus.invalid),
],
@ -85,10 +84,9 @@ void main() {
'emits [valid] when email/password are valid',
build: () => SignInCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
),
seed: () => const SignInState(password: validPassword),
act: (SignInCubit cubit) => cubit.emailChanged(validEmailString),
act: (cubit) => cubit.emailChanged(validEmailString),
expect: () => const <SignInState>[
SignInState(
email: validEmail,
@ -104,10 +102,8 @@ void main() {
'emits [invalid] when email/password are invalid',
build: () => SignInCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
),
act: (SignInCubit cubit) =>
cubit.passwordChanged(invalidPasswordString),
act: (cubit) => cubit.passwordChanged(invalidPasswordString),
expect: () => const <SignInState>[
SignInState(
password: invalidPassword,
@ -120,10 +116,9 @@ void main() {
'emits [valid] when email/password are valid',
build: () => SignInCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
),
seed: () => const SignInState(email: validEmail),
act: (SignInCubit cubit) => cubit.passwordChanged(validPasswordString),
act: (cubit) => cubit.passwordChanged(validPasswordString),
expect: () => const <SignInState>[
SignInState(
email: validEmail,
@ -139,9 +134,8 @@ void main() {
'does nothing when status is not validated',
build: () => SignInCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
),
act: (SignInCubit cubit) => cubit.signInWithEmailAndPassword(),
act: (cubit) => cubit.signInWithEmailAndPassword(),
expect: () => const <SignInState>[],
);
@ -149,14 +143,13 @@ void main() {
'calls signInWithEmailAndPassword with correct email/password',
build: () => SignInCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
),
seed: () => const SignInState(
status: FormStatus.valid,
email: validEmail,
password: validPassword,
),
act: (SignInCubit cubit) => cubit.signInWithEmailAndPassword(),
act: (cubit) => cubit.signInWithEmailAndPassword(),
verify: (_) {
verify(
() => authenticationRepository.signInWithEmailAndPassword(
@ -172,14 +165,13 @@ void main() {
'when signInWithEmailAndPassword succeeds',
build: () => SignInCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
),
seed: () => const SignInState(
status: FormStatus.valid,
email: validEmail,
password: validPassword,
),
act: (SignInCubit cubit) => cubit.signInWithEmailAndPassword(),
act: (cubit) => cubit.signInWithEmailAndPassword(),
expect: () => const <SignInState>[
SignInState(
status: FormStatus.submissionInProgress,
@ -207,14 +199,13 @@ void main() {
},
build: () => SignInCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
),
seed: () => const SignInState(
status: FormStatus.valid,
email: validEmail,
password: validPassword,
),
act: (SignInCubit cubit) => cubit.signInWithEmailAndPassword(),
act: (cubit) => cubit.signInWithEmailAndPassword(),
expect: () => const <SignInState>[
SignInState(
status: FormStatus.submissionInProgress,

View File

@ -21,9 +21,10 @@ import 'package:wyatt_authentication_bloc/wyatt_authentication_bloc.dart';
import 'package:wyatt_form_bloc/wyatt_form_bloc.dart';
class MockAuthenticationRepository extends Mock
implements AuthenticationRepositoryInterface {}
implements AuthenticationRepository {}
class MockAuthenticationCubit extends Mock implements AuthenticationCubit {}
class MockAuthenticationCubit extends Mock
implements AuthenticationCubit<void> {}
void main() {
const String invalidEmailString = 'invalid';
@ -39,8 +40,8 @@ void main() {
const Password validPassword = Password.dirty(validPasswordString);
group('SignUpCubit', () {
late AuthenticationRepositoryInterface authenticationRepository;
late AuthenticationCubit authenticationCubit;
late AuthenticationRepository authenticationRepository;
late AuthenticationCubit<void> authenticationCubit;
setUp(() {
authenticationRepository = MockAuthenticationRepository();
@ -50,9 +51,7 @@ void main() {
email: any(named: 'email'),
password: any(named: 'password'),
),
).thenAnswer((_) async {
return 'uid';
});
).thenAnswer((_) async => 'uid');
when(
() => authenticationCubit.start(),
@ -67,8 +66,7 @@ void main() {
expect(
SignUpCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
entries: const FormData.empty(),
formData: const FormData.empty(),
).state,
const SignUpState(data: FormData.empty()),
);
@ -79,10 +77,9 @@ void main() {
'emits [invalid] when email/password are invalid',
build: () => SignUpCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
entries: const FormData.empty(),
formData: const FormData.empty(),
),
act: (SignUpCubit cubit) => cubit.emailChanged(invalidEmailString),
act: (cubit) => cubit.emailChanged(invalidEmailString),
expect: () => <SignUpState>[
const SignUpState(
email: invalidEmail,
@ -96,14 +93,13 @@ void main() {
'emits [valid] when email/password are valid',
build: () => SignUpCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
entries: const FormData.empty(),
formData: const FormData.empty(),
),
seed: () => const SignUpState(
password: validPassword,
data: FormData.empty(),
),
act: (SignUpCubit cubit) => cubit.emailChanged(validEmailString),
act: (cubit) => cubit.emailChanged(validEmailString),
expect: () => <SignUpState>[
const SignUpState(
email: validEmail,
@ -120,11 +116,9 @@ void main() {
'emits [invalid] when email/password are invalid',
build: () => SignUpCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
entries: const FormData.empty(),
formData: const FormData.empty(),
),
act: (SignUpCubit cubit) =>
cubit.passwordChanged(invalidPasswordString),
act: (cubit) => cubit.passwordChanged(invalidPasswordString),
expect: () => <SignUpState>[
const SignUpState(
password: invalidPassword,
@ -138,14 +132,13 @@ void main() {
'emits [valid] when email/password are valid',
build: () => SignUpCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
entries: const FormData.empty(),
formData: const FormData.empty(),
),
seed: () => const SignUpState(
email: validEmail,
data: FormData.empty(),
),
act: (SignUpCubit cubit) => cubit.passwordChanged(validPasswordString),
act: (cubit) => cubit.passwordChanged(validPasswordString),
expect: () => <SignUpState>[
const SignUpState(
email: validEmail,
@ -162,10 +155,9 @@ void main() {
'does nothing when status is not validated',
build: () => SignUpCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
entries: const FormData.empty(),
formData: const FormData.empty(),
),
act: (SignUpCubit cubit) => cubit.signUpFormSubmitted(),
act: (cubit) => cubit.signUpFormSubmitted(),
expect: () => const <SignUpState>[],
);
@ -173,8 +165,7 @@ void main() {
'calls signUp with correct email/password/confirmedPassword',
build: () => SignUpCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
entries: const FormData.empty(),
formData: const FormData.empty(),
),
seed: () => const SignUpState(
status: FormStatus.valid,
@ -182,7 +173,7 @@ void main() {
password: validPassword,
data: FormData.empty(),
),
act: (SignUpCubit cubit) => cubit.signUpFormSubmitted(),
act: (cubit) => cubit.signUpFormSubmitted(),
verify: (_) {
verify(
() => authenticationRepository.signUp(
@ -198,8 +189,7 @@ void main() {
'when signUp succeeds',
build: () => SignUpCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
entries: const FormData.empty(),
formData: const FormData.empty(),
),
seed: () => const SignUpState(
status: FormStatus.valid,
@ -207,7 +197,7 @@ void main() {
password: validPassword,
data: FormData.empty(),
),
act: (SignUpCubit cubit) => cubit.signUpFormSubmitted(),
act: (cubit) => cubit.signUpFormSubmitted(),
expect: () => <SignUpState>[
const SignUpState(
status: FormStatus.submissionInProgress,
@ -237,8 +227,7 @@ void main() {
},
build: () => SignUpCubit(
authenticationRepository: authenticationRepository,
authenticationCubit: authenticationCubit,
entries: const FormData.empty(),
formData: const FormData.empty(),
),
seed: () => const SignUpState(
status: FormStatus.valid,
@ -246,7 +235,7 @@ void main() {
password: validPassword,
data: FormData.empty(),
),
act: (SignUpCubit cubit) => cubit.signUpFormSubmitted(),
act: (cubit) => cubit.signUpFormSubmitted(),
expect: () => <SignUpState>[
const SignUpState(
status: FormStatus.submissionInProgress,

View File

@ -1,3 +1,15 @@
## 0.0.6
- **FEAT**: add raw form validator.
## 0.0.5
- **FEAT**: update deps.
## 0.0.4
- **FEAT**: add form validator class with strategy design pattern.
## 0.0.3
- **FEAT**: add helpers.

View File

@ -28,4 +28,8 @@ abstract class FormValidator {
.every((validator) => validator.pure);
FormStatus validate(FormData form);
FormStatus rawValidate(
List<FormInputValidator<dynamic, ValidationError>> validators,
);
}

View File

@ -29,9 +29,14 @@ class EveryInputValidator extends FormValidator {
return FormStatus.pure;
}
if (form
.validators<dynamic, ValidationError>()
.any((validator) => validator.valid == false)) {
return rawValidate(form.validators<dynamic, ValidationError>());
}
@override
FormStatus rawValidate(
List<FormInputValidator<dynamic, ValidationError>> validators,
) {
if (validators.any((validator) => validator.valid == false)) {
return FormStatus.invalid;
}

View File

@ -14,6 +14,7 @@
// 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 'form/every_input_validator.dart';
export 'inputs/base/regex_validator.dart';
export 'inputs/base/text_validator.dart';
export 'inputs/boolean.dart';

View File

@ -1,14 +1,14 @@
name: wyatt_form_bloc
description: Manage forms in Dart & Flutter with Bloc
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_form_bloc
version: 0.0.3
version: 0.0.6
environment:
sdk: '>=2.17.2 <3.0.0'
dependencies:
bloc: ^8.0.3
equatable: ^2.0.3
bloc: ^8.1.0
equatable: ^2.0.5
dev_dependencies:
test: ^1.21.4

133
packages/wyatt_type_utils/.gitignore vendored Normal file
View File

@ -0,0 +1,133 @@
# Miscellaneous
*.class
*.lock
*.log
*.pyc
*.swp
.DS_Store
.atom/
.buildlog/
.history
.svn/
# IntelliJ related
*.iml
*.ipr
*.iws
.idea/*
# Visual Studio Code related
.classpath
.project
.settings/
.vscode/*
!.vscode/settings.json
!.vscode/extensions.json
# Flutter repo-specific
/bin/cache/
/bin/mingit/
/dev/benchmarks/mega_gallery/
/dev/bots/.recipe_deps
/dev/bots/android_tools/
/dev/docs/doc/
/dev/docs/flutter.docs.zip
/dev/docs/lib/
/dev/docs/pubspec.yaml
/dev/integration_tests/**/xcuserdata
/dev/integration_tests/**/Pods
/packages/flutter/coverage/
version
# packages file containing multi-root paths
.packages.generated
# Flutter/Dart/Pub related
**/doc/api/
**/ios/Flutter/.last_build_id
.dart_tool/
.flutter-plugins
.flutter-plugins-dependencies
.packages
.pub-cache/
.pub/
build/
flutter_*.png
linked_*.ds
unlinked.ds
unlinked_spec.ds
.fvm/
# Android related
**/android/**/gradle-wrapper.jar
**/android/.gradle
**/android/captures/
**/android/gradlew
**/android/gradlew.bat
**/android/local.properties
**/android/**/GeneratedPluginRegistrant.java
**/android/key.properties
**/android/.idea/
*.jks
# iOS/XCode related
**/ios/**/*.mode1v3
**/ios/**/*.mode2v3
**/ios/**/*.moved-aside
**/ios/**/*.pbxuser
**/ios/**/*.perspectivev3
**/ios/**/*sync/
**/ios/**/.sconsign.dblite
**/ios/**/.tags*
**/ios/**/.vagrant/
**/ios/**/DerivedData/
**/ios/**/Icon?
**/ios/**/Pods/
**/ios/**/.symlinks/
**/ios/**/profile
**/ios/**/xcuserdata
**/ios/.generated/
**/ios/Flutter/App.framework
**/ios/Flutter/Flutter.framework
**/ios/Flutter/Flutter.podspec
**/ios/Flutter/Generated.xcconfig
**/ios/Flutter/app.flx
**/ios/Flutter/app.zip
**/ios/Flutter/.last_build_id
**/ios/Flutter/flutter_assets/
**/ios/Flutter/flutter_export_environment.sh
**/ios/ServiceDefinitions.json
**/ios/Runner/GeneratedPluginRegistrant.*
# Coverage
coverage/
# Submodules
!pubspec.lock
packages/**/pubspec.lock
# Web related
lib/generated_plugin_registrant.dart
# Symbolication related
app.*.symbols
# Obfuscation related
app.*.map.json
# Exceptions to the above rules.
!**/ios/**/default.mode1v3
!**/ios/**/default.mode2v3
!**/ios/**/default.pbxuser
!**/ios/**/default.perspectivev3
!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
!/dev/ci/**/Gemfile.lock
!.vscode/extensions.json
!.vscode/launch.json
!.idea/codeStyles/
!.idea/dictionaries/
!.idea/runConfigurations/
# Omit committing pubspec.lock for library packages; see
# https://dart.dev/guides/libraries/private-files#pubspeclock.
pubspec.lock

View File

@ -0,0 +1,24 @@
/*
* 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/>.
*/
{
"recommendations": [
"psioniq.psi-header",
"blaugold.melos-code"
]
}

View File

@ -0,0 +1,16 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Launch Example",
"request": "launch",
"type": "dart",
"cwd": "example/",
"program": "lib/main.dart",
"flutterMode": "debug"
},
]
}

View File

@ -0,0 +1,71 @@
{
"psi-header.changes-tracking": {
"isActive": true
},
"psi-header.config": {
"blankLinesAfter": 1,
"forceToTop": true
},
"psi-header.lang-config": [
{
"beforeHeader": [
"# -*- coding:utf-8 -*-",
"#!/usr/bin/env python3"
],
"begin": "###",
"end": "###",
"language": "python",
"prefix": "# "
},
{
"beforeHeader": [
"#!/usr/bin/env sh",
""
],
"language": "shellscript",
"begin": "",
"end": "",
"prefix": "# "
},
{
"begin": "",
"end": "",
"language": "dart",
"prefix": "// "
},
{
"begin": "",
"end": "",
"language": "yaml",
"prefix": "# "
},
{
"begin": "<!--",
"end": "-->",
"language": "markdown",
},
],
"psi-header.templates": [
{
"language": "*",
"template": [
"Copyright (C) <<year>> WYATT GROUP",
"Please see the AUTHORS file for details.",
"",
"This program is free software: you can redistribute it and/or modify",
"it under the terms of the GNU General Public License as published by",
"the Free Software Foundation, either version 3 of the License, or",
"any later version.",
"",
"This program is distributed in the hope that it will be useful,",
"but WITHOUT ANY WARRANTY; without even the implied warranty of",
"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the",
"GNU General Public License for more details.",
"",
"You should have received a copy of the GNU General Public License",
"along with this program. If not, see <https://www.gnu.org/licenses/>."
],
}
],
"dart.runPubGetOnPubspecChanges": false,
}

View File

@ -0,0 +1,8 @@
# Below is a list of people and organizations that have contributed
# to this project. Names should be added to the list like so:
#
# Name/Organization <email address>
Wyatt Group S.A.S
Hugo Pointcheval <hugo.pointcheval@wyattapp.io>
Malo Léon <malo.leon@wyattapp.io>

View File

@ -0,0 +1,9 @@
## 0.0.2
- **FEAT**: add strongly typed Option and Result.
- **FEAT**: add mason generated package.
- **DOCS**: remove useless web example.
# 0.0.1
- TODO: Describe initial release.

View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

View File

@ -0,0 +1,79 @@
<!--
* 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/>.
-->
# Dart - Wyatt Type Utils
<p align="left">
<a href="https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis">
<img src="https://img.shields.io/badge/Style-Wyatt%20Analysis-blue.svg?style=flat-square" alt="Style: Wyatt Analysis" />
</a>
<img src="https://img.shields.io/badge/SDK-Dart%20%7C%20Flutter-blue?style=flat-square" alt="SDK: Dart & Flutter" />
</p>
Type Utils for Dart & Flutter.
## Option\<T>
**Option** is a container object which may or may not contain a non-null value. If a **Value** is present, `isPresent()` will return true and `get()` will return the value. Additional methods that depend on the presence or absence of a contained value are provided, such as `orElse()` (return a default value if value not present) and `ifPresent()` (execute a block of code if the value is present).
```dart
final Option<int> rand = Option.ofNullable(
Random().nextBool() ? null : 10,
);
print(
"`rand` is${rand.isNull ? "" : " not"} null, "
"so it's value is ${rand.orElse(15)}",
);
// Ok, `orElse` is equivalent to ?? but the Option is
// useful for match pattern and other utils accesses.
rand.match((value) {
print('Value is: $value');
}, () {
print('Rand is null');
},
);
print('`rand` contains 10 ? => ${rand.contains(10)}');
```
## Result\<T, E>
**Result** type is coming from functional languages where exceptions are (rightfully) considered a side-effect, and therefore not appropriate to pass domain errors. Mind the difference between different kinds of errors: Some of them belong to domain, others don't.
*E.g. null reference exception or index out of bounds are not related to domain - they rather indicate a defect.*
Either is defined as a generic type with two branches
- success with **T**
- failure with **E**
It can appear in two forms, where it contains an object of **Ok**, or where it contains an object of **Err**. It cannot appear in both states at once, or in none of them. Therefore, if one possesses an **Result** instance, it either contains a successfully produced result, or contains an error object.
```dart
Future<Result<TodoModel, AppError>> requestTodo() async => Result.tryCatchAsync(
() => get('https://jsonplaceholder.typicode.com/todos/1'),
(error) => ServerError('Error while getting todo'),
);
final Result<TodoModel, AppError> todo1 = await requestTodo();
// In Flutter:
todo1.either(buildWidgetWithTodo, buildSizedBox);
```

View File

@ -0,0 +1,20 @@
# 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/>.
include: package:wyatt_analysis/analysis_options.yaml
analyzer:
exclude: "!example/**"

View File

@ -0,0 +1,33 @@
// Copyright (C) 2022 WYATT GROUP
// Please see the AUTHORS file for details.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
class AppError {
final String message;
const AppError(this.message);
@override
// ignore: no_runtimetype_tostring
String toString() => '$runtimeType: $message';
}
class ServerError extends AppError {
ServerError(super.message);
}
class ClientError extends AppError {
ClientError(super.message);
}

View File

@ -0,0 +1,63 @@
// 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:math';
import 'package:http/http.dart' as http;
import 'package:type_utils_example/error.dart';
import 'package:type_utils_example/todo.dart';
import 'package:wyatt_type_utils/wyatt_type_utils.dart';
Future<TodoModel> get(String url) async {
final res = await http.get(Uri.parse(url));
final todo = TodoModel.fromJson(res.body);
return todo;
}
Future<Result<TodoModel, AppError>> requestTodo() async => Result.tryCatchAsync(
() => get('https://jsonplaceholder.typicode.com/todos/1'),
(error) => ServerError('Error while getting todo'),
);
Future<Result<TodoModel, AppError>> requestBadTodo() async =>
Result.tryCatchAsync(
() => get('https://jsonplaceholder.typicode.com/todos/123897'),
(error) => ServerError('Error while getting todo'),
);
Future<void> main() async {
final Result<TodoModel, AppError> todo1 = await requestTodo();
todo1.either(print, print);
final Result<TodoModel, AppError> todo2 = await requestBadTodo();
todo2.either(print, print);
final Option<int> rand = Option.ofNullable(Random().nextBool() ? null : 10);
print(
"`rand` is${rand.isNull ? "" : " not"} null, "
"so it's value is ${rand.orElse(15)}",
);
// Ok, `orElse` is equivalent to ?? but the Option is useful for match pattern
rand.match((value) {
print('Value is: $value');
}, () {
print('Rand is null');
});
print('`rand` contains 10 ? => ${rand.contains(10)}');
}

View File

@ -0,0 +1,85 @@
// 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/>.
// ignore_for_file: public_member_api_docs, sort_constructors_first,
// ignore_for_file: avoid_equals_and_hash_code_on_mutable_classes
import 'dart:convert';
class TodoModel {
final int id;
final int userId;
final String title;
final bool completed;
TodoModel({
required this.id,
required this.userId,
required this.title,
required this.completed,
});
TodoModel copyWith({
int? id,
int? userId,
String? title,
bool? completed,
}) =>
TodoModel(
id: id ?? this.id,
userId: userId ?? this.userId,
title: title ?? this.title,
completed: completed ?? this.completed,
);
Map<String, dynamic> toMap() => <String, dynamic>{
'id': id,
'userId': userId,
'title': title,
'completed': completed,
};
factory TodoModel.fromMap(Map<String, dynamic> map) => TodoModel(
id: map['id'] as int,
userId: map['userId'] as int,
title: map['title'] as String,
completed: map['completed'] as bool,
);
String toJson() => json.encode(toMap());
factory TodoModel.fromJson(String source) =>
TodoModel.fromMap(json.decode(source) as Map<String, dynamic>);
@override
String toString() => 'TodoModel(id: $id, userId: $userId, title: '
'$title, completed: $completed)';
@override
bool operator ==(covariant TodoModel other) {
if (identical(this, other)) {
return true;
}
return other.id == id &&
other.userId == userId &&
other.title == title &&
other.completed == completed;
}
@override
int get hashCode =>
id.hashCode ^ userId.hashCode ^ title.hashCode ^ completed.hashCode;
}

View File

@ -0,0 +1,43 @@
name: type_utils_example
description: A new Flutter project.
# The following line prevents the package from being accidentally published to
# pub.dev using `flutter pub publish`. This is preferred for private packages.
publish_to: "none" # Remove this line if you wish to publish to pub.dev
# The following defines the version and build number for your application.
# A version number is three numbers separated by dots, like 1.2.43
# followed by an optional build number separated by a +.
# Both the version and the builder number may be overridden in flutter
# build by specifying --build-name and --build-number, respectively.
# In Android, build-name is used as versionName while build-number used as versionCode.
# Read more about Android versioning at https://developer.android.com/studio/publish/versioning
# In iOS, build-name is used as CFBundleShortVersionString while build-number used as CFBundleVersion.
# Read more about iOS versioning at
# https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html
version: 1.0.0+1
environment:
sdk: ">=2.17.0 <3.0.0"
# Dependencies specify other packages that your package needs in order to work.
# To automatically upgrade your package dependencies to the latest versions
# consider running `flutter pub upgrade --major-versions`. Alternatively,
# dependencies can be manually updated by changing the version numbers below to
# the latest version available on pub.dev. To see which dependencies have newer
# versions available, run `flutter pub outdated`.
dependencies:
http: ^0.13.4
wyatt_type_utils:
path: "../"
dev_dependencies:
wyatt_analysis:
git:
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
ref: wyatt_analysis-v2.1.0
path: packages/wyatt_analysis
# For information on the generic Dart part of this file, see the
# following page: https://dart.dev/tools/pub/pubspec

View File

@ -13,6 +13,3 @@
//
// 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 'authentication_repository_firebase.dart';
export 'authentication_repository_interface.dart';

View File

@ -0,0 +1,145 @@
// // 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/>.
// // ignore_for_file: avoid_positional_boolean_parameters
part 'future_result.dart';
part 'result.dart';
part 'option.dart';
mixin _Left<LeftType, RightType> on _EitherBase<LeftType, RightType> {}
mixin _Right<LeftType, RightType> on _EitherBase<LeftType, RightType> {}
class _EitherBaseException implements Exception {
final String message;
const _EitherBaseException(this.message);
@override
String toString() => '_EitherException: $message';
}
abstract class _EitherBase<LeftType, RightType> {
const _EitherBase();
bool get _isLeft => this is _Left<LeftType, RightType>;
bool get _isRight => this is _Right<LeftType, RightType>;
LeftType? get _left => _fold<LeftType?>(
(value) => value,
(right) => null,
);
RightType? get _right => _fold<RightType?>(
(left) => null,
(value) => value,
);
U _unwrap<U>() {
if (U == LeftType) {
return _fold<LeftType>(
(value) => value,
(right) => throw const ResultException(
'Illegal use. You should check left value before calling',
),
) as U;
}
if (U == RightType) {
return _fold<RightType>(
(left) => throw const ResultException(
'Illegal use. You should check right value before calling',
),
(value) => value,
) as U;
}
throw ResultException(
'Illegal use. You should use $LeftType or $RightType type',
);
}
Future<U> _unwrapAsync<U>() {
if (U == LeftType) {
return _foldAsync<LeftType>(
Future.value,
(right) => throw const ResultException(
'Illegal use. You should check left value before calling',
),
) as Future<U>;
}
if (U == RightType) {
return _foldAsync<RightType>(
(left) => throw const ResultException(
'Illegal use. You should check right value before calling',
),
Future.value,
) as Future<U>;
}
throw ResultException(
'Illegal use. You should use $LeftType or $RightType type',
);
}
U _fold<U>(
U Function(LeftType left) fnL,
U Function(RightType right) fnR,
);
Future<U> _foldAsync<U>(
Future<U> Function(LeftType left) fnL,
Future<U> Function(RightType right) fnR,
);
_EitherBase<U, RightType> _and<U>(
_EitherBase<U, RightType> res,
);
_EitherBase<LeftType, F> _or<F>(
_EitherBase<LeftType, F> res,
);
bool _contains<U>(U x);
LeftType _expect(String msg);
RightType _expectErr(String msg);
_EitherBase<U, RightType> _map<U>(
U Function(LeftType left) mapper,
);
Future<_EitherBase<U, RightType>> _mapAsync<U>(
Future<U> Function(LeftType left) mapper,
);
_EitherBase<LeftType, F> _mapErr<F>(
F Function(RightType right) mapper,
);
Future<_EitherBase<LeftType, F>> _mapErrAsync<F>(
Future<F> Function(RightType right) mapper,
);
_EitherBase<L, R> _either<L, R>(
L Function(LeftType left) fnL,
R Function(RightType right) fnR,
);
Future<_EitherBase<L, R>> _eitherAsync<L, R>(
Future<L> Function(LeftType left) fnL,
Future<R> Function(RightType right) fnR,
);
}

View File

@ -0,0 +1,108 @@
// 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/>.
part of 'either_base.dart';
extension FutureResult<T, E> on Future<Result<T, E>> {
/// Represents the left side of [Result] class.
Future<bool> get isOk => then((result) => result.isOk);
/// Represents the right side of [Result] class.
Future<bool> get isErr => then((result) => result.isErr);
/// Get [U] value, may throw an exception.
Future<U> unwrap<U>() => then((result) => result.unwrap<U>());
/// Get **async** [U] value, may throw an exception.
///
/// With nullable, `Future(Future(U)) == Future(U)`
Future<U> unwrapAsync<U>() => then((result) => result.unwrapAsync<U>());
/// Fold [Ok] and [Err] into the value of one type
Future<U> fold<U>(
U Function(T value) valueTransformer,
U Function(E error) errorTransformer,
) =>
then((result) => result.fold(valueTransformer, errorTransformer));
/// Fold [Ok] and [Err] **asynchronously** into the value of one type
Future<U> foldAsync<U>(
Future<U> Function(T value) valueTransformer,
Future<U> Function(E error) errorTransformer,
) =>
then((result) => result.foldAsync(valueTransformer, errorTransformer));
/// Swap [Ok] and [Err]
Future<Result<E, T>> swap() => then((result) => result.swap());
/// Returns [res] if the [Result] is [Ok], otherwise returns
/// the [Err] value of this.
Future<Result<U, E>> and<U>(Result<U, E> res) =>
then((result) => result.and(res));
/// Returns [res] if the [Result] is [Err], otherwise returns
/// the [Ok] value of this.
Future<Result<T, F>> or<F>(Result<T, F> res) =>
then((result) => result.or(res));
/// Returns true if the result is an [Ok] or [Err] value containing
/// the given value/error.
Future<bool> contains<U>(U x) => then((result) => result.contains(x));
/// Returns the contained [Ok] value. Throw [ResultException] on [Err] with
/// its content.
Future<T> expect(String msg) => then((result) => result.expect(msg));
/// Returns the contained [Err] value. Throw [ResultException] on [Ok] with
/// its content.
Future<E> expectErr(String msg) => then((result) => result.expectErr(msg));
/// Maps a [Result<T, E>] to [Result<U, E>] by applying a function to a
/// contained [Ok] value, leaving an [Err] value untouched.
Future<Result<U, E>> map<U>(U Function(T value) mapper) =>
then((result) => result.map(mapper));
/// Maps a [Result<T, E>] to [Result<U, E>] by applying an **async** function
/// to a contained [Ok] value, leaving an [Err] value untouched.
Future<Result<U, E>> mapAsync<U>(Future<U> Function(T value) mapper) =>
then((result) => result.mapAsync(mapper));
/// Maps a [Result<T, E>] to [Result<T, F>] by applying a function to a
/// contained [Err] value, leaving an [Ok] value untouched.
Future<Result<T, F>> mapErr<F>(F Function(E error) mapper) =>
then((result) => result.mapErr(mapper));
/// Maps a [Result<T, E>] to [Result<U, E>] by applying an **async** function
/// to a contained [Err] value, leaving an [Ok] value untouched.
Future<Result<T, F>> mapErrAsync<F>(Future<F> Function(E error) mapper) =>
then((result) => result.mapErrAsync(mapper));
/// Transforms a [Result<T, E>] to [Result<U, F>] by applying functions to
/// contained [Ok] and [Err] values.
Future<Result<U, F>> either<U, F>(
U Function(T value) valueTransformer,
F Function(E error) errorTransformer,
) =>
then((result) => result.either(valueTransformer, errorTransformer));
/// Transforms a [Result<T, E>] to [Result<U, F>] by applying **async**
/// functions to contained [Ok] and [Err] values.
Future<Result<U, F>> eitherAsync<U, F>(
Future<U> Function(T value) valueTransformer,
Future<F> Function(E error) errorTransformer,
) =>
then((result) => result.eitherAsync(valueTransformer, errorTransformer));
}

View File

@ -0,0 +1,301 @@
// 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/>.
part of 'either_base.dart';
/// {@template option_exception}
/// [OptionException] is sometimes threw by [Option] objects.
///
/// ```dart
/// throw OptionException('Emergency failure!');
/// ```
/// {@endtemplate}
class OptionException extends _EitherBaseException {
/// {@macro result_exception}
const OptionException(super.message);
@override
String toString() => 'OptionException: $message';
}
/// {@template option}
/// [Option] is a container object which may or may not contain a non-null
/// value. If a [Value] is present, isPresent() will return true and get()
/// will return the value.
///
/// Additional methods that depend on the presence or absence of
/// a contained value are provided, such as orElse() (return a default value
/// if value not present) and ifPresent() (execute a block of code if the
/// value is present).
/// {@endtemplate}
abstract class Option<T> extends _EitherBase<T, void> {
/// {@macro option}
const Option._();
/// Represents the left side of [Option] class.
bool get isPresent => _isLeft;
/// Represents the right side of [Option] class.
bool get isNull => _isRight;
/// Get nullable [Value].
T? get() => _left;
/// Get [U] value, may throw an exception.
U unwrap<U>() => _unwrap<U>();
/// Get **async** [U] value, may throw an exception.
Future<U> unwrapAsync<U>() => _unwrapAsync<U>();
/// Match [Value] and [None].
void match(
void Function(T value) value,
void Function() none,
) =>
_fold<void>(
(left) => value(left),
(right) => none(),
);
/// Match **async** [Value] and [None].
Future<void> matchAsync(
Future<void> Function(T value) value,
Future<void> Function() none,
) =>
_foldAsync<void>(
(left) => value(left),
(right) => none(),
);
/// If [Value] is present, invoke the specified consumer
/// with the value, otherwise do nothing.
void ifPresent(
void Function(T value) consumer,
) =>
_fold<void>(
(left) => consumer(left),
(right) => {},
);
/// Return the [Value] if present, otherwise return [other].
T orElse(
T other,
) =>
_fold<T>(
(left) => left,
(right) => other,
);
/// Return the [Value] if present, otherwise call and return result
/// of [supplier].
T orElseLazy(
T Function() supplier,
) =>
_fold<T>(
(left) => left,
(right) => supplier(),
);
/// Returns [res] if the [Option] is [Value], otherwise returns
/// the [None] value of this.
Option<U> and<U>(Option<U> res) => _and<U>(res) as Option<U>;
/// Returns [res] if the [Option] is [None], otherwise returns
/// the [Value] of this.
Option<T> or(Option<T> res) => _or<void>(res) as Option<T>;
/// Returns true if the result is a [Value].
bool contains<U>(U x) => _contains(x);
/// Returns the contained [Value]. Throw [OptionException] on [None].
T expect(String msg) => _expect(msg);
/// Maps a [Option<T>] to [Option<U>] by applying a function to a
/// contained [Value].
Option<U> map<U>(U Function(T value) mapper) => _map(mapper) as Option<U>;
/// Maps a [Option<T>] to [Option<U>] by applying an **async** function
/// to a contained [Value].
Future<Option<U>> mapAsync<U>(Future<U> Function(T value) mapper) async =>
await _mapAsync(mapper) as Option<U>;
/// Constructs an [Option] with the specified present non-null [Value].
static Value<T> of<T>(T value) {
if (value == null) {
throw const OptionException("Value can' be null. Use `ofNullable()`");
}
return ofNullable(value) as Value<T>;
}
/// Constructs an [Option] describing the specified [Value],
/// if non-null, otherwise returns a [None].
static Option<T> ofNullable<T>(T? value) {
if (value != null) {
return Value(value);
} else {
return None<T>();
}
}
/// Constructs an [Option] with the specified present non-null [Value].
static Value<T> ofLazy<T>(T Function() value) {
final v = value();
if (v == null) {
throw const OptionException("Value can' be null. Use `ofNullableLazy()`");
}
return ofNullable(v) as Value<T>;
}
/// Constructs an [Option] describing the specified [Value],
/// if non-null, otherwise returns a [None].
static Option<T> ofNullableLazy<T>(T? Function() value) {
final v = value();
if (v != null) {
return Value(v);
} else {
return None<T>();
}
}
}
class Value<T> extends Option<T> with _Left<T, void> {
final T value;
/// {@macro ok}
const Value(this.value) : super._();
@override
_EitherBase<U, void> _and<U>(_EitherBase<U, void> res) => res as Option<U>;
@override
bool _contains<U>(U x) => value == x;
@override
_EitherBase<L, R> _either<L, R>(
L Function(T left) fnL,
R Function(void right) fnR,
) =>
throw UnimplementedError();
@override
Future<_EitherBase<L, R>> _eitherAsync<L, R>(
Future<L> Function(T left) fnL,
Future<R> Function(void right) fnR,
) =>
throw UnimplementedError();
@override
T _expect(String msg) => value;
@override
void _expectErr(String msg) => throw UnimplementedError();
@override
U _fold<U>(U Function(T left) fnL, U Function(void right) fnR) => fnL(value);
@override
Future<U> _foldAsync<U>(
Future<U> Function(T left) fnL,
Future<U> Function(void right) fnR,
) =>
fnL(value);
@override
_EitherBase<U, void> _map<U>(U Function(T left) mapper) =>
Value(mapper(value));
@override
Future<_EitherBase<U, void>> _mapAsync<U>(
Future<U> Function(T left) mapper,
) =>
mapper(value).then(Value.new);
@override
_EitherBase<T, F> _mapErr<F>(F Function(void right) mapper) =>
throw UnimplementedError();
@override
Future<_EitherBase<T, F>> _mapErrAsync<F>(
Future<F> Function(void right) mapper,
) =>
throw UnimplementedError();
@override
_EitherBase<T, F> _or<F>(_EitherBase<T, F> res) => this as _EitherBase<T, F>;
}
class None<T> extends Option<T> with _Right<T, void> {
/// {@macro ok}
const None() : super._();
@override
_EitherBase<U, void> _and<U>(_EitherBase<U, void> res) => this as Option<U>;
@override
bool _contains<U>(U x) => false;
@override
_EitherBase<L, R> _either<L, R>(
L Function(T left) fnL,
R Function(void right) fnR,
) =>
throw UnimplementedError();
@override
Future<_EitherBase<L, R>> _eitherAsync<L, R>(
Future<L> Function(T left) fnL,
Future<R> Function(void right) fnR,
) =>
throw UnimplementedError();
@override
T _expect(String msg) => throw OptionException(msg);
@override
void _expectErr(String msg) => throw UnimplementedError();
@override
U _fold<U>(U Function(T left) fnL, U Function(void right) fnR) => fnR(null);
@override
Future<U> _foldAsync<U>(
Future<U> Function(T left) fnL,
Future<U> Function(void right) fnR,
) =>
fnR(null);
@override
_EitherBase<U, void> _map<U>(U Function(T left) mapper) => None<U>();
@override
Future<_EitherBase<U, void>> _mapAsync<U>(
Future<U> Function(T left) mapper,
) =>
Future.value(None<U>());
@override
_EitherBase<T, F> _mapErr<F>(F Function(void right) mapper) =>
throw UnimplementedError();
@override
Future<_EitherBase<T, F>> _mapErrAsync<F>(
Future<F> Function(void right) mapper,
) =>
throw UnimplementedError();
@override
_EitherBase<T, F> _or<F>(_EitherBase<T, F> res) => res;
}

View File

@ -0,0 +1,327 @@
// 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/>.
// ignore_for_file: avoid_positional_boolean_parameters
part of 'either_base.dart';
/// {@template result_exception}
/// [ResultException] is sometimes threw by [Result] objects.
///
/// ```dart
/// throw ResultException('Emergency failure!');
/// ```
/// {@endtemplate}
class ResultException extends _EitherBaseException {
/// {@macro result_exception}
const ResultException(super.message);
@override
String toString() => 'ResultException: $message';
}
/// {@template result}
/// [Result] type is coming from functional languages where exceptions are
/// (rightfully) considered a side-effect, and therefore not appropriate to
/// pass domain errors. Mind the difference between different kinds of errors:
/// Some of them belong to domain, others don't.
///
/// *E.g. null reference exception or index out of bounds
/// are not related to domain - they rather indicate a defect.*
///
/// Either is defined as a generic type with two branches
/// - success with [T]
/// - failure with [E]
///
/// It can appear in two forms, where
/// it contains an object of [Ok], or where it contains an object
/// of [Err]. It cannot appear in both states at once, or in none of them.
/// Therefore, if one possesses an [Result] instance, it either contains a
/// successfully produced result, or contains an error object.
/// {@endtemplate}
abstract class Result<T, E> extends _EitherBase<T, E> {
/// {@macro result}
const Result._();
/// Represents the left side of [Result] class.
bool get isOk => _isLeft;
/// Represents the right side of [Result] class.
bool get isErr => _isRight;
/// Get nullable [Ok] value, and discarding the error, if any.
T? get ok => _left;
/// Get nullable [Err] value, and discarding the success value, if any.
E? get err => _right;
/// Get [U] value, may throw an exception.
U unwrap<U>() => _unwrap<U>();
/// Get **async** [U] value, may throw an exception.
Future<U> unwrapAsync<U>() => _unwrapAsync<U>();
/// Fold [Ok] and [Err] into the value of one type
U fold<U>(
U Function(T value) valueTransformer,
U Function(E error) errorTransformer,
) =>
_fold(
(left) => valueTransformer(left),
(right) => errorTransformer(right),
);
/// Fold [Ok] and [Err] **asynchronously** into the value of one type
Future<U> foldAsync<U>(
Future<U> Function(T value) valueTransformer,
Future<U> Function(E error) errorTransformer,
) =>
_foldAsync(
(left) => valueTransformer(left),
(right) => errorTransformer(right),
);
/// Swap [Ok] and [Err]
Result<E, T> swap() => fold(Err.new, Ok.new);
/// Returns [res] if the [Result] is [Ok], otherwise returns
/// the [Err] value of this.
Result<U, E> and<U>(Result<U, E> res) => _and<U>(res) as Result<U, E>;
/// Returns [res] if the [Result] is [Err], otherwise returns
/// the [Ok] value of this.
Result<T, F> or<F>(Result<T, F> res) => _or<F>(res) as Result<T, F>;
/// Returns true if the result is an [Ok] or [Err] value containing
/// the given value/error.
bool contains<U>(U x) => _contains(x);
/// Returns the contained [Ok] value. Throw [ResultException] on [Err] with
/// its content.
T expect(String msg) => _expect(msg);
/// Returns the contained [Err] value. Throw [ResultException] on [Ok] with
/// its content.
E expectErr(String msg) => _expectErr(msg);
/// Maps a [Result<T, E>] to [Result<U, E>] by applying a function to a
/// contained [Ok] value, leaving an [Err] value untouched.
Result<U, E> map<U>(U Function(T value) mapper) =>
_map(mapper) as Result<U, E>;
/// Maps a [Result<T, E>] to [Result<U, E>] by applying an **async** function
/// to a contained [Ok] value, leaving an [Err] value untouched.
Future<Result<U, E>> mapAsync<U>(Future<U> Function(T value) mapper) =>
_mapAsync(mapper) as Future<Result<U, E>>;
/// Maps a [Result<T, E>] to [Result<T, F>] by applying a function to a
/// contained [Err] value, leaving an [Ok] value untouched.
Result<T, F> mapErr<F>(F Function(E error) mapper) =>
_mapErr(mapper) as Result<T, F>;
/// Maps a [Result<T, E>] to [Result<U, E>] by applying an **async** function
/// to a contained [Err] value, leaving an [Ok] value untouched.
Future<Result<T, F>> mapErrAsync<F>(Future<F> Function(E error) mapper) =>
_mapErrAsync(mapper) as Future<Result<T, F>>;
/// Transforms a [Result<T, E>] to [Result<U, F>] by applying functions to
/// contained [Ok] and [Err] values.
Result<U, F> either<U, F>(
U Function(T value) valueTransformer,
F Function(E error) errorTransformer,
) =>
_either<U, F>(valueTransformer, errorTransformer) as Result<U, F>;
/// Transforms a [Result<T, E>] to [Result<U, F>] by applying **async**
/// functions to contained [Ok] and [Err] values.
Future<Result<U, F>> eitherAsync<U, F>(
Future<U> Function(T value) valueTransformer,
Future<F> Function(E error) errorTransformer,
) =>
_eitherAsync<U, F>(valueTransformer, errorTransformer)
as Future<Result<U, F>>;
/// Constructs a new [Result] from a function that might throw
static Result<T, E> tryCatch<T, E, Error extends Object>(
T Function() tryFn,
E Function(Error error) onError,
) {
try {
return Ok(tryFn());
} on Error catch (e) {
return Err(onError(e));
}
}
/// Constructs a new [Result] from an **async** function that might throw
static Future<Result<T, E>> tryCatchAsync<T, E, Error extends Object>(
Future<T> Function() tryFn,
E Function(Error error) onError,
) async {
try {
return Ok(await tryFn());
} on Error catch (e) {
return Err(onError(e));
}
}
/// If the condition is satify then return [value] in
/// [Ok] else [error] in [Err]
static Result<T, E> conditional<T, E>(
bool test,
T value,
E error,
) =>
test ? Ok(value) : Err(error);
/// If the condition is satify then return *command* [value]
/// in [Ok] else [error] in [Err]
static Result<T, E> conditionalLazy<T, E>(
bool test,
T Function() value,
E Function() error,
) =>
test ? Ok(value()) : Err(error());
}
/// {@template ok}
/// Contains the success value of a [Result]
///
/// {@macro result}
/// {@endtemplate}
class Ok<T, E> extends Result<T, E> with _Left<T, E> {
final T value;
/// {@macro ok}
const Ok(this.value) : super._();
@override
U _fold<U>(U Function(T left) fnL, U Function(E right) fnR) => fnL(value);
@override
Future<U> _foldAsync<U>(
Future<U> Function(T left) fnL,
Future<U> Function(E right) fnR,
) =>
fnL(value);
@override
Result<U, E> _and<U>(_EitherBase<U, E> res) => res as Result<U, E>;
@override
Result<T, F> _or<F>(_EitherBase<T, F> res) => this as Result<T, F>;
@override
bool _contains<U>(U x) => value == x;
@override
T _expect(String msg) => value;
@override
E _expectErr(String msg) => throw ResultException('$msg: $value');
@override
Result<U, E> _map<U>(U Function(T value) mapper) => Ok(mapper(value));
@override
Future<Result<U, E>> _mapAsync<U>(Future<U> Function(T value) mapper) =>
mapper(value).then(Ok.new);
@override
Result<T, F> _mapErr<F>(F Function(E error) mapper) => Ok(value);
@override
Future<Result<T, F>> _mapErrAsync<F>(Future<F> Function(E error) mapper) =>
Future.value(Ok(value));
@override
Result<U, F> _either<U, F>(
U Function(T value) fnL,
F Function(E error) fnR,
) =>
Ok(fnL(value));
@override
Future<Result<U, F>> _eitherAsync<U, F>(
Future<U> Function(T value) fnL,
Future<F> Function(E error) fnR,
) =>
fnL(value).then(Ok.new);
}
/// {@template err}
/// Contains the error value of a [Result]
///
/// {@macro result}
/// {@endtemplate}
class Err<T, E> extends Result<T, E> with _Right<T, E> {
final E error;
/// {@macro err}
const Err(this.error) : super._();
@override
U _fold<U>(U Function(T left) fnL, U Function(E right) fnR) => fnR(error);
@override
Future<U> _foldAsync<U>(
Future<U> Function(T left) fnL,
Future<U> Function(E right) fnR,
) =>
fnR(error);
@override
Result<U, E> _and<U>(_EitherBase<U, E> res) => this as Result<U, E>;
@override
Result<T, F> _or<F>(_EitherBase<T, F> res) => res as Result<T, F>;
@override
bool _contains<U>(U x) => error == x;
@override
T _expect(String msg) => throw ResultException('$msg: $error');
@override
E _expectErr(String msg) => error;
@override
Result<U, E> _map<U>(U Function(T value) mapper) => Err(error);
@override
Future<Result<U, E>> _mapAsync<U>(Future<U> Function(T value) mapper) =>
Future.value(Err(error));
@override
Result<T, F> _mapErr<F>(F Function(E error) mapper) => Err(mapper(error));
@override
Future<Result<T, F>> _mapErrAsync<F>(Future<F> Function(E error) mapper) =>
mapper(error).then(Err.new);
@override
Result<U, F> _either<U, F>(
U Function(T value) fnL,
F Function(E error) fnR,
) =>
Err(fnR(error));
@override
Future<Result<U, F>> _eitherAsync<U, F>(
Future<U> Function(T value) fnL,
Future<F> Function(E error) fnR,
) =>
fnR(error).then(Err.new);
}

Some files were not shown because too many files have changed in this diff Show More